Allows to define one or several breadcrumb trail elements.
If the IterateOn or RecurseStart/RecurseNext expressions are set, then several elements will be rendered.
Attributes | ||
optional
String
|
CssClass |
The CSS class to apply. Default: none. |
optional
String
|
IteratorVar |
The name of the iterator contextual bean. This is used when IterateOn or RecurseStart/RecurseNext are used. This bean is available at render-time only. Default: $item. |
optional
enums.Direction |
RecurseOrder |
Defines the way elements are rendered when recursing (from left to right or from right to left). This is used only when RecurseStart/RecurseNext are used. Default: from right to left (reverse order). |
Named Children Elements | ||
optional
binding.Expression |
IterateOn |
Vector of item objects (any). When set, it allows to render several multiple elements (by iterating on the returned vector). |
optional
binding.Expression |
RecurseStart |
Expression that returns the first breadcrumb element that initiates recursing. When using this expression, RecurseNext has to be set and must return a type compatible with RecurseStart. |
optional
binding.Expression |
RecurseNext |
Expression that returns the next breadcrumb element when recursing. Supported contextual beans: $item (the current breadcrumb element). |
mandatory
binding.Expression |
Title |
The breadcrumb element title. Supported contextual beans: $item (if expression 'IterateOn' or 'RecurseStart' and 'RecurseNext' is set). |
optional
binding.Expression |
Tooltip |
The breadcrumb element tooltip text. Supported contextual beans: $item (if expression 'IterateOn' or 'RecurseStart' and 'RecurseNext' is set). |
optional
binding.Expression |
Icon |
The breadcrumb element's icon. The path returned by this expression is relative to the war root directory (ex: 'resources/images/icon.png'). Supported contextual beans: $item (if expression 'IterateOn' or 'RecurseStart' and 'RecurseNext' is set). |
optional
action.IAction |
OnClick |
Action to trigger when the breadcrumb element is clicked. Supported contextual beans: $item (if expression 'IterateOn' or 'RecurseStart' and 'RecurseNext' is set). |
optional
binding.Expression |
Disabled |
Determines whether the breadcrumb element is enabled. Supported contextual beans: $item (if expression 'IterateOn' or 'RecurseStart' and 'RecurseNext' is set). Default: true. |
optional
html.breadcrumb.IBreadCrumbDef |
Parent |
Defines the parent breadcrumb. The parent element(s) will be rendered prior to this element(s). |