com.hybris.backoffice.attributechooser

Class AttributeChooserRenderer

java.lang.Object

com.hybris.backoffice.attributechooser.AttributeChooserRenderer

All Implemented Interfaces:

WidgetComponentRenderer<org.zkoss.zk.ui.Component,AttributesChooserConfig,AttributeChooserForm>

public class AttributeChooserRenderer
extends Object
implements WidgetComponentRenderer<org.zkoss.zk.ui.Component,AttributesChooserConfig,AttributeChooserForm>

Renders two lists: available attributes and chosen attributes. Every time list of chosen attributes is changed an event will be posted on parent component EVENT_ATTRIBUTES_SELECTED passed to render method.

Field Summary

Fields

Modifier and Type	Field and Description
static String	EVENT_ATTRIBUTES_SELECTED
protected static String	MODE_VISIBLE_ROWS_NUMBER
protected static String	MODEL_INCLUDE_ALL_SELECTED
protected static String	MODEL_SEARCH_TEXT
protected static String	MODEL_SELECTED_PATHS
protected static String	RENDERER_PREFIX
protected static String	SECTION_ID_AVAILABLE
protected static String	SECTION_ID_SELECTED

Constructor Summary

Constructors

Constructor and Description
AttributeChooserRenderer()

Method Summary

Modifier and Type	Method and Description
protected void	addChosenAttributesListener(org.zkoss.zul.Tree availableTree, org.zkoss.zul.Tree selectedTree, WidgetInstanceManager wim, AttributeChooserForm form, AttributesChooserConfig config, org.zkoss.zk.ui.Component parent)
protected void	addLocalizedNodesSelectionListener(org.zkoss.zul.Tree tree)
protected void	addSelectedPathsListener(org.zkoss.zul.Tree tree, WidgetInstanceManager wim, String sectionId)
protected org.zkoss.zul.Div	createAttributesSection(org.zkoss.zul.Tree attributesTree, WidgetInstanceManager wim, AttributesChooserConfig config, String sectionId)
protected org.zkoss.zk.ui.Component	createButtonsSection(org.zkoss.zul.Tree availableTree, org.zkoss.zul.Tree selectedTree)
protected org.zkoss.zk.ui.Component	createIncludeAllOverlay()
protected org.zkoss.zk.ui.Component	createIncludeAllSection(boolean initialState, org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.CheckEvent> onIncludeAllListener)
protected org.zkoss.zul.Button	createMoveButton(org.zkoss.zul.Tree from, org.zkoss.zul.Tree to, String buttonId)
protected org.zkoss.zk.ui.HtmlBasedComponent	createNoAttributesOverlay(AttributesChooserConfig config, WidgetInstanceManager wim)
protected org.zkoss.zul.Tree	createTree(int visibleRows)
protected org.zkoss.zul.AbstractTreeModel<org.zkoss.zul.TreeNode<Attribute>>	createTreeModel(List<org.zkoss.zul.DefaultTreeNode<Attribute>> treeNodes, String searchText)
protected Set<Attribute>	getAttributes(org.zkoss.zul.Tree available, org.zkoss.zul.Tree selected, boolean includeAll)
protected String	getFilterText(WidgetInstanceManager wim, String sectionId)
protected org.zkoss.zul.AbstractTreeModel<org.zkoss.zul.TreeNode<Attribute>>	getModel(org.zkoss.zul.Tree tree)
NodeOperationsHandler	getNodeOperationsHandler()
org.zkoss.zul.TreeitemRenderer<org.zkoss.zul.DefaultTreeNode<Attribute>>	getTreeItemRenderer()
protected org.zkoss.zul.AbstractTreeModel<org.zkoss.zul.TreeNode<Attribute>>	getUnfilteredModel(org.zkoss.zul.Tree tree)
protected int	getVisibleRowsNumber()
protected int	getVisibleRowsNumber(WidgetInstanceManager wim)
protected boolean	isIncludeAllSelected(WidgetInstanceManager wim, AttributesChooserConfig config)
protected void	moveSelectedNodes(org.zkoss.zul.Tree sourceTree, org.zkoss.zul.Tree targetTree)
protected void	notifyChosenAttributesChanged(AttributeChooserForm form, org.zkoss.zk.ui.Component parent)
protected void	openFirstMultiChildLevel(org.zkoss.zul.AbstractTreeModel<org.zkoss.zul.TreeNode<Attribute>> model, org.zkoss.zul.TreeNode<Attribute> root)
protected void	openFirstMultiChildLevel(org.zkoss.zul.Tree tree, AttributesChooserConfig config)
protected void	populateTreeData(org.zkoss.zul.Tree availableValuesTree, org.zkoss.zul.Tree selectedValuesTree, AttributeChooserForm form, AttributesChooserConfig config, WidgetInstanceManager wim)
protected void	refreshTreeSearch(org.zkoss.zul.Tree tree, String searchText)
void	render(org.zkoss.zk.ui.Component parent, AttributesChooserConfig config, AttributeChooserForm form, DataType dataType, WidgetInstanceManager wim) Renders a component inside parent, representing given data and complying to given ui configuration.
protected void	restoreSelectedPaths(org.zkoss.zul.Tree tree, String sectionId, WidgetInstanceManager wim)
void	setNodeOperationsHandler(NodeOperationsHandler nodeOperationsHandler)
void	setTreeItemRenderer(org.zkoss.zul.TreeitemRenderer<org.zkoss.zul.DefaultTreeNode<Attribute>> treeItemRenderer)
void	setVisibleRowsNumber(Integer visibleRowsNumber)
protected void	storeSelectedPaths(String sectionId, WidgetInstanceManager wim, int[][] paths)
protected void	storeSelectedPaths(org.zkoss.zul.Tree tree, String sectionId, WidgetInstanceManager wim)
protected String	uniquePrefix(AttributesChooserConfig config, String modelKey)

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

addRendererListener, removeRendererListener, render

Field Detail

EVENT_ATTRIBUTES_SELECTED

public static final String EVENT_ATTRIBUTES_SELECTED

See Also:

Constant Field Values

RENDERER_PREFIX

protected static final String RENDERER_PREFIX

MODEL_INCLUDE_ALL_SELECTED

protected static final String MODEL_INCLUDE_ALL_SELECTED

MODE_VISIBLE_ROWS_NUMBER

protected static final String MODE_VISIBLE_ROWS_NUMBER

See Also:

Constant Field Values

MODEL_SELECTED_PATHS

protected static final String MODEL_SELECTED_PATHS

MODEL_SEARCH_TEXT

protected static final String MODEL_SEARCH_TEXT

SECTION_ID_AVAILABLE

protected static final String SECTION_ID_AVAILABLE

See Also:

Constant Field Values

SECTION_ID_SELECTED

protected static final String SECTION_ID_SELECTED

See Also:

Constant Field Values

Constructor Detail

AttributeChooserRenderer

public AttributeChooserRenderer()

Method Detail

render

public void render(org.zkoss.zk.ui.Component parent,
                   AttributesChooserConfig config,
                   AttributeChooserForm form,
                   DataType dataType,
                   WidgetInstanceManager wim)

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.

Specified by:

render in interface WidgetComponentRenderer<org.zkoss.zk.ui.Component,AttributesChooserConfig,AttributeChooserForm>

Parameters:

parent - parent component on which to render

config - configuration of renderer

form - data to be rendered

dataType - meta information about type of data provided

wim - widget manager in scope of which renderer is used

createIncludeAllSection

protected org.zkoss.zk.ui.Component createIncludeAllSection(boolean initialState,
                                                            org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.CheckEvent> onIncludeAllListener)

createIncludeAllOverlay

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

createNoAttributesOverlay

protected org.zkoss.zk.ui.HtmlBasedComponent createNoAttributesOverlay(AttributesChooserConfig config,
                                                                       WidgetInstanceManager wim)

createAttributesSection

protected org.zkoss.zul.Div createAttributesSection(org.zkoss.zul.Tree attributesTree,
                                                    WidgetInstanceManager wim,
                                                    AttributesChooserConfig config,
                                                    String sectionId)

getFilterText

protected String getFilterText(WidgetInstanceManager wim,
                               String sectionId)

addSelectedPathsListener

protected void addSelectedPathsListener(org.zkoss.zul.Tree tree,
                                        WidgetInstanceManager wim,
                                        String sectionId)

restoreSelectedPaths

protected void restoreSelectedPaths(org.zkoss.zul.Tree tree,
                                    String sectionId,
                                    WidgetInstanceManager wim)

storeSelectedPaths

protected void storeSelectedPaths(org.zkoss.zul.Tree tree,
                                  String sectionId,
                                  WidgetInstanceManager wim)

storeSelectedPaths

protected void storeSelectedPaths(String sectionId,
                                  WidgetInstanceManager wim,
                                  int[][] paths)

createButtonsSection

protected org.zkoss.zk.ui.Component createButtonsSection(org.zkoss.zul.Tree availableTree,
                                                         org.zkoss.zul.Tree selectedTree)

createMoveButton

protected org.zkoss.zul.Button createMoveButton(org.zkoss.zul.Tree from,
                                                org.zkoss.zul.Tree to,
                                                String buttonId)

createTree

protected org.zkoss.zul.Tree createTree(int visibleRows)

populateTreeData

protected void populateTreeData(org.zkoss.zul.Tree availableValuesTree,
                                org.zkoss.zul.Tree selectedValuesTree,
                                AttributeChooserForm form,
                                AttributesChooserConfig config,
                                WidgetInstanceManager wim)

isIncludeAllSelected

protected boolean isIncludeAllSelected(WidgetInstanceManager wim,
                                       AttributesChooserConfig config)

uniquePrefix

protected String uniquePrefix(AttributesChooserConfig config,
                              String modelKey)

createTreeModel

protected org.zkoss.zul.AbstractTreeModel<org.zkoss.zul.TreeNode<Attribute>> createTreeModel(List<org.zkoss.zul.DefaultTreeNode<Attribute>> treeNodes,
                                                                                             String searchText)

refreshTreeSearch

protected void refreshTreeSearch(org.zkoss.zul.Tree tree,
                                 String searchText)

getModel

protected org.zkoss.zul.AbstractTreeModel<org.zkoss.zul.TreeNode<Attribute>> getModel(org.zkoss.zul.Tree tree)

getUnfilteredModel

protected org.zkoss.zul.AbstractTreeModel<org.zkoss.zul.TreeNode<Attribute>> getUnfilteredModel(org.zkoss.zul.Tree tree)

moveSelectedNodes

protected void moveSelectedNodes(org.zkoss.zul.Tree sourceTree,
                                 org.zkoss.zul.Tree targetTree)

addLocalizedNodesSelectionListener

protected void addLocalizedNodesSelectionListener(org.zkoss.zul.Tree tree)

addChosenAttributesListener

protected void addChosenAttributesListener(org.zkoss.zul.Tree availableTree,
                                           org.zkoss.zul.Tree selectedTree,
                                           WidgetInstanceManager wim,
                                           AttributeChooserForm form,
                                           AttributesChooserConfig config,
                                           org.zkoss.zk.ui.Component parent)

notifyChosenAttributesChanged

protected void notifyChosenAttributesChanged(AttributeChooserForm form,
                                             org.zkoss.zk.ui.Component parent)

getAttributes

protected Set<Attribute> getAttributes(org.zkoss.zul.Tree available,
                                       org.zkoss.zul.Tree selected,
                                       boolean includeAll)

openFirstMultiChildLevel

protected void openFirstMultiChildLevel(org.zkoss.zul.Tree tree,
                                        AttributesChooserConfig config)

openFirstMultiChildLevel

protected void openFirstMultiChildLevel(org.zkoss.zul.AbstractTreeModel<org.zkoss.zul.TreeNode<Attribute>> model,
                                        org.zkoss.zul.TreeNode<Attribute> root)

getTreeItemRenderer

public org.zkoss.zul.TreeitemRenderer<org.zkoss.zul.DefaultTreeNode<Attribute>> getTreeItemRenderer()

setTreeItemRenderer

public void setTreeItemRenderer(org.zkoss.zul.TreeitemRenderer<org.zkoss.zul.DefaultTreeNode<Attribute>> treeItemRenderer)

setVisibleRowsNumber

public void setVisibleRowsNumber(Integer visibleRowsNumber)

getNodeOperationsHandler

public NodeOperationsHandler getNodeOperationsHandler()

setNodeOperationsHandler

public void setNodeOperationsHandler(NodeOperationsHandler nodeOperationsHandler)

getVisibleRowsNumber

protected int getVisibleRowsNumber()

getVisibleRowsNumber

protected int getVisibleRowsNumber(WidgetInstanceManager wim)