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, MessageHolderAware, com.opensymphony.xwork.Action, com.opensymphony.xwork.LocaleProvider, com.opensymphony.xwork.TextProvider, com.opensymphony.xwork.Validateable, com.opensymphony.xwork.ValidationAware, java.io.Serializable

Direct Known Subclasses:

AbstractPreviewPageAction, RevertPageBackToVersionAction, ViewPageAction

public abstract class AbstractPageAction
extends AbstractPageAwareAction
implements TinyUrlAware

See Also:

Serialized Form

Field Summary

protected java.util.List	incomingLinks
protected LinkManager	linkManager
protected PageManager	pageManager
static java.lang.String	PREVIEW
static java.lang.String	RICHTEXT
protected Renderer	viewRenderer
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, messageHolder, 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.
java.util.List	getAvailableSpaces()
protected java.lang.Object	getBeanKey()
BlogPost	getBlogPost()
java.lang.String	getEditorVersion()
ThemeHelper	getHelper()
java.util.List<OutgoingLink>	getIncomingLinks() returns list of "unique" incoming links to this page.
protected java.util.List<Label>	getLabels()
java.lang.String	getMode()
BlogPost	getNextPost()
protected java.lang.String	getNumberOfAttachmentsAsString()
protected java.lang.String	getNumberOfLabelsAsString()
protected java.util.List<java.lang.String>	getPermissionTypes()
java.util.List<Page>	getPermittedChildren()
java.util.Date	getPostingDate()
java.lang.String	getPostingDay()
BlogPost	getPreviousPost()
AbstractPage	getPreviousVersion(int version)
SpaceManager	getSpaceManager()
java.util.List	getSuggestedLabels()
java.lang.String	getTinyUrl()
WebInterfaceContext	getWebInterfaceContext() Returns a context which can be passed to web items when rendering them.
boolean	hasAttachFilePermissions()
boolean	hasPermittedChildren()
protected boolean	isSpaceAdmin()
boolean	isSuperUser() Deprecated. since 3.5 this method is not called anywhere and should not be used
boolean	isUserWatchingOwnContent()
void	setConfluenceWysiwygConverter(ConfluenceWysiwygConverter wysiwygConverter)
void	setEditorManager(EditorManager editorManager)
void	setLinkManager(LinkManager linkManager)
void	setMode(java.lang.String mode)
void	setPageManager(PageManager pageManager)
void	setPostingDate(java.lang.String date)
void	setViewRenderer(Renderer viewRenderer)

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

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

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

addActionError, addActionMessage, addFieldError, addPermissionTypeTo, addToHistory, doDefault, formatFriendlyDate, getActionName, getActionName, getAuthenticatedUser, getBootstrapManager, getCancel, getCancelResult, getContext, getDateFormatSetting, getDateFormatter, getDefaultResourceBundle, getDocLink, getEventManager, getFriendlyDateFormatter, getGlobalSettings, getI18n, getInstalledLanguages, getLabelManager, getLanguageManager, getLanguageUserFriendly, getLocale, getLocaleManager, getLocaleString, getMessageHolder, getNiceContentType, getPermittedEntitiesOf, getPermittedEntitiesOf, getPermittedEntitiesOf, getPreviousLoginDate, getRemoteUser, getSession, getSystemInformationService, getText, getText, getText, getText, getTextStatic, getTextStatic, getTextStrict, getTimeZone, getUser, getUserAccessor, getUserByName, getUserFullName, getUserInterfaceState, getUserLocaleDefaultDatePattern, getUserProfilePicUrl, getWebInterfaceManager, hasPermissionForSpace, isAnonymousUser, isCanceled, isDevMode, isEmailVisible, isExternalUserManagementEnabled, isLabelable, isPermissionCheck, isPermittedAsString, isPrintableVersion, isSharedMode, isUserStatusPluginEnabled, isUsingHSQL, setApiDateFormatService, setBootstrapManager, setCancel, setContentUiSupport, setEventManager, setFormatSettingsManager, setI18NBean, setI18NBeanFactory, setLabelManager, setLanguageManager, setLocaleManager, setLoginManager, setMessageHolder, setPermissionCheck, setPermissionManager, setPluginAccessor, setPreviousLoginDate, setSettingsManager, setSpacePermissionManager, setSystemInformationService, 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

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

validate

Field Detail

pageManager

protected PageManager pageManager

linkManager

protected LinkManager linkManager

incomingLinks

protected java.util.List incomingLinks

wysiwygConverter

protected ConfluenceWysiwygConverter wysiwygConverter

viewRenderer

protected Renderer viewRenderer

RICHTEXT

public static final java.lang.String RICHTEXT

See Also:

Constant Field Values

PREVIEW

public static final java.lang.String PREVIEW

See Also:

Constant Field Values

Constructor Detail

AbstractPageAction

public AbstractPageAction()

Method Detail

getPostingDay

public java.lang.String getPostingDay()

displayDatePath

public boolean displayDatePath()

getBlogPost

public BlogPost getBlogPost()

setPageManager

public void setPageManager(PageManager pageManager)

setLinkManager

public void setLinkManager(LinkManager linkManager)

getIncomingLinks

public java.util.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 java.util.List<java.lang.String> getPermissionTypes()

Overrides:

getPermissionTypes in class ConfluenceActionSupport

getPostingDate

public java.util.Date getPostingDate()

setPostingDate

public void setPostingDate(java.lang.String date)

getNextPost

public BlogPost getNextPost()

getPreviousPost

public BlogPost getPreviousPost()

getTinyUrl

public java.lang.String getTinyUrl()

Specified by:

getTinyUrl in interface TinyUrlAware

isSpaceAdmin

protected boolean isSpaceAdmin()

isSuperUser

@Deprecated
public boolean isSuperUser()

Deprecated. since 3.5 this method is not called anywhere and should not be used

See Also:

PermissionManager.hasPermission(User, Permission , Object)

isUserWatchingOwnContent

public boolean isUserWatchingOwnContent()

getAvailableSpaces

public java.util.List getAvailableSpaces()

getPreviousVersion

public AbstractPage getPreviousVersion(int version)

getBeanKey

protected java.lang.Object getBeanKey()

getHelper

public ThemeHelper getHelper()

Overrides:

getHelper in class ConfluenceActionSupport

getPermittedChildren

public java.util.List<Page> getPermittedChildren()

hasPermittedChildren

public boolean hasPermittedChildren()

hasAttachFilePermissions

public boolean hasAttachFilePermissions()

setConfluenceWysiwygConverter

public void setConfluenceWysiwygConverter(ConfluenceWysiwygConverter wysiwygConverter)

getMode

public java.lang.String getMode()

getSuggestedLabels

public java.util.List getSuggestedLabels()

setMode

public void setMode(java.lang.String mode)

getSpaceManager

public SpaceManager getSpaceManager()

getEditorVersion

public java.lang.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

getNumberOfAttachmentsAsString

protected java.lang.String getNumberOfAttachmentsAsString()

getLabels

protected java.util.List<Label> getLabels()

getNumberOfLabelsAsString

protected java.lang.String getNumberOfLabelsAsString()

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

setViewRenderer

public void setViewRenderer(Renderer viewRenderer)