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

List<Breadcrumb>	getBreadcrumbsTrail() Gets all the breadcrumbs trail (including itself) required for display.
String	getDisplayTitle() Gets the display title of the breadcrumb for user display.
String	getTarget() Gets the relative url for the target which a breadcrumb points to.
String	getTitle() Gets the i18n key for the title of the breadcrumb.
String	getTooltip() Gets the breadcrumb's tooltip.

Method Detail

getTarget

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

String getTitle()

Gets the i18n key for the title of the breadcrumb. See getDisplayTitle() for titles that don't need to be translated.

Returns:

the i18n key for the breadcrumb title

getDisplayTitle

String getDisplayTitle()

Gets the display title of the breadcrumb for user display.

Returns:

display title of the breadcrumb or null if not defined

getTooltip

String getTooltip()

Gets the breadcrumb's tooltip.

Returns:

the tooltip to display for the breadcrumb

getBreadcrumbsTrail

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