public class

BreadcrumbAction

extends ConfluenceActionSupport
implements Beanable PageAware
java.lang.Object
   ↳ com.opensymphony.xwork.ActionSupport
     ↳ com.atlassian.confluence.core.ConfluenceActionSupport
       ↳ com.atlassian.confluence.pages.actions.BreadcrumbAction

Class Overview

Returns the breadcrumb of a page via JSON.

Summary

[Expand]
Inherited Constants
From class com.atlassian.confluence.core.ConfluenceActionSupport
From interface com.opensymphony.xwork.Action
[Expand]
Inherited Fields
From class com.atlassian.confluence.core.ConfluenceActionSupport
From class com.opensymphony.xwork.ActionSupport
Public Constructors
BreadcrumbAction()
Public Methods
String execute()
Object getBean()
AbstractPage getPage()
String getUserBreadcrumbs()
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 isViewPermissionRequired()
void setFileName(String fileName)
void setPage(AbstractPage page)
IOC method for setting the page on the action.
void setPageId(long pageId)
void setSpaceKey(String spaceKey)
void setSpaceManager(SpaceManager spaceManager)
void setTitle(String title)
void setUserName(String userName)
[Expand]
Inherited Methods
From class com.atlassian.confluence.core.ConfluenceActionSupport
From class com.opensymphony.xwork.ActionSupport
From class java.lang.Object
From interface com.atlassian.confluence.core.Beanable
From interface com.atlassian.confluence.pages.actions.PageAware
From interface com.atlassian.confluence.plugin.descriptor.web.WebInterface
From interface com.opensymphony.xwork.Action
From interface com.opensymphony.xwork.LocaleProvider
From interface com.opensymphony.xwork.TextProvider
From interface com.opensymphony.xwork.Validateable
From interface com.opensymphony.xwork.ValidationAware

Public Constructors

public BreadcrumbAction ()

Public Methods

public String execute ()

Throws
Exception

public Object getBean ()

public AbstractPage getPage ()

public String getUserBreadcrumbs ()

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

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

public boolean isPageRequired ()

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

Returns
  • true if the action requires a page in order to execute

public boolean isViewPermissionRequired ()

public void setFileName (String fileName)

public void setPage (AbstractPage page)

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

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

public void setPageId (long pageId)

public void setSpaceKey (String spaceKey)

public void setSpaceManager (SpaceManager spaceManager)

public void setTitle (String title)

public void setUserName (String userName)