Package com.atlassian.confluence.util.breadcrumbs

Interface Breadcrumb

All Known Implementing Classes:
AbstractActionBreadcrumb, AbstractBreadcrumb, AbstractSpaceActionBreadcrumb, AbstractSpaceBreadcrumb, AdminActionBreadcrumb, AdminBreadcrumb, AttachmentBreadcrumb, BlogCollectorBreadcrumb, BlogCrumb, BlogPostBreadcrumb, BlogPostBreadcrumb, BlogPostDateBreadcrumb, BlogPostDateBreadcrumb, BrowseSpaceBreadcrumb, CompositeBreadcrumb, ContentActionBreadcrumb, CustomContentBreadcrumb, DashboardBreadcrumb, EmptyBreadcrumb, GroupAdminActionBreadcrumb, LabelBreadcrumb, ListPageTemplatesBreadcrumb, LongRunningTaskBreadcrumb, MailServersActionBreadcrumb, PageBreadcrumb, PageBreadcrumb, PagesCollectorBreadcrumb, PageTemplatesActionBreadcrumb, PeopleBreadcrumb, SimpleBreadcrumb, SpaceAdminActionBreadcrumb, SpaceBreadcrumb, SpaceBreadcrumb, UserAdminActionBreadcrumb, UserBreadcrumb, UserProfileActionBreadcrumb
public interface Breadcrumb
Represents a single item in a breadcrumb chain, like the 'Dashboard' link at the start (however, the dashboard breadcrumb is filtered out of the trail in BreadcrumbGenerator as of 5.0).

Be aware that the last breadcrumb in the trail is filtered out by default, unless the implementation of filterTrailingBreadcrumb returns false.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    filterTrailingBreadcrumb()
    Whether or not the last breadcrumb in the breadcrumbs trail should be filtered out.
    List<Breadcrumb>
    getBreadcrumbsTrail()
    Gets all the breadcrumbs trail (including itself) required for display.
    String
    getCssClass()
    CSS class to apply to the breadcrumb
    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.
    void
    setCssClass(String css)
    Override the default CSS class of the 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.

  • Method Details

    • 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

    • getCssClass

      String getCssClass()
      CSS class to apply to the breadcrumb
      Returns:
      a String or null

    • setCssClass

      void setCssClass(String css)
      Override the default CSS class of the breadcrumb
      Parameters:
      css - the default string to write in the class attribute

    • setFilterTrailingBreadcrumb

      void setFilterTrailingBreadcrumb(boolean filterTrailingBreadcrumb)
      Override the breadcrumb's default value for whether or not the last breadcrumb in the trail should be filtered out.
      Parameters:
      filterTrailingBreadcrumb - true if the last breadcrumb in the trail should be filtered out.

    • filterTrailingBreadcrumb

      boolean filterTrailingBreadcrumb()
      Whether or not the last breadcrumb in the breadcrumbs trail should be filtered out. For example, we don't want to duplicate the page title in the breadcrumbs trail when it's already displayed on the page.