Breadcrumb

From AlfrescoWiki

Back to Component Library

Contents 1 Breadcrumb 1.1 General Description 1.2 Tag details 1.3 Custom tag attributes 1.4 Example 1.5 Screenshots

[edit] Breadcrumb

[edit] General Description

The breadcrumb component enables the manipulation and display of a separated path string. It displays HTML links to enable the user to immediately select any part of the breadcrumb path. The breadcrumb provides standard action and actionListener command properties for developers to handle user interaction with the component.

[edit] Tag details

<a:breadcrumb
  id="<string>"
  rendered="<boolean>"
  styleClass="<string>"
  style="<string>"
  tooltip="<string>"
  value="<string>" MANDATORY
  separator="<string>"
  action="<string>"
  actionListener="<method-binding>"
  showRoot="<boolean>"
/>

[edit] Custom tag attributes

value - the initial breadcrumb path value to display. This is either a String based path using slash '/' separator characters or a value bound bean property which provides a List of IBreadcrumbHandler objects that make up the breadcrumb elements. The IBreadcrumbHandler interface and component framework support methods to allow the construction of a breadcrumb to aributary locations in the UI, each element in the breadcrumb needing no knowledge of other parent or child elements.

separator - the separator string to use when displaying the breadcrumb. The default value is the '>' character.

action - command outcome action value.

actionListener - command listener method binding.

showRoot - whether to show the first token in the the path string.

[edit] Example

  <a:breadcrumb value="/horse/biscuit/flibble" separator="~"
     action="success" actionListener="#{bean.clickBreadcrumb}" />

[edit] Screenshots

Breadcrumb with default styles and modified separator string:

Breadcrumb with a style applied and default separator string: