de.hybris.platform.hmc

Class MenuChip

java.lang.Object

de.hybris.platform.hmc.webchips.AbstractChip

de.hybris.platform.hmc.MenuChip

All Implemented Interfaces:

DisplayRequestHandler, SearchRequestHandler, Chip, Serializable, Cloneable

public class MenuChip
extends AbstractChip
implements DisplayRequestHandler, SearchRequestHandler

This is the chip for the top hirarchy.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	HOME
static String	MENU
static String	SCROLLX
static String	SCROLLY
static String	TREE

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

Method Summary

Modifier and Type	Method and Description
boolean	canHandleRequest(DisplayRequest request)
boolean	canHandleRequest(SearchRequest request) Implementation of SearchRequestHandler interface.
void	checkValid() Gives the chip the possibility to check if its objects are still valid.
String	getJSPURI() Returns the URI of the JSP that this chip wants to use.
GenericExplorerMenuTreeNodeContentChip	getMenuContentChip()
List	getRootChips() Return all root chips.
int	getScrollX()
int	getScrollY()
Chip	getSelected()
String	getUserName() Returns the name of the current session user.
void	handleRequest(DisplayRequest request)
void	handleRequest(SearchRequest request) Implementation of SearchRequestHandler interface.
boolean	isChildSelected(Chip chip)
boolean	isHomeSelected()
boolean	isSelected(Chip chip)
void	processEvents(Map events) Handles all incoming requests for this chip.
void	setSelected(Chip chip)

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

Field Detail

TREE

public static final String TREE

See Also:

Constant Field Values

MENU

public static final String MENU

See Also:

Constant Field Values

SCROLLX

public static final String SCROLLX

See Also:

Constant Field Values

SCROLLY

public static final String SCROLLY

See Also:

Constant Field Values

HOME

public static final String HOME

See Also:

Constant Field Values

Constructor Detail

MenuChip

public MenuChip(DisplayState displayState,
                Chip parent)

Method Detail

getMenuContentChip

public GenericExplorerMenuTreeNodeContentChip getMenuContentChip()

getRootChips

public List getRootChips()

Return all root chips.

Returns:

List of Root-Chips

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)

Specified by:

processEvents in interface Chip

getScrollX

public int getScrollX()

getScrollY

public int getScrollY()

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

getUserName

public String getUserName()

Returns the name of the current session user. If the name is null, the login of the current session user is returned as a fallback.

Returns:

the name of the current session user. If the name is null, the login of the current session user is returned as a fallback

isSelected

public boolean isSelected(Chip chip)

setSelected

public void setSelected(Chip chip)

getSelected

public Chip getSelected()

isHomeSelected

public boolean isHomeSelected()

Since:

3.00

isChildSelected

public boolean isChildSelected(Chip chip)

checkValid

public void checkValid()

Description copied from class: AbstractChip

Gives the chip the possibility to check if its objects are still valid. If you override this method, call super.checkValid()

Specified by:

checkValid in interface Chip

Overrides:

checkValid in class AbstractChip

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. Returns true if one of the treenodes can handle the given request.

Specified by:

canHandleRequest in interface SearchRequestHandler

Parameters:

request - the SearchRequest to be handled

Returns:

true if one of the treenodes can handle the given request.

Since:

1.3.1

handleRequest

public void handleRequest(SearchRequest request)

Implementation of SearchRequestHandler interface. Delegates the given search request to the first treenode that can handle it.

Specified by:

handleRequest in interface SearchRequestHandler

Parameters:

request - the SearchRequest to be handled

Since:

1.3.1