Interface CollectionBrowserMoldStrategy
-
- All Superinterfaces:
org.springframework.core.Ordered
- All Known Implementing Classes:
AbstractMoldStrategy,GridViewCollectionBrowserMoldStrategy,ListViewCollectionBrowserMoldStrategy,TreeViewCollectionBrowserMoldStrategy
public interface CollectionBrowserMoldStrategy extends org.springframework.core.OrderedInterface for mold strategies used by Collection Browser widget.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description voiddeselectItems()Deselects all items.default voidfocusItem(java.lang.Object oldFocus, java.lang.Object newFocus)Mark provided item as focused.java.lang.StringgetName()NavigationItemSelectorContextgetNavigationItemSelectorContext()java.lang.StringgetTooltipText()java.lang.StringgetTypeCode()voidhandleObjectCreateEvent(CockpitEvent event)Additional logic to perform on object create event.voidhandleObjectDeleteEvent(CockpitEvent event)Additional logic to perform on object deleted event.default voidhandleObjectsUpdateEvent(CockpitEvent event)Additional logic to perform on objects updated event.voidhandleObjectUpdateEvent(CockpitEvent event)Additional logic to perform on object updated event.booleanisHandlingObjectEvents(java.lang.String typeCode)Check if we can handle object events for a given type code.voidnextItemSelectorInvocation()Handle "next item" navigation event.voidpreviousItemSelectorInvocation()Handle "previous item" navigation event.voidrelease()Method called by the controller when mold is turned off.voidrender(org.zkoss.zk.ui.Component parent, SinglePage singlePage)Render mold inside given parent component with single page.voidreset()Resets the mold to the initial state, displaying no data.voidselectItems(java.util.Set<?> items)Select given items.voidsetContext(CollectionBrowserMoldContext context)Sets a communication channel with widget controller.voidsetOrder(int order)Set the order value for this bean.voidsetPage(SinglePage singlePage)Set data for a single page.voidsetTypeCode(java.lang.String typeCode)Set type code for the current mold strategy.
-
-
-
Method Detail
-
setContext
void setContext(CollectionBrowserMoldContext context)
Sets a communication channel with widget controller.- Parameters:
context- communication channel with widget controller.
-
setPage
void setPage(SinglePage singlePage)
Set data for a single page.
-
render
void render(org.zkoss.zk.ui.Component parent, SinglePage singlePage)Render mold inside given parent component with single page.
-
previousItemSelectorInvocation
void previousItemSelectorInvocation()
Handle "previous item" navigation event.
-
nextItemSelectorInvocation
void nextItemSelectorInvocation()
Handle "next item" navigation event.
-
isHandlingObjectEvents
boolean isHandlingObjectEvents(java.lang.String typeCode)
Check if we can handle object events for a given type code.- Parameters:
typeCode- type code.- Returns:
trueif mold is interested in handling object events for objects of given type, otherwisefalse.
-
handleObjectDeleteEvent
void handleObjectDeleteEvent(CockpitEvent event)
Additional logic to perform on object deleted event.
-
handleObjectUpdateEvent
void handleObjectUpdateEvent(CockpitEvent event)
Additional logic to perform on object updated event.
-
handleObjectsUpdateEvent
default void handleObjectsUpdateEvent(CockpitEvent event)
Additional logic to perform on objects updated event.
-
handleObjectCreateEvent
void handleObjectCreateEvent(CockpitEvent event)
Additional logic to perform on object create event.
-
selectItems
void selectItems(java.util.Set<?> items)
Select given items.No notifications should be sent.
- Parameters:
items- items to be selected.
-
deselectItems
void deselectItems()
Deselects all items.No notifications should be sent.
-
focusItem
default void focusItem(java.lang.Object oldFocus, java.lang.Object newFocus)Mark provided item as focused. Only one item may be focused at the time.- Parameters:
oldFocus- item that was focused up until nownewFocus- item to be marked as focused
-
release
void release()
Method called by the controller when mold is turned off. It should remove itself from its parent and free resources.
-
getName
java.lang.String getName()
- Returns:
- name of the mold for internal use (e.g. to determine CSS class of (in)active mold selection button).
-
setTypeCode
void setTypeCode(java.lang.String typeCode)
Set type code for the current mold strategy.
-
getTypeCode
java.lang.String getTypeCode()
- Returns:
- type code for the current mold strategy.
-
getTooltipText
java.lang.String getTooltipText()
- Returns:
- tooltip text that should appear on a mold selection button.
-
getNavigationItemSelectorContext
NavigationItemSelectorContext getNavigationItemSelectorContext()
- Returns:
- current
NavigationItemSelectorContext.
-
reset
void reset()
Resets the mold to the initial state, displaying no data.
-
setOrder
void setOrder(int order)
Set the order value for this bean. The higher the order, the farther it will appear in mold selector.
-
-