de.hybris.platform.hmc.webchips

Class SocketChip

java.lang.Object

de.hybris.platform.hmc.webchips.AbstractChip

de.hybris.platform.hmc.webchips.SocketChip

All Implemented Interfaces:

Chip, Serializable, Cloneable

public class SocketChip
extends AbstractChip

This is a chip without any own functionality, providing just a socket for a plugin. Its bound to a window via its name. So you can set its content, named here plugin, via the window from any place of your webchips application. If you do not need this functionality you might use a HolderChip. Be aware that an additional name is used here instead of AbstractChip.getID() to provide a programmer readable identifier.

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

Method Summary

Modifier and Type	Method and Description
String	getDisplayParameters() The default implementation returns Null since this feature is not supported by default.
String	getJSPURI() Returns the URI of the JSP that this chip wants to use.
String	getName()
Chip	getPlugin()
boolean	hasPlugin()
void	processEvents(Map events) Should never be called.
void	setPlugin(Chip plugin)

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

addEventListener, checkValid, clearInfoMessages, clone, containsDisplayEvent, createMenuEntriesForJS, dispose, errorQueueEmpty, getClipboard, getCommandID, 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

SocketChip

public SocketChip(DisplayState displayState,
                  Chip parent,
                  String name)

Constructor for creating a socket with no content.

Parameters:

name - The name of the socket which will be used for identifying it by the window.

SocketChip

public SocketChip(DisplayState displayState,
                  Chip parent,
                  String name,
                  Chip initialPlugin)

Constructor for a socket with a initial plugin.

Parameters:

name - The name of the socket which will be used for identifying it by the window.

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()

hasPlugin

public boolean hasPlugin()

getName

public String getName()

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.

getDisplayParameters

public String getDisplayParameters()

Description copied from class: AbstractChip

The default implementation returns Null since this feature is not supported by default.

Specified by:

getDisplayParameters in interface Chip

Overrides:

getDisplayParameters in class AbstractChip

Returns:

Parameters the chip needs to restore its current display status. Currently these parameters are used by the PRG (Post-Redirect-Get Pattern) request, if the user uses back-functionality of the browser.

See Also:

Chip.getDisplayParameters()