com.atlassian.confluence.util.breadcrumbs

Class CompositeBreadcrumb

java.lang.Object

com.atlassian.confluence.util.breadcrumbs.AbstractBreadcrumb

com.atlassian.confluence.util.breadcrumbs.CompositeBreadcrumb

All Implemented Interfaces:

Breadcrumb

public class CompositeBreadcrumb
extends AbstractBreadcrumb

Field Summary

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

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

Constructor Summary

Constructors

Constructor and Description
CompositeBreadcrumb(List<Breadcrumb> originalTrail, Breadcrumb topmostParent)

Method Summary

Modifier and Type	Method and Description
protected List<Breadcrumb>	getMyCrumbs() Returns a list of breadcrumbs for the current breadcrumb.
protected Breadcrumb	getParent() Gets the parent breadcrumb.
void	setFilterTrailingBreadcrumb(boolean filterTrailingBreadcrumb) Override the breadcrumb's default value for whether or not the last breadcrumb in the trail should be filtered out.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

CompositeBreadcrumb

public CompositeBreadcrumb(List<Breadcrumb> originalTrail,
                           Breadcrumb topmostParent)

Method Detail

getParent

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

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

setFilterTrailingBreadcrumb

public void setFilterTrailingBreadcrumb(boolean filterTrailingBreadcrumb)

Description copied from interface: Breadcrumb

Override the breadcrumb's default value for whether or not the last breadcrumb in the trail should be filtered out.

Specified by:

setFilterTrailingBreadcrumb in interface Breadcrumb

Overrides:

setFilterTrailingBreadcrumb in class AbstractBreadcrumb

Parameters:

filterTrailingBreadcrumb - true if the last breadcrumb in the trail should be filtered out.