com.hybris.backoffice.widgets.collectionpreview

Class CollectionPreviewController

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.collectionpreview.CollectionPreviewController

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 CollectionPreviewController
extends DefaultWidgetController

Controller of the collection preview widget - responsible for rendering a preview for each item from a passed Pageable pageable

. In order to setPage a comprehensive item representation controller relies on Base configuration where one can specified its name, description and a graphical representation.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	COMP_ID_ITEMLIST
protected static String	ENTRY_DESCR
protected static String	ENTRY_IMG_FALLBACK
protected static String	ENTRY_IMG_URL
protected static String	ENTRY_NAME
protected static String	MODEL_ITEM_SELECTED_INDEX
protected static String	MODEL_PAGEABLE
protected static String	MODEL_PAGEABLE_LIST
static String	SOCKET_IN_PAGEABLE
static String	SOCKET_SELECTED_ITEM
static String	WIDGET_SETTING_ASYNC
static String	WIDGET_SETTING_CONFIG_CONTEXT
protected static String	YW_COLLECTION_PREVIEW_EMPTY_LIST

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

Method Summary

Modifier and Type	Method and Description
protected <T> List<T>	convertAllPagesIntoSingleList(Pageable<T> pageable)
protected org.zkoss.zk.ui.Component	createEntry(Object entry, Base config)
protected Pageable	createPageableInstance(List<?> allResults, int pageSize, String typeCode) Creates new instance of Pageable
CockpitComponentDefinitionService	getComponentDefinitionService()
protected int	getIndexToSelectAfterRemoval(int currentIndex, int removedIndex) Returns new index of item to select based on currently selected and removed items or -1 if currently selected item has been removed
org.zkoss.zul.Listbox	getItemList()
LabelService	getLabelService()
ObjectPreviewService	getObjectPreviewService()
protected Pageable<?>	getPageableCopyWithResultList(List<?> allResults)
protected Map<String,Object>	getRendererProps(Object entry, Base baseConfig) Returns a map with all the key/value pairs which should be passed to the zul template used for rendering.
TypeFacade	getTypeFacade()
protected Widget	getWidget(Widgetslot widgetslot)
protected String	getWidgetResourcePath()
void	handleObjectDeletedEvent(CockpitEvent event)
void	handleObjectUpdatedEvent(CockpitEvent event)
void	initialize(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 Base	loadConfiguration(String typeCode) Loads the UI configuration for component with code "configContext" and for the specified type, typeCode.
protected void	render(Pageable<?> pageable, List<?> genericObjectList) Renders the provided entries as a list - each item is represented by base configuration where one can configure name, description and an image representation.
void	selectEntry(org.zkoss.zk.ui.event.SelectEvent<org.zkoss.zk.ui.Component,?> event) Call back method for select events.
protected void	selectItem(Integer position)
void	setPageable(Pageable<?> pageable) Called whenever a socket event is sent to the "pageable" socket.
protected void	setPageable(Pageable<?> pageable, boolean synch) Renders the entries in the pageable object (if any) Thread-safety is provided
protected void	setResultList(List<?> allResults, Integer indexToSelect) Changes current MODEL_PAGEABLE to its copy with passed as an argument collection of available elements and selects an element with provided index
protected void	setResultList(List<?> allResults, Integer indexToSelect, boolean synch) Changes current MODEL_PAGEABLE to its copy with passed as an argument collection of available elements and selects an element with provided index
void	setSelectedItem(Object itemToSelect)
protected void	updatePreviewCollection(CockpitEvent event)
protected void	updatePreviewCollection(Pageable pageable, CockpitEvent event, Object updatedObject)

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_IN_PAGEABLE

public static final String SOCKET_IN_PAGEABLE

See Also:

Constant Field Values

SOCKET_SELECTED_ITEM

public static final String SOCKET_SELECTED_ITEM

See Also:

Constant Field Values

WIDGET_SETTING_CONFIG_CONTEXT

public static final String WIDGET_SETTING_CONFIG_CONTEXT

See Also:

Constant Field Values

WIDGET_SETTING_ASYNC

public static final String WIDGET_SETTING_ASYNC

See Also:

Constant Field Values

ENTRY_NAME

protected static final String ENTRY_NAME

See Also:

Constant Field Values

ENTRY_DESCR

protected static final String ENTRY_DESCR

See Also:

Constant Field Values

ENTRY_IMG_URL

protected static final String ENTRY_IMG_URL

See Also:

Constant Field Values

ENTRY_IMG_FALLBACK

protected static final String ENTRY_IMG_FALLBACK

See Also:

Constant Field Values

YW_COLLECTION_PREVIEW_EMPTY_LIST

protected static final String YW_COLLECTION_PREVIEW_EMPTY_LIST

See Also:

Constant Field Values

COMP_ID_ITEMLIST

protected static final String COMP_ID_ITEMLIST

See Also:

Constant Field Values

MODEL_PAGEABLE

protected static final String MODEL_PAGEABLE

See Also:

Constant Field Values

MODEL_PAGEABLE_LIST

protected static final String MODEL_PAGEABLE_LIST

See Also:

Constant Field Values

MODEL_ITEM_SELECTED_INDEX

protected static final String MODEL_ITEM_SELECTED_INDEX

See Also:

Constant Field Values

Constructor Detail

CollectionPreviewController

public CollectionPreviewController()

Method Detail

initialize

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

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

setPageable

public void setPageable(Pageable<?> pageable)

Called whenever a socket event is sent to the "pageable" socket. Renders the entries in the pageable object (if any)

Thread-safety is provided

Parameters:

pageable - the pageable object to setPage

setPageable

protected void setPageable(Pageable<?> pageable,
                           boolean synch)

Renders the entries in the pageable object (if any)

Thread-safety is provided

Parameters:

pageable - the pageable object to setPage

synch - when true renders entries synchronously

selectEntry

public void selectEntry(org.zkoss.zk.ui.event.SelectEvent<org.zkoss.zk.ui.Component,?> event)

Call back method for select events. Resolves the selected object and sends it out on the outgoing socket called "selectedItem".

Parameters:

event - the select event

setSelectedItem

public void setSelectedItem(Object itemToSelect)

render

protected void render(Pageable<?> pageable,
                      List<?> genericObjectList)

Renders the provided entries as a list - each item is represented by base configuration where one can configure name, description and an image representation.

Parameters:

pageable - used to resolve the relevant type code (if any) and other paging information

genericObjectList - the objects to be rendered

handleObjectUpdatedEvent

public void handleObjectUpdatedEvent(CockpitEvent event)

handleObjectDeletedEvent

public void handleObjectDeletedEvent(CockpitEvent event)

updatePreviewCollection

protected void updatePreviewCollection(CockpitEvent event)

updatePreviewCollection

protected void updatePreviewCollection(Pageable pageable,
                                       CockpitEvent event,
                                       Object updatedObject)

getIndexToSelectAfterRemoval

protected int getIndexToSelectAfterRemoval(int currentIndex,
                                           int removedIndex)

Returns new index of item to select based on currently selected and removed items or -1 if currently selected item has been removed

Parameters:

currentIndex - index of currently selected item

removedIndex - index of removed item

Returns:

new index of item to select

setResultList

protected void setResultList(List<?> allResults,
                             Integer indexToSelect)

Changes current MODEL_PAGEABLE to its copy with passed as an argument collection of available elements and selects an element with provided index

Parameters:

allResults - collection of available elements to be set on the MODEL_PAGEABLE.

indexToSelect - index of an element to be selected

setResultList

protected void setResultList(List<?> allResults,
                             Integer indexToSelect,
                             boolean synch)

Changes current MODEL_PAGEABLE to its copy with passed as an argument collection of available elements and selects an element with provided index

Parameters:

allResults - collection of available elements to be set on the MODEL_PAGEABLE.

indexToSelect - index of an element to be selected

synch - when true renders entries synchronously

getPageableCopyWithResultList

protected Pageable<?> getPageableCopyWithResultList(List<?> allResults)

createPageableInstance

protected Pageable createPageableInstance(List<?> allResults,
                                          int pageSize,
                                          String typeCode)

Creates new instance of Pageable

Parameters:

allResults - collection of all elements available in the preview. The collection is exposed through Pageable.getAllResults()

pageSize -

typeCode -

Returns:

new instance of Pageable with provided parameters

getWidgetResourcePath

protected String getWidgetResourcePath()

getWidget

protected Widget getWidget(Widgetslot widgetslot)

createEntry

protected org.zkoss.zk.ui.Component createEntry(Object entry,
                                                Base config)

loadConfiguration

protected Base loadConfiguration(String typeCode)

Loads the UI configuration for component with code "configContext" and for the specified type, typeCode.

Parameters:

typeCode - the type code for which the configuration should be loaded

Returns:

the configuration object if found, null otherwise

getRendererProps

protected Map<String,Object> getRendererProps(Object entry,
                                              Base baseConfig)

Returns a map with all the key/value pairs which should be passed to the zul template used for rendering.

Parameters:

entry - the object to be rendered

baseConfig - the UI configuration to be used when rendering

Returns:

map with renderer properties, which are accessible in the zul template (using ${args.<KEY_NAME>} )

selectItem

protected void selectItem(Integer position)

convertAllPagesIntoSingleList

protected <T> List<T> convertAllPagesIntoSingleList(Pageable<T> pageable)

getLabelService

public LabelService getLabelService()

getTypeFacade

public TypeFacade getTypeFacade()

getComponentDefinitionService

public CockpitComponentDefinitionService getComponentDefinitionService()

getItemList

public org.zkoss.zul.Listbox getItemList()

getObjectPreviewService

public ObjectPreviewService getObjectPreviewService()