com.atlassian.confluence.pages.actions
Class AbstractPageAction

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

All Implemented Interfaces:

PageAware, TinyUrlAware, WebInterface, 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:

AbstractPageChangeAction, AbstractPreviewPageAction, AddPageNotificationAction, ChildrenAction, DownloadAllAttachmentsOnPageAction, ExportPageAction, ExportWordPageAction, GallerySlideshowAction, MovePageAction, PageNotPermittedAction, RemoveCommentAction, RemovePageAction, RemovePageNotificationAction, RevertPageBackToVersionAction, ViewPageAction, ViewPreviousVersionsAction

public abstract class AbstractPageAction
extends ConfluenceActionSupport
implements PageAware, TinyUrlAware

See Also:

Serialized Form

Field Summary

protected CaptchaManager	captchaManager
protected ContentPermissionManager	contentPermissionManager
protected java.lang.Boolean	expertView
protected java.util.List	incomingLinks
protected boolean	isXHtml
protected LinkManager	linkManager
static java.lang.String	MARKUP
protected PageManager	pageManager
static java.lang.String	PREVIEW
static java.lang.String	RICHTEXT
protected SpaceManager	spaceManager
protected ConfluenceWysiwygConverter	wysiwygConverter

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

CANCEL, DEVMODE, eventManager, i18NBeanFactory, labelManager, languageManager, LICENSE_EXPIRED, LICENSE_USERS_EXCEEDED, log, permissionManager, permitted, 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()
protected java.lang.String	extractPageTitle(java.lang.String pageString) To extract the PageName from a String like Spacekey:Pagename, the extractPageTitle Method can be used.
protected java.lang.String	extractSpaceKey(java.lang.String pageString) This method extracts the SpaceKey from a String which should look like Spacekey:Pagename This method is used as a helper method to parse the String given by the PagePicker which is used by the parentPage form field as well as the moveAttachment.
java.lang.String	generateAncestryBreadcrumbs()
java.util.List	getAvailableSpaces()
protected java.lang.Object	getBeanKey()
BlogPost	getBlogPost()
java.lang.String	getCaptchaId()
CaptchaManager	getCaptchaManager()
Editor	getEditor()
java.lang.String	getEditorVersion()
java.lang.Boolean	getExpertView()
ThemeHelper	getHelper()
java.util.List	getIncomingLinks() returns list of "unique" incoming links to this page
static java.lang.String	getMARKUP()
java.lang.String	getMode()
BlogPost	getNextPost()
AbstractPage	getPage()
long	getPageId()
protected java.util.List	getPermissionTypes()
java.util.List	getPermittedChildren()
java.util.Date	getPostingDate()
java.lang.String	getPostingDay()
java.lang.String	getPostingDayOfMonth()
java.lang.String	getPostingMonth()
java.lang.String	getPostingMonthNumeric()
java.lang.String	getPostingYear()
static java.lang.String	getPREVIEW()
BlogPost	getPreviousPost()
AbstractPage	getPreviousVersion(int version)
static java.lang.String	getRICHTEXT()
boolean	getShowMarkup()
Space	getSpace()
java.lang.String	getSpaceKey()
SpaceManager	getSpaceManager()
java.lang.String	getSubscribableName()
java.util.List	getSuggestedLabels()
boolean	getSupportWysiwyg()
java.lang.String	getTinyUrl()
java.lang.String	getTitle()
boolean	getUseWysiwyg()
WebInterfaceContext	getWebInterfaceContext() Returns a context which can be passed to web items when rendering them.
boolean	getXhtml()
boolean	hasAttachFilePermissions()
protected boolean	hasInvalidTitleCharacters(java.lang.String str)
boolean	hasPermittedChildren()
boolean	hasSetPagePermissionsPermission()
protected boolean	hasViewPagePermission()
boolean	isLatestVersionRequired() If the action can only work on the most recent version of a page, this will cause the interceptor to silently replace the version that it looks up with the most recent version, if necessary.
boolean	isPageRequired() If the action requires that the page be set before being run, then it should return true to this method.
boolean	isPermitted()
protected boolean	isSpaceAdmin()
boolean	isViewPermissionRequired()
void	setBreadcrumbsManager(BreadcrumbsManager breadcrumbsManager)
void	setCaptchaId(java.lang.String captchaId)
void	setCaptchaManager(CaptchaManager captchaManager)
void	setConfluenceWysiwygConverter(ConfluenceWysiwygConverter wysiwygConverter)
void	setContentPermissionManager(ContentPermissionManager contentPermissionManager)
void	setEditorManager(EditorManager editorManager)
void	setLinkManager(LinkManager linkManager)
void	setMode(java.lang.String mode)
void	setPage(AbstractPage page) IOC method for setting the page on the action.
void	setPageManager(PageManager pageManager)
void	setPostingDate(java.util.Date date)
void	setSpaceManager(SpaceManager spaceManager)
void	setXhtml(boolean XHtml)

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

addActionError, addFieldError, addPermissionTypeTo, addToHistory, doDefault, formatFriendlyDate, getActionName, getBootstrapManager, getCancelResult, getDateFormatter, getDefaultResourceBundle, getEventManager, getFriendlyDateFormatter, getGlobalHelper, getGlobalSettings, getI18n, getInstalledLanguages, getLabelManager, getLanguageManager, getLanguageUserFriendly, getLocale, getLocaleManager, getLocaleString, getNiceContentType, getPermittedEntitiesOf, getPermittedEntitiesOf, getPermittedEntitiesOf, getPreviousLoginDate, getRandom, getRemoteUser, getSession, getSpaceHelper, getText, getText, getText, getText, getTextStatic, getTextStatic, getTextStrict, getTimeZone, getUser, getUserAccessor, getUserFullName, getUserInterfaceState, getWebInterfaceManager, hasPermissionForSpace, isAnonymousUser, isCanceled, isDevMode, isEmailVisible, isExternalUserManagementEnabled, isLabelable, isPermissionCheck, isPermittedAsString, isPrintableVersion, isUsingHSQL, setBootstrapManager, setCancel, setEventManager, setFormatSettingsManager, setI18NBean, setI18NBeanFactory, setLabelManager, setLanguageManager, setLocaleManager, setPermissionCheck, setPermissionManager, 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

spaceManager

protected SpaceManager spaceManager

captchaManager

protected CaptchaManager captchaManager

linkManager

protected LinkManager linkManager

contentPermissionManager

protected ContentPermissionManager contentPermissionManager

incomingLinks

protected java.util.List incomingLinks

expertView

protected java.lang.Boolean expertView

isXHtml

protected boolean isXHtml

wysiwygConverter

protected ConfluenceWysiwygConverter wysiwygConverter

RICHTEXT

public static java.lang.String RICHTEXT

MARKUP

public static java.lang.String MARKUP

PREVIEW

public static java.lang.String PREVIEW

Constructor Detail

AbstractPageAction

public AbstractPageAction()

Method Detail

getSpaceKey

public java.lang.String getSpaceKey()

getTitle

public java.lang.String getTitle()

getPostingDay

public java.lang.String getPostingDay()

displayDatePath

public boolean displayDatePath()

getPostingYear

public java.lang.String getPostingYear()

getPostingMonth

public java.lang.String getPostingMonth()

getPostingMonthNumeric

public java.lang.String getPostingMonthNumeric()

getPostingDayOfMonth

public java.lang.String getPostingDayOfMonth()

getPage

public AbstractPage getPage()

Specified by:

getPage in interface PageAware

Returns:

page the page that the action worked on

getBlogPost

public BlogPost getBlogPost()

getSpace

public Space getSpace()

setPageManager

public void setPageManager(PageManager pageManager)

setSpaceManager

public void setSpaceManager(SpaceManager spaceManager)

setLinkManager

public void setLinkManager(LinkManager linkManager)

getIncomingLinks

public java.util.List getIncomingLinks()

returns list of "unique" incoming links to this page

getSubscribableName

public java.lang.String getSubscribableName()

getPermissionTypes

protected java.util.List getPermissionTypes()

Overrides:

getPermissionTypes in class ConfluenceActionSupport

isPermitted

public boolean isPermitted()

Overrides:

isPermitted in class ConfluenceActionSupport

hasViewPagePermission

protected boolean hasViewPagePermission()

hasInvalidTitleCharacters

protected boolean hasInvalidTitleCharacters(java.lang.String str)

getPostingDate

public java.util.Date getPostingDate()

setPostingDate

public void setPostingDate(java.util.Date date)

getNextPost

public BlogPost getNextPost()

getPreviousPost

public BlogPost getPreviousPost()

getTinyUrl

public java.lang.String getTinyUrl()

Specified by:

getTinyUrl in interface TinyUrlAware

setPage

public void setPage(AbstractPage page)

Description copied from interface: PageAware

IOC method for setting the page on the action. This is called from the interceptor

Specified by:

setPage in interface PageAware

Parameters:

page - the page that the action will be working on.

isPageRequired

public boolean isPageRequired()

Description copied from interface: PageAware

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

Specified by:

isPageRequired in interface PageAware

Returns:

true if the action requires a page in order to execute

isLatestVersionRequired

public boolean isLatestVersionRequired()

Description copied from interface: PageAware

If the action can only work on the most recent version of a page, this will cause the interceptor to silently replace the version that it looks up with the most recent version, if necessary.

Specified by:

isLatestVersionRequired in interface PageAware

Returns:

true if the action requires the most recent version of a page

isViewPermissionRequired

public boolean isViewPermissionRequired()

Specified by:

isViewPermissionRequired in interface PageAware

Returns:

true if the action requires a check on the view page level permissions on this page

getPageId

public long getPageId()

isSpaceAdmin

protected boolean isSpaceAdmin()

hasSetPagePermissionsPermission

public boolean hasSetPagePermissionsPermission()

getExpertView

public java.lang.Boolean getExpertView()

getAvailableSpaces

public java.util.List getAvailableSpaces()

getPreviousVersion

public AbstractPage getPreviousVersion(int version)

getBeanKey

protected java.lang.Object getBeanKey()

extractSpaceKey

protected java.lang.String extractSpaceKey(java.lang.String pageString)

This method extracts the SpaceKey from a String which should look like Spacekey:Pagename This method is used as a helper method to parse the String given by the PagePicker which is used by the parentPage form field as well as the moveAttachment.

Parameters:

pageString -

Returns:

The space name parsed from the input String if defined otherwise the function returns null

extractPageTitle

protected java.lang.String extractPageTitle(java.lang.String pageString)

To extract the PageName from a String like Spacekey:Pagename, the extractPageTitle Method can be used.

Parameters:

pageString -

Returns:

The page name parsed from the input String

generateAncestryBreadcrumbs

public java.lang.String generateAncestryBreadcrumbs()

setContentPermissionManager

public void setContentPermissionManager(ContentPermissionManager contentPermissionManager)

getHelper

public ThemeHelper getHelper()

Overrides:

getHelper in class ConfluenceActionSupport

getPermittedChildren

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

getSuggestedLabels

public java.util.List getSuggestedLabels()

setMode

public void setMode(java.lang.String mode)

setBreadcrumbsManager

public void setBreadcrumbsManager(BreadcrumbsManager breadcrumbsManager)

getRICHTEXT

public static java.lang.String getRICHTEXT()

getMARKUP

public static java.lang.String getMARKUP()

getPREVIEW

public static java.lang.String getPREVIEW()

getSpaceManager

public SpaceManager getSpaceManager()

getCaptchaManager

public CaptchaManager getCaptchaManager()

setCaptchaManager

public void setCaptchaManager(CaptchaManager captchaManager)

getCaptchaId

public java.lang.String getCaptchaId()

setCaptchaId

public void setCaptchaId(java.lang.String captchaId)

getEditor

public Editor getEditor()

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