de.hybris.platform.hmc

Class AbstractExplorerMenuTreeNodeChip

java.lang.Object

de.hybris.platform.hmc.webchips.AbstractChip

de.hybris.platform.hmc.AbstractTreeNodeChip

de.hybris.platform.hmc.AbstractExplorerMenuTreeNodeChip

All Implemented Interfaces:

AjaxRequestHandler, DisplayRequestHandler, SearchRequestHandler, Chip, Serializable, Cloneable

Direct Known Subclasses:

GenericExplorerMenuTreeNodeChip, TreeLeafChip

public abstract class AbstractExplorerMenuTreeNodeChip
extends AbstractTreeNodeChip
implements DisplayRequestHandler, SearchRequestHandler, AjaxRequestHandler

This is a template for tree nodes in the explorer tree. It allows to add extensions nodes, set the display chip for the content socket, changes the backgroundcolor if selected.

See Also:

Serialized Form

Field Summary

Fields inherited from class de.hybris.platform.hmc.AbstractTreeNodeChip

COLLAPSE, EDIT, EXPAND, 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
AbstractExplorerMenuTreeNodeChip(DisplayState displayState, Chip parent)

Method Summary

Modifier and Type	Method and Description
boolean	canHandleRequest(DisplayRequest request)
boolean	canHandleRequest(SearchRequest request) Implementation of SearchRequestHandler interface.
protected void	edit() Sets the content of the explorer.
protected abstract List	getChildren()
String	getDescription()
protected abstract Chip	getDisplayChip(Chip parent)
String	getJSPURI() Returns the URI of the JSP that this chip wants to use.
protected MenuChip	getMenuChip()
List	getMenuEntries() Here you can specify what Actions you are able to perform at the moment.
void	handleRequest(DisplayRequest request)
void	handleRequest(SearchRequest request) Implementation of SearchRequestHandler interface.
abstract boolean	hasDisplayChip()
List	initializeChildren() Unifiyes the own children and those children given by extensions.
boolean	isSelected()
void	processAjaxEvents(HttpServletRequest request, HttpServletResponse response, PrintWriter out, Map requestParameters)
void	processEvents(Map<String,List<String>> events) Handles all incoming requests for this chip.
protected void	setContent()
void	setDescription(String description)
protected void	setSelected()

Methods inherited from class de.hybris.platform.hmc.AbstractTreeNodeChip

checkValid, getAllChildren, getChildrenInternal, getIcon, getName, hasChildren, isActive, isExpanded, setChildrenInternal, setExpanded

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

Constructor Detail

AbstractExplorerMenuTreeNodeChip

public AbstractExplorerMenuTreeNodeChip(DisplayState displayState,
                                        Chip parent)

Method Detail

isSelected

public boolean isSelected()

Overrides:

isSelected in class AbstractTreeNodeChip

getMenuChip

protected MenuChip getMenuChip()

setContent

protected void setContent()

setSelected

protected void setSelected()

getMenuEntries

public List getMenuEntries()

Description copied from class: AbstractChip

Here you can specify what Actions you are able to perform at the moment. Should be overridden in sub classes.

Specified by:

getMenuEntries in interface Chip

Overrides:

getMenuEntries in class AbstractChip

Returns:

List of MenuEntry

edit

protected void edit()

Sets the content of the explorer. Overwrite this method to invoke other edit actions, activated by the event string AbstractTreeNodeChip.EDIT.

Specified by:

edit in class AbstractTreeNodeChip

processEvents

public void processEvents(Map<String,List<String>> events)

Description copied from interface: Chip

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

Specified by:

processEvents in interface Chip

Overrides:

processEvents in class AbstractTreeNodeChip

getDisplayChip

protected abstract Chip getDisplayChip(Chip parent)

getChildren

protected abstract List getChildren()

initializeChildren

public final List initializeChildren()

Unifiyes the own children and those children given by extensions.

Specified by:

initializeChildren in class AbstractTreeNodeChip

Returns:

List of AbstractExplorerMenuTreeNodeChips.

getJSPURI

public String getJSPURI()

Description copied from interface: Chip

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

Specified by:

getJSPURI in interface Chip

hasDisplayChip

public abstract boolean hasDisplayChip()

canHandleRequest

public boolean canHandleRequest(DisplayRequest request)

Specified by:

canHandleRequest in interface DisplayRequestHandler

handleRequest

public void handleRequest(DisplayRequest request)

Specified by:

handleRequest in interface DisplayRequestHandler

canHandleRequest

public boolean canHandleRequest(SearchRequest request)

Implementation of SearchRequestHandler interface. All children of this chip are asked if they can handle the given request.

Specified by:

canHandleRequest in interface SearchRequestHandler

Parameters:

request - the SearchRequest to be handled

Returns:

true if the given request can be handled by the implementing class

Since:

1.3.1

handleRequest

public void handleRequest(SearchRequest request)

Implementation of SearchRequestHandler interface. The request will be delegated to the first child found which can handle the given request.

Specified by:

handleRequest in interface SearchRequestHandler

Parameters:

request - the SearchRequest to be handled

Since:

1.3.1

getDescription

public String getDescription()

Since:

2.10

setDescription

public void setDescription(String description)

Since:

2.10

processAjaxEvents

public void processAjaxEvents(HttpServletRequest request,
                              HttpServletResponse response,
                              PrintWriter out,
                              Map requestParameters)

Specified by:

processAjaxEvents in interface AjaxRequestHandler

Since:

3.0 (beta1)