com.atlassian.breadcrumbs

Class BuildCrumb

java.lang.Object

com.atlassian.breadcrumbs.BaseCrumb

com.atlassian.breadcrumbs.BuildCrumb

All Implemented Interfaces:

BreadCrumb

public class BuildCrumb
extends BaseCrumb

Crumb for a single Buildable object.

Field Summary

Fields inherited from class com.atlassian.breadcrumbs.BaseCrumb

action, BROWSE_PREFIX, NUMBER_PREFIX, request

Constructor Summary

Constructors

Constructor and Description
BuildCrumb(javax.servlet.http.HttpServletRequest request, com.opensymphony.xwork2.Action action)

Method Summary

Methods

Modifier and Type	Method and Description
Collection<BreadCrumb>	getChildCrumbs() Returns the children crumbs.
String	getId()
String	getLabel() Returns the visible label for the bread crumb
String	getTitle()
String	getUrl() Returns the URL for the given label
boolean	isCurrentPage() Returns true if the curren BreadCrumb should be selected
boolean	isDisabled()
boolean	isShown() Should the BreadCrumb be shown?

Methods inherited from class com.atlassian.breadcrumbs.BaseCrumb

createUrl, createUrl, getAccessKey, getLabelWithAccessKeyUnderlined, getText, isAnyChildShown, isInCurrentPath, setAction, setRequest

Methods inherited from class java.lang.Object

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

Constructor Detail

BuildCrumb

public BuildCrumb(javax.servlet.http.HttpServletRequest request,
          com.opensymphony.xwork2.Action action)

Method Detail

isShown

public boolean isShown()

Description copied from interface: BreadCrumb

Should the BreadCrumb be shown?

Returns:

true if it should be displayed

getTitle

public String getTitle()

getId

public String getId()

getLabel

public String getLabel()

Description copied from interface: BreadCrumb

Returns the visible label for the bread crumb

Returns:

string, cannot be null

getUrl

public String getUrl()

Description copied from interface: BreadCrumb

Returns the URL for the given label

Returns:

URL of label. No context is added

isCurrentPage

public boolean isCurrentPage()

Description copied from interface: BreadCrumb

Returns true if the curren BreadCrumb should be selected

Returns:

true or false

getChildCrumbs

public Collection<BreadCrumb> getChildCrumbs()

Description copied from interface: BreadCrumb

Returns the children crumbs. This is not as sinister as it sounds! The bread crumb will iterate throught each chil crumb until one returns true for BreadCrumb.isShown() and then it'll follow down that crumb tree

Returns:

Collection of BreadCrumb objects. Collections.emptyList() if no child crumbs

isDisabled

public boolean isDisabled()