Package com.atlassian.confluence.spaces.actions

Class CustomPageContentAction

java.lang.Object

org.apache.struts2.ActionSupport

com.atlassian.confluence.core.AbstractI18nActionSupport

com.atlassian.confluence.core.ConfluenceActionSupport

com.atlassian.confluence.spaces.actions.AbstractSpaceAction

com.atlassian.confluence.spaces.actions.CustomPageContentAction

All Implemented Interfaces:

FormAware, WebInterface, SpaceAware, Spaced, MessageHolderAware, Serializable, org.apache.struts2.action.Action, org.apache.struts2.interceptor.ValidationAware, org.apache.struts2.locale.LocaleProvider, org.apache.struts2.text.TextProvider, org.apache.struts2.Validateable

public class CustomPageContentAction
extends AbstractSpaceAction
implements FormAware, SpaceAware

See Also:

• Serialized Form

Field Summary

Fields inherited from class com.atlassian.confluence.spaces.actions.AbstractSpaceAction

key, notificationManager, space, spaceManager, themeManager, wikiStyleRenderer

Fields inherited from class com.atlassian.confluence.core.ConfluenceActionSupport

accessModeService, CANCEL, confluenceAccessManager, contentUiSupport, eventPublisher, formatSettingsManager, globalSettingsManager, i18NBeanFactory, labelManager, languageManager, LICENSE_EXPIRED, LICENSE_USERS_EXCEEDED, localeManager, loginManager, messageHolder, permissionManager, pluginAccessor, PREVIEW, request, response, spacePermissionManager, strutsHelper, systemInformationService, userAccessor, webInterfaceManager

Fields inherited from class org.apache.struts2.ActionSupport

container

Fields inherited from interface org.apache.struts2.action.Action

ERROR, INPUT, LOGIN, NONE, SUCCESS

Constructor Summary

Constructors

Constructor	Description
CustomPageContentAction()

Method Summary

Modifier and Type	Method	Description
String	doDefault()	Convenient Action execution method which defaults to returning INPUT
String	execute()
String	getFooterText()
String	getHeaderText()
String	getSidebarText()
boolean	isEditMode()
boolean	isPermitted()	Consulted by PermissionCheckInterceptor.
boolean	isSpaceRequired()	If the action requires that the space be set before being run, then it should return true to this method.
boolean	isViewPermissionRequired()
void	setCustomPageSettingsManager(CustomPageSettingsManager customPageSettingsManager)
void	setFooterText(String footerText)
void	setHeaderText(String headerText)
void	setSidebarText(String sidebarText)

Methods inherited from class com.atlassian.confluence.spaces.actions.AbstractSpaceAction

getActionSpaceKey, getKey, getPermissionTypes, getSpace, getSpaceKey, getSpaceManager, getSubscribableName, getThemeManager, hasSpaceIA, isPersonalSpace, isUserWatchingSpace, isValidSpaceKey, setKey, setNotificationManager, setSpace, setSpaceManager, setThemeManager, setWikiStyleRenderer

Methods inherited from class com.atlassian.confluence.core.ConfluenceActionSupport

addActionError, addActionMessage, addFieldError, addPermissionTypeTo, addToHistory, getActionErrors, getActionMessages, getActionName, getActiveRequest, getActiveResponse, getAuthenticatedUser, getBootstrapStatusProvider, getCancelResult, getDateFormatter, getDefaultTimeZone, getFieldErrors, getGlobalSettings, getHelper, getI18n, getLocale, getMessageHolder, getPermittedEntitiesOf, getPermittedEntitiesOf, getPermittedEntitiesOf, getPreviousLoginDate, getTimeZone, getUserByName, getUserInterfaceState, getWebInterfaceContext, isAnonymousUser, isEmailVisible, setAccessModeService, setBootstrapStatusProvider, setCancel, setConfluenceAccessManager, setContentUiSupport, setEventPublisher, setFormatSettingsManager, setI18NBean, setI18NBeanFactory, setLabelManager, setLanguageManager, setLocaleManager, setLoginManager, setMessageHolder, setPermissionManager, setPluginAccessor, setPreviousLoginDate, setSettingsManager, setSpacePermissionManager, setStrutsHelper, setSystemInformationService, setTimeZoneManager, setUserAccessor, setWebInterfaceManager

Methods inherited from class com.atlassian.confluence.core.AbstractI18nActionSupport

getText, getText, getText, getText, getText, getText, getText, getText, getTextStrict

Methods inherited from class org.apache.struts2.ActionSupport

addActionError, addActionMessage, addFieldError, clearActionErrors, clearErrors, clearErrorsAndMessages, clearFieldErrors, clearMessages, clone, getContainer, getFormatted, getLocaleProvider, getText, getText, getTextProvider, getTexts, getTexts, hasActionErrors, hasActionMessages, hasErrors, hasFieldErrors, hasKey, input, isValidLocale, isValidLocaleString, pause, setActionErrors, setActionMessages, setContainer, setFieldErrors, toLocale, validate

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.atlassian.confluence.validation.MessageHolderAware

validate

Methods inherited from interface com.atlassian.confluence.spaces.actions.SpaceAware

setSpace

Methods inherited from interface com.atlassian.confluence.spaces.Spaced

getSpace

Constructor Details

CustomPageContentAction

public CustomPageContentAction()

Method Details

isPermitted

public boolean isPermitted()

Description copied from class: ConfluenceActionSupport

Consulted by PermissionCheckInterceptor.

Overrides:

isPermitted in class AbstractSpaceAction

doDefault

public String doDefault()

Description copied from class: ConfluenceActionSupport

Convenient Action execution method which defaults to returning INPUT

Overrides:

doDefault in class ConfluenceActionSupport

execute

public String execute()
               throws Exception

Specified by:

execute in interface org.apache.struts2.action.Action

Overrides:

execute in class org.apache.struts2.ActionSupport

Throws:

Exception

getFooterText

public String getFooterText()

getHeaderText

public String getHeaderText()

getSidebarText

public String getSidebarText()

setHeaderText

public void setHeaderText(String headerText)

setFooterText

public void setFooterText(String footerText)

setSidebarText

public void setSidebarText(String sidebarText)

setCustomPageSettingsManager

public void setCustomPageSettingsManager(CustomPageSettingsManager customPageSettingsManager)

isEditMode

public boolean isEditMode()

Specified by:

isEditMode in interface FormAware

isSpaceRequired

public boolean isSpaceRequired()

Description copied from interface: SpaceAware

If the action requires that the space be set before being run, then it should return true to this method. If the action requires a space, but no space is available, then the interceptor will automatically redirect to the 'pagenotfound' result

Specified by:

isSpaceRequired in interface SpaceAware

Returns:

true if the action requires a space in order to execute

isViewPermissionRequired

public boolean isViewPermissionRequired()

Specified by:

isViewPermissionRequired in interface SpaceAware

Returns:

true if the action requires view space permission