de.hybris.platform.hmc.webchips.tree

Class TreeChip

java.lang.Object

de.hybris.platform.hmc.webchips.AbstractChip

de.hybris.platform.hmc.webchips.tree.TreeChip

All Implemented Interfaces:

Chip, Serializable, Cloneable

public class TreeChip
extends AbstractChip

This chip represents a tree. It uses TreeModel to get data and TreeCellRenderer to get the display chips for the node contents.

See Also:

TreeModel, TreeCellRenderer, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	TreeChip.TreeNodeChip Chip representing one node in the tree.

Field Summary

Fields

Modifier and Type	Field and Description
static String	TREE_EVENT help event, always active, to enable proper node selection event processing

Fields inherited from class de.hybris.platform.hmc.webchips.AbstractChip

CHIP_KEY, FALSE, FRAME_KEY, SHOW_JSP_COMMENTS, TRUE, USE_SOCKET_NAMING

Fields inherited from interface de.hybris.platform.hmc.webchips.Chip

DISPLAY_EVENT, FILTERED_PREFIX

Constructor Summary

Constructors

Constructor and Description
TreeChip(DisplayState displayState, Chip parent, TreeModel model, TreeCellRenderer cellRenderer) Constructor.

Method Summary

Modifier and Type	Method and Description
void	clearSelection()
void	expand(TreePath path) Expands the given node.
TreeCellRenderer	getCellRenderer() Gets the tree cell renderer used by this tree.
TreePath	getCurrentPath() Returns the current path.
String	getCurrentPathBackground()
TreePath	getFirstSelectedPath()
Chip	getHeaderRendererChip(int row)
String	getJSPURI() Returns the URI of the JSP that this chip wants to use.
int	getMaxLevel()
TreeModel	getModel() Gets the tree model used by this tree.
TreeChip.TreeNodeChip	getRootNodeChip() Gets the root node chip.
Set	getSelectedPaths() Returns the currently selected paths.
Chip	getSelectionHeaderRendererChip()
boolean	highlightCurrentPath()
boolean	isCurrentPath(TreePath path) Returns true if the given tree path is the current path, false otherwise.
boolean	isMultipleSelectionEnabled()
boolean	isSelected(TreePath path) Returns true if the given tree path is selected, false otherwise.
boolean	isSelectionEnabled()
boolean	makePathVisible(TreePath path)
boolean	pathExists(TreePath path) Returns true if the given path exists within the model, false otherwise.
boolean	pathVisible(TreePath path) Returns true if the given path is visible (parent node is expanded), false otherwise.
void	processEvents(Map events) Handles all incoming requests for this chip.
void	refresh()
void	resetHeader()
void	select(TreePath path) Selects the given tree path.
void	setCurrentPath(TreePath path) Selects the given tree path.
void	setCurrentPathBackground(String color)
void	setHighlightCurrentPath(boolean highlight)
void	setModel(TreeModel model)
void	setMultipleSelectionEnabled(boolean multipleSelection)
void	setRenderer(TreeCellRenderer cellRenderer)
void	setSelectionEnabled(boolean selectionEnabled)
void	setShowHeader(boolean show)
void	setShowLines(boolean show)
void	setShowRoot(boolean show)
boolean	showHeader()
boolean	showLines()
boolean	showRoot()
void	synchronize() Updates the tree structure.

Methods inherited from class de.hybris.platform.hmc.webchips.AbstractChip

addEventListener, checkValid, clearInfoMessages, clone, containsDisplayEvent, createMenuEntriesForJS, dispose, errorQueueEmpty, getClipboard, getCommandID, getDisplayParameters, getDisplayState, getEventID, getEventURL, getEventValue, getFrame, getID, getInfoMessages, getJaloSession, getLocalizedString, getLocalizedString, getLogger, getMenuEntries, getNameSpace, getNameSpaceFor, getParent, getProposedUniqueName, getProposedUniqueNameFor, getRequestFocus, getSessionIdentifier, getStringValue, getUniqueName, getWindow, goFullScreen, hasVisibleContextMenuEntries, isButtonPushed, isButtonPushed, isErrorQueueEmpty, isValid, leaveFullScreen, notifyEventListeners, notifyEventListeners, postErrorMessage, postInfoMessage, postWindowEvent, refreshChild, registerUniqueName, removeEventListener, removeInfoMessage, render, render, setClipboard, setParent, setRequestFocus, setValid, setWindowStatus, translateFormFieldToEventName, translateFormFieldToEventValue

Methods inherited from class java.lang.Object

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

Field Detail

TREE_EVENT

public static final String TREE_EVENT

help event, always active, to enable proper node selection event processing

Since:

2.20

See Also:

Constant Field Values

Constructor Detail

TreeChip

public TreeChip(DisplayState displayState,
                Chip parent,
                TreeModel model,
                TreeCellRenderer cellRenderer)

Constructor.

Parameters:

displayState -

parent -

model -

cellRenderer -

Method Detail

setModel

public void setModel(TreeModel model)

Since:

2.20

setRenderer

public void setRenderer(TreeCellRenderer cellRenderer)

Since:

2.20

refresh

public void refresh()

Overrides:

refresh in class AbstractChip

synchronize

public void synchronize()

Updates the tree structure.
This method is called by jsp before the tree rendering starts.

processEvents

public void processEvents(Map events)

Description copied from interface: Chip

Handles all incoming requests for this chip. Map contains name (String) and value (List of Strings)

getJSPURI

public String getJSPURI()

Description copied from interface: Chip

Returns the URI of the JSP that this chip wants to use.

isSelectionEnabled

public boolean isSelectionEnabled()

setSelectionEnabled

public void setSelectionEnabled(boolean selectionEnabled)

isMultipleSelectionEnabled

public boolean isMultipleSelectionEnabled()

setMultipleSelectionEnabled

public void setMultipleSelectionEnabled(boolean multipleSelection)

setShowLines

public void setShowLines(boolean show)

showLines

public boolean showLines()

setHighlightCurrentPath

public void setHighlightCurrentPath(boolean highlight)

Since:

2.20

highlightCurrentPath

public boolean highlightCurrentPath()

Since:

2.20

setCurrentPathBackground

public void setCurrentPathBackground(String color)

Since:

2.20

getCurrentPathBackground

public String getCurrentPathBackground()

Since:

2.20

setShowRoot

public void setShowRoot(boolean show)

Since:

2.20

showRoot

public boolean showRoot()

Since:

2.20

setShowHeader

public void setShowHeader(boolean show)

Since:

2.20

showHeader

public boolean showHeader()

Since:

2.20

resetHeader

public void resetHeader()

Since:

2.20

getHeaderRendererChip

public Chip getHeaderRendererChip(int row)

Since:

2.20

getSelectionHeaderRendererChip

public Chip getSelectionHeaderRendererChip()

Since:

2.20

getModel

public TreeModel getModel()

Gets the tree model used by this tree.

Returns:

the tree model used by this tree

getCellRenderer

public TreeCellRenderer getCellRenderer()

Gets the tree cell renderer used by this tree.

Returns:

the tree cell renderer used by this tree

getRootNodeChip

public TreeChip.TreeNodeChip getRootNodeChip()

Gets the root node chip.

Returns:

the root node chip

pathExists

public boolean pathExists(TreePath path)

Returns true if the given path exists within the model, false otherwise. The path may not be visible.

Parameters:

path -

Returns:

true if the given path exists within the model, false otherwise

Since:

2.20

pathVisible

public boolean pathVisible(TreePath path)

Returns true if the given path is visible (parent node is expanded), false otherwise.

Parameters:

path -

Returns:

true if the given path is visible (parent node is expanded), false otherwise

Since:

2.20

makePathVisible

public boolean makePathVisible(TreePath path)

Since:

2.20

expand

public void expand(TreePath path)

Expands the given node.

Parameters:

path - the path to the node to be expanded

select

public void select(TreePath path)

Selects the given tree path.

clearSelection

public void clearSelection()

isCurrentPath

public boolean isCurrentPath(TreePath path)

Returns true if the given tree path is the current path, false otherwise.

Parameters:

path - the tree path

Returns:

true if the given tree path is the current path, false otherwise

getCurrentPath

public TreePath getCurrentPath()

Returns the current path.

Returns:

the current path

setCurrentPath

public void setCurrentPath(TreePath path)

Selects the given tree path.

Parameters:

path - the tree path

isSelected

public boolean isSelected(TreePath path)

Returns true if the given tree path is selected, false otherwise.

Parameters:

path - the tree path

Returns:

true if the given tree path is selected, false otherwise

getSelectedPaths

public Set getSelectedPaths()

Returns the currently selected paths.

Returns:

currently selected paths

getFirstSelectedPath

public TreePath getFirstSelectedPath()

getMaxLevel

public int getMaxLevel()