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

Class TreeViewCollectionBrowserMoldStrategy

java.lang.Object

com.hybris.cockpitng.widgets.collectionbrowser.mold.impl.common.AbstractMoldStrategy<org.zkoss.zul.Treeitem,java.lang.Void,TreeViewCollectionBrowserNode>

com.hybris.cockpitng.widgets.collectionbrowser.mold.impl.treeview.TreeViewCollectionBrowserMoldStrategy

All Implemented Interfaces:

CollectionBrowserMoldStrategy, org.springframework.core.Ordered

public class TreeViewCollectionBrowserMoldStrategy
extends AbstractMoldStrategy<org.zkoss.zul.Treeitem,java.lang.Void,TreeViewCollectionBrowserNode>

Tree view mold strategy for Collection Browser widget

Renders data in tree form with paging by creating children nodes from references
Uses zk Tree component

Field Summary

Fields

Modifier and Type	Field	Description
protected static java.lang.String	COMPONENT_ATTRIBUTE_DATA
static java.lang.String	MODEL_OPEN_PATHS
static java.lang.String	MODEL_TREE
protected ObjectValueService	objectValueService
protected org.zkoss.zk.ui.Component	parent
protected WidgetComponentRenderer<org.zkoss.zul.Treeitem,java.lang.Void,TreeViewCollectionBrowserNode>	renderer
static java.lang.String	SCLASS_TREE_TABLE
static java.lang.String	SCLASS_TREE_TABLE_EMPTY
static java.lang.String	TOOLTIP_PROPERTY_KEY
protected org.zkoss.zul.Tree	tree
protected TypeFacade	typeFacade

Fields inherited from class com.hybris.cockpitng.widgets.collectionbrowser.mold.impl.common.AbstractMoldStrategy

ATTRIBUTE_HYPERLINK_CANDIDATE, EMPTY_NAVIGATION_ITEM_SELECTOR_CONTEXT, EMPTY_PAGE_SIZE, KEY_LABEL_EMPTY_LIST, MODEL_COLUMNS_CONFIG, NO_SELECTION_INDEX, SCLASS_CELL_FOCUSED, SCLASS_CELL_HYPERLINK

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
TreeViewCollectionBrowserMoldStrategy()

Method Summary

Modifier and Type	Method	Description
protected void	addLink(org.zkoss.zk.ui.HtmlBasedComponent component, TreeViewCollectionBrowserNode node)
protected WidgetComponentRendererListener<org.zkoss.zul.Treeitem,java.lang.Void,TreeViewCollectionBrowserNode>	createLinkRenderedListener()
protected WidgetComponentRendererListener<org.zkoss.zul.Treeitem,java.lang.Void,TreeViewCollectionBrowserNode>	createNodeRenderedListener()
protected java.util.List<TreeViewCollectionBrowserNode>	createNodesFromData(java.util.List<java.lang.Object> data)
protected java.util.List<TreeViewCollectionBrowserNode>	createNodeWithLabel(java.lang.String label)
protected java.util.List<TreeViewCollectionBrowserNode>	createNoEntriesNode()	Deprecated, for removal: This API element is subject to removal in a future version. since 2005
protected TreeViewCollectionBrowserTreeModel<? extends TreeViewCollectionBrowserNode>	createTreeModel(java.util.List<java.lang.Object> currentPage)	Deprecated, for removal: This API element is subject to removal in a future version. since 2005
protected TreeViewCollectionBrowserTreeModel<? extends TreeViewCollectionBrowserNode>	createTreeModel(java.util.List<java.lang.Object> currentPage, SinglePage singlePage)
void	deselectItems()	Deselects all items.
void	focusItem(java.lang.Object oldFocus, java.lang.Object newFocus)	Mark provided item as focused.
protected org.zkoss.zk.ui.Component	getComponent(java.lang.Object item)
protected java.lang.Object	getEditableItemFromSelectedItem(java.lang.Object selectedItem)
protected org.zkoss.zul.Treeitem	getItem(org.zkoss.zul.Treechildren treechildren, java.util.Collection<TreeViewCollectionBrowserNode> nodes, int[] modelPath)
protected java.lang.Object	getModel()
java.lang.String	getName()
NavigationItemSelectorContext	getNavigationItemSelectorContext()
protected ObjectValueService	getObjectValueService()
int	getOrder()
protected org.zkoss.zk.ui.Component	getParent()
protected java.lang.String	getRendererSetting()
java.lang.String	getTooltipText()
java.lang.String	getTypeCode()
protected TypeFacade	getTypeFacade()
protected WidgetModel	getWidgetModel()
protected void	handleCollectionUpdate(java.util.Collection<java.lang.Object> collection)
void	handleObjectCreateEvent(CockpitEvent event)	Additional logic to perform on object create event.
void	handleObjectDeleteEvent(CockpitEvent event)	Additional logic to perform on object deleted event.
protected void	initialize()
protected void	initializeRenderer(NotifyingWidgetComponentRenderer<org.zkoss.zul.Treeitem,java.lang.Void,TreeViewCollectionBrowserNode> renderer)
boolean	isHandlingObjectEvents(java.lang.String typeCode)	Check if we can handle object events for a given type code.
protected boolean	isItemAtomic(java.lang.Object item)
protected boolean	isNodeClickable(org.zkoss.zk.ui.Component nodeComponent, AbstractTreeViewNode node)
void	nextItemSelectorInvocation()	Handle "next item" navigation event.
protected void	onSelectEvent(org.zkoss.zk.ui.event.Event event)	Callback method for Tree Events.ON_SELECT event.
protected void	onTreeitemClickEvent(org.zkoss.zk.ui.event.Event event)	Callback method for Treeitem Events.ON_CLICK event.
protected void	onTreeitemOnOpenEvent(org.zkoss.zk.ui.event.Event openEvent)
void	previousItemSelectorInvocation()	Handle "previous item" navigation event.
void	release()	Method called by the controller when mold is turned off.
void	render(org.zkoss.zk.ui.Component parent, SinglePage singlePage)	Render mold inside given parent component with single page.
void	reset()	Resets the mold to the initial state, displaying no data.
protected void	resetModel()
protected void	resetView()
protected DataType	resolveDataType(java.lang.Object object)
protected void	restoreOpenNodes()
protected void	restoreSelection()
void	selectItems(java.util.Set<?> items)	Select given items.
protected void	setItemFocused(org.zkoss.zk.ui.Component item, boolean focused)
void	setObjectValueService(ObjectValueService objectValueService)
void	setOrder(int order)	Set the order value for this bean.
void	setPage(SinglePage singlePage)	Set data for a single page.
protected void	setTreeRenderer()
protected void	setTreeStyle(java.util.List<?> currentPage)
void	setTypeCode(java.lang.String typeCode)	Set type code for the current mold strategy.
void	setTypeFacade(TypeFacade typeFacade)
protected void	updateAllCachedNodesData(java.util.List<TreeViewCollectionBrowserNode> topLevelNodes, java.lang.Object data)
protected void	updateModelData(TreeViewCollectionBrowserTreeModel<TreeViewCollectionBrowserNode> treeModel, java.lang.Object data)
protected void	updateNodesData(java.util.List<TreeViewCollectionBrowserNode> nodes, java.lang.Object data)

Methods inherited from class com.hybris.cockpitng.widgets.collectionbrowser.mold.impl.common.AbstractMoldStrategy

addLink, canHandle, chooseEmptyMessageToDisplayFor, getBackofficeTypeUtils, getContext, getFocusedObjectFromModel, getHyperlinkFallbackLabelProvider, getIndexOf, getLabelService, getNotificationService, getPermissionFacade, getRenderer, getUiElementAt, getUiModelSize, handleChangeFocus, handleObjectsUpdateEvent, handleObjectUpdateEvent, initializeRenderer, isLink, setBackofficeTypeUtils, setContext, setHyperlinkFallbackLabelProvider, setLabelService, setMoldRendererFactory, setNotificationService, setPermissionFacade, setRenderer, setRendererFactory

Methods inherited from class java.lang.Object

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

Field Detail

MODEL_TREE

public static final java.lang.String MODEL_TREE

See Also:

Constant Field Values

TOOLTIP_PROPERTY_KEY

public static final java.lang.String TOOLTIP_PROPERTY_KEY

See Also:

Constant Field Values

SCLASS_TREE_TABLE

public static final java.lang.String SCLASS_TREE_TABLE

See Also:

Constant Field Values

SCLASS_TREE_TABLE_EMPTY

public static final java.lang.String SCLASS_TREE_TABLE_EMPTY

See Also:

Constant Field Values

COMPONENT_ATTRIBUTE_DATA

protected static final java.lang.String COMPONENT_ATTRIBUTE_DATA

See Also:

Constant Field Values

MODEL_OPEN_PATHS

public static final java.lang.String MODEL_OPEN_PATHS

See Also:

Constant Field Values

renderer

protected WidgetComponentRenderer<org.zkoss.zul.Treeitem,java.lang.Void,TreeViewCollectionBrowserNode> renderer

parent

protected org.zkoss.zk.ui.Component parent

typeFacade

protected TypeFacade typeFacade

objectValueService

protected ObjectValueService objectValueService

tree

protected org.zkoss.zul.Tree tree

Constructor Detail

TreeViewCollectionBrowserMoldStrategy

public TreeViewCollectionBrowserMoldStrategy()

Method Detail

render

public void render(org.zkoss.zk.ui.Component parent,
                   SinglePage singlePage)

Description copied from interface: CollectionBrowserMoldStrategy

Render mold inside given parent component with single page.

getParent

protected org.zkoss.zk.ui.Component getParent()

reset

public void reset()

Description copied from interface: CollectionBrowserMoldStrategy

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

resetModel

protected void resetModel()

resetView

protected void resetView()

initialize

protected void initialize()

onSelectEvent

protected void onSelectEvent(org.zkoss.zk.ui.event.Event event)

Callback method for Tree Events.ON_SELECT event.

Parameters:

event - SelectEvent

release

public void release()

Description copied from interface: CollectionBrowserMoldStrategy

Method called by the controller when mold is turned off. It should remove itself from its parent and free resources.

setPage

public void setPage(SinglePage singlePage)

Description copied from interface: CollectionBrowserMoldStrategy

Set data for a single page.

Specified by:

setPage in interface CollectionBrowserMoldStrategy

Overrides:

setPage in class AbstractMoldStrategy<org.zkoss.zul.Treeitem,java.lang.Void,TreeViewCollectionBrowserNode>

restoreSelection

protected void restoreSelection()

restoreOpenNodes

protected void restoreOpenNodes()

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

Overrides:

isHandlingObjectEvents in class AbstractMoldStrategy<org.zkoss.zul.Treeitem,java.lang.Void,TreeViewCollectionBrowserNode>

Parameters:

typeCode - type code.

Returns:

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

handleCollectionUpdate

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

Specified by:

handleCollectionUpdate in class AbstractMoldStrategy<org.zkoss.zul.Treeitem,java.lang.Void,TreeViewCollectionBrowserNode>

updateModelData

protected void updateModelData(TreeViewCollectionBrowserTreeModel<TreeViewCollectionBrowserNode> treeModel,
                               java.lang.Object data)

updateAllCachedNodesData

protected void updateAllCachedNodesData(java.util.List<TreeViewCollectionBrowserNode> topLevelNodes,
                                        java.lang.Object data)

updateNodesData

protected void updateNodesData(java.util.List<TreeViewCollectionBrowserNode> nodes,
                               java.lang.Object data)

selectItems

public void selectItems(java.util.Set<?> items)

Description copied from interface: CollectionBrowserMoldStrategy

Select given items.

No notifications should be sent.

Parameters:

items - items to be selected.

deselectItems

public void deselectItems()

Description copied from interface: CollectionBrowserMoldStrategy

Deselects all items.

No notifications should be sent.

focusItem

public void focusItem(java.lang.Object oldFocus,
                      java.lang.Object newFocus)

Description copied from interface: CollectionBrowserMoldStrategy

Mark provided item as focused. Only one item may be focused at the time.

Parameters:

oldFocus - item that was focused up until now

newFocus - item to be marked as focused

setItemFocused

protected void setItemFocused(org.zkoss.zk.ui.Component item,
                              boolean focused)

getComponent

protected org.zkoss.zk.ui.Component getComponent(java.lang.Object item)

getItem

protected org.zkoss.zul.Treeitem getItem(org.zkoss.zul.Treechildren treechildren,
                                         java.util.Collection<TreeViewCollectionBrowserNode> nodes,
                                         int[] modelPath)

onTreeitemClickEvent

protected void onTreeitemClickEvent(org.zkoss.zk.ui.event.Event event)

Callback method for Treeitem Events.ON_CLICK event.

Parameters:

event - MouseEvent

isNodeClickable

protected boolean isNodeClickable(org.zkoss.zk.ui.Component nodeComponent,
                                  AbstractTreeViewNode node)

handleObjectCreateEvent

public void handleObjectCreateEvent(CockpitEvent event)

Description copied from interface: CollectionBrowserMoldStrategy

Additional logic to perform on object create event.

handleObjectDeleteEvent

public void handleObjectDeleteEvent(CockpitEvent event)

Description copied from interface: CollectionBrowserMoldStrategy

Additional logic to perform on object deleted event.

previousItemSelectorInvocation

public void previousItemSelectorInvocation()

Description copied from interface: CollectionBrowserMoldStrategy

Handle "previous item" navigation event.

Specified by:

previousItemSelectorInvocation in interface CollectionBrowserMoldStrategy

Overrides:

previousItemSelectorInvocation in class AbstractMoldStrategy<org.zkoss.zul.Treeitem,java.lang.Void,TreeViewCollectionBrowserNode>

nextItemSelectorInvocation

public void nextItemSelectorInvocation()

Description copied from interface: CollectionBrowserMoldStrategy

Handle "next item" navigation event.

Specified by:

nextItemSelectorInvocation in interface CollectionBrowserMoldStrategy

Overrides:

nextItemSelectorInvocation in class AbstractMoldStrategy<org.zkoss.zul.Treeitem,java.lang.Void,TreeViewCollectionBrowserNode>

getEditableItemFromSelectedItem

protected java.lang.Object getEditableItemFromSelectedItem(java.lang.Object selectedItem)

isItemAtomic

protected boolean isItemAtomic(java.lang.Object item)
                        throws TypeNotFoundException

Throws:

TypeNotFoundException

createTreeModel

@Deprecated(since="2005",
            forRemoval=true)
protected TreeViewCollectionBrowserTreeModel<? extends TreeViewCollectionBrowserNode> createTreeModel(java.util.List<java.lang.Object> currentPage)

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

since 2005

createTreeModel

protected TreeViewCollectionBrowserTreeModel<? extends TreeViewCollectionBrowserNode> createTreeModel(java.util.List<java.lang.Object> currentPage,
                                                                                                      SinglePage singlePage)

createNodesFromData

protected java.util.List<TreeViewCollectionBrowserNode> createNodesFromData(java.util.List<java.lang.Object> data)

createNoEntriesNode

@Deprecated(since="2005",
            forRemoval=true)
protected java.util.List<TreeViewCollectionBrowserNode> createNoEntriesNode()

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

since 2005

createNodeWithLabel

protected java.util.List<TreeViewCollectionBrowserNode> createNodeWithLabel(java.lang.String label)

setTreeRenderer

protected void setTreeRenderer()

onTreeitemOnOpenEvent

protected void onTreeitemOnOpenEvent(org.zkoss.zk.ui.event.Event openEvent)

getRendererSetting

protected java.lang.String getRendererSetting()

Overrides:

getRendererSetting in class AbstractMoldStrategy<org.zkoss.zul.Treeitem,java.lang.Void,TreeViewCollectionBrowserNode>

initializeRenderer

protected void initializeRenderer(NotifyingWidgetComponentRenderer<org.zkoss.zul.Treeitem,java.lang.Void,TreeViewCollectionBrowserNode> renderer)

Overrides:

initializeRenderer in class AbstractMoldStrategy<org.zkoss.zul.Treeitem,java.lang.Void,TreeViewCollectionBrowserNode>

createLinkRenderedListener

protected WidgetComponentRendererListener<org.zkoss.zul.Treeitem,java.lang.Void,TreeViewCollectionBrowserNode> createLinkRenderedListener()

createNodeRenderedListener

protected WidgetComponentRendererListener<org.zkoss.zul.Treeitem,java.lang.Void,TreeViewCollectionBrowserNode> createNodeRenderedListener()

addLink

protected void addLink(org.zkoss.zk.ui.HtmlBasedComponent component,
                       TreeViewCollectionBrowserNode node)

resolveDataType

protected DataType resolveDataType(java.lang.Object object)

setTreeStyle

protected void setTreeStyle(java.util.List<?> currentPage)

getTypeFacade

protected TypeFacade getTypeFacade()

setTypeFacade

public void setTypeFacade(TypeFacade typeFacade)

getObjectValueService

protected ObjectValueService getObjectValueService()

setObjectValueService

public void setObjectValueService(ObjectValueService objectValueService)

getModel

protected java.lang.Object getModel()

getName

public java.lang.String getName()

Returns:

name of the mold for internal use (e.g. to determine CSS class of (in)active mold selection button).

getTypeCode

public java.lang.String getTypeCode()

Specified by:

getTypeCode in interface CollectionBrowserMoldStrategy

Overrides:

getTypeCode in class AbstractMoldStrategy<org.zkoss.zul.Treeitem,java.lang.Void,TreeViewCollectionBrowserNode>

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

Overrides:

setTypeCode in class AbstractMoldStrategy<org.zkoss.zul.Treeitem,java.lang.Void,TreeViewCollectionBrowserNode>

getTooltipText

public java.lang.String getTooltipText()

Returns:

tooltip text that should appear on a mold selection button.

getNavigationItemSelectorContext

public NavigationItemSelectorContext getNavigationItemSelectorContext()

Returns:

current NavigationItemSelectorContext.

getOrder

public int getOrder()

Specified by:

getOrder in interface org.springframework.core.Ordered

Overrides:

getOrder in class AbstractMoldStrategy<org.zkoss.zul.Treeitem,java.lang.Void,TreeViewCollectionBrowserNode>

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

Overrides:

setOrder in class AbstractMoldStrategy<org.zkoss.zul.Treeitem,java.lang.Void,TreeViewCollectionBrowserNode>

getWidgetModel

protected WidgetModel getWidgetModel()

Overrides:

getWidgetModel in class AbstractMoldStrategy<org.zkoss.zul.Treeitem,java.lang.Void,TreeViewCollectionBrowserNode>