de.hybris.platform.hmc.webchips

Class Window

java.lang.Object

de.hybris.platform.hmc.webchips.AbstractChip

de.hybris.platform.hmc.webchips.Frame

de.hybris.platform.hmc.webchips.Window

All Implemented Interfaces:

Chip, ExtraParamHandler, Serializable, Cloneable

Direct Known Subclasses:

FileDownloadWindow

public class Window
extends Frame

This Chip represents a window.

See Also:

Serialized Form

Field Summary

Fields inherited from class de.hybris.platform.hmc.webchips.Frame

SET_SCROLLDOWNABSOLUTE, SET_SCROLLDOWNRELATIVE, SET_SCROLLX, 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
Window(DisplayState displayState, String name)
Window(DisplayState displayState, String name, String backgroundColor)

Method Summary

Modifier and Type	Method and Description
void	close() Closes the window.
String	getBackgroundColor() Returns the background color
String	getName() Returns the name (window title)
Chip	getPlugin(String socketID) Gets the plugin for the socket with the specified socketID.
protected String	getProposedUniqueName()
SocketChip	getSocket(String socketID) Gets the SocketChip for the socket with the specified socketID.
String	getStatus()
void	open(int width, int height) Opens the window with a specified size.
void	open(int width, int height, int xOffset, int yOffset) Opens the window with a specified size and offset.
void	open(WindowOpenEvent windowOpenEvent) Opens the window using the given window event.
void	redirect(String url) Redirects the window to another URL.
void	refresh() Refreshs the Window using a WindowRefreshEvent.
void	registerSocketChip(String id, SocketChip chip) Registers a new socket at this window.
void	setBackgroundColor(String color) Sets the color which is then used as the window background color.
void	setName(String name) Sets the name which is then used as the window title in the browser.
void	setPlugin(String socketID, Chip plugin) Sets a new plugin for the socket with the specified socketID.
protected void	setStatus(String value)

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

checkValid, displayHeader, getCurrent, getDisplayParameters, getJSPURI, getMainChip, getScrollX, getScrollY, getSystemMessage, getWindow, handleExtraParams, hasSystemMessage, isUpdating, processEvents, revivePreviousMainChip, setCurrent, setDisplayHeader, setMainChip, setScrollX, setScrollY, setUpdating, 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

Constructor Detail

Window

public Window(DisplayState displayState,
              String name)

Window

public Window(DisplayState displayState,
              String name,
              String backgroundColor)

Method Detail

open

public void open(int width,
                 int height,
                 int xOffset,
                 int yOffset)

Opens the window with a specified size and offset.

Parameters:

width - The width in pixels of the open window.

height - The height in pixels of the open window.

xOffset - the x offset relative to the parent window

yOffset - the y offset relative to the parent window

Since:

2.10

open

public void open(int width,
                 int height)

Opens the window with a specified size.

Parameters:

width - The width in pixels of the open window.

height - The height in pixels of the open window.

open

public void open(WindowOpenEvent windowOpenEvent)

Opens the window using the given window event.

Parameters:

windowOpenEvent - The event which will be posted in order to create the new window.

close

public void close()

Closes the window.

redirect

public void redirect(String url)

Redirects the window to another URL.

Parameters:

url - The URL which should be displayed in the window.

setName

public void setName(String name)

Sets the name which is then used as the window title in the browser.

getName

public String getName()

Returns the name (window title)

setBackgroundColor

public void setBackgroundColor(String color)

Sets the color which is then used as the window background color.

getBackgroundColor

public String getBackgroundColor()

Returns the background color

getProposedUniqueName

protected String getProposedUniqueName()

Overrides:

getProposedUniqueName in class Frame

registerSocketChip

public void registerSocketChip(String id,
                               SocketChip chip)

Registers a new socket at this window.

Parameters:

id - The unique identifier for the socket to register.

setPlugin

public void setPlugin(String socketID,
                      Chip plugin)

Sets a new plugin for the socket with the specified socketID.

Parameters:

socketID - specifies the socket which plugin should be changed.

Throws:

RuntimeException - If there doesnt exist a socket with the specfied id.

getPlugin

public Chip getPlugin(String socketID)

Gets the plugin for the socket with the specified socketID.

Parameters:

socketID - specifies the socket which plugin should be changed.

getSocket

public SocketChip getSocket(String socketID)

Gets the SocketChip for the socket with the specified socketID.

Parameters:

socketID - specifies the socket which plugin should be changed.

refresh

public void refresh()

Refreshs the Window using a WindowRefreshEvent.

Overrides:

refresh in class Frame

setStatus

protected void setStatus(String value)

getStatus

public String getStatus()