com.atlassian.confluence.pages.actions
Class AbstractPageAction

java.lang.Object
  com.opensymphony.xwork.ActionSupport
      com.atlassian.confluence.core.ConfluenceActionSupport
          com.atlassian.confluence.pages.actions.AbstractPageAwareAction
              com.atlassian.confluence.pages.actions.AbstractPageAction

All Implemented Interfaces:

PageAware, TinyUrlAware, WebInterface, Action, LocaleProvider, TextProvider, Validateable, ValidationAware, Serializable

Direct Known Subclasses:

AbstractPageChangeAction, AbstractPreviewPageAction, ExportWordPageAction, RevertPageBackToVersionAction, ViewPageAction

public abstract class AbstractPageAction
extends AbstractPageAwareAction
implements TinyUrlAware

See Also:

Serialized Form

Field Summary

protected List	incomingLinks
protected boolean	isXHtml
protected LinkManager	linkManager
static String	MARKUP
protected PageManager	pageManager
static String	PREVIEW
static String	RICHTEXT
protected ConfluenceWysiwygConverter	wysiwygConverter

Fields inherited from class com.atlassian.confluence.pages.actions.AbstractPageAwareAction

contentPermissionManager, spaceManager

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

CANCEL, DEVMODE, eventManager, i18NBeanFactory, labelManager, languageManager, LICENSE_EXPIRED, LICENSE_USERS_EXCEEDED, log, permissionManager, permitted, pluginAccessor, settingsManager, spacePermissionManager, userAccessor, webInterfaceManager

Fields inherited from class com.opensymphony.xwork.ActionSupport

LOG

Fields inherited from interface com.opensymphony.xwork.Action

ERROR, INPUT, LOGIN, NONE, SUCCESS

Constructor Summary

AbstractPageAction()

Method Summary

boolean	displayDatePath()
ContentEntityObject	getAttachmentSourceContent() Returns the ConfluenceEntityObject that contains attachments relevant to the current action.
List	getAvailableSpaces()
protected Object	getBeanKey()
BlogPost	getBlogPost()
Editor	getEditor()
String	getEditorVersion()
ThemeHelper	getHelper()
List<OutgoingLink>	getIncomingLinks() returns list of "unique" incoming links to this page.
static String	getMARKUP()
String	getMode()
BlogPost	getNextPost()
protected List<String>	getPermissionTypes()
List	getPermittedChildren()
Date	getPostingDate()
String	getPostingDay()
String	getPostingDayOfMonth()
String	getPostingMonth()
String	getPostingMonthNumeric()
String	getPostingYear()
static String	getPREVIEW()
BlogPost	getPreviousPost()
AbstractPage	getPreviousVersion(int version)
static String	getRICHTEXT()
boolean	getShowMarkup()
SpaceManager	getSpaceManager()
List	getSuggestedLabels()
boolean	getSupportWysiwyg()
String	getTinyUrl()
boolean	getUseWysiwyg()
WebInterfaceContext	getWebInterfaceContext() Returns a context which can be passed to web items when rendering them.
boolean	getXhtml()
boolean	hasAttachFilePermissions()
boolean	hasPermittedChildren()
protected boolean	isSpaceAdmin()
void	setConfluenceWysiwygConverter(ConfluenceWysiwygConverter wysiwygConverter)
void	setEditorManager(EditorManager editorManager)
void	setLinkManager(LinkManager linkManager)
void	setMode(String mode)
void	setPageManager(PageManager pageManager)
void	setPostingDate(Date date)
void	setXhtml(boolean XHtml)

Methods inherited from class com.atlassian.confluence.pages.actions.AbstractPageAwareAction

getPage, getPageId, getSpace, getSpaceKey, getTitle, hasViewPagePermission, isLatestVersionRequired, isPageRequired, isPermitted, isViewPermissionRequired, setContentPermissionManager, setPage, setSpaceManager

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

addActionError, addFieldError, addPermissionTypeTo, addToHistory, doDefault, formatFriendlyDate, getActionName, getActionName, getBootstrapManager, getCancelResult, getDateFormatter, getDefaultResourceBundle, getEventManager, getFriendlyDateFormatter, getGlobalSettings, getI18n, getInstalledLanguages, getLabelManager, getLanguageManager, getLanguageUserFriendly, getLocale, getLocaleManager, getLocaleString, getNiceContentType, getPermittedEntitiesOf, getPermittedEntitiesOf, getPermittedEntitiesOf, getPreviousLoginDate, getRandom, getRemoteUser, getSession, getText, getText, getText, getText, getTextStatic, getTextStatic, getTextStrict, getTimeZone, getUser, getUserAccessor, getUserFullName, getUserInterfaceState, getWebInterfaceManager, hasPermissionForSpace, isAnonymousUser, isCanceled, isDevMode, isEmailVisible, isExternalUserManagementEnabled, isLabelable, isPermissionCheck, isPermittedAsString, isPrintableVersion, isSharedMode, isUserStatusPluginEnabled, isUsingHSQL, setBootstrapManager, setCancel, setEventManager, setFormatSettingsManager, setI18NBean, setI18NBeanFactory, setLabelManager, setLanguageManager, setLocaleManager, setPermissionCheck, setPermissionManager, setPluginAccessor, setPreviousLoginDate, setSettingsManager, setSpacePermissionManager, setUserAccessor, setWebInterfaceManager

Methods inherited from class com.opensymphony.xwork.ActionSupport

addActionError, addActionMessage, addFieldError, execute, getActionErrors, getActionMessages, getErrorMessages, getErrors, getFieldErrors, getText, getTexts, getTexts, hasActionErrors, hasActionMessages, hasErrors, hasFieldErrors, setActionErrors, setActionMessages, setFieldErrors, validate

Methods inherited from class java.lang.Object

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

Field Detail

pageManager

protected PageManager pageManager

linkManager

protected LinkManager linkManager

incomingLinks

protected List incomingLinks

isXHtml

protected boolean isXHtml

wysiwygConverter

protected ConfluenceWysiwygConverter wysiwygConverter

RICHTEXT

public static final String RICHTEXT

See Also:

Constant Field Values

MARKUP

public static final String MARKUP

See Also:

Constant Field Values

PREVIEW

public static final String PREVIEW

See Also:

Constant Field Values

Constructor Detail

AbstractPageAction

public AbstractPageAction()

Method Detail

getPostingDay

public String getPostingDay()

displayDatePath

public boolean displayDatePath()

getPostingYear

public String getPostingYear()

getPostingMonth

public String getPostingMonth()

getPostingMonthNumeric

public String getPostingMonthNumeric()

getPostingDayOfMonth

public String getPostingDayOfMonth()

getBlogPost

public BlogPost getBlogPost()

setPageManager

public void setPageManager(PageManager pageManager)

setLinkManager

public void setLinkManager(LinkManager linkManager)

getIncomingLinks

public List<OutgoingLink> getIncomingLinks()

returns list of "unique" incoming links to this page. TODO remove this from AbstractPageAction and only use on relevant actions

getPermissionTypes

protected List<String> getPermissionTypes()

Overrides:

getPermissionTypes in class ConfluenceActionSupport

getPostingDate

public Date getPostingDate()

setPostingDate

public void setPostingDate(Date date)

getNextPost

public BlogPost getNextPost()

getPreviousPost

public BlogPost getPreviousPost()

getTinyUrl

public String getTinyUrl()

Specified by:

getTinyUrl in interface TinyUrlAware

isSpaceAdmin

protected boolean isSpaceAdmin()

getAvailableSpaces

public List getAvailableSpaces()

getPreviousVersion

public AbstractPage getPreviousVersion(int version)

getBeanKey

protected Object getBeanKey()

getHelper

public ThemeHelper getHelper()

Overrides:

getHelper in class ConfluenceActionSupport

getPermittedChildren

public List getPermittedChildren()

hasPermittedChildren

public boolean hasPermittedChildren()

hasAttachFilePermissions

public boolean hasAttachFilePermissions()

setXhtml

public void setXhtml(boolean XHtml)

getXhtml

public boolean getXhtml()

setConfluenceWysiwygConverter

public void setConfluenceWysiwygConverter(ConfluenceWysiwygConverter wysiwygConverter)

getUseWysiwyg

public boolean getUseWysiwyg()

getSupportWysiwyg

public boolean getSupportWysiwyg()

getShowMarkup

public boolean getShowMarkup()

getMode

public String getMode()

getSuggestedLabels

public List getSuggestedLabels()

setMode

public void setMode(String mode)

getRICHTEXT

public static String getRICHTEXT()

getMARKUP

public static String getMARKUP()

getPREVIEW

public static String getPREVIEW()

getSpaceManager

public SpaceManager getSpaceManager()

getEditor

public Editor getEditor()

getEditorVersion

public String getEditorVersion()

setEditorManager

public void setEditorManager(EditorManager editorManager)

getWebInterfaceContext

public WebInterfaceContext getWebInterfaceContext()

Description copied from interface: WebInterface

Returns a context which can be passed to web items when rendering them.

Typically, WebWork actions will implement this to provide extra details in the context such as content objects, and so on.

Specified by:

getWebInterfaceContext in interface WebInterface

Overrides:

getWebInterfaceContext in class ConfluenceActionSupport

getAttachmentSourceContent

public ContentEntityObject getAttachmentSourceContent()

Returns the ConfluenceEntityObject that contains attachments relevant to the current action. E.g.:

• The AbstractPage being viewed or edited.
• The Draft of the AbstractPage being created
• The AbstractPage to which the Comment being created/edited belongs