public class DefaultBreadcrumbGenerator extends Object implements BreadcrumbGenerator
Constructor and Description |
---|
DefaultBreadcrumbGenerator(ThemeManager themeManager) |
Modifier and Type | Method and Description |
---|---|
Breadcrumb |
getAdvancedBreadcrumb(Space space)
Returns the advanced breadcrumb in a space.
|
Breadcrumb |
getBlogCollectorBreadcrumb(Space space) |
Breadcrumb |
getContentActionBreadcrumb(com.opensymphony.xwork.Action action,
Space space,
AbstractPage page,
DisplayableLabel label)
Returns an appropriate breadcrumb for the given action, space, page and label.
|
Breadcrumb |
getContentBreadcrumb(Space space,
AbstractPage page)
Returns an appropriate breadcrumb for a page or blogpost
|
Breadcrumb |
getContentCollectorBreadcrumb(Space space,
Class contentClass)
Returns an appropriate collector page breadcrumb to represent content at the root level
of a space conforming to the new space information architecture.
|
Breadcrumb |
getContentDetailActionBreadcrumb(com.opensymphony.xwork.Action action,
Space space,
AbstractPage page)
Breadcrumb for the "detail" pages of a Page/Blog, like Info, Attachments or History.
|
List<Breadcrumb> |
getFilteredBreadcrumbTrail(ConfluenceActionSupport action,
javax.servlet.http.HttpServletRequest request)
Returns the breadcrumb trail after filtering.
|
List<Breadcrumb> |
getFilteredBreadcrumbTrail(Space space,
Breadcrumb breadcrumb)
Returns the breadcrumb trail after filtering.
|
Breadcrumb |
getSpaceAdminBreadcrumb(com.opensymphony.xwork.Action action,
Space space)
Returns the breadcrumb for a space admin action in a space.
|
Breadcrumb |
getSpaceOperationsBreadcrumb(Space space)
Returns the space operations breadcrumb (i.e.
|
public DefaultBreadcrumbGenerator(ThemeManager themeManager)
public List<Breadcrumb> getFilteredBreadcrumbTrail(ConfluenceActionSupport action, javax.servlet.http.HttpServletRequest request)
BreadcrumbGenerator
Since the new header (published in Confluence 5.0), we filter out the Dashboard from the breadcrumbs. We also filter out the last breadcrumb in the trail (usually the page name), unless the breadcrumb's filterTrailingBreadcrumb method returns false.
getFilteredBreadcrumbTrail
in interface BreadcrumbGenerator
action
- the action to build breadcrumbs forrequest
- the request to build breadcrumbs forpublic List<Breadcrumb> getFilteredBreadcrumbTrail(Space space, Breadcrumb breadcrumb)
BreadcrumbGenerator
This method should be used when a breadcrumb is generated independently of an action - E.g. when showing the new location of a page in the move page dialog.
getFilteredBreadcrumbTrail
in interface BreadcrumbGenerator
space
- the space in which the breadcrumb belongs, or null when this is not applicablebreadcrumb
- the breadcrumb to retrieve a filtered trail forpublic Breadcrumb getContentActionBreadcrumb(com.opensymphony.xwork.Action action, Space space, AbstractPage page, DisplayableLabel label)
BreadcrumbGenerator
getContentActionBreadcrumb
in interface BreadcrumbGenerator
action
- the action to retrieve the breadcrumb forspace
- the space to retrieve the breadcrumb for, can be null for global labelspage
- the page to retrieve the breadcrumb for, can be null when retrieving breadcrumb for a labellabel
- the label to retrieve the breadcrumb for, can be null when retrieving breadcrumb for a pagepublic Breadcrumb getContentBreadcrumb(Space space, AbstractPage page)
BreadcrumbGenerator
getContentBreadcrumb
in interface BreadcrumbGenerator
space
- the space to retrieve the breadcrumb forpage
- the page or blogpost to retrieve the breadcrumb forpublic Breadcrumb getContentCollectorBreadcrumb(Space space, Class contentClass)
BreadcrumbGenerator
This should only be used for retrieving a breadcrumb for content creation at the root level of a space - once the content exists, the breadcrumb for that content should be used instead.
getContentCollectorBreadcrumb
in interface BreadcrumbGenerator
space
- the space to retrieve a collector breadcrumb for.contentClass
- the type of content to retrieve a collector breadcrumb for.public Breadcrumb getSpaceAdminBreadcrumb(com.opensymphony.xwork.Action action, Space space)
BreadcrumbGenerator
getSpaceAdminBreadcrumb
in interface BreadcrumbGenerator
action
- the action to retrieve a space admin breadcrumb for.space
- the space to retrieve a space admin breadcrumb for.public Breadcrumb getSpaceOperationsBreadcrumb(Space space)
BreadcrumbGenerator
getSpaceOperationsBreadcrumb
in interface BreadcrumbGenerator
space
- the space to retrieve a space operations breadcrumb for.public Breadcrumb getAdvancedBreadcrumb(Space space)
BreadcrumbGenerator
getAdvancedBreadcrumb
in interface BreadcrumbGenerator
space
- the space to retrieve an advanced breadcrumb for.public Breadcrumb getBlogCollectorBreadcrumb(Space space)
getBlogCollectorBreadcrumb
in interface BreadcrumbGenerator
public Breadcrumb getContentDetailActionBreadcrumb(com.opensymphony.xwork.Action action, Space space, AbstractPage page)
This breadcrumb is not to be used for actions on content itself, like ViewPageAction,
which should use getContentActionBreadcrumb(Action, Space, AbstractPage, DisplayableLabel)
.
getContentDetailActionBreadcrumb
in interface BreadcrumbGenerator
action
- the action to retrieve the breadcrumb forspace
- the space to retrieve the breadcrumb forpage
- the page to retrieve the breadcrumb forCopyright © 2003–2016 Atlassian. All rights reserved.