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

Class DefaultTreeViewRenderer

java.lang.Object

com.hybris.cockpitng.widgets.common.AbstractWidgetComponentRenderer<org.zkoss.zul.Treeitem,java.lang.Void,TreeViewCollectionBrowserNode>

com.hybris.cockpitng.widgets.collectionbrowser.mold.impl.treeview.renderer.DefaultTreeViewRenderer

All Implemented Interfaces:

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

public class DefaultTreeViewRenderer
extends AbstractWidgetComponentRenderer<org.zkoss.zul.Treeitem,java.lang.Void,TreeViewCollectionBrowserNode>

Renders tree entries in two column form: preview and label. If it gets a node with String as its underlying data object, it treats it as localized label key.

Field Summary

Fields

Modifier and Type	Field	Description
protected static java.lang.String	SCLASS_TREEVIEW_CELL
protected static java.lang.String	SCLASS_TREEVIEW_CELL_DATA_ATTRIBUTE
protected static java.lang.String	SCLASS_TREEVIEW_CELL_LABEL
protected static java.lang.String	SCLASS_TREEVIEW_CELL_PREVIEW
protected static java.lang.String	SCLASS_TREEVIEW_CELL_READ_RESTRICTED
protected static java.lang.String	SCLASS_TREEVIEW_ROW_SELECTED
protected static java.lang.String	SCLASS_TREEVIEW_ROW_SUBNODE
protected static java.lang.String	SCLASS_TREEVIEW_ROW_TOPNODE

Constructor Summary

Constructors

Constructor	Description
DefaultTreeViewRenderer()

Method Summary

Modifier and Type	Method	Description
protected void	appendStyleToTreeItemByNestingLevel(org.zkoss.zul.Treerow row, TreeViewCollectionBrowserNode entry)
protected WidgetComponentRenderer<org.zkoss.zul.Treecell,java.lang.Void,TreeViewCollectionBrowserNode>	createCellRenderer()
CockpitLocaleService	getCockpitLocaleService()
FallbackLocaleProvider	getFallbackLocaleProvider()
LabelService	getLabelService()
ObjectPreviewService	getObjectPreviewService()
TypeFacade	getTypeFacade()
void	render(org.zkoss.zul.Treeitem item, java.lang.Void config, TreeViewCollectionBrowserNode entry, DataType dataType, WidgetInstanceManager widgetInstanceManager)	Renders a component inside parent, representing given data and complying to given ui configuration.
protected org.zkoss.zul.Div	renderDataAttribute(org.zkoss.zul.Div labelDiv, TreeViewCollectionBrowserNode entry, java.util.function.Consumer<org.zkoss.zk.ui.HtmlBasedComponent> trigger)	Renders an attribute
protected org.zkoss.zul.Div	renderEntryLabel(org.zkoss.zul.Div labelDiv, TreeViewCollectionBrowserNode entry, java.util.function.Consumer<org.zkoss.zk.ui.HtmlBasedComponent> trigger)	Renders a label for provided object.
protected org.zkoss.zul.Div	renderEntryPreview(org.zkoss.zul.Div previewDiv, TreeViewCollectionBrowserNode entry, DataType dataType, WidgetInstanceManager widgetInstanceManager, java.util.function.Consumer<org.zkoss.zk.ui.HtmlBasedComponent> trigger)	Renders a preview image of provided entry.
protected void	renderItemNode(org.zkoss.zul.Treeitem item, TreeViewCollectionBrowserNode entry, org.zkoss.zul.Treerow treeRow, DataType dataType, WidgetInstanceManager widgetInstanceManager)
protected void	renderLocalizedLabelNode(org.zkoss.zul.Treeitem item, TreeViewCollectionBrowserNode entry, org.zkoss.zul.Treerow treeRow, WidgetInstanceManager widgetInstanceManager)
void	setCockpitLocaleService(CockpitLocaleService cockpitLocaleService)
void	setFallbackLocaleProvider(FallbackLocaleProvider fallbackLocaleProvider)
void	setLabelService(LabelService labelService)
void	setObjectPreviewService(ObjectPreviewService objectPreviewService)
void	setTypeFacade(TypeFacade typeFacade)
protected boolean	shouldRenderNode(TreeViewCollectionBrowserNode entry, DataType dataType)

Methods inherited from class com.hybris.cockpitng.widgets.common.AbstractWidgetComponentRenderer

addRendererListener, fireComponentRendered, fireComponentRendered, fireComponentRendered, removeRendererListener

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.common.WidgetComponentRenderer

render

Field Detail

SCLASS_TREEVIEW_CELL

protected static final java.lang.String SCLASS_TREEVIEW_CELL

See Also:

Constant Field Values

SCLASS_TREEVIEW_CELL_PREVIEW

protected static final java.lang.String SCLASS_TREEVIEW_CELL_PREVIEW

See Also:

Constant Field Values

SCLASS_TREEVIEW_CELL_DATA_ATTRIBUTE

protected static final java.lang.String SCLASS_TREEVIEW_CELL_DATA_ATTRIBUTE

See Also:

Constant Field Values

SCLASS_TREEVIEW_CELL_LABEL

protected static final java.lang.String SCLASS_TREEVIEW_CELL_LABEL

See Also:

Constant Field Values

SCLASS_TREEVIEW_CELL_READ_RESTRICTED

protected static final java.lang.String SCLASS_TREEVIEW_CELL_READ_RESTRICTED

See Also:

Constant Field Values

SCLASS_TREEVIEW_ROW_SELECTED

protected static final java.lang.String SCLASS_TREEVIEW_ROW_SELECTED

See Also:

Constant Field Values

SCLASS_TREEVIEW_ROW_TOPNODE

protected static final java.lang.String SCLASS_TREEVIEW_ROW_TOPNODE

See Also:

Constant Field Values

SCLASS_TREEVIEW_ROW_SUBNODE

protected static final java.lang.String SCLASS_TREEVIEW_ROW_SUBNODE

See Also:

Constant Field Values

Constructor Detail

DefaultTreeViewRenderer

public DefaultTreeViewRenderer()

Method Detail

render

public void render(org.zkoss.zul.Treeitem item,
                   java.lang.Void config,
                   TreeViewCollectionBrowserNode entry,
                   DataType dataType,
                   WidgetInstanceManager widgetInstanceManager)

Description copied from interface: WidgetComponentRenderer

Renders a component inside parent, representing given data and complying to given ui configuration. The data should be of give dataType. The renderer implementation could communicate with underlying widget via widgetInstanceManager.

Parameters:

item - parent component on which to render

config - configuration of renderer

entry - data to be rendered

dataType - meta information about type of data provided

widgetInstanceManager - widget manager in scope of which renderer is used

shouldRenderNode

protected boolean shouldRenderNode(TreeViewCollectionBrowserNode entry,
                                   DataType dataType)

renderLocalizedLabelNode

protected void renderLocalizedLabelNode(org.zkoss.zul.Treeitem item,
                                        TreeViewCollectionBrowserNode entry,
                                        org.zkoss.zul.Treerow treeRow,
                                        WidgetInstanceManager widgetInstanceManager)

renderItemNode

protected void renderItemNode(org.zkoss.zul.Treeitem item,
                              TreeViewCollectionBrowserNode entry,
                              org.zkoss.zul.Treerow treeRow,
                              DataType dataType,
                              WidgetInstanceManager widgetInstanceManager)

createCellRenderer

protected WidgetComponentRenderer<org.zkoss.zul.Treecell,java.lang.Void,TreeViewCollectionBrowserNode> createCellRenderer()

renderDataAttribute

protected org.zkoss.zul.Div renderDataAttribute(org.zkoss.zul.Div labelDiv,
                                                TreeViewCollectionBrowserNode entry,
                                                java.util.function.Consumer<org.zkoss.zk.ui.HtmlBasedComponent> trigger)

Renders an attribute

Parameters:

labelDiv - div component that is to contain attribute's data

entry - tree node on which it will be displayed

trigger - notification consumer for each component rendered

Returns:

div component that is containing all that needs to be displayed (by default if would be the same that labelDiv)

renderEntryPreview

protected org.zkoss.zul.Div renderEntryPreview(org.zkoss.zul.Div previewDiv,
                                               TreeViewCollectionBrowserNode entry,
                                               DataType dataType,
                                               WidgetInstanceManager widgetInstanceManager,
                                               java.util.function.Consumer<org.zkoss.zk.ui.HtmlBasedComponent> trigger)

Renders a preview image of provided entry.

Parameters:

previewDiv - div component on which to render

entry - tree node on which it will be displayed

dataType - type of data which preview is to be rendered

widgetInstanceManager - widget manager in scope of which renderer is used

trigger - notification consumer for each component rendered

Returns:

div component that is containing all that needs to be displayed (by default if would be the same that previewDiv)

renderEntryLabel

protected org.zkoss.zul.Div renderEntryLabel(org.zkoss.zul.Div labelDiv,
                                             TreeViewCollectionBrowserNode entry,
                                             java.util.function.Consumer<org.zkoss.zk.ui.HtmlBasedComponent> trigger)

Renders a label for provided object.

Parameters:

labelDiv - div component that is to contain data's label

entry - tree node on which it will be displayed

trigger - notification consumer for each component rendered

Returns:

div component that is containing all that needs to be displayed (by default if would be the same that labelDiv)

appendStyleToTreeItemByNestingLevel

protected void appendStyleToTreeItemByNestingLevel(org.zkoss.zul.Treerow row,
                                                   TreeViewCollectionBrowserNode entry)

getTypeFacade

public TypeFacade getTypeFacade()

setTypeFacade

public void setTypeFacade(TypeFacade typeFacade)

getCockpitLocaleService

public CockpitLocaleService getCockpitLocaleService()

setCockpitLocaleService

public void setCockpitLocaleService(CockpitLocaleService cockpitLocaleService)

getLabelService

public LabelService getLabelService()

setLabelService

public void setLabelService(LabelService labelService)

getObjectPreviewService

public ObjectPreviewService getObjectPreviewService()

setObjectPreviewService

public void setObjectPreviewService(ObjectPreviewService objectPreviewService)

getFallbackLocaleProvider

public FallbackLocaleProvider getFallbackLocaleProvider()

setFallbackLocaleProvider

public void setFallbackLocaleProvider(FallbackLocaleProvider fallbackLocaleProvider)