com.sencha.gxt.widget.core.client

Class Dialog

java.lang.Object

Widget

com.sencha.gxt.widget.core.client.Component

com.sencha.gxt.widget.core.client.container.Container

com.sencha.gxt.widget.core.client.container.ResizeContainer

com.sencha.gxt.widget.core.client.container.SimpleContainer

com.sencha.gxt.widget.core.client.ContentPanel

com.sencha.gxt.widget.core.client.Window

com.sencha.gxt.widget.core.client.Dialog

All Implemented Interfaces:

HasGestureRecognizers, Collapsible, HasLayout, ActivateEvent.HasActivateHandlers<Window>, AddEvent.HasAddHandlers, BeforeAddEvent.HasBeforeAddHandlers, BeforeCollapseEvent.HasBeforeCollapseHandlers, BeforeExpandEvent.HasBeforeExpandHandlers, BeforeHideEvent.HasBeforeHideHandlers, BeforeRemoveEvent.HasBeforeRemoveHandlers, BeforeShowContextMenuEvent.HasBeforeShowContextMenuHandler, BeforeShowEvent.HasBeforeShowHandlers, BlurEvent.HasBlurHandlers, CollapseEvent.HasCollapseHandlers, ContainerHandler.HasContainerHandlers, DeactivateEvent.HasDeactivateHandlers<Window>, DialogHideEvent.HasDialogHideHandlers, DisableEvent.HasDisableHandlers, EnableEvent.HasEnableHandlers, ExpandEvent.HasExpandHandlers, FocusEvent.HasFocusHandlers, HideEvent.HasHideHandlers, MaximizeEvent.HasMaximizeHandlers, MinimizeEvent.HasMinimizeHandlers, MoveEvent.HasMoveHandlers, RemoveEvent.HasRemoveHandlers, RestoreEvent.HasRestoreHandlers, ShowContextMenuEvent.HasShowContextMenuHandler, ShowEvent.HasShowHandlers, HasFocusSupport, HasItemId

Direct Known Subclasses:

MessageBox

public class Dialog
extends Window
implements DialogHideEvent.HasDialogHideHandlers

A Window with specialized support for buttons. Defaults to a dialog with an 'ok' button.

Code snippet:

 Dialog d = new Dialog();
 d.setHeading("Exit Warning!");
 d.setWidget(new HTML("Do you wish to save before exiting?"));
 d.setBodyStyle("fontWeight:bold;padding:13px;");
 d.setPixelSize(300, 100);
 d.setHideOnButtonClick(true);
 d.setPredefinedButtons(PredefinedButton.YES, PredefinedButton.NO, PredefinedButton.CANCEL);
 d.show();
 

To check which button is clicked using the basic MVP pattern, add a SelectEvent.HasSelectHandlers or DialogHideEvent.HasDialogHideHandlers method to the view's display interface defined by the presenter:

 public interface Display extends IsWidget {
   HasSelectHandlers getYesButton();
   HasDialogHideHandlers getDialog();
 }
 

Add an implementation of the method(s) to the view:

  @Override
 public HasSelectHandlers getYesButton() {
   return dialog.getButton(PredefinedButton.YES);
 }

  @Override
 public HasDialogHideHandlers getDialog() {
   return dialog;
 }
 

And add a handler for the method(s) to the presenter:

   display.getYesButton().addSelectHandler(new SelectHandler() {
      @Override
     public void onSelect(SelectEvent event) {
       // Take action when user hides dialog by clicking on YES button
     }
   });
   
   display.getDialog().addDialogHideHandler(new DialogHideHandler() {
      @Override
     public void onDialogHide(DialogHideEvent event) {
       // Invoke event.getHideButton() and take action based on value of returned enum
     }
   });
 

Note: this example illustrates using both a select handler and a dialog hide handler; you can use either approach.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	Dialog.DefaultDialogMessages
static interface	Dialog.DialogMessages The translatable strings (e.g.
static class	Dialog.PredefinedButton The predefined buttons supported by this dialog window.

Nested classes/interfaces inherited from class com.sencha.gxt.widget.core.client.Window

Window.DefaultWindowMessages, Window.WindowAppearance, Window.WindowMessages

Nested classes/interfaces inherited from class com.sencha.gxt.widget.core.client.ContentPanel

ContentPanel.ContentPanelAppearance, ContentPanel.ContentPanelMessages, ContentPanel.DefaultContentPanelMessages, ContentPanel.PanelHeaderAppearance

Field Summary

Fields inherited from class com.sencha.gxt.widget.core.client.Window

ariaMoveResizeDistance, closeBtn, dragger, manager, removeFromParentOnHide, restoreBtn

Fields inherited from class com.sencha.gxt.widget.core.client.ContentPanel

buttonBar, header, secondPassRequired

Fields inherited from class com.sencha.gxt.widget.core.client.container.SimpleContainer

resize, widget

Fields inherited from class com.sencha.gxt.widget.core.client.container.ResizeContainer

forceLayoutCommand, forceLayoutOnResize, hadLayoutRunning, layoutCommand, layoutRequiredThisEventLoop, layoutRunning

Fields inherited from class com.sencha.gxt.widget.core.client.Component

adjustSize, allowTextSelection, cacheSizes, disableContextMenu, disabled, disabledStyle, ensureVisibilityOnSizing, height, hidden, lastSize, layer, left, mask, maskMessage, monitorWindowResize, pageX, pageY, shim, tabIndex, toolTip, toolTipConfig, top, width, windowResizeDelay, windowResizeTask

Constructor Summary

Constructors

Constructor and Description
Dialog() Creates a dialog window with default appearance.
Dialog(Window.WindowAppearance appearance) Creates a dialog window with the specified appearance.

Method Summary

Modifier and Type	Method and Description
HandlerRegistration	addDialogHideHandler(DialogHideEvent.DialogHideHandler handler) Adds a DialogHideEvent.DialogHideHandler handler for DialogHideEvent events.
protected void	createButtons() Creates the buttons based on button creation constant
TextButton	getButton(Dialog.PredefinedButton predefinedButton) Returns the text button associated with the specified predefined button.
Dialog.DialogMessages	getDialogMessages() Returns the translatable strings (e.g.
Dialog.PredefinedButton	getPredefinedButton(TextButton textButton) Returns the predefined button associated with the specified text button or null if no predefined button is associated with the text button.
List<Dialog.PredefinedButton>	getPredefinedButtons() Returns the buttons that are currently configured for this dialog window.
protected String	getText(Dialog.PredefinedButton button)
void	hide() Hide this widget.
boolean	isHideOnButtonClick() Returns true if the dialog will be hidden on any button click.
protected void	onButtonPressed(TextButton textButton) Called after a button in the button bar is selected.
void	setDialogMessages(Dialog.DialogMessages dialogMessages) Sets the translatable strings (e.g.
void	setHideOnButtonClick(boolean hideOnButtonClick) True to hide the dialog on any button click.
void	setPredefinedButtons(Dialog.PredefinedButton... buttons) Sets the predefined buttons to display (defaults to OK).

Methods inherited from class com.sencha.gxt.widget.core.client.Window

addActivateHandler, addDeactivateHandler, addMaximizeHandler, addMinimizeHandler, addRestoreHandler, afterShow, alignTo, center, createGhost, doFocus, doLayout, fitContainer, focus, getAppearance, getConstrain, getContainer, getDraggable, getFocusWidget, getMinHeight, getMinWidth, getModalPanel, getResizable, getWindowMessages, ghost, initTools, isAutoHide, isBlinkModal, isClosable, isDraggable, isMaximizable, isMaximized, isMinimizable, isModal, isOnEsc, isResizable, maximize, minimize, onAfterFirstAttach, onBrowserEvent, onDetach, onDragCancel, onDragEnd, onDragMove, onDragStart, onEndResize, onKeyPress, onStartResize, onWindowResize, restore, setActive, setAutoHide, setBlinkModal, setClosable, setConstrain, setContainer, setDraggable, setFocusWidget, setMaximizable, setMinHeight, setMinimizable, setMinWidth, setModal, setOnEsc, setPagePosition, setPosition, setResizable, setWindowMessages, setZIndex, show, showWindow, toBack, toFront, unghost

Methods inherited from class com.sencha.gxt.widget.core.client.ContentPanel

addBeforeCollapseHandler, addBeforeExpandHandler, addButton, addCollapseHandler, addExpandHandler, addTool, adjustBodySize, afterCollapse, afterExpand, collapse, doAttachChildren, doDetachChildren, doLayoutButtonBar, expand, forceLayout, getAnimationDuration, getBody, getButtonAlign, getButtonBar, getContainerTarget, getFrameSize, getHeader, getHeading, getMessages, getMinButtonWidth, isAnimCollapse, isCollapsed, isCollapsible, isExpanded, isHideCollapseTool, isTitleCollapse, layoutBars, onClick, onCollapse, onDisable, onEnable, onExpand, onResize, setAnimationDuration, setAnimCollapse, setBodyBorder, setBodyStyle, setBodyStyleName, setButtonAlign, setCollapsible, setExpanded, setHeaderVisible, setHeading, setHideCollapseTool, setMessages, setMinButtonWidth, setTitleCollapse

Methods inherited from class com.sencha.gxt.widget.core.client.container.SimpleContainer

add, add, getWidget, isResize, onRemove, setElement, setResize, setWidget, setWidget

Methods inherited from class com.sencha.gxt.widget.core.client.container.ResizeContainer

applyLayout, applyLayout, forceLayoutOnChildren, forceLayoutOnChildren, getLeftRightMargins, getParentLayoutWidget, getSideMargins, getTopBottomMargins, isLayoutRunning, isOrWasLayoutRunning, isWidgetVisible, onBeforeDoLayout, onLoad, onResize

Methods inherited from class com.sencha.gxt.widget.core.client.container.Container

addAddHandler, addBeforeAddHandler, addBeforeRemoveHandler, addContainerHandler, addRemoveHandler, adjustIndex, adopt, checkIndexBoundsForInsertion, clear, disable, doPhysicalAttach, doPhysicalDetach, enable, ensureGroupingHandlerRegistration, findWidget, getChildren, getItemByItemId, getWidget, getWidgetCount, getWidgetIndex, getWidgetIndex, insert, iterator, onInsert, onWidgetHide, onWidgetShow, orphan, remove, remove, remove

Methods inherited from class com.sencha.gxt.widget.core.client.Component

addBeforeHideHandler, addBeforeShowContextMenuHandler, addBeforeShowHandler, addBlurHandler, addDisableHandler, addEnableHandler, addFocusHandler, addGestureRecognizer, addHideHandler, addMoveHandler, addResizeHandler, addShowContextMenuHandler, addShowHandler, addStyleDependentName, addStyleOnOver, adjustPosition, adjustSize, applyState, assertAfterRender, assertPreRender, blur, clearSizeCache, disableContextMenu, disableEvents, enableEvents, fireCancellableEvent, fireEvent, getData, getElement, getFocusEl, getFocusSupport, getGestureRecognizer, getGestureRecognizerCount, getHideMode, getId, getItemId, getOffsetHeight, getOffsetWidth, getPositionEl, getShadow, getShadowPosition, getStateId, getTabIndex, getToolTip, hideShadow, hideToolTip, isAllowTextSelection, isAutoHeight, isAutoWidth, isDeferHeight, isEnabled, isMonitorWindowResize, isRendered, isStateful, isVisible, isVisible, mask, mask, notifyHide, notifyShow, onAttach, onBlur, onFocus, onHide, onHideContextMenu, onPosition, onRightClick, onShow, onShowContextMenu, onTouch, onUnload, removeStyleDependentName, removeStyleOnOver, removeToolTip, setAllowTextSelection, setBorders, setBounds, setBounds, setContextMenu, setData, setDeferHeight, setEnabled, setHeight, setHeight, setHideMode, setId, setItemId, setMonitorWindowResize, setPixelSize, setShadow, setShadowPosition, setSize, setStateful, setStateId, setStyleDependentName, setTabIndex, setToolTip, setToolTipConfig, setVisible, setWidth, setWidth, sync, syncSize, unmask

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Dialog

public Dialog()

Creates a dialog window with default appearance.

Dialog

public Dialog(Window.WindowAppearance appearance)

Creates a dialog window with the specified appearance.

Parameters:

appearance - the dialog window appearance

Method Detail

addDialogHideHandler

public HandlerRegistration addDialogHideHandler(DialogHideEvent.DialogHideHandler handler)

Description copied from interface: DialogHideEvent.HasDialogHideHandlers

Adds a DialogHideEvent.DialogHideHandler handler for DialogHideEvent events.

Specified by:

addDialogHideHandler in interface DialogHideEvent.HasDialogHideHandlers

Parameters:

handler - the handler

Returns:

the registration for the event

getButton

public TextButton getButton(Dialog.PredefinedButton predefinedButton)

Returns the text button associated with the specified predefined button.

Parameters:

predefinedButton - the predefined button

Returns:

the text button associated with the predefined button, or null if the predefined button has not been added to the dialog box (see setPredefinedButtons(PredefinedButton...)).

getDialogMessages

public Dialog.DialogMessages getDialogMessages()

Returns the translatable strings (e.g. button text and ToolTips) for the dialog window.

Returns:

the translatable strings for the dialog window

getPredefinedButton

public Dialog.PredefinedButton getPredefinedButton(TextButton textButton)

Returns the predefined button associated with the specified text button or null if no predefined button is associated with the text button.

Parameters:

textButton - the text button to look up

Returns:

the associated predefined button

getPredefinedButtons

public List<Dialog.PredefinedButton> getPredefinedButtons()

Returns the buttons that are currently configured for this dialog window.

Returns:

the buttons the buttons

hide

public void hide()

Description copied from class: Component

Hide this widget.

Overrides:

hide in class Window

isHideOnButtonClick

public boolean isHideOnButtonClick()

Returns true if the dialog will be hidden on any button click.

Returns:

the hide on button click state

setDialogMessages

public void setDialogMessages(Dialog.DialogMessages dialogMessages)

Sets the translatable strings (e.g. button text and ToolTips) for the dialog window.

Parameters:

dialogMessages - the translatable strings

setHideOnButtonClick

public void setHideOnButtonClick(boolean hideOnButtonClick)

True to hide the dialog on any button click.

Parameters:

hideOnButtonClick - true to hide

setPredefinedButtons

public void setPredefinedButtons(Dialog.PredefinedButton... buttons)

Sets the predefined buttons to display (defaults to OK). Can be any combination of:

 Dialog.PredefinedButton.OK
 Dialog.PredefinedButton.CANCEL
 Dialog.PredefinedButton.CLOSE
 Dialog.PredefinedButton.YES
 Dialog.PredefinedButton.NO
 

Parameters:

buttons - the buttons to display

createButtons

protected void createButtons()

Creates the buttons based on button creation constant

getText

protected String getText(Dialog.PredefinedButton button)

onButtonPressed

protected void onButtonPressed(TextButton textButton)

Called after a button in the button bar is selected. If setHideOnButtonClick(boolean) is true, hides the dialog when any button is pressed.

Parameters:

textButton - the button