com.atlassian.confluence.pages.actions
Class BreadcrumbAction
java.lang.Object
com.opensymphony.xwork.ActionSupport
com.atlassian.confluence.core.ConfluenceActionSupport
com.atlassian.confluence.pages.actions.BreadcrumbAction
- All Implemented Interfaces:
- Beanable, PageAware, 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
public class BreadcrumbAction
- extends ConfluenceActionSupport
- implements PageAware, Beanable
Returns the breadcrumb of a page via JSON.
- See Also:
- Serialized Form
Fields inherited from class com.atlassian.confluence.core.ConfluenceActionSupport |
CANCEL, DEVMODE, eventManager, i18NBeanFactory, labelManager, languageManager, LICENSE_EXPIRED, LICENSE_USERS_EXCEEDED, messageHolder, permissionManager, permitted, pluginAccessor, PREVIEW, 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 |
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, getHelper, getI18n, getInstalledLanguages, getLabelManager, getLanguageManager, getLanguageUserFriendly, getLocale, getLocaleManager, getLocaleString, getMessageHolder, getNiceContentType, getPermissionTypes, getPermittedEntitiesOf, getPermittedEntitiesOf, getPermittedEntitiesOf, getPreviousLoginDate, getRemoteUser, getSession, getSystemInformationService, getText, getText, getText, getText, getTextStatic, getTextStatic, getTextStrict, getTimeZone, getUser, getUserAccessor, getUserByName, getUserFullName, getUserInterfaceState, getUserLocaleDefaultDatePattern, getUserProfilePicUrl, getWebInterfaceContext, getWebInterfaceManager, hasPermissionForSpace, isAnonymousUser, isCanceled, isDevMode, isEmailVisible, isExternalUserManagementEnabled, isLabelable, isPermissionCheck, isPermitted, 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, 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 |
BreadcrumbAction
public BreadcrumbAction()
execute
public java.lang.String execute()
throws java.lang.Exception
- Specified by:
execute
in interface com.opensymphony.xwork.Action
- Overrides:
execute
in class com.opensymphony.xwork.ActionSupport
- Throws:
java.lang.Exception
getBean
public java.lang.Object getBean()
- Specified by:
getBean
in interface Beanable
setUserName
public void setUserName(java.lang.String userName)
setFileName
public void setFileName(java.lang.String fileName)
setSpaceKey
public void setSpaceKey(java.lang.String spaceKey)
setTitle
public void setTitle(java.lang.String title)
setPageId
public void setPageId(long pageId)
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.
getPage
public AbstractPage getPage()
- Specified by:
getPage
in interface PageAware
- Returns:
- page the page that the action worked 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
setSpaceManager
public void setSpaceManager(SpaceManager spaceManager)
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
getSpace
public Space getSpace()
setBreadcrumbGenerator
public void setBreadcrumbGenerator(BreadcrumbGenerator breadcrumbGenerator)
Copyright © 2003-2014 Atlassian. All Rights Reserved.