Package com.atlassian.confluence.util.breadcrumbs

Class LabelBreadcrumb

java.lang.Object

com.atlassian.confluence.util.breadcrumbs.AbstractBreadcrumb

com.atlassian.confluence.util.breadcrumbs.AbstractActionBreadcrumb

com.atlassian.confluence.util.breadcrumbs.AbstractSpaceActionBreadcrumb

com.atlassian.confluence.util.breadcrumbs.LabelBreadcrumb

All Implemented Interfaces:

Breadcrumb

public class LabelBreadcrumb
extends AbstractSpaceActionBreadcrumb

Represents Label breadcrumbs. Handles all Label actions, including listing and viewing. A crumb of "Labels" always occurs and is just text (see examples below).

Examples: If viewing a global label: "Dashboard > Labels > labelOne" If viewing a space label: "Dashboard > Demo Space > Browse Space > Labels > labelOne"

Field Summary

Fields inherited from class com.atlassian.confluence.util.breadcrumbs.AbstractSpaceActionBreadcrumb

space

Fields inherited from class com.atlassian.confluence.util.breadcrumbs.AbstractActionBreadcrumb

action

Fields inherited from class com.atlassian.confluence.util.breadcrumbs.AbstractBreadcrumb

cssClass, displayTitle, filterTrailingBreadcrumb, MAX_BREADCRUMBS, target, title, tooltip

Constructor Summary

Constructors

Constructor	Description
LabelBreadcrumb(ConfluenceActionSupport action, DisplayableLabel label, Space space)	Label crumbs are sequenced a little differently than normal (where ContentActionBreadcrumbs typically come last).
LabelBreadcrumb(com.opensymphony.xwork.Action action, DisplayableLabel label, Space space)	Deprecated, for removal: This API element is subject to removal in a future version. since 8.0 as this constructor exists solely to provide bytecode compatibility for plugins that were compiled against Confluence 7.x
LabelBreadcrumb(com.opensymphony.xwork2.Action action, DisplayableLabel label, Space space)	Deprecated. since 8.2, use LabelBreadcrumb(ConfluenceActionSupport, DisplayableLabel, Space)

Method Summary

Modifier and Type	Method	Description
protected List<Breadcrumb>	getMyCrumbs()	Returns a list of breadcrumbs for the current breadcrumb.
Breadcrumb	getParent()	Gets the parent breadcrumb.

Methods inherited from class com.atlassian.confluence.util.breadcrumbs.AbstractBreadcrumb

filterTrailingBreadcrumb, getBreadcrumbsTrail, getCssClass, getDisplayTitle, getTarget, getTitle, getTooltip, setCssClass, setFilterTrailingBreadcrumb, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

LabelBreadcrumb

public LabelBreadcrumb(ConfluenceActionSupport action,
                       DisplayableLabel label,
                       Space space)

Label crumbs are sequenced a little differently than normal (where ContentActionBreadcrumbs typically come last). Space labels can only be viewed via the browse space tab so it's crumbs will look something like: Browse Space > Labels > LabelName

LabelBreadcrumb

@Deprecated(since="8.2")
public LabelBreadcrumb(com.opensymphony.xwork2.Action action,
                       DisplayableLabel label,
                       Space space)

Deprecated.

since 8.2, use LabelBreadcrumb(ConfluenceActionSupport, DisplayableLabel, Space)

LabelBreadcrumb

@Deprecated(since="8.0",
            forRemoval=true)
public LabelBreadcrumb(com.opensymphony.xwork.Action action,
                       DisplayableLabel label,
                       Space space)

Deprecated, for removal: This API element is subject to removal in a future version.

since 8.0 as this constructor exists solely to provide bytecode compatibility for plugins that were compiled against Confluence 7.x

Do not use!

Method Detail

getMyCrumbs

protected List<Breadcrumb> getMyCrumbs()

Description copied from class: AbstractBreadcrumb

Returns a list of breadcrumbs for the current breadcrumb. For example, the BlogPostBreadcrumb overrides this method and returns 4 crumbs altogether to represent itself: 2007 > 11 > 28 > BlogTitle.

By default my crumbs will be a list with size 1, containing itself, unless the current breadcrumb has no title.

Overrides:

getMyCrumbs in class AbstractBreadcrumb

getParent

public Breadcrumb getParent()

Description copied from class: AbstractBreadcrumb

Gets the parent breadcrumb. By default the dashboard breadcrumb is returned.

Specified by:

getParent in class AbstractBreadcrumb

Returns:

the parent breadcrumb.