|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 | |
---|---|
boolean |
filterTrailingBreadcrumb()
Whether or not the last breadcrumb in the breadcrumbs trail should be filtered out. |
java.util.List<Breadcrumb> |
getBreadcrumbsTrail()
Gets all the breadcrumbs trail (including itself) required for display. |
java.lang.String |
getCssClass()
CSS class to apply to the breadcrumb |
java.lang.String |
getDisplayTitle()
Gets the display title of the breadcrumb for user display. |
java.lang.String |
getTarget()
Gets the relative url for the target which a breadcrumb points to. |
java.lang.String |
getTitle()
Gets the i18n key for the title of the breadcrumb. |
java.lang.String |
getTooltip()
Gets the breadcrumb's tooltip. |
void |
setCssClass(java.lang.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 Detail |
---|
java.lang.String getTarget()
java.lang.String getTitle()
getDisplayTitle()
for
titles that don't need to be translated.
java.lang.String getDisplayTitle()
java.lang.String getTooltip()
java.util.List<Breadcrumb> getBreadcrumbsTrail()
Breadcrumb
s with this object being the last item.
List
of breadcrumbs for displayjava.lang.String getCssClass()
void setCssClass(java.lang.String css)
css
- the default string to write in the class attributevoid setFilterTrailingBreadcrumb(boolean filterTrailingBreadcrumb)
filterTrailingBreadcrumb
- true if the last breadcrumb in the trail should be filtered out.boolean filterTrailingBreadcrumb()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |