com.atlassian.confluence.util.breadcrumbs
Interface Breadcrumb

All Known Implementing Classes:

AbstractActionBreadcrumb, AbstractBreadcrumb, AbstractSpaceActionBreadcrumb, AbstractSpaceBreadcrumb, AdminActionBreadcrumb, AdminBreadcrumb, AttachmentBreadcrumb, BlogPostBreadcrumb, BrowseSpaceBreadcrumb, ContentActionBreadcrumb, DashboardBreadcrumb, GroupAdminActionBreadcrumb, LabelBreadcrumb, ListPageTemplatesBreadcrumb, LongRunningTaskBreadcrumb, MailActionBreadcrumb, MailServersActionBreadcrumb, PageBreadcrumb, PageNotFoundBreadcrumb, PageTemplatesActionBreadcrumb, PeopleBreadcrumb, SimpleBreadcrumb, SpaceAdminActionBreadcrumb, SpaceBreadcrumb, UserAdminActionBreadcrumb, UserBreadcrumb, UserProfileActionBreadcrumb, ViewBlogPostsByDateBreadcrumb

public interface Breadcrumb

Represents a single item in a breadcrumb chain, like the 'Dashboard' link at the start.

Method Summary

java.util.List<Breadcrumb>	getBreadcrumbsTrail() Gets all the breadcrumbs trail (including itself) required for display.
java.lang.String	getTarget() Gets the relative url for the target which a breadcrumb points to.
java.lang.String	getTitle() Gets the title of the breadcrumb for user display.

Method Detail

getTarget

java.lang.String getTarget()

Gets the relative url for the target which a breadcrumb points to.

Returns:

the relative url for the breadcrumb, or null if the breadcrumb has no link

getTitle

java.lang.String getTitle()

Gets the title of the breadcrumb for user display. The title may be displayable text or an i18n key.

Returns:

the display title of the breadcrumb

getBreadcrumbsTrail

java.util.List<Breadcrumb> getBreadcrumbsTrail()

Gets all the breadcrumbs trail (including itself) required for display. It must be a list of Breadcrumbs with this object being the last item.

Returns:

a List of breadcrumbs for display