de.hybris.platform.hmc.webchips

Class HolderChip

java.lang.Object

de.hybris.platform.hmc.webchips.AbstractChip

de.hybris.platform.hmc.webchips.HolderChip

All Implemented Interfaces:

Chip, Serializable, Cloneable

Direct Known Subclasses:

NamedHolderChip

public class HolderChip
extends AbstractChip

This is a chip without any own functionality, providing just a socket for a plugin. It is different from the SocketChip in that it is not associated with a name. This is just a dumb socket which can hold another chip as plugin.

See Also:

Serialized Form

Field Summary

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
HolderChip(DisplayState displayState, Chip parent) Constructor for creating a socket with no content.
HolderChip(DisplayState displayState, Chip parent, Chip initialPlugin) Constructor for a socket with a initial plugin.

Method Summary

Modifier and Type	Method and Description
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.
Chip	getPlugin()
void	processEvents(Map events) Should never be called.
void	setPlugin(Chip plugin)

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

Constructor Detail

HolderChip

public HolderChip(DisplayState displayState,
                  Chip parent)

Constructor for creating a socket with no content.

HolderChip

public HolderChip(DisplayState displayState,
                  Chip parent,
                  Chip initialPlugin)

Constructor for a socket with a initial plugin.

Parameters:

initialPlugin - The plugin which will be registered initially.

Method Detail

setPlugin

public void setPlugin(Chip plugin)

Parameters:

plugin - Can never be NULL.

Throws:

RuntimeException - If parameter plugin is NULL.

getPlugin

public Chip getPlugin()

getJSPURI

public String getJSPURI()

Description copied from interface: Chip

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

processEvents

public void processEvents(Map events)

Should never be called.

Throws:

RuntimeException - If its invoked.

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