de.hybris.platform.hmc.util

Class DialogContainerChip

java.lang.Object

de.hybris.platform.hmc.webchips.AbstractChip

de.hybris.platform.hmc.util.DialogContainerChip

All Implemented Interfaces:

Chip, Serializable, Cloneable

Direct Known Subclasses:

ActionDialogContainerChip

public class DialogContainerChip
extends AbstractChip

This class provides a standard dialog container. It has one button to close the window. By providing own dialog jsp's (using setDialogChip(DialogChip) you can fill this container window with content as you like. Since there is only one button in this container, the content will most likely be only a simple message or information (you can use the SimpleMessageDialogChip if you like). More sophisticated dialog container chips should extend this class (like the ActionDialogContainerChip does).

Since:

2.10

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLOSE

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
DialogContainerChip(Window callingWindow) Creates a new DialogContainerChip.

Method Summary

Modifier and Type	Method and Description
Window	getCallingWindow()
String	getCloseButtonName() Returns the name of the close button in this dialog (which will be used as a localization key!).
DialogChip	getDialogChip()
protected String	getDialogSize()
String	getJSPURI() Returns the URI of the JSP that this chip wants to use.
String	getName() Returns the name of this container chip which will be used as the title of the surrounding window (it will be used as a localization key).
void	processEvents(Map events) Processes the close button event: The dialog chip in this container will be notified via DialogChip.notifyClose(), the calling window will be refreshed and then this dialog window will be closed.
void	refreshCallingWindow()
void	setCallingWindow(Window callingWindow)
void	setCloseButtonName(String buttonName) Sets the name of the close button in this dialog (which will be used as a localization key!).
void	setDialogChip(DialogChip dialogChip)
void	setName(String name) Sets the name of this container chip which will be used as the title of the surrounding window (it will be used as a localization key).
void	show() Opens a new window containing this dialog container and its embedded dialog chip.

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

addEventListener, checkValid, 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

CLOSE

public static final String CLOSE

See Also:

Constant Field Values

Constructor Detail

DialogContainerChip

public DialogContainerChip(Window callingWindow)

Creates a new DialogContainerChip. If the calling window is set it will be refreshed when the 'close' button is pressed.

Parameters:

callingWindow - the Window by which this dialog has been created

Method Detail

processEvents

public void processEvents(Map events)

Processes the close button event:
The dialog chip in this container will be notified via DialogChip.notifyClose(), the calling window will be refreshed and then this dialog window will be closed.

show

public void show()

Opens a new window containing this dialog container and its embedded dialog chip.

getJSPURI

public String getJSPURI()

Description copied from interface: Chip

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

getDialogChip

public DialogChip getDialogChip()

setDialogChip

public void setDialogChip(DialogChip dialogChip)

getCallingWindow

public Window getCallingWindow()

setCallingWindow

public void setCallingWindow(Window callingWindow)

refreshCallingWindow

public void refreshCallingWindow()

getDialogSize

protected String getDialogSize()

getName

public String getName()

Returns the name of this container chip which will be used as the title of the surrounding window (it will be used as a localization key).

Returns:

the name of this container chip

setName

public void setName(String name)

Sets the name of this container chip which will be used as the title of the surrounding window (it will be used as a localization key).

Parameters:

name - the localization key of the name of this dialog container chip

getCloseButtonName

public String getCloseButtonName()

Returns the name of the close button in this dialog (which will be used as a localization key!).

Returns:

Returns the buttonName.

setCloseButtonName

public void setCloseButtonName(String buttonName)

Sets the name of the close button in this dialog (which will be used as a localization key!). The name will default to 'close' if not set implicitly, but sometimes it may be more appropriate to use something like 'ok', for example.

Parameters:

buttonName - The buttonName to set.