com.hybris.cockpitng.widgets.collectionbrowser

Class CollectionBrowserController

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.cockpitng.widgets.collectionbrowser.CollectionBrowserController

All Implemented Interfaces:

WidgetController, WidgetDragAndDropAware, WidgetInstanceManagerAware, 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 Summary

Fields

Modifier and Type	Field and Description
static String	ACTION_SLOT_COMPONENT_ID
static String	ATTRIBUTE_MOLD_CLASS
static String	COMPONENT_ITEM_COUNT
static String	CTX_PARAM_UPDATED_OBJECT_IS_NEW
static String	DEFAULT_COLLECTION_BROWSER_CONFIG_CTX
static String	DESELECT_ALL_COMPONENT
static CollectionBrowserMoldStrategy	EMPTY_MOLD
static String	GLOBAL_EVENT_ITEM_LOCKED_STATE_CHANGED
static String	ITEM_COUNT_ACTIVE_SCLASS
static String	MODEL_ACTIVE_MOLD_NAME
protected static String	MODEL_DATA_TYPE
protected static String	MODEL_DATA_TYPE_CODE
static String	MODEL_EXPORT_COLUMNS_AND_DATA
protected static String	MODEL_FOCUSED_OBJECT Deprecated. since 6.7, please use DefaultSelectAndFocusDelegateController.MODEL_FOCUSED_OBJECT
static String	MODEL_LAST_ACTIVE_PAGE_NUMBER
static String	MODEL_MULTI_SELECT_ENABLED
static String	MODEL_PAGEABLE
static String	MODEL_SELECTED_OBJECTS Deprecated. since 6.7, please use DefaultSelectAndFocusDelegateController.MODEL_SELECTED_OBJECTS
static String	MODEL_SELECTION_CONTEXT
static String	POPUP_POSITION
static String	SCLASS_ACTIVE_MOLD_SELECTOR
static String	SCLASS_COLL_BROWSER_MOLD_SEL_BTN
static String	SCLASS_INACTIVE_MOLD_SELECTOR
static String	SCLASS_MULTISELECT
static String	SETTING_COLLECTION_BROWSER_CONFIG_CTX
static String	SETTING_FALLBACK_TYPE_CODE
protected static String	SETTING_HYPERLINKS_ENABLED
static String	SETTING_MULTI_SELECT
static String	SETTING_PAGE_SIZE
static String	SETTING_PAGING_POSITION
protected static String	SETTING_PAGING_POSITION_BOTTOM
protected static String	SETTING_PAGING_POSITION_TOP
static String	SETTING_REFRESH_AFTER_OBJECT_CREATION
static String	SETTING_SEND_ITEMS_ON_SELECT
static String	SHOULD_RELOAD_AFTER_UPDATE
static String	SOCKET_IN_DESELECT_ALL_ITEMS
static String	SOCKET_IN_DESELECT_ITEMS
static String	SOCKET_IN_FOCUS_ITEM
static String	SOCKET_IN_OBJECT_LIST
static String	SOCKET_IN_PAGEABLE
static String	SOCKET_IN_SELECT_CONTEXT
static String	SOCKET_IN_SELECT_ITEM
static String	SOCKET_NEXT_ITEM_SELECTOR_CONTEXT
static String	SOCKET_NEXT_ITEM_SELECTOR_INVOCATION
protected static String	SOCKET_OUT_FOCUSED_ITEM Deprecated. since 6.7, please use DefaultSelectAndFocusDelegateController.SOCKET_OUT_FOCUSED_ITEM
protected static String	SOCKET_OUT_SELECTED_ITEM Deprecated. since 6.7, please use DefaultSelectAndFocusDelegateController.SOCKET_OUT_SELECTED_ITEM
protected static String	SOCKET_OUT_SELECTED_ITEMS Deprecated. since 6.7, please use DefaultSelectAndFocusDelegateController.SOCKET_OUT_SELECTED_ITEMS
static String	SOCKET_OUT_SORTDATA
static String	SOCKET_PREVIOUS_ITEM_SELECTOR_CONTEXT
static String	SOCKET_PREVIOUS_ITEM_SELECTOR_INVOCATION
static String	TYPE_CODE_KEY Deprecated. since 6.7, not used anymore

Fields inherited from class org.zkoss.zk.ui.util.GenericAutowireComposer

_separator, application, applicationScope, arg, componentScope, desktop, desktopScope, execution, page, pageScope, param, requestScope, self, session, sessionScope, spaceOwner, spaceScope

Fields inherited from class org.zkoss.zk.ui.util.GenericComposer

_applied

Constructor Summary

Constructors

Constructor and Description
CollectionBrowserController()

Method Summary

Modifier and Type	Method and Description
protected void	applyMoldSelectorStyle(CollectionBrowserMoldStrategy activeMold, CollectionBrowserMoldStrategy mold, String moldName, org.zkoss.zul.Div moldSelector)
boolean	areHyperlinksEnabled()
void	callExecuteOperation(Operation operation, org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event> callbackEvent, String busyMessage)
protected boolean	canHandleEvent(CockpitEvent event)
void	deselectAllItems()
void	deselectItems()
void	deselectItems(List<Object> itemsToDeselect) Removes given items from the current selection
void	focusItem(Object item)
Actions	getActionSlot()
CollectionBrowserMoldStrategy	getActiveMold()
protected BackofficeTypeUtils	getBackofficeTypeUtils()
org.zkoss.zul.Div	getBottomBar()
org.zkoss.zul.Div	getBrowserContainer()
CockpitLocaleService	getCockpitLocaleService()
protected CollectionBrowserConfigurationLoader	getCollectionBrowserConfigurationLoader()
org.zkoss.zul.Div	getContentsContainer()
DataType	getCurrentType()
String	getCurrentTypeCode()
org.zkoss.zul.Button	getDeselectAll()
org.zkoss.zul.Popup	getDeselectPopup()
ExceptionTranslationService	getExceptionTranslationService()
FieldSearchFacade	getFieldSearchFacade()
<E> E	getFocusedItem() Deprecated. since 6.7, please use SelectAndFocusDelegateController.getFocusedItem()
org.zkoss.zul.Button	getItemCount()
LabelService	getLabelService()
org.zkoss.zul.Label	getListSubtitle()
org.zkoss.zul.Label	getListTitle()
org.zkoss.zul.Hbox	getMoldSelectorContainer()
org.zkoss.zul.Label	getNumberOfItemsLabel()
ObjectValueService	getObjectValueService()
org.zkoss.zul.Paging	getPaging()
org.zkoss.zul.Div	getPagingContainerBottom()
org.zkoss.zul.Div	getPagingContainerTop()
PagingDelegateController	getPagingDelegateController()
PermissionFacade	getPermissionFacade()
SelectAndFocusDelegateController	getSelectAndFocusDelegateController()
static Object	getSelectedItem(Collection<?> selection) Deprecated. since 6.7, please use SelectAndFocusDelegateController.getSelectedItem(java.util.Collection<?>)
<E> Collection<E>	getSelectedItems() Deprecated. since 6.7, please use SelectAndFocusDelegateController.getSelectedItems()
int	getSelectedItemsCount()
org.zkoss.zul.Div	getStatusBar()
TitleDelegateController	getTitleDelegateController()
protected TypeCodeResolver	getTypeCodeResolver()
TypeFacade	getTypeFacade()
void	handleObjectCreateEvent(CockpitEvent event)
void	handleObjectDeleteEvent(CockpitEvent event)
void	handleObjectsUpdatedEvent(CockpitEvent event)
void	handleSelectionChanged(Collection<?> selectedItems)
void	handleSelectionContext(Map<String,Object> inputContext)
protected void	handleSelectionRefresh(CockpitEvent event) Deprecated. since 6.7, please use the SelectAndFocusDelegateController.handleObjectUpdated(CockpitEvent) instead
void	handleSelectionRefresh(Collection<?> updatedObjects) Deprecated. since 6.7, please use the DefaultSelectAndFocusDelegateController.handleSelectionRefresh(Collection)} instead
protected void	handleViewRefresh(CockpitEvent event)
protected boolean	hasPermissionToType()
void	initialize(org.zkoss.zk.ui.Component component) Override this method to do initialization stuff for your widget, like initialize widget settings, restore view state from viewmodel, etc.
void	initializeActionSlot()
protected void	initializeAvailableMolds()
protected void	initializeCollectionBrowserConfigurationLoader()
protected void	initializeDataType()
void	initializeDataType(String typeCode)
protected void	initializeModelSelectedObjects() Deprecated. since 6.7, please use the SelectAndFocusDelegateController.initialize() instead
void	initializeMoldSelector()
protected void	initializeObserverForModelColumnsConfig()
protected void	initializeObserverForModelPageable()
protected void	initializePagingContainer(org.zkoss.zk.ui.Component parent)
protected void	initializePagingDelegateController()
protected void	initializeSelectAndFocusDelegateController()
protected void	initializeTitle()
protected void	initializeTitleDelegateController()
protected boolean	isActiveMoldHandlingEventData(Object eventData)
protected boolean	isAssignableFrom(String superType, Collection<?> subTypeObjects)
boolean	isDataAmongSelectedItems(Object data, Collection<Object> selectedItems) Deprecated. since 6.7, please use the DefaultSelectAndFocusDelegateController.isDataAmongSelectedItems(Object, Collection)
boolean	isMultiSelectEnabled()
protected boolean	isNewTheUpdatedObject(CockpitEvent event)
boolean	isSendItemsOnSelectEnabled()
void	itemLockingChanged(CockpitEvent event)
void	loadAvailableMolds()
void	nextItemSelectorInvocation()
void	notifyHyperlinkClicked(Object value) Deprecated. since 6.7, please use SelectAndFocusDelegateController.handleHyperlinkClicked(Object)
void	notifyItemClicked(Object item) Deprecated. since 6.7, DefaultSelectAndFocusDelegateController.handleItemClicked(Object)
void	previousItemSelectorInvocation()
void	process(Pageable<?> pageable) Callback method for the input socket .
protected <E> void	process(Pageable<E> pageable, Consumer<Pageable<E>> callback)
protected void	registerMoldSelectorEvents(CollectionBrowserMoldStrategy mold, org.zkoss.zul.Div moldSelector)
void	releaseAllMolds()
void	removeActiveSclassForItemCount()
void	reset()
void	reset(Map<Object,Object> params) Resets the widget to the initial state, displaying no data.
protected void	resetModel()
protected void	resetView()
protected String	resolveTypeCodeFromCollection(Collection<?> objects) Deprecated. since 6.7, please use the TypeCodeResolver.resolveTypeCodeFromCollection(Collection, WidgetInstanceManager) instead
protected String	resolveTypeCodeFromObject(Object object) Deprecated. since 6.7, please use the TypeCodeResolver.resolveTypeCodeFromObject(Object, WidgetInstanceManager) instead
void	selectItem(Object itemToSelect) Method to select item
protected void	selectItems(Collection<?> selectedItems) Deprecated. since 6.7, please use the SelectAndFocusDelegateController.selectItems(Collection) instead
void	sendNavigationItemSelectorContext(NavigationItemSelectorContext navigationContext) Deprecated. since 6.7, please use the DefaultSelectAndFocusDelegateController.sendNavigationItemSelectorContext(NavigationItemSelectorContext) instead
void	setActiveMold(CollectionBrowserMoldStrategy activeMold)
void	setAvailableMolds(List<CollectionBrowserMoldStrategy> availableMolds) Sets the list of available mold strategies.
void	setBackofficeTypeUtils(BackofficeTypeUtils backofficeTypeUtils)
void	setBottomBar(org.zkoss.zul.Div bottomBar)
void	setCockpitLocaleService(CockpitLocaleService cockpitLocaleService)
void	setCollectionBrowserConfigurationLoader(CollectionBrowserConfigurationLoader collectionBrowserConfigurationLoader)
void	setExceptionTranslationService(ExceptionTranslationService exceptionTranslationService)
void	setFieldSearchFacade(FieldSearchFacade<?> fieldSearchFacade)
protected void	setItemFocused(Object item) Deprecated. since 6.7, please use the SelectAndFocusDelegateController.focusItem(Object) instead
void	setLabelService(LabelService labelService)
void	setList(List<Object> objects) Callback method for the socket event "list".
void	setNumberOfItemsLabel(org.zkoss.zul.Label numberOfItemsLabel)
void	setObjectValueService(ObjectValueService objectValueService)
void	setPagingContainerBottom(org.zkoss.zul.Div pagingContainerBottom)
void	setPagingContainerTop(org.zkoss.zul.Div pagingContainerTop)
void	setPagingDelegateController(PagingDelegateController pagingDelegateController)
void	setPermissionFacade(PermissionFacade permissionFacade)
void	setSelectAndFocusDelegateController(SelectAndFocusDelegateController selectAndFocusDelegateController)
void	setSelectedItems(Collection<?> selectedItems) Deprecated. since 6.7, please use the SelectAndFocusDelegateController.selectItems(Collection) instead
protected void	setSelectedItemsCount(int count)
void	setStatusBarVisible(boolean visible)
void	setTitleDelegateController(TitleDelegateController titleDelegateController)
void	setTypeCodeResolver(TypeCodeResolver typeCodeResolver)
void	setTypeFacade(TypeFacade typeFacade)
protected boolean	shouldRefreshAfterObjectCreation()
protected boolean	shouldReloadAfterUpdate(CockpitEvent event)
void	showPopup()
void	sort(SortData sortData)
protected void	updateItemCount(int count)
protected void	updateModelExportColumnsAndData()
protected void	updateMoldSelector(org.zkoss.zk.ui.Component component, CollectionBrowserMoldStrategy mold, org.zkoss.zul.Div moldSelector)

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

Methods inherited from class org.zkoss.zk.ui.util.GenericComposer

doCatch, doFinally

Methods inherited from class org.zkoss.zk.ui.event.GenericEventListener

bindComponent, getController, onEvent, unbindComponent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SOCKET_OUT_SORTDATA

public static final String SOCKET_OUT_SORTDATA

See Also:

Constant Field Values

SOCKET_IN_PAGEABLE

public static final String SOCKET_IN_PAGEABLE

See Also:

Constant Field Values

SOCKET_IN_OBJECT_LIST

public static final String SOCKET_IN_OBJECT_LIST

See Also:

Constant Field Values

SOCKET_PREVIOUS_ITEM_SELECTOR_INVOCATION

public static final String SOCKET_PREVIOUS_ITEM_SELECTOR_INVOCATION

See Also:

Constant Field Values

SOCKET_NEXT_ITEM_SELECTOR_INVOCATION

public static final String SOCKET_NEXT_ITEM_SELECTOR_INVOCATION

See Also:

Constant Field Values

SOCKET_PREVIOUS_ITEM_SELECTOR_CONTEXT

public static final String SOCKET_PREVIOUS_ITEM_SELECTOR_CONTEXT

See Also:

Constant Field Values

SOCKET_NEXT_ITEM_SELECTOR_CONTEXT

public static final String SOCKET_NEXT_ITEM_SELECTOR_CONTEXT

See Also:

Constant Field Values

SOCKET_IN_SELECT_ITEM

public static final String SOCKET_IN_SELECT_ITEM

See Also:

Constant Field Values

SOCKET_IN_DESELECT_ITEMS

public static final String SOCKET_IN_DESELECT_ITEMS

See Also:

Constant Field Values

SOCKET_IN_DESELECT_ALL_ITEMS

public static final String SOCKET_IN_DESELECT_ALL_ITEMS

See Also:

Constant Field Values

SOCKET_IN_SELECT_CONTEXT

public static final String SOCKET_IN_SELECT_CONTEXT

See Also:

Constant Field Values

SOCKET_IN_FOCUS_ITEM

public static final String SOCKET_IN_FOCUS_ITEM

See Also:

Constant Field Values

DEFAULT_COLLECTION_BROWSER_CONFIG_CTX

public static final String DEFAULT_COLLECTION_BROWSER_CONFIG_CTX

See Also:

Constant Field Values

SETTING_COLLECTION_BROWSER_CONFIG_CTX

public static final String SETTING_COLLECTION_BROWSER_CONFIG_CTX

See Also:

Constant Field Values

SETTING_REFRESH_AFTER_OBJECT_CREATION

public static final String SETTING_REFRESH_AFTER_OBJECT_CREATION

See Also:

Constant Field Values

SHOULD_RELOAD_AFTER_UPDATE

public static final String SHOULD_RELOAD_AFTER_UPDATE

See Also:

Constant Field Values

SETTING_PAGE_SIZE

public static final String SETTING_PAGE_SIZE

See Also:

Constant Field Values

SETTING_MULTI_SELECT

public static final String SETTING_MULTI_SELECT

See Also:

Constant Field Values

SETTING_PAGING_POSITION

public static final String SETTING_PAGING_POSITION

See Also:

Constant Field Values

SETTING_SEND_ITEMS_ON_SELECT

public static final String SETTING_SEND_ITEMS_ON_SELECT

See Also:

Constant Field Values

SETTING_FALLBACK_TYPE_CODE

public static final String SETTING_FALLBACK_TYPE_CODE

See Also:

Constant Field Values

CTX_PARAM_UPDATED_OBJECT_IS_NEW

public static final String CTX_PARAM_UPDATED_OBJECT_IS_NEW

See Also:

Constant Field Values

DESELECT_ALL_COMPONENT

public static final String DESELECT_ALL_COMPONENT

See Also:

Constant Field Values

COMPONENT_ITEM_COUNT

public static final String COMPONENT_ITEM_COUNT

See Also:

Constant Field Values

ITEM_COUNT_ACTIVE_SCLASS

public static final String ITEM_COUNT_ACTIVE_SCLASS

See Also:

Constant Field Values

POPUP_POSITION

public static final String POPUP_POSITION

See Also:

Constant Field Values

SCLASS_ACTIVE_MOLD_SELECTOR

public static final String SCLASS_ACTIVE_MOLD_SELECTOR

See Also:

Constant Field Values

SCLASS_INACTIVE_MOLD_SELECTOR

public static final String SCLASS_INACTIVE_MOLD_SELECTOR

See Also:

Constant Field Values

SCLASS_COLL_BROWSER_MOLD_SEL_BTN

public static final String SCLASS_COLL_BROWSER_MOLD_SEL_BTN

See Also:

Constant Field Values

SCLASS_MULTISELECT

public static final String SCLASS_MULTISELECT

See Also:

Constant Field Values

ACTION_SLOT_COMPONENT_ID

public static final String ACTION_SLOT_COMPONENT_ID

See Also:

Constant Field Values

ATTRIBUTE_MOLD_CLASS

public static final String ATTRIBUTE_MOLD_CLASS

See Also:

Constant Field Values

MODEL_SELECTED_OBJECTS

@Deprecated
public static final String MODEL_SELECTED_OBJECTS

Deprecated. since 6.7, please use DefaultSelectAndFocusDelegateController.MODEL_SELECTED_OBJECTS

See Also:

Constant Field Values

MODEL_PAGEABLE

public static final String MODEL_PAGEABLE

See Also:

Constant Field Values

MODEL_EXPORT_COLUMNS_AND_DATA

public static final String MODEL_EXPORT_COLUMNS_AND_DATA

See Also:

Constant Field Values

MODEL_ACTIVE_MOLD_NAME

public static final String MODEL_ACTIVE_MOLD_NAME

See Also:

Constant Field Values

MODEL_LAST_ACTIVE_PAGE_NUMBER

public static final String MODEL_LAST_ACTIVE_PAGE_NUMBER

See Also:

Constant Field Values

MODEL_SELECTION_CONTEXT

public static final String MODEL_SELECTION_CONTEXT

See Also:

Constant Field Values

MODEL_MULTI_SELECT_ENABLED

public static final String MODEL_MULTI_SELECT_ENABLED

See Also:

Constant Field Values

EMPTY_MOLD

public static final CollectionBrowserMoldStrategy EMPTY_MOLD

TYPE_CODE_KEY

@Deprecated
public static final String TYPE_CODE_KEY

Deprecated. since 6.7, not used anymore

See Also:

Constant Field Values

GLOBAL_EVENT_ITEM_LOCKED_STATE_CHANGED

public static final String GLOBAL_EVENT_ITEM_LOCKED_STATE_CHANGED

See Also:

Constant Field Values

MODEL_FOCUSED_OBJECT

@Deprecated
protected static final String MODEL_FOCUSED_OBJECT

Deprecated. since 6.7, please use DefaultSelectAndFocusDelegateController.MODEL_FOCUSED_OBJECT

See Also:

Constant Field Values

SOCKET_OUT_SELECTED_ITEM

@Deprecated
protected static final String SOCKET_OUT_SELECTED_ITEM

Deprecated. since 6.7, please use DefaultSelectAndFocusDelegateController.SOCKET_OUT_SELECTED_ITEM

See Also:

Constant Field Values

SOCKET_OUT_SELECTED_ITEMS

@Deprecated
protected static final String SOCKET_OUT_SELECTED_ITEMS

Deprecated. since 6.7, please use DefaultSelectAndFocusDelegateController.SOCKET_OUT_SELECTED_ITEMS

See Also:

Constant Field Values

SOCKET_OUT_FOCUSED_ITEM

@Deprecated
protected static final String SOCKET_OUT_FOCUSED_ITEM

Deprecated. since 6.7, please use DefaultSelectAndFocusDelegateController.SOCKET_OUT_FOCUSED_ITEM

See Also:

Constant Field Values

SETTING_PAGING_POSITION_BOTTOM

protected static final String SETTING_PAGING_POSITION_BOTTOM

See Also:

Constant Field Values

SETTING_PAGING_POSITION_TOP

protected static final String SETTING_PAGING_POSITION_TOP

See Also:

Constant Field Values

MODEL_DATA_TYPE

protected static final String MODEL_DATA_TYPE

See Also:

Constant Field Values

MODEL_DATA_TYPE_CODE

protected static final String MODEL_DATA_TYPE_CODE

See Also:

Constant Field Values

SETTING_HYPERLINKS_ENABLED

protected static final String SETTING_HYPERLINKS_ENABLED

See Also:

Constant Field Values

Constructor Detail

CollectionBrowserController

public CollectionBrowserController()

Method Detail

getSelectedItem

@Deprecated
public static Object getSelectedItem(Collection<?> selection)

Deprecated. 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 . 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,
                           Consumer<Pageable<E>> callback)

setList

public void setList(List<Object> objects)

Callback method for the socket event "list".

Wraps the provided objects in a PageableList and calls process(com.hybris.cockpitng.search.data.pageable.Pageable) (if the list is not empty).

Parameters:

objects - objects to be displayed

previousItemSelectorInvocation

public void previousItemSelectorInvocation()

nextItemSelectorInvocation

public void nextItemSelectorInvocation()

deselectAllItems

public void deselectAllItems()

reset

public void reset(Map<Object,Object> params)

Resets the widget to the initial state, displaying no data.

selectItem

public void selectItem(Object itemToSelect)

Method to select item

Parameters:

itemToSelect - an item to be selected

deselectItems

public void deselectItems(List<Object> itemsToDeselect)

Removes given items from the current selection

Parameters:

itemsToDeselect - objects to remove from selection

handleSelectionContext

public void handleSelectionContext(Map<String,Object> inputContext)

handleObjectDeleteEvent

public void handleObjectDeleteEvent(CockpitEvent event)

handleObjectsUpdatedEvent

public void handleObjectsUpdatedEvent(CockpitEvent event)

itemLockingChanged

public void itemLockingChanged(CockpitEvent event)

isDataAmongSelectedItems

@Deprecated
public boolean isDataAmongSelectedItems(Object data,
                                                    Collection<Object> selectedItems)

Deprecated. since 6.7, please use the DefaultSelectAndFocusDelegateController.isDataAmongSelectedItems(Object, Collection)

handleSelectionRefresh

@Deprecated
protected void handleSelectionRefresh(CockpitEvent event)

Deprecated. since 6.7, please use the SelectAndFocusDelegateController.handleObjectUpdated(CockpitEvent) instead

handleSelectionRefresh

@Deprecated
public void handleSelectionRefresh(Collection<?> updatedObjects)

Deprecated. since 6.7, please use the DefaultSelectAndFocusDelegateController.handleSelectionRefresh(Collection)} instead

handleViewRefresh

protected void handleViewRefresh(CockpitEvent event)

isAssignableFrom

protected boolean isAssignableFrom(String superType,
                                   Collection<?> subTypeObjects)

shouldRefreshAfterObjectCreation

protected boolean shouldRefreshAfterObjectCreation()

isNewTheUpdatedObject

protected boolean isNewTheUpdatedObject(CockpitEvent event)

shouldReloadAfterUpdate

protected boolean shouldReloadAfterUpdate(CockpitEvent event)

handleObjectCreateEvent

public void handleObjectCreateEvent(CockpitEvent event)

showPopup

public void showPopup()

deselectItems

public void deselectItems()

removeActiveSclassForItemCount

public void removeActiveSclassForItemCount()

initialize

public void initialize(org.zkoss.zk.ui.Component component)

Description copied from class: DefaultWidgetController

Override this method to do initialization stuff for your widget, like initialize widget settings, restore view state from viewmodel, etc. This method will be invoked by DefaultWidgetController.doAfterCompose(Component) everytime your widget view is created. See GenericForwardComposer.doAfterCompose(Component) for more details.

Overrides:

initialize in class DefaultWidgetController

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()

applyMoldSelectorStyle

protected void applyMoldSelectorStyle(CollectionBrowserMoldStrategy activeMold,
                                      CollectionBrowserMoldStrategy mold,
                                      String moldName,
                                      org.zkoss.zul.Div moldSelector)

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
protected void initializeModelSelectedObjects()

Deprecated. since 6.7, please use the SelectAndFocusDelegateController.initialize() instead

initializeTitle

protected void initializeTitle()

initializeDataType

protected void initializeDataType()

initializeDataType

public void initializeDataType(String typeCode)

initializeActionSlot

public void initializeActionSlot()

getCurrentTypeCode

public 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(Object eventData)

resolveTypeCodeFromObject

@Deprecated
protected String resolveTypeCodeFromObject(Object object)

Deprecated. since 6.7, please use the TypeCodeResolver.resolveTypeCodeFromObject(Object, WidgetInstanceManager) instead

resolveTypeCodeFromCollection

@Deprecated
protected String resolveTypeCodeFromCollection(Collection<?> objects)

Deprecated. since 6.7, please use the TypeCodeResolver.resolveTypeCodeFromCollection(Collection, WidgetInstanceManager) instead

notifyHyperlinkClicked

@Deprecated
public void notifyHyperlinkClicked(Object value)

Deprecated. since 6.7, please use SelectAndFocusDelegateController.handleHyperlinkClicked(Object)

Notifies that a hyperlink with specified value has been clicked.

If SETTING_HYPERLINKS_ENABLED is enabled the item will be sent through SOCKET_OUT_SELECTED_ITEM output socket.
It will not affect the selection.

Parameters:

value - hyperlink's value

See Also:

areHyperlinksEnabled()

notifyItemClicked

@Deprecated
public void notifyItemClicked(Object item)

Deprecated. since 6.7, DefaultSelectAndFocusDelegateController.handleItemClicked(Object)

Notifies that a specified item has been clicked.

Item will be sent through SOCKET_OUT_FOCUSED_ITEM output socket and mold will be asked to focus provided item.
If SETTING_HYPERLINKS_ENABLED is set to true, selection will not be affected. Otherwise event will be also treated as item selection.

Parameters:

item - clicked item

See Also:

CollectionBrowserMoldStrategy.focusItem(Object, Object), DefaultSelectAndFocusDelegateController.selectItems(Collection)

focusItem

public void focusItem(Object item)

setItemFocused

@Deprecated
protected void setItemFocused(Object item)

Deprecated. since 6.7, please use the SelectAndFocusDelegateController.focusItem(Object) instead

getSelectedItems

@Deprecated
public <E> Collection<E> getSelectedItems()

Deprecated. since 6.7, please use SelectAndFocusDelegateController.getSelectedItems()

Gets currently selected items.

Method returns a value provided in last call to setSelectedItems(Collection)

Type Parameters:

E - expected type of selected items

Returns:

selected items

See Also:

setSelectedItems(Collection)

setSelectedItems

@Deprecated
public void setSelectedItems(Collection<?> selectedItems)

Deprecated. 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

getFocusedItem

@Deprecated
public <E> E getFocusedItem()

Deprecated. since 6.7, please use SelectAndFocusDelegateController.getFocusedItem()

Gets an item that is currently focused.

Method returns a value provided in last call to notifyItemClicked(Object)

Type Parameters:

E - expected type of focused item

Returns:

focused item

See Also:

notifyItemClicked(Object)

selectItems

@Deprecated
protected void selectItems(Collection<?> selectedItems)

Deprecated. since 6.7, please use the SelectAndFocusDelegateController.selectItems(Collection) instead

handleSelectionChanged

public void handleSelectionChanged(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,
                                 String busyMessage)

setStatusBarVisible

public void setStatusBarVisible(boolean visible)

sendNavigationItemSelectorContext

@Deprecated
public void sendNavigationItemSelectorContext(NavigationItemSelectorContext navigationContext)

Deprecated. since 6.7, please use the DefaultSelectAndFocusDelegateController.sendNavigationItemSelectorContext(NavigationItemSelectorContext) instead

getActiveMold

public CollectionBrowserMoldStrategy getActiveMold()

setActiveMold

public void setActiveMold(CollectionBrowserMoldStrategy activeMold)

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)

setAvailableMolds

public void setAvailableMolds(List<CollectionBrowserMoldStrategy> availableMolds)

Sets the list of available mold strategies. If the list is not set before call to initialize(org.zkoss.zk.ui.Component) method, controller tries to load all Spring beans implementing CollectionBrowserMoldStrategy interface

Parameters:

availableMolds - list of available mold strategies

getCollectionBrowserConfigurationLoader

protected CollectionBrowserConfigurationLoader getCollectionBrowserConfigurationLoader()

setCollectionBrowserConfigurationLoader

public void setCollectionBrowserConfigurationLoader(CollectionBrowserConfigurationLoader collectionBrowserConfigurationLoader)

getPagingDelegateController

public PagingDelegateController getPagingDelegateController()

setPagingDelegateController

public void setPagingDelegateController(PagingDelegateController pagingDelegateController)

getTitleDelegateController

public TitleDelegateController getTitleDelegateController()

setTitleDelegateController

public void setTitleDelegateController(TitleDelegateController titleDelegateController)

getSelectAndFocusDelegateController

public SelectAndFocusDelegateController getSelectAndFocusDelegateController()

setSelectAndFocusDelegateController

public void setSelectAndFocusDelegateController(SelectAndFocusDelegateController selectAndFocusDelegateController)

getBackofficeTypeUtils

protected BackofficeTypeUtils getBackofficeTypeUtils()

setBackofficeTypeUtils

public void setBackofficeTypeUtils(BackofficeTypeUtils backofficeTypeUtils)

getLabelService

public LabelService getLabelService()

setLabelService

public void setLabelService(LabelService labelService)

getTypeFacade

public TypeFacade getTypeFacade()

setTypeFacade

public void setTypeFacade(TypeFacade typeFacade)

getObjectValueService

public ObjectValueService getObjectValueService()

setObjectValueService

public void setObjectValueService(ObjectValueService objectValueService)

getCockpitLocaleService

public CockpitLocaleService getCockpitLocaleService()

setCockpitLocaleService

public void setCockpitLocaleService(CockpitLocaleService cockpitLocaleService)

getPermissionFacade

public PermissionFacade getPermissionFacade()

setPermissionFacade

public void setPermissionFacade(PermissionFacade permissionFacade)

getExceptionTranslationService

public ExceptionTranslationService getExceptionTranslationService()

setExceptionTranslationService

public void setExceptionTranslationService(ExceptionTranslationService exceptionTranslationService)

getFieldSearchFacade

public FieldSearchFacade getFieldSearchFacade()

setFieldSearchFacade

public void setFieldSearchFacade(FieldSearchFacade<?> fieldSearchFacade)

getTypeCodeResolver

protected TypeCodeResolver getTypeCodeResolver()

setTypeCodeResolver

public void setTypeCodeResolver(TypeCodeResolver typeCodeResolver)