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
    • Constructor Detail

      • CollectionBrowserController

        public CollectionBrowserController()
    • Method Detail

      • getSelectedItem

        @Deprecated
        public static java.lang.Object getSelectedItem​(java.util.Collection<?> selection)
        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.
      • 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
      • 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()
      • 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()
      • 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)
      • setSelectedItems

        @Deprecated
        public void setSelectedItems​(java.util.Collection<?> selectedItems)
        Deprecated.
        Sets new collection of selected items. All values needed are updated and socket messages are being sent.
        Parameters:
        selectedItems - items that has been selected
      • 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()
      • 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)