de.hybris.platform.hmc.webchips

Class Frame

java.lang.Object

de.hybris.platform.hmc.webchips.AbstractChip

de.hybris.platform.hmc.webchips.Frame

All Implemented Interfaces:

Chip, ExtraParamHandler, Serializable, Cloneable

Direct Known Subclasses:

Window

public class Frame
extends AbstractChip
implements ExtraParamHandler

This chip represents a frame and knows another Chip which will be displayed. Also this chip displays the container frame.jsp which has to be present.
The Frame stores the client frame scroll position. If a user scrolls down a page and clicks a link or submits a form then it might be useful to scroll the new page to the exact same position. This is especially true with a complex user interface and when the requested action does not change the page completely. See getScrollX() and getScrollY().

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	SET_SCROLLDOWNABSOLUTE Deprecated. since 3.0 M2, this field didn't serve any purpose for a long time anyway
static String	SET_SCROLLDOWNRELATIVE Deprecated. since 3.0 M2, this field didn't serve any purpose for a long time anyway
static String	SET_SCROLLX
static String	SET_SCROLLY

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
Frame(DisplayState displayState, Chip parent)
Frame(DisplayState displayState, Chip parent, String frameName)

Method Summary

Modifier and Type	Method and Description
void	checkValid() Delegates the check for validity to getMainChip().
boolean	displayHeader()
static Frame	getCurrent()
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.
Chip	getMainChip() Returns the main chip of this frame.
protected String	getProposedUniqueName()
int	getScrollX() Returns the client side x scroll position.
int	getScrollY() Returns the client side y scroll position.
String	getSystemMessage()
Window	getWindow() Tries to find the surrounding window
void	handleExtraParams(Map extraParams) Implementations of this method should handle and consume the parameters they are capable of handling.
boolean	hasSystemMessage()
boolean	isUpdating()
void	processEvents(Map events) Handles all incoming requests for this chip.
void	refresh() Refreshes the frame using a FrameRefreshEvent.
protected void	revivePreviousMainChip() Uses the predecessor relation to get the previous main chip
protected static void	setCurrent(Frame frame)
void	setDisplayHeader(boolean displayHeader)
void	setMainChip(Chip aChip) Sets the main chip of this frame.
void	setScrollX(int scrollX)
void	setScrollY(int scrollY)
void	setUpdating(boolean isUpdating)
protected static void	unsetCurrent()

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

addEventListener, clearInfoMessages, clone, containsDisplayEvent, createMenuEntriesForJS, dispose, errorQueueEmpty, getClipboard, getCommandID, getDisplayState, getEventID, getEventURL, getEventValue, getFrame, getID, getInfoMessages, getJaloSession, getLocalizedString, getLocalizedString, getLogger, getMenuEntries, getNameSpace, getNameSpaceFor, getParent, getProposedUniqueNameFor, getRequestFocus, getSessionIdentifier, getStringValue, getUniqueName, goFullScreen, hasVisibleContextMenuEntries, isButtonPushed, isButtonPushed, isErrorQueueEmpty, isValid, leaveFullScreen, notifyEventListeners, notifyEventListeners, postErrorMessage, postInfoMessage, postWindowEvent, 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

SET_SCROLLX

public static final String SET_SCROLLX

See Also:

Constant Field Values

SET_SCROLLY

public static final String SET_SCROLLY

See Also:

Constant Field Values

SET_SCROLLDOWNABSOLUTE

@Deprecated
public static final String SET_SCROLLDOWNABSOLUTE

Deprecated. since 3.0 M2, this field didn't serve any purpose for a long time anyway

See Also:

Constant Field Values

SET_SCROLLDOWNRELATIVE

@Deprecated
public static final String SET_SCROLLDOWNRELATIVE

Deprecated. since 3.0 M2, this field didn't serve any purpose for a long time anyway

See Also:

Constant Field Values

Constructor Detail

Frame

public Frame(DisplayState displayState,
             Chip parent,
             String frameName)

Frame

public Frame(DisplayState displayState,
             Chip parent)

Method Detail

setCurrent

protected static final void setCurrent(Frame frame)

getCurrent

public static final Frame getCurrent()

unsetCurrent

protected static final void unsetCurrent()

getMainChip

public Chip getMainChip()

Returns the main chip of this frame. If no mainchip is set, null is returned!

setMainChip

public void setMainChip(Chip aChip)

Sets the main chip of this frame. The main chip will be displayed fullscreen, meaning it can use the complete body.

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

revivePreviousMainChip

protected final void revivePreviousMainChip()

Uses the predecessor relation to get the previous main chip

processEvents

public final 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

isUpdating

public boolean isUpdating()

setUpdating

public void setUpdating(boolean isUpdating)

checkValid

public void checkValid()

Delegates the check for validity to getMainChip().

Specified by:

checkValid in interface Chip

Overrides:

checkValid in class AbstractChip

refresh

public void refresh()

Refreshes the frame using a FrameRefreshEvent. Please note this is overridden in Window.refresh()

Overrides:

refresh in class AbstractChip

getWindow

public Window getWindow()

Description copied from class: AbstractChip

Tries to find the surrounding window

Overrides:

getWindow in class AbstractChip

Returns:

The window of the chip or NULL if the chip is not part of a window.

setScrollX

public void setScrollX(int scrollX)

Since:

3.0 M2

getScrollX

public int getScrollX()

Returns the client side x scroll position. This should be used to scroll the window to the position where it was before the request. The value is set by sending an event using SET_SCROLLX.

setScrollY

public void setScrollY(int scrollY)

Since:

3.0 M2

getScrollY

public int getScrollY()

Returns the client side y scroll position. This should be used to scroll the window to the position where it was before the request. The value is set by sending an event using SET_SCROLLY.

getProposedUniqueName

protected String getProposedUniqueName()

Overrides:

getProposedUniqueName in class AbstractChip

setDisplayHeader

public void setDisplayHeader(boolean displayHeader)

displayHeader

public boolean displayHeader()

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

hasSystemMessage

public boolean hasSystemMessage()

Since:

2.30

getSystemMessage

public String getSystemMessage()

Since:

2.30

handleExtraParams

public void handleExtraParams(Map extraParams)

Description copied from interface: ExtraParamHandler

Implementations of this method should handle and consume the parameters they are capable of handling.
Note: The map extraParams contains [String -> List] mappings.

Specified by:

handleExtraParams in interface ExtraParamHandler

Since:

3.0 M2