de.hybris.platform.hmc

Class AbstractTreeNodeChip

java.lang.Object

de.hybris.platform.hmc.webchips.AbstractChip

de.hybris.platform.hmc.AbstractTreeNodeChip

All Implemented Interfaces:

Chip, java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

AbstractExplorerMenuTreeNodeChip, AbstractItemTreeNodeChip, SearchResultTreeChip

public abstract class AbstractTreeNodeChip
extends AbstractChip

This is a template for tree nodes. It allows to collapse and expand the node and have menuentries for the right-mouse-click contextmenu. A method edit() is required to determine how the Chip reacts on the EDIT-event. The Chip may have Children that are also AbstractTreeNodeChips.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COLLAPSE
static java.lang.String	EDIT Events string for editing the connected object.
static java.lang.String	EXPAND
static java.lang.String	TOGGLE

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
AbstractTreeNodeChip(DisplayState displayState, Chip parent)

Method Summary

Modifier and Type	Method and Description
void	checkValid() Implements the calling of checkValid() of all children getChildrenInternal(), but not the handling of invalid children.
protected abstract void	edit() Activated by the event string EDIT.
java.util.List	getAllChildren() Initializes the set of children getChildrenInternal() if its not done before.
protected java.util.List	getChildrenInternal()
abstract java.lang.String	getIcon()
abstract java.lang.String	getName()
boolean	hasChildren() This implementation has potential for causing slowdowns in the application.
protected abstract java.util.List	initializeChildren()
boolean	isActive() returns whether or not the chip is active inactive chips will be shown with gray icon and grey label default is true
boolean	isExpanded()
boolean	isSelected()
void	processEvents(java.util.Map<java.lang.String,java.util.List<java.lang.String>> events) Handles all incoming requests for this chip.
protected void	setChildrenInternal(java.util.List children)
void	setExpanded(boolean isExpanded)

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

addEventListener, 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, refresh, 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

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

getJSPURI

Field Detail

EXPAND

public static final java.lang.String EXPAND

See Also:

Constant Field Values

COLLAPSE

public static final java.lang.String COLLAPSE

See Also:

Constant Field Values

TOGGLE

public static final java.lang.String TOGGLE

See Also:

Constant Field Values

EDIT

public static final java.lang.String EDIT

Events string for editing the connected object. Invokes the method edit().

See Also:

Constant Field Values

Constructor Detail

AbstractTreeNodeChip

public AbstractTreeNodeChip(DisplayState displayState,
                            Chip parent)

Method Detail

isExpanded

public boolean isExpanded()

setExpanded

public void setExpanded(boolean isExpanded)

edit

protected abstract void edit()

Activated by the event string EDIT.

processEvents

public void processEvents(java.util.Map<java.lang.String,java.util.List<java.lang.String>> events)

Description copied from interface: Chip

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

getIcon

public abstract java.lang.String getIcon()

getName

public abstract java.lang.String getName()

hasChildren

public boolean hasChildren()

This implementation has potential for causing slowdowns in the application. It always calls getAllChildren() to answer the question.

initializeChildren

protected abstract java.util.List initializeChildren()

getChildrenInternal

protected java.util.List getChildrenInternal()

Returns:

The internal list of children or NULL if its not initialized by method initializeChildren().

setChildrenInternal

protected void setChildrenInternal(java.util.List children)

getAllChildren

public final java.util.List getAllChildren()

Initializes the set of children getChildrenInternal() if its not done before.

Returns:

List of AbstractTreeNodeChips.

checkValid

public void checkValid()

Implements the calling of checkValid() of all children getChildrenInternal(), but not the handling of invalid children.

Specified by:

checkValid in interface Chip

Overrides:

checkValid in class AbstractChip

isSelected

public boolean isSelected()

isActive

public boolean isActive()

returns whether or not the chip is active inactive chips will be shown with gray icon and grey label default is true