CollectionBrowserMoldStrategy (cockpitng 18.08.0-RC7 API)

All Superinterfaces:

org.springframework.core.Ordered

All Known Implementing Classes:

AbstractMoldStrategy, GridViewCollectionBrowserMoldStrategy, ListViewCollectionBrowserMoldStrategy, TreeViewCollectionBrowserMoldStrategy
```
public interface CollectionBrowserMoldStrategy
extends org.springframework.core.Ordered
```
Interface for mold strategies used by Collection Browser widget.

Field Summary
- Fields inherited from interface org.springframework.core.Ordered
  HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`void`	`deselectItems()` Deselects all items.
`default void`	`focusItem(Object oldFocus, Object newFocus)` Mark provided item as focused.
`String`	`getName()`
`NavigationItemSelectorContext`	`getNavigationItemSelectorContext()`
`String`	`getTooltipText()`
`String`	`getTypeCode()`
`void`	`handleObjectCreateEvent(CockpitEvent event)` Additional logic to perform on object create event.
`void`	`handleObjectDeleteEvent(CockpitEvent event)` Additional logic to perform on object deleted event.
`default void`	`handleObjectsUpdateEvent(CockpitEvent event)` Additional logic to perform on objects updated event.
`void`	`handleObjectUpdateEvent(CockpitEvent event)` Additional logic to perform on object updated event.
`boolean`	`isHandlingObjectEvents(String typeCode)` Check if we can handle object events for a given type code.
`void`	`nextItemSelectorInvocation()` Handle "next item" navigation event.
`void`	`previousItemSelectorInvocation()` Handle "previous item" navigation event.
`void`	`release()` Method called by the controller when mold is turned off.
`void`	`render(org.zkoss.zk.ui.Component parent, SinglePage singlePage)` Render mold inside given parent component with single page.
`void`	`reset()` Resets the mold to the initial state, displaying no data.
`void`	`selectItems(Set<?> items)` Select given items.
`void`	`setContext(CollectionBrowserMoldContext context)` Sets a communication channel with widget controller.
`void`	`setOrder(int order)` Set the order value for this bean.
`void`	`setPage(SinglePage singlePage)` Set data for a single page.
`void`	`setTypeCode(String typeCode)` Set type code for the current mold strategy.

Methods inherited from interface org.springframework.core.Ordered
getOrder

- 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(String typeCode)
```
    Check if we can handle object events for a given type code.
    
    Parameters:
    
    typeCode - type code.
    
    Returns:
    
    true if mold is interested in handling object events for objects of given type, otherwise false.
  - 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(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(Object oldFocus,
                       Object newFocus)
```
    Mark provided item as focused. Only one item may be focused at the time.
    
    Parameters:
    
    oldFocus - item that was focused up until now
    
    newFocus - 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
```
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(String typeCode)
```
    Set type code for the current mold strategy.
  - getTypeCode
```
String getTypeCode()
```
    Returns:
    
    type code for the current mold strategy.
  - getTooltipText
```
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.

Interface CollectionBrowserMoldStrategy

Field Summary

Fields inherited from interface org.springframework.core.Ordered

Method Summary

Methods inherited from interface org.springframework.core.Ordered

Method Detail

setContext

setPage

render

previousItemSelectorInvocation

nextItemSelectorInvocation

isHandlingObjectEvents

handleObjectDeleteEvent

handleObjectUpdateEvent

handleObjectsUpdateEvent

handleObjectCreateEvent

selectItems

deselectItems

focusItem

release

getName

setTypeCode

getTypeCode

getTooltipText

getNavigationItemSelectorContext

reset

setOrder