Class QuickListController
- java.lang.Object
-
- org.zkoss.zk.ui.event.GenericEventListener
-
- org.zkoss.zk.ui.util.GenericComposer<T>
-
- org.zkoss.zk.ui.util.GenericAutowireComposer<T>
-
- org.zkoss.zk.ui.util.GenericForwardComposer<org.zkoss.zk.ui.Component>
-
- com.hybris.cockpitng.util.ViewAnnotationAwareComposer
-
- com.hybris.cockpitng.util.DefaultWidgetController
-
- com.hybris.backoffice.widgets.quicklist.QuickListController
-
- All Implemented Interfaces:
WidgetController,WidgetDragAndDropAware,WidgetInstanceManagerAware,java.io.Serializable,org.zkoss.zk.ui.event.EventListener,org.zkoss.zk.ui.event.SerializableEventListener,org.zkoss.zk.ui.util.ComponentActivationListener,org.zkoss.zk.ui.util.ComponentCloneListener,org.zkoss.zk.ui.util.Composer<org.zkoss.zk.ui.Component>,org.zkoss.zk.ui.util.ComposerExt<org.zkoss.zk.ui.Component>
public class QuickListController extends DefaultWidgetController
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.StringATTRIBUTE_ITEM_DATAstatic java.lang.StringATTRIBUTE_TILE_MARKERstatic java.lang.StringITEM_COUNT_LABELstatic java.lang.StringMODEL_KEY_ELEMENTS_TYPEstatic java.lang.StringMODEL_KEY_ITEMSstatic java.lang.StringMODEL_KEY_SOURCE_WIDGET_IDstatic java.lang.StringSCLASS_QUICKLIST_INFO_LABELstatic java.lang.StringSCLASS_YW_QUICK_LIST_TILEstatic java.lang.StringSCLASS_YW_QUICK_LIST_TILE_SELECTEDstatic java.lang.StringSETTING_ACTION_SLOT_COMPONENT_IDstatic java.lang.StringSETTING_CONFIGURATION_CONTEXTstatic java.lang.StringSETTING_CONFIGURATION_RENDERERstatic java.lang.StringSOCKET_IN_ITEMSstatic java.lang.StringSOCKET_IN_SELECT_ITEMstatic java.lang.StringSOCKET_OUT_ITEMS_LIST_UPDATEDstatic java.lang.StringSOCKET_OUT_ITEMS_REMOVEDstatic java.lang.StringSOCKET_OUT_ITEMS_REMOVED_BY_CLICKDeprecated, for removal: This API element is subject to removal in a future version.since 19.05, useSOCKET_OUT_ITEMS_REMOVEDinsteadstatic java.lang.StringSOCKET_OUT_OPEN_ITEM
-
Constructor Summary
Constructors Constructor Description QuickListController()
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description protected java.util.List<java.lang.Object>applyAccessRights(java.util.List<java.lang.Object> items)protected WidgetComponentRenderer<org.zkoss.zk.ui.HtmlBasedComponent,QuickList,java.lang.Object>createItemRenderer()protected org.zkoss.zul.ListModelList<java.lang.Object>createModel()protected java.util.Collection<java.lang.Object>extractDataCollection(CockpitEvent event)protected java.lang.StringfindElementsType(org.zkoss.zul.ListModel model)protected org.zkoss.zul.ListModelList<java.lang.Object>findModel()protected org.zkoss.zk.ui.ComponentfindTileInParents(org.zkoss.zk.ui.Component component)protected ActionsgetActionSlot()protected CockpitTypeUtilsgetCockpitTypeUtils()protected DataTypegetDataType(java.lang.Object data)protected java.lang.StringgetElementsType()protected org.zkoss.zul.LabelgetInfoLabel()protected org.zkoss.zul.DivgetItemContainer()protected PermissionFacadegetPermissionFacade()protected NotifyingWidgetComponentRendererFactory<org.zkoss.zk.ui.HtmlBasedComponent,QuickList,java.lang.Object>getRendererFactory()protected TypeFacadegetTypeFacade()protected WidgetComponentRendererFactory<org.zkoss.zk.ui.HtmlBasedComponent,QuickList,java.lang.Object>getWidgetComponentRendererFactory()Deprecated, for removal: This API element is subject to removal in a future version.since 6.5voidhandleObjectDeletedEvent(CockpitEvent event)voidhandleObjectUpdatedEvent(CockpitEvent event)protected booleanhasAccessRights(java.lang.Object item)voidinitialize(org.zkoss.zk.ui.Component comp)Override this method to do initialization stuff for your widget, like initialize widget settings, restore view state from viewmodel, etc.protected QuickListloadConfiguration()Deprecated, for removal: This API element is subject to removal in a future version.protected QuickListloadConfiguration(java.lang.String type)protected voidmarkTileSelected(org.zkoss.zk.ui.HtmlBasedComponent tile, boolean isSelected)protected voidnotifyOpenItem()protected voidonItemRemoveClick(org.zkoss.zk.ui.event.Event clickEvent, java.lang.Object data)protected voidonItemTitleClick(org.zkoss.zk.ui.event.Event clickEvent, java.lang.Object data)protected voidonModelChange(org.zkoss.zul.event.ListDataEvent event)protected voidrefreshActionSlot()protected voidremoveTiles(int indexBegin, int indexEnd)protected voidrenderTiles(int indexBegin, int indexEnd, org.zkoss.zul.ListModel model, boolean createNew)protected voidreplaceElementsInModel(org.zkoss.zul.ListModelList<java.lang.Object> model, java.lang.Object element)Deprecated, for removal: This API element is subject to removal in a future version.since 19.05, please usereplaceModelElements(ListModelList, Object)protected voidreplaceItems(java.util.List<java.lang.Object> items)protected booleanreplaceModelElements(org.zkoss.zul.ListModelList<java.lang.Object> model, java.lang.Object element)protected QuickListretrieveQuickListConfiguration(java.util.Map<java.lang.String,QuickList> quickListConfigurations, java.lang.String dataType)protected voidselectTilesByData(java.util.Collection data)protected voidsetActionSlot(Actions actionSlot)protected voidsetInfoLabel(org.zkoss.zul.Label infoLabel)protected voidsetItemContainer(org.zkoss.zul.Div itemContainer)protected voidsetRendererFactory(NotifyingWidgetComponentRendererFactory<org.zkoss.zk.ui.HtmlBasedComponent,QuickList,java.lang.Object> notifyingWidgetComponentRenderer)protected voidsetWidgetComponentRendererFactory(WidgetComponentRendererFactory<org.zkoss.zk.ui.HtmlBasedComponent,QuickList,java.lang.Object> widgetComponentRendererFactory)Deprecated, for removal: This API element is subject to removal in a future version.since 6.5voidsocketIncomingItems(org.zkoss.zk.ui.event.Event event)voidsocketSelectItem(java.lang.Object item)protected voidstoreModel(org.zkoss.zul.ListModelList<java.lang.Object> items)protected voidupdateItemsCount(int count)-
Methods inherited from class com.hybris.cockpitng.util.DefaultWidgetController
doAfterCompose, doBeforeCompose, doBeforeComposeChildren, executeOperation, getDragAndDropStrategy, getLabel, getLabel, getModel, getValue, getWidgetDragAndDropStrategyRepository, getWidgetInstanceManager, getWidgetRoot, getWidgetSettings, getWidgetslot, getWidgetTitle, getWidgetUtils, initDragAndDropAwareness, initWidgetSetting, initWidgetSetting, initWidgetSetting, initWidgetSetting, initWidgetSetting, invokeListenerMethod, onSocketInput, preInitialize, sendOutput, sendOutputAfterOperation, sendOutputAfterOperation, sendOutputAfterOperation, setValue, setWidgetInstanceManager, setWidgetTitle
-
Methods inherited from class com.hybris.cockpitng.util.ViewAnnotationAwareComposer
scanEventListeners
-
Methods inherited from class org.zkoss.zk.ui.util.GenericAutowireComposer
alert, didActivate, getPage, willClone, willPassivate
-
-
-
-
Field Detail
-
SCLASS_YW_QUICK_LIST_TILE
public static final java.lang.String SCLASS_YW_QUICK_LIST_TILE
- See Also:
- Constant Field Values
-
SCLASS_YW_QUICK_LIST_TILE_SELECTED
public static final java.lang.String SCLASS_YW_QUICK_LIST_TILE_SELECTED
- See Also:
- Constant Field Values
-
SCLASS_QUICKLIST_INFO_LABEL
public static final java.lang.String SCLASS_QUICKLIST_INFO_LABEL
- See Also:
- Constant Field Values
-
SETTING_CONFIGURATION_CONTEXT
public static final java.lang.String SETTING_CONFIGURATION_CONTEXT
- See Also:
- Constant Field Values
-
SETTING_CONFIGURATION_RENDERER
public static final java.lang.String SETTING_CONFIGURATION_RENDERER
- See Also:
- Constant Field Values
-
SETTING_ACTION_SLOT_COMPONENT_ID
public static final java.lang.String SETTING_ACTION_SLOT_COMPONENT_ID
- See Also:
- Constant Field Values
-
SOCKET_IN_ITEMS
public static final java.lang.String SOCKET_IN_ITEMS
- See Also:
- Constant Field Values
-
SOCKET_IN_SELECT_ITEM
public static final java.lang.String SOCKET_IN_SELECT_ITEM
- See Also:
- Constant Field Values
-
SOCKET_OUT_OPEN_ITEM
public static final java.lang.String SOCKET_OUT_OPEN_ITEM
- See Also:
- Constant Field Values
-
SOCKET_OUT_ITEMS_REMOVED
public static final java.lang.String SOCKET_OUT_ITEMS_REMOVED
- See Also:
- Constant Field Values
-
SOCKET_OUT_ITEMS_LIST_UPDATED
public static final java.lang.String SOCKET_OUT_ITEMS_LIST_UPDATED
- See Also:
- Constant Field Values
-
SOCKET_OUT_ITEMS_REMOVED_BY_CLICK
@Deprecated(since="19.05", forRemoval=true) public static final java.lang.String SOCKET_OUT_ITEMS_REMOVED_BY_CLICKDeprecated, for removal: This API element is subject to removal in a future version.since 19.05, useSOCKET_OUT_ITEMS_REMOVEDinstead- See Also:
- Constant Field Values
-
MODEL_KEY_ITEMS
public static final java.lang.String MODEL_KEY_ITEMS
- See Also:
- Constant Field Values
-
MODEL_KEY_SOURCE_WIDGET_ID
public static final java.lang.String MODEL_KEY_SOURCE_WIDGET_ID
- See Also:
- Constant Field Values
-
MODEL_KEY_ELEMENTS_TYPE
public static final java.lang.String MODEL_KEY_ELEMENTS_TYPE
- See Also:
- Constant Field Values
-
ATTRIBUTE_ITEM_DATA
public static final java.lang.String ATTRIBUTE_ITEM_DATA
- See Also:
- Constant Field Values
-
ATTRIBUTE_TILE_MARKER
public static final java.lang.String ATTRIBUTE_TILE_MARKER
- See Also:
- Constant Field Values
-
ITEM_COUNT_LABEL
public static final java.lang.String ITEM_COUNT_LABEL
- See Also:
- Constant Field Values
-
-
Method Detail
-
refreshActionSlot
protected void refreshActionSlot()
-
initialize
public void initialize(org.zkoss.zk.ui.Component comp)
Description copied from class:DefaultWidgetControllerOverride this method to do initialization stuff for your widget, like initialize widget settings, restore view state from viewmodel, etc. This method will be invoked byDefaultWidgetController.doAfterCompose(Component)everytime your widget view is created. SeeGenericForwardComposer.doAfterCompose(Component)for more details.- Overrides:
initializein classDefaultWidgetController
-
createModel
protected org.zkoss.zul.ListModelList<java.lang.Object> createModel()
-
createItemRenderer
protected WidgetComponentRenderer<org.zkoss.zk.ui.HtmlBasedComponent,QuickList,java.lang.Object> createItemRenderer()
-
findTileInParents
protected org.zkoss.zk.ui.Component findTileInParents(org.zkoss.zk.ui.Component component)
-
onModelChange
protected void onModelChange(org.zkoss.zul.event.ListDataEvent event)
-
selectTilesByData
protected void selectTilesByData(java.util.Collection data)
-
markTileSelected
protected void markTileSelected(org.zkoss.zk.ui.HtmlBasedComponent tile, boolean isSelected)
-
renderTiles
protected void renderTiles(int indexBegin, int indexEnd, org.zkoss.zul.ListModel model, boolean createNew)
-
findElementsType
protected java.lang.String findElementsType(org.zkoss.zul.ListModel model)
-
retrieveQuickListConfiguration
protected QuickList retrieveQuickListConfiguration(java.util.Map<java.lang.String,QuickList> quickListConfigurations, java.lang.String dataType)
-
removeTiles
protected void removeTiles(int indexBegin, int indexEnd)
-
onItemRemoveClick
protected void onItemRemoveClick(org.zkoss.zk.ui.event.Event clickEvent, java.lang.Object data)
-
onItemTitleClick
protected void onItemTitleClick(org.zkoss.zk.ui.event.Event clickEvent, java.lang.Object data)
-
notifyOpenItem
protected void notifyOpenItem()
-
socketSelectItem
public void socketSelectItem(java.lang.Object item)
-
socketIncomingItems
public void socketIncomingItems(org.zkoss.zk.ui.event.Event event)
-
replaceItems
protected void replaceItems(java.util.List<java.lang.Object> items)
-
applyAccessRights
protected java.util.List<java.lang.Object> applyAccessRights(java.util.List<java.lang.Object> items)
-
hasAccessRights
protected boolean hasAccessRights(java.lang.Object item)
-
updateItemsCount
protected void updateItemsCount(int count)
-
handleObjectUpdatedEvent
public void handleObjectUpdatedEvent(CockpitEvent event)
-
replaceModelElements
protected boolean replaceModelElements(org.zkoss.zul.ListModelList<java.lang.Object> model, java.lang.Object element)
-
replaceElementsInModel
@Deprecated(since="19.05", forRemoval=true) protected void replaceElementsInModel(org.zkoss.zul.ListModelList<java.lang.Object> model, java.lang.Object element)Deprecated, for removal: This API element is subject to removal in a future version.since 19.05, please usereplaceModelElements(ListModelList, Object)
-
handleObjectDeletedEvent
public void handleObjectDeletedEvent(CockpitEvent event)
-
extractDataCollection
protected java.util.Collection<java.lang.Object> extractDataCollection(CockpitEvent event)
-
getDataType
protected DataType getDataType(java.lang.Object data)
-
loadConfiguration
@Deprecated(since="1905", forRemoval=true) protected QuickList loadConfiguration()Deprecated, for removal: This API element is subject to removal in a future version.UseloadConfiguration(String). QuickList can render context of tile for each type individually.- Since:
- 1905
-
loadConfiguration
protected QuickList loadConfiguration(java.lang.String type)
-
getElementsType
protected java.lang.String getElementsType()
-
findModel
protected org.zkoss.zul.ListModelList<java.lang.Object> findModel()
-
storeModel
protected void storeModel(org.zkoss.zul.ListModelList<java.lang.Object> items)
-
getItemContainer
protected org.zkoss.zul.Div getItemContainer()
-
setItemContainer
protected void setItemContainer(org.zkoss.zul.Div itemContainer)
-
getTypeFacade
protected TypeFacade getTypeFacade()
-
getCockpitTypeUtils
protected CockpitTypeUtils getCockpitTypeUtils()
-
getRendererFactory
protected NotifyingWidgetComponentRendererFactory<org.zkoss.zk.ui.HtmlBasedComponent,QuickList,java.lang.Object> getRendererFactory()
-
setRendererFactory
protected void setRendererFactory(NotifyingWidgetComponentRendererFactory<org.zkoss.zk.ui.HtmlBasedComponent,QuickList,java.lang.Object> notifyingWidgetComponentRenderer)
-
getWidgetComponentRendererFactory
@Deprecated(since="6.5", forRemoval=true) protected WidgetComponentRendererFactory<org.zkoss.zk.ui.HtmlBasedComponent,QuickList,java.lang.Object> getWidgetComponentRendererFactory()Deprecated, for removal: This API element is subject to removal in a future version.since 6.5- See Also:
getRendererFactory()
-
setWidgetComponentRendererFactory
@Deprecated(since="6.5", forRemoval=true) protected void setWidgetComponentRendererFactory(WidgetComponentRendererFactory<org.zkoss.zk.ui.HtmlBasedComponent,QuickList,java.lang.Object> widgetComponentRendererFactory)Deprecated, for removal: This API element is subject to removal in a future version.since 6.5
-
getPermissionFacade
protected PermissionFacade getPermissionFacade()
-
getInfoLabel
protected org.zkoss.zul.Label getInfoLabel()
-
setInfoLabel
protected void setInfoLabel(org.zkoss.zul.Label infoLabel)
-
getActionSlot
protected Actions getActionSlot()
-
setActionSlot
protected void setActionSlot(Actions actionSlot)
-
-