Package com.hybris.cockpitng.widgets.collectionbrowser

Class CollectionBrowserController

  • 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 CollectionBrowserController
extends DefaultWidgetController
    See Also:
    Serialized Form

    • Field Detail

      • SOCKET_OUT_SORTDATA

        public static final java.lang.String SOCKET_OUT_SORTDATA
        See Also:
        Constant Field Values

      • SOCKET_IN_PAGEABLE

        public static final java.lang.String SOCKET_IN_PAGEABLE
        See Also:
        Constant Field Values

      • SOCKET_IN_OBJECT_LIST

        public static final java.lang.String SOCKET_IN_OBJECT_LIST
        See Also:
        Constant Field Values

      • SOCKET_PREVIOUS_ITEM_SELECTOR_INVOCATION

        public static final java.lang.String SOCKET_PREVIOUS_ITEM_SELECTOR_INVOCATION
        See Also:
        Constant Field Values

      • SOCKET_NEXT_ITEM_SELECTOR_INVOCATION

        public static final java.lang.String SOCKET_NEXT_ITEM_SELECTOR_INVOCATION
        See Also:
        Constant Field Values

      • SOCKET_PREVIOUS_ITEM_SELECTOR_CONTEXT

        public static final java.lang.String SOCKET_PREVIOUS_ITEM_SELECTOR_CONTEXT
        See Also:
        Constant Field Values

      • SOCKET_NEXT_ITEM_SELECTOR_CONTEXT

        public static final java.lang.String SOCKET_NEXT_ITEM_SELECTOR_CONTEXT
        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_IN_SELECT_ITEMS

        public static final java.lang.String SOCKET_IN_SELECT_ITEMS
        See Also:
        Constant Field Values

      • SOCKET_IN_DESELECT_ITEMS

        public static final java.lang.String SOCKET_IN_DESELECT_ITEMS
        See Also:
        Constant Field Values

      • SOCKET_IN_DESELECT_ALL_ITEMS

        public static final java.lang.String SOCKET_IN_DESELECT_ALL_ITEMS
        See Also:
        Constant Field Values

      • SOCKET_IN_SELECT_CONTEXT

        public static final java.lang.String SOCKET_IN_SELECT_CONTEXT
        See Also:
        Constant Field Values

      • SOCKET_IN_FOCUS_ITEM

        public static final java.lang.String SOCKET_IN_FOCUS_ITEM
        See Also:
        Constant Field Values

      • SOCKET_IN_RESET_ACTION_SLOT

        public static final java.lang.String SOCKET_IN_RESET_ACTION_SLOT
        See Also:
        Constant Field Values

      • SOCKET_IN_REFRESH

        public static final java.lang.String SOCKET_IN_REFRESH
        See Also:
        Constant Field Values

      • DEFAULT_COLLECTION_BROWSER_CONFIG_CTX

        public static final java.lang.String DEFAULT_COLLECTION_BROWSER_CONFIG_CTX
        See Also:
        Constant Field Values

      • SETTING_COLLECTION_BROWSER_CONFIG_CTX

        public static final java.lang.String SETTING_COLLECTION_BROWSER_CONFIG_CTX
        See Also:
        Constant Field Values

      • SETTING_REFRESH_AFTER_OBJECT_CREATION

        public static final java.lang.String SETTING_REFRESH_AFTER_OBJECT_CREATION
        See Also:
        Constant Field Values

      • SHOULD_RELOAD_AFTER_UPDATE

        public static final java.lang.String SHOULD_RELOAD_AFTER_UPDATE
        See Also:
        Constant Field Values

      • SETTING_PAGE_SIZE

        public static final java.lang.String SETTING_PAGE_SIZE
        See Also:
        Constant Field Values

      • SETTING_MULTI_SELECT

        public static final java.lang.String SETTING_MULTI_SELECT
        See Also:
        Constant Field Values

      • SETTING_PAGING_POSITION

        public static final java.lang.String SETTING_PAGING_POSITION
        See Also:
        Constant Field Values

      • SETTING_SEND_ITEMS_ON_SELECT

        public static final java.lang.String SETTING_SEND_ITEMS_ON_SELECT
        See Also:
        Constant Field Values

      • SETTING_FALLBACK_TYPE_CODE

        public static final java.lang.String SETTING_FALLBACK_TYPE_CODE
        See Also:
        Constant Field Values

      • SETTING_DRAG_ENABLED

        public static final java.lang.String SETTING_DRAG_ENABLED
        See Also:
        Constant Field Values

      • SETTING_DROP_ENABLED

        public static final java.lang.String SETTING_DROP_ENABLED
        See Also:
        Constant Field Values

      • CTX_PARAM_UPDATED_OBJECT_IS_NEW

        public static final java.lang.String CTX_PARAM_UPDATED_OBJECT_IS_NEW
        See Also:
        Constant Field Values

      • DESELECT_ALL_COMPONENT

        public static final java.lang.String DESELECT_ALL_COMPONENT
        See Also:
        Constant Field Values

      • COMPONENT_ITEM_COUNT

        public static final java.lang.String COMPONENT_ITEM_COUNT
        See Also:
        Constant Field Values

      • ITEM_COUNT_ACTIVE_SCLASS

        public static final java.lang.String ITEM_COUNT_ACTIVE_SCLASS
        See Also:
        Constant Field Values

      • SCLASS_ACTIVE_MOLD_SELECTOR

        public static final java.lang.String SCLASS_ACTIVE_MOLD_SELECTOR
        See Also:
        Constant Field Values

      • SCLASS_INACTIVE_MOLD_SELECTOR

        public static final java.lang.String SCLASS_INACTIVE_MOLD_SELECTOR
        See Also:
        Constant Field Values

      • SCLASS_COLL_BROWSER_MOLD_SEL_BTN

        public static final java.lang.String SCLASS_COLL_BROWSER_MOLD_SEL_BTN
        See Also:
        Constant Field Values

      • SCLASS_MULTISELECT

        public static final java.lang.String SCLASS_MULTISELECT
        See Also:
        Constant Field Values

      • ACTION_SLOT_COMPONENT_ID

        public static final java.lang.String ACTION_SLOT_COMPONENT_ID
        See Also:
        Constant Field Values

      • ATTRIBUTE_MOLD_CLASS

        public static final java.lang.String ATTRIBUTE_MOLD_CLASS
        See Also:
        Constant Field Values

      • MODEL_EXPORT_COLUMNS_AND_DATA

        public static final java.lang.String MODEL_EXPORT_COLUMNS_AND_DATA
        See Also:
        Constant Field Values

      • MODEL_ACTIVE_MOLD_NAME

        public static final java.lang.String MODEL_ACTIVE_MOLD_NAME
        See Also:
        Constant Field Values

      • MODEL_LAST_ACTIVE_PAGE_NUMBER

        public static final java.lang.String MODEL_LAST_ACTIVE_PAGE_NUMBER
        See Also:
        Constant Field Values

      • MODEL_SELECTION_CONTEXT

        public static final java.lang.String MODEL_SELECTION_CONTEXT
        See Also:
        Constant Field Values

      • MODEL_MULTI_SELECT_ENABLED

        public static final java.lang.String MODEL_MULTI_SELECT_ENABLED
        See Also:
        Constant Field Values

      • TYPE_CODE_KEY

        @Deprecated(since="6.7",
            forRemoval=true)
public static final java.lang.String TYPE_CODE_KEY
        Deprecated, for removal: This API element is subject to removal in a future version.
        since 6.7, not used anymore
        See Also:
        Constant Field Values

      • GLOBAL_EVENT_ITEM_LOCKED_STATE_CHANGED

        public static final java.lang.String GLOBAL_EVENT_ITEM_LOCKED_STATE_CHANGED
        See Also:
        Constant Field Values

      • SETTING_PAGING_POSITION_BOTTOM

        protected static final java.lang.String SETTING_PAGING_POSITION_BOTTOM
        See Also:
        Constant Field Values

      • SETTING_PAGING_POSITION_TOP

        protected static final java.lang.String SETTING_PAGING_POSITION_TOP
        See Also:
        Constant Field Values

      • MODEL_DATA_TYPE

        protected static final java.lang.String MODEL_DATA_TYPE
        See Also:
        Constant Field Values

      • MODEL_DATA_TYPE_CODE

        protected static final java.lang.String MODEL_DATA_TYPE_CODE
        See Also:
        Constant Field Values

      • SETTING_HYPERLINKS_ENABLED

        protected static final java.lang.String SETTING_HYPERLINKS_ENABLED
        See Also:
        Constant Field Values

    • Constructor Detail

      • CollectionBrowserController

        public CollectionBrowserController()

    • Method Detail

      • getSelectedItem

        @Deprecated(since="6.7",
            forRemoval=true)
public static java.lang.Object getSelectedItem​(java.util.Collection<?> selection)
        Deprecated, for removal: This API element is subject to removal in a future version.
        since 6.7, please use SelectAndFocusDelegateController.getSelectedItem(java.util.Collection<?>)
        Gets a single selection from multiple selected items
        Parameters:
        selection - selected items
        Returns:
        item that should be treated as single selection

      • process

        public void process​(Pageable<?> pageable)
        Callback method for the input socket "pageable". Renders the values contained in the provided pageable object and updates paging information if provided.
        Parameters:
        pageable - the pageable object to setPage

      • process

        protected <E> void process​(Pageable<E> pageable,
                           java.util.function.Consumer<Pageable<E>> callback)

      • previousItemSelectorInvocation

        public void previousItemSelectorInvocation()

      • nextItemSelectorInvocation

        public void nextItemSelectorInvocation()

      • deselectAllItems

        public void deselectAllItems()

      • reset

        public void reset​(java.util.Map<java.lang.Object,​java.lang.Object> params)
        Resets the widget to the initial state, displaying no data.

      • refresh

        public void refresh()
        Refreshes the widget's data.

      • resetActionSlot

        public void resetActionSlot()
        Resets the widget's actions.

      • selectItem

        public void selectItem​(java.lang.Object itemToSelect)
        Method to select item
        Parameters:
        itemToSelect - an item to be selected

      • selectMultipleItems

        public void selectMultipleItems​(java.util.List<java.lang.Object> itemsToSelect)
        Method to select multiple items
        Parameters:
        itemsToSelect - an item to be selected

      • deselectItems

        public void deselectItems​(java.util.List<java.lang.Object> itemsToDeselect)
        Removes given items from the current selection
        Parameters:
        itemsToDeselect - objects to remove from selection

      • handleSelectionContext

        public void handleSelectionContext​(java.util.Map<java.lang.String,​java.lang.Object> inputContext)

      • handleObjectDeleteEvent

        public void handleObjectDeleteEvent​(CockpitEvent event)

      • handleObjectsUpdatedEvent

        public void handleObjectsUpdatedEvent​(CockpitEvent event)

      • isModifiedItemDisplayed

        protected boolean isModifiedItemDisplayed​(java.util.Collection<java.lang.Object> itemsToUpdate)

      • itemLockingChanged

        public void itemLockingChanged​(CockpitEvent event)

      • handleViewRefresh

        protected void handleViewRefresh​(CockpitEvent event)

      • isAssignableFrom

        protected boolean isAssignableFrom​(java.lang.String superType,
                                   java.util.Collection<?> subTypeObjects)

      • shouldRefreshAfterObjectCreation

        protected boolean shouldRefreshAfterObjectCreation()

      • isNewTheUpdatedObject

        protected boolean isNewTheUpdatedObject​(CockpitEvent event)

      • shouldReloadAfterUpdate

        protected boolean shouldReloadAfterUpdate​(CockpitEvent event)

      • isShouldReloadAfterUpdateEnabled

        protected boolean isShouldReloadAfterUpdateEnabled​(CockpitEvent event)

      • areUpdatedObjectsVisibleOnCurrentPage

        protected boolean areUpdatedObjectsVisibleOnCurrentPage​(CockpitEvent event)

      • handleObjectCreateEvent

        public void handleObjectCreateEvent​(CockpitEvent event)

      • showPopup

        public void showPopup()

      • deselectItems

        public void deselectItems()

      • removeActiveSclassForItemCount

        public void removeActiveSclassForItemCount()

      • initializePagingContainer

        protected void initializePagingContainer​(org.zkoss.zk.ui.Component parent)

      • initializeCollectionBrowserConfigurationLoader

        protected void initializeCollectionBrowserConfigurationLoader()

      • initializePagingDelegateController

        protected void initializePagingDelegateController()

      • initializeTitleDelegateController

        protected void initializeTitleDelegateController()

      • initializeSelectAndFocusDelegateController

        protected void initializeSelectAndFocusDelegateController()

      • initializeAvailableMolds

        protected void initializeAvailableMolds()

      • loadAvailableMolds

        public void loadAvailableMolds()

      • initializeMoldSelector

        public void initializeMoldSelector()

      • registerMoldSelectorEvents

        protected void registerMoldSelectorEvents​(CollectionBrowserMoldStrategy mold,
                                          org.zkoss.zul.Div moldSelector)

      • updateMoldSelector

        protected void updateMoldSelector​(org.zkoss.zk.ui.Component component,
                                  CollectionBrowserMoldStrategy mold,
                                  org.zkoss.zul.Div moldSelector)

      • initializeObserverForModelPageable

        protected void initializeObserverForModelPageable()

      • initializeObserverForModelColumnsConfig

        protected void initializeObserverForModelColumnsConfig()

      • updateModelExportColumnsAndData

        protected void updateModelExportColumnsAndData()

      • initializeModelSelectedObjects

        @Deprecated(since="6.7",
            forRemoval=true)
protected void initializeModelSelectedObjects()
        Deprecated, for removal: This API element is subject to removal in a future version.
        since 6.7, please use the SelectAndFocusDelegateController.initialize() instead

      • initializeTitle

        protected void initializeTitle()

      • initializeDataType

        protected void initializeDataType()

      • initializeDataType

        public void initializeDataType​(java.lang.String typeCode)

      • initializeActionSlot

        public void initializeActionSlot()

      • getCurrentTypeCode

        public java.lang.String getCurrentTypeCode()

      • getCurrentType

        public DataType getCurrentType()

      • releaseAllMolds

        public void releaseAllMolds()

      • refreshPageable

        protected void refreshPageable()

      • reset

        public void reset()

      • resetModel

        protected void resetModel()

      • resetView

        protected void resetView()

      • sort

        public void sort​(SortData sortData)

      • canHandleEvent

        protected boolean canHandleEvent​(CockpitEvent event)

      • isActiveMoldHandlingEventData

        protected boolean isActiveMoldHandlingEventData​(java.lang.Object eventData)

      • focusItem

        public void focusItem​(java.lang.Object item)

      • setItemFocused

        @Deprecated(since="6.7",
            forRemoval=true)
protected void setItemFocused​(java.lang.Object item)
        Deprecated, for removal: This API element is subject to removal in a future version.
        since 6.7, please use the SelectAndFocusDelegateController.focusItem(Object) instead

      • setSelectedItems

        @Deprecated(since="6.7",
            forRemoval=true)
public void setSelectedItems​(java.util.Collection<?> selectedItems)
        Deprecated, for removal: This API element is subject to removal in a future version.
        since 6.7, please use the SelectAndFocusDelegateController.selectItems(Collection) instead
        Sets new collection of selected items. All values needed are updated and socket messages are being sent.
        Parameters:
        selectedItems - items that has been selected

      • selectItems

        @Deprecated(since="6.7",
            forRemoval=true)
protected void selectItems​(java.util.Collection<?> selectedItems)
        Deprecated, for removal: This API element is subject to removal in a future version.
        since 6.7, please use the SelectAndFocusDelegateController.selectItems(Collection) instead

      • handleSelectionChanged

        public void handleSelectionChanged​(java.util.Collection<?> selectedItems)

      • getSelectedItemsCount

        public int getSelectedItemsCount()

      • setSelectedItemsCount

        protected void setSelectedItemsCount​(int count)

      • updateItemCount

        protected void updateItemCount​(int count)

      • callExecuteOperation

        public void callExecuteOperation​(Operation operation,
                                 org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event> callbackEvent,
                                 java.lang.String busyMessage)

      • setStatusBarVisible

        public void setStatusBarVisible​(boolean visible)

      • areHyperlinksEnabled

        public boolean areHyperlinksEnabled()
        Returns:
        true if widget supports hyperlinks in displayed values

      • hasPermissionToType

        protected boolean hasPermissionToType()

      • isMultiSelectEnabled

        public boolean isMultiSelectEnabled()

      • isSendItemsOnSelectEnabled

        public boolean isSendItemsOnSelectEnabled()

      • isDragEnabled

        public boolean isDragEnabled()
        Returns:
        returns if items can be dragged from this widget

      • isDropEnabled

        public boolean isDropEnabled()
        Returns:
        returns if items can be dropped on this widget

      • getListTitle

        public org.zkoss.zul.Label getListTitle()

      • getListSubtitle

        public org.zkoss.zul.Label getListSubtitle()

      • getItemCount

        public org.zkoss.zul.Button getItemCount()

      • getDeselectAll

        public org.zkoss.zul.Button getDeselectAll()

      • getDeselectPopup

        public org.zkoss.zul.Popup getDeselectPopup()

      • getPaging

        public org.zkoss.zul.Paging getPaging()

      • getStatusBar

        public org.zkoss.zul.Div getStatusBar()

      • getBrowserContainer

        public org.zkoss.zul.Div getBrowserContainer()

      • getMoldSelectorContainer

        public org.zkoss.zul.Hbox getMoldSelectorContainer()

      • getActionSlot

        public Actions getActionSlot()

      • getNumberOfItemsLabel

        public org.zkoss.zul.Label getNumberOfItemsLabel()

      • setNumberOfItemsLabel

        public void setNumberOfItemsLabel​(org.zkoss.zul.Label numberOfItemsLabel)

      • getContentsContainer

        public org.zkoss.zul.Div getContentsContainer()

      • getPagingContainerTop

        public org.zkoss.zul.Div getPagingContainerTop()

      • setPagingContainerTop

        public void setPagingContainerTop​(org.zkoss.zul.Div pagingContainerTop)

      • getPagingContainerBottom

        public org.zkoss.zul.Div getPagingContainerBottom()

      • setPagingContainerBottom

        public void setPagingContainerBottom​(org.zkoss.zul.Div pagingContainerBottom)

      • getBottomBar

        public org.zkoss.zul.Div getBottomBar()

      • setBottomBar

        public void setBottomBar​(org.zkoss.zul.Div bottomBar)

      • setPagingDelegateController

        public void setPagingDelegateController​(PagingDelegateController pagingDelegateController)

      • setTitleDelegateController

        public void setTitleDelegateController​(TitleDelegateController titleDelegateController)

      • setBackofficeTypeUtils

        public void setBackofficeTypeUtils​(BackofficeTypeUtils backofficeTypeUtils)

      • setLabelService

        public void setLabelService​(LabelService labelService)

      • getTypeFacade

        public TypeFacade getTypeFacade()

      • setTypeFacade

        public void setTypeFacade​(TypeFacade typeFacade)

      • setObjectValueService

        public void setObjectValueService​(ObjectValueService objectValueService)

      • setCockpitLocaleService

        public void setCockpitLocaleService​(CockpitLocaleService cockpitLocaleService)

      • setPermissionFacade

        public void setPermissionFacade​(PermissionFacade permissionFacade)

      • setExceptionTranslationService

        public void setExceptionTranslationService​(ExceptionTranslationService exceptionTranslationService)

      • setFieldSearchFacade

        public void setFieldSearchFacade​(FieldSearchFacade<?> fieldSearchFacade)

      • setTypeCodeResolver

        public void setTypeCodeResolver​(TypeCodeResolver typeCodeResolver)