Interface IBreadCrumbParticipant
-
- All Superinterfaces:
IClusterable
,Serializable
- All Known Implementing Classes:
BreadCrumbPanel
,BreadCrumbParticipantDelegate
public interface IBreadCrumbParticipant extends IClusterable
Bread crumb participants function as proxies for components that are part of a bread crumb hierarchy. An example of a bread crumb is:Home > Products & Solutions > Hardware > Desktop Systems
In apanel based implementation
, Home, Products & Solutions etc would be separate panels that all are bread crumb participants: for instance the Home participant'stitle
would return 'Home', andthe component
would be the corresponding panel.- Author:
- Eelco Hillenius
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Component
getComponent()
Gets the participating component.IModel<String>
getTitle()
Gets the title of the bread crumb, which will be used for displaying it.void
onActivate(IBreadCrumbParticipant previous)
Called when the corresponding bread crumb is activated.
-
-
-
Method Detail
-
getComponent
Component getComponent()
Gets the participating component. Typically, this is a panel.- Returns:
- The participating component, must return a non-null value
-
getTitle
IModel<String> getTitle()
Gets the title of the bread crumb, which will be used for displaying it.- Returns:
- The title of the bread crumb
-
onActivate
void onActivate(IBreadCrumbParticipant previous)
Called when the corresponding bread crumb is activated.- Parameters:
previous
- The previously active bread crumb participant, possibly null
-
-