Package com.hybris.cockpitng.widgets.collectionbrowser.mold.impl.common

Class AbstractMoldStrategy<I extends org.zkoss.zk.ui.Component,C,D>

java.lang.Object

com.hybris.cockpitng.widgets.collectionbrowser.mold.impl.common.AbstractMoldStrategy<I,C,D>

All Implemented Interfaces:

CollectionBrowserMoldStrategy, org.springframework.core.Ordered

Direct Known Subclasses:

GridViewCollectionBrowserMoldStrategy, ListViewCollectionBrowserMoldStrategy, TreeViewCollectionBrowserMoldStrategy

public abstract class AbstractMoldStrategy<I extends org.zkoss.zk.ui.Component,C,D>
extends java.lang.Object
implements CollectionBrowserMoldStrategy

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ATTRIBUTE_HYPERLINK_CANDIDATE
static NavigationItemSelectorContext	EMPTY_NAVIGATION_ITEM_SELECTOR_CONTEXT
static int	EMPTY_PAGE_SIZE
static java.lang.String	KEY_LABEL_EMPTY_LIST
static java.lang.String	MODEL_COLUMNS_CONFIG
static int	NO_SELECTION_INDEX
protected static java.lang.String	SCLASS_CELL_FOCUSED
protected static java.lang.String	SCLASS_CELL_HYPERLINK

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
AbstractMoldStrategy()

Method Summary

Modifier and Type	Method	Description
protected void	addLink(org.zkoss.zk.ui.HtmlBasedComponent component, com.google.common.base.Supplier<java.lang.Object> value)
protected boolean	canHandle(CockpitEvent event)
protected java.lang.String	chooseEmptyMessageToDisplayFor(SinglePage singlePage)
BackofficeTypeUtils	getBackofficeTypeUtils()
protected CollectionBrowserMoldContext	getContext()
protected java.util.Optional<java.lang.Object>	getFocusedObjectFromModel()
HyperlinkFallbackLabelProvider	getHyperlinkFallbackLabelProvider()
protected int	getIndexOf(java.lang.Object element)
LabelService	getLabelService()
protected NotificationService	getNotificationService()
int	getOrder()
protected PermissionFacade	getPermissionFacade()
WidgetComponentRenderer<I,C,D>	getRenderer()	Returns the list view renderer based on the value of the "itemRenderer" widget setting.
protected java.lang.String	getRendererSetting()
java.lang.String	getTypeCode()
protected java.util.Optional<java.lang.Object>	getUiElementAt(int index)
protected int	getUiModelSize()
protected WidgetModel	getWidgetModel()
protected void	handleChangeFocus(java.lang.Object itemToFocus)
protected abstract void	handleCollectionUpdate(java.util.Collection<java.lang.Object> eventDataAsCollection)
void	handleObjectsUpdateEvent(CockpitEvent event)	Additional logic to perform on objects updated event.
void	handleObjectUpdateEvent(CockpitEvent event)	Additional logic to perform on object updated event.
protected void	initializeRenderer(NotifyingWidgetComponentRenderer<I,C,D> renderer)
protected void	initializeRenderer(WidgetComponentRenderer<I,C,D> renderer)	Deprecated, for removal: This API element is subject to removal in a future version. since 6.5
boolean	isHandlingObjectEvents(java.lang.String typeCode)	Check if we can handle object events for a given type code.
protected boolean	isLink(org.zkoss.zk.ui.Component component)
void	nextItemSelectorInvocation()	Handle "next item" navigation event.
void	previousItemSelectorInvocation()	Handle "previous item" navigation event.
void	setBackofficeTypeUtils(BackofficeTypeUtils backofficeTypeUtils)
void	setContext(CollectionBrowserMoldContext context)	Sets a communication channel with widget controller.
void	setHyperlinkFallbackLabelProvider(HyperlinkFallbackLabelProvider hyperlinkFallbackLabelProvider)
void	setLabelService(LabelService labelService)
void	setMoldRendererFactory(NotifyingWidgetComponentRendererFactory<I,C,D> rendererFactory)
void	setNotificationService(NotificationService notificationService)
void	setOrder(int order)	Set the order value for this bean.
void	setPage(SinglePage singlePage)	Set data for a single page.
void	setPermissionFacade(PermissionFacade permissionFacade)
void	setRenderer(WidgetComponentRenderer<I,C,D> renderer)	Deprecated, for removal: This API element is subject to removal in a future version. since 6.5
void	setRendererFactory(WidgetComponentRendererFactory<I,C,D> rendererFactory)	Deprecated, for removal: This API element is subject to removal in a future version. since 6.5
void	setTypeCode(java.lang.String typeCode)	Set type code for the current mold strategy.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.hybris.cockpitng.widgets.collectionbrowser.mold.CollectionBrowserMoldStrategy

deselectItems, focusItem, getName, getNavigationItemSelectorContext, getTooltipText, handleObjectCreateEvent, handleObjectDeleteEvent, release, render, reset, selectItems

Field Detail

EMPTY_PAGE_SIZE

public static final int EMPTY_PAGE_SIZE

See Also:

Constant Field Values

NO_SELECTION_INDEX

public static final int NO_SELECTION_INDEX

See Also:

Constant Field Values

ATTRIBUTE_HYPERLINK_CANDIDATE

public static final java.lang.String ATTRIBUTE_HYPERLINK_CANDIDATE

See Also:

Constant Field Values

MODEL_COLUMNS_CONFIG

public static final java.lang.String MODEL_COLUMNS_CONFIG

See Also:

Constant Field Values

KEY_LABEL_EMPTY_LIST

public static final java.lang.String KEY_LABEL_EMPTY_LIST

See Also:

Constant Field Values

EMPTY_NAVIGATION_ITEM_SELECTOR_CONTEXT

public static final NavigationItemSelectorContext EMPTY_NAVIGATION_ITEM_SELECTOR_CONTEXT

SCLASS_CELL_HYPERLINK

protected static final java.lang.String SCLASS_CELL_HYPERLINK

See Also:

Constant Field Values

SCLASS_CELL_FOCUSED

protected static final java.lang.String SCLASS_CELL_FOCUSED

See Also:

Constant Field Values

Constructor Detail

AbstractMoldStrategy

public AbstractMoldStrategy()

Method Detail

handleObjectUpdateEvent

public void handleObjectUpdateEvent(CockpitEvent event)

Description copied from interface: CollectionBrowserMoldStrategy

Additional logic to perform on object updated event.

Specified by:

handleObjectUpdateEvent in interface CollectionBrowserMoldStrategy

handleObjectsUpdateEvent

public void handleObjectsUpdateEvent(CockpitEvent event)

Description copied from interface: CollectionBrowserMoldStrategy

Additional logic to perform on objects updated event.

Specified by:

handleObjectsUpdateEvent in interface CollectionBrowserMoldStrategy

handleCollectionUpdate

protected abstract void handleCollectionUpdate(java.util.Collection<java.lang.Object> eventDataAsCollection)

canHandle

protected boolean canHandle(CockpitEvent event)

getRendererSetting

protected java.lang.String getRendererSetting()

initializeRenderer

@Deprecated(since="6.5",
            forRemoval=true)
protected void initializeRenderer(WidgetComponentRenderer<I,C,D> renderer)

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.5

See Also:

initializeRenderer(NotifyingWidgetComponentRenderer)

initializeRenderer

protected void initializeRenderer(NotifyingWidgetComponentRenderer<I,C,D> renderer)

getRenderer

public WidgetComponentRenderer<I,C,D> getRenderer()

Returns the list view renderer based on the value of the "itemRenderer" widget setting.

If the setting value contains one or more '.' this method will assume that it's a class and try instantiate the renderer accordingly. If there are no '.' it will assume that it's a Spring bean ID.

Returns:

list view renderer

setRenderer

@Deprecated(since="6.5",
            forRemoval=true)
public void setRenderer(WidgetComponentRenderer<I,C,D> renderer)

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.5

Sets the list view renderer used for rendering rows.

Parameters:

renderer - list view renderer

See Also:

setMoldRendererFactory(NotifyingWidgetComponentRendererFactory)

addLink

protected void addLink(org.zkoss.zk.ui.HtmlBasedComponent component,
                       com.google.common.base.Supplier<java.lang.Object> value)

isLink

protected boolean isLink(org.zkoss.zk.ui.Component component)

previousItemSelectorInvocation

public void previousItemSelectorInvocation()

Description copied from interface: CollectionBrowserMoldStrategy

Handle "previous item" navigation event.

Specified by:

previousItemSelectorInvocation in interface CollectionBrowserMoldStrategy

nextItemSelectorInvocation

public void nextItemSelectorInvocation()

Description copied from interface: CollectionBrowserMoldStrategy

Handle "next item" navigation event.

Specified by:

nextItemSelectorInvocation in interface CollectionBrowserMoldStrategy

getIndexOf

protected int getIndexOf(java.lang.Object element)

Parameters:

element - to lookup in the UI model

Returns:

the index of the element or -1 if not found

setPage

public void setPage(SinglePage singlePage)

Description copied from interface: CollectionBrowserMoldStrategy

Set data for a single page.

Specified by:

setPage in interface CollectionBrowserMoldStrategy

chooseEmptyMessageToDisplayFor

protected java.lang.String chooseEmptyMessageToDisplayFor(SinglePage singlePage)

getUiModelSize

protected int getUiModelSize()

getUiElementAt

protected java.util.Optional<java.lang.Object> getUiElementAt(int index)

handleChangeFocus

protected void handleChangeFocus(java.lang.Object itemToFocus)

getContext

protected CollectionBrowserMoldContext getContext()

setContext

public void setContext(CollectionBrowserMoldContext context)

Description copied from interface: CollectionBrowserMoldStrategy

Sets a communication channel with widget controller.

Specified by:

setContext in interface CollectionBrowserMoldStrategy

Parameters:

context - communication channel with widget controller.

getTypeCode

public java.lang.String getTypeCode()

Specified by:

getTypeCode in interface CollectionBrowserMoldStrategy

Returns:

type code for the current mold strategy.

setTypeCode

public void setTypeCode(java.lang.String typeCode)

Description copied from interface: CollectionBrowserMoldStrategy

Set type code for the current mold strategy.

Specified by:

setTypeCode in interface CollectionBrowserMoldStrategy

isHandlingObjectEvents

public boolean isHandlingObjectEvents(java.lang.String typeCode)

Description copied from interface: CollectionBrowserMoldStrategy

Check if we can handle object events for a given type code.

Specified by:

isHandlingObjectEvents in interface CollectionBrowserMoldStrategy

Parameters:

typeCode - type code.

Returns:

true if mold is interested in handling object events for objects of given type, otherwise false.

getLabelService

public LabelService getLabelService()

setLabelService

public void setLabelService(LabelService labelService)

getFocusedObjectFromModel

protected java.util.Optional<java.lang.Object> getFocusedObjectFromModel()

getWidgetModel

protected WidgetModel getWidgetModel()

getOrder

public int getOrder()

Specified by:

getOrder in interface org.springframework.core.Ordered

setOrder

public void setOrder(int order)

Description copied from interface: CollectionBrowserMoldStrategy

Set the order value for this bean. The higher the order, the farther it will appear in mold selector.

Specified by:

setOrder in interface CollectionBrowserMoldStrategy

getBackofficeTypeUtils

public BackofficeTypeUtils getBackofficeTypeUtils()

setBackofficeTypeUtils

public void setBackofficeTypeUtils(BackofficeTypeUtils backofficeTypeUtils)

setMoldRendererFactory

public void setMoldRendererFactory(NotifyingWidgetComponentRendererFactory<I,C,D> rendererFactory)

setRendererFactory

@Deprecated(since="6.5",
            forRemoval=true)
public void setRendererFactory(WidgetComponentRendererFactory<I,C,D> rendererFactory)

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.5

See Also:

setMoldRendererFactory(NotifyingWidgetComponentRendererFactory)

getNotificationService

protected NotificationService getNotificationService()

setNotificationService

public void setNotificationService(NotificationService notificationService)

getHyperlinkFallbackLabelProvider

public HyperlinkFallbackLabelProvider getHyperlinkFallbackLabelProvider()

setHyperlinkFallbackLabelProvider

public void setHyperlinkFallbackLabelProvider(HyperlinkFallbackLabelProvider hyperlinkFallbackLabelProvider)

getPermissionFacade

protected PermissionFacade getPermissionFacade()

setPermissionFacade

public void setPermissionFacade(PermissionFacade permissionFacade)