com.atlassian.confluence.pages.actions
Class AbstractPageAction

java.lang.Object
  extended by com.opensymphony.xwork.ActionSupport
      extended by com.atlassian.confluence.core.ConfluenceActionSupport
          extended by com.atlassian.confluence.pages.actions.AbstractPageAwareAction
              extended by 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, 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  LinkManager linkManager
           
protected  PageManager pageManager
           
static String PREVIEW
           
static 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, 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()
           
 String getEditorVersion()
           
 ThemeHelper getHelper()
           
 List<OutgoingLink> getIncomingLinks()
          returns list of "unique" incoming links to this page.
protected  List<Label> getLabels()
           
 String getMode()
           
 BlogPost getNextPost()
           
protected  String getNumberOfLabelsAsString()
           
protected  List<String> getPermissionTypes()
           
 List getPermittedChildren()
           
 Date getPostingDate()
           
 String getPostingDay()
           
 BlogPost getPreviousPost()
           
 AbstractPage getPreviousVersion(int version)
           
 SpaceManager getSpaceManager()
           
 List getSuggestedLabels()
           
 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(String mode)
           
 void setPageManager(PageManager pageManager)
           
 void setPostingDate(String date)
           
 void setViewRenderer(Renderer viewRenderer)
           
 
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, getContext, getDateFormatSetting, getDateFormatter, getDefaultResourceBundle, getDocLink, getEventManager, getFriendlyDateFormatter, getGlobalSettings, getI18n, getInstalledLanguages, getLabelManager, getLanguageManager, getLanguageUserFriendly, getLocale, getLocaleManager, getLocaleString, getNiceContentType, getPermittedEntitiesOf, getPermittedEntitiesOf, getPermittedEntitiesOf, getPreviousLoginDate, getRandom, getRemoteUser, getSession, getSystemInformationService, 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, setLoginManager, 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
 

Field Detail

pageManager

protected PageManager pageManager

linkManager

protected LinkManager linkManager

incomingLinks

protected List incomingLinks

wysiwygConverter

protected ConfluenceWysiwygConverter wysiwygConverter

viewRenderer

protected Renderer viewRenderer

RICHTEXT

public static final String RICHTEXT
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()

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(String date)

getNextPost

public BlogPost getNextPost()

getPreviousPost

public BlogPost getPreviousPost()

getTinyUrl

public String getTinyUrl()
Specified by:
getTinyUrl in interface TinyUrlAware

isSpaceAdmin

protected boolean isSpaceAdmin()

isSuperUser

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 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()

setConfluenceWysiwygConverter

public void setConfluenceWysiwygConverter(ConfluenceWysiwygConverter wysiwygConverter)

getMode

public String getMode()

getSuggestedLabels

public List getSuggestedLabels()

setMode

public void setMode(String mode)

getSpaceManager

public SpaceManager getSpaceManager()

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

getLabels

protected List<Label> getLabels()

getNumberOfLabelsAsString

protected String getNumberOfLabelsAsString()

getAttachmentSourceContent

public ContentEntityObject getAttachmentSourceContent()
Returns the ConfluenceEntityObject that contains attachments relevant to the current action. E.g.:


setViewRenderer

public void setViewRenderer(Renderer viewRenderer)


Copyright © 2003-2011 Atlassian. All Rights Reserved.