com.atlassian.breadcrumbs
Interface BreadCrumb

All Known Implementing Classes:
AbstractBuildCrumb, AbstractBuildResultsCrumb, AdminCrumb, AllBuildResultsCrumb, AllBuildTestResultsCrumb, AllProjectCrumb, AllTestsCrumb, ArtifactsCrumb, BaseCrumb, BuildCrumb, BuildFilesCrumb, BuildResultSummaryCrumb, CommitsCrumb, LogsCrumb, ProjectCrumb, TestCaseCrumb, TestCaseResultCrumb, TestSuiteResultCrumb

public interface BreadCrumb

An interface that represents a single item in a series of breadcrumbs


Method Summary
 java.lang.String getAccessKey()
          Returns a key as an access key
 java.util.Collection getChildCrumbs()
          Returns the children crumbs.
 java.lang.String getLabel()
          Returns the visible label for the bread crumb
 java.lang.String getUrl()
          Returns the URL for the given label
 boolean isCurrentPage()
          Returns true if the curren BreadCrumb should be selected
 boolean isShown()
          Should the BreadCrumb be showm?
 

Method Detail

isShown

boolean isShown()
Should the BreadCrumb be showm?

Returns:
true if it shou;d be displayed

isCurrentPage

boolean isCurrentPage()
Returns true if the curren BreadCrumb should be selected

Returns:
true or false

getLabel

java.lang.String getLabel()
Returns the visible label for the bread crumb

Returns:
string, cannot be null
Throws:
java.lang.ClassCastException - possible if isShown() doesn't hold true

getUrl

java.lang.String getUrl()
Returns the URL for the given label

Returns:
URL of label. No context is added
Throws:
java.lang.ClassCastException - possible if isShown() doesn't hold true

getChildCrumbs

java.util.Collection getChildCrumbs()
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 isShown() and then it'll follow down that crumb tree

Returns:
Collection of BreadCrumb objects. Collections.EMPTY_LIST if no child crumbs

getAccessKey

java.lang.String getAccessKey()
Returns a key as an access key

Returns:
null if doesn't exist


Copyright © 2008 Atlassian Pty Ltd. All Rights Reserved.