com.extjs.gxt.ui.client.widget
Class Dialog

java.lang.Object
  extended by com.google.gwt.user.client.ui.UIObject
      extended by com.google.gwt.user.client.ui.Widget
          extended by com.extjs.gxt.ui.client.widget.Component
              extended by com.extjs.gxt.ui.client.widget.BoxComponent
                  extended by com.extjs.gxt.ui.client.widget.Container<T>
                      extended by com.extjs.gxt.ui.client.widget.ScrollContainer<Component>
                          extended by com.extjs.gxt.ui.client.widget.LayoutContainer
                              extended by com.extjs.gxt.ui.client.widget.ContentPanel
                                  extended by com.extjs.gxt.ui.client.widget.Window
                                      extended by com.extjs.gxt.ui.client.widget.Dialog
All Implemented Interfaces:
Observable, IconSupport, com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.IsWidget

public class Dialog
extends Window

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.addText("Do you wish to save before exiting?");
 d.setBodyStyle("fontWeight:bold;padding:13px;");
 d.setSize(300, 100);
 d.setHideOnButtonClick(true);
 d.setButtons(Dialog.YESNOCANCEL);
 d.show();
 

The internal buttons can be retrieved from the button bar using their respective ids ('ok', 'cancel', 'yes', 'no', 'cancel') or by index. The method ContentPanel.getButtonBar() creates the buttons, so any call before the dialog is rendered will cause the buttons to be created based on the setButtons(String) value.

Inherited Events:
Window Activate
Window Deactivate
Window Minimize
Window Maximize
Window Restore
Window Resize
ContentPanel BeforeExpand
ContentPanel Expand
ContentPanel BeforeCollapse
ContentPanel Collapse
ContentPanel BeforeClose
ContentPanel Close
LayoutContainer AfterLayout
ScrollContainer Scroll
Container BeforeAdd
Container Add
Container BeforeRemove
Container Remove
BoxComponent Move
BoxComponent Resize
Component Enable
Component Disable
Component BeforeHide
Component Hide
Component BeforeShow
Component Show
Component Attach
Component Detach
Component BeforeRender
Component Render
Component BrowserEvent
Component BeforeStateRestore
Component StateRestore
Component BeforeStateSave
Component SaveState


Nested Class Summary
 
Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject
com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled
 
Field Summary
static java.lang.String CANCEL
          Button constant that displays a single CANCEL button.
 java.lang.String cancelText
          The Cancel button text (defaults to 'Cancel').
static java.lang.String CLOSE
          Button constant that displays a single CLOSE button.
 java.lang.String closeText
          The Close button text (defaults to 'Close').
static java.lang.String NO
          Button constant for the itemId of a NO button.
 java.lang.String noText
          The No button text (defaults to 'No').
static java.lang.String OK
          Button constant that displays a single OK button.
static java.lang.String OKCANCEL
          Button constant that displays a OK and CANCEL button.
 java.lang.String okText
          The OK button text (defaults to 'OK');
static java.lang.String YES
          Button constant for the itemId of a YES button.
static java.lang.String YESNO
          Button constant that displays a YES and NO button.
static java.lang.String YESNOCANCEL
          Button constant that displays a YES, NO, and CANCEL button.
 java.lang.String yesText
          The Yes button text (defaults to 'Yes').
 
Fields inherited from class com.extjs.gxt.ui.client.widget.Window
ariaMoveResizeDistance, closeBtn, dragger, manager, removeFromParentOnHide, restoreBtn
 
Fields inherited from class com.extjs.gxt.ui.client.widget.ContentPanel
bbarStyle, bodStyle, body, bwrap, bwrapStyle, collapseStyle, fbar, footerStyle, frame, head, headerStyle, headerTextStyle, tbarStyle
 
Fields inherited from class com.extjs.gxt.ui.client.widget.Container
attachChildren, enableLayout, layoutExecuted, layoutNeeded, layoutOnAttach, layoutOnChange
 
Fields inherited from class com.extjs.gxt.ui.client.widget.BoxComponent
adjustSize, cacheSizes, ensureVisibilityOnSizing, height, lastSize, layer, shim, width
 
Fields inherited from class com.extjs.gxt.ui.client.widget.Component
afterRender, attachables, baseStyle, disabled, disabledStyle, disableTextSelection, dummy, focusable, hidden, mask, maskMessage, maskMessageStyleName, monitorWindowResize, rendered, resizeHandler, setElementRender, stateId, swallowEvents, toolTip, windowResizeDelay, windowResizeTask
 
Fields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX
 
Constructor Summary
Dialog()
           
 
Method Summary
protected  void createButtons()
          Creates the buttons based on button creation constant
 Button getButtonById(java.lang.String string)
           
 java.lang.String getButtons()
          Returns the button's.
 boolean isHideOnButtonClick()
          Returns true if the dialog will be hidden on any button click.
protected  void onButtonPressed(Button button)
          Called after a button in the button bar is selected.
 void setButtons(java.lang.String buttons)
          Sets the buttons to display (defaults to OK).
 void setHideOnButtonClick(boolean hideOnButtonClick)
          True to hide the dialog on any button click.
 
Methods inherited from class com.extjs.gxt.ui.client.widget.Window
addWindowListener, afterShow, alignTo, center, close, close, createComponentEvent, createGhost, doFocus, endDrag, fitContainer, focus, getConstrain, getContainer, getDraggable, getFocusWidget, getInitialWidth, getMinHeight, getMinWidth, getModalPanel, getResizable, ghost, hide, hide, initTools, isAutoHide, isBlinkModal, isClosable, isDraggable, isMaximizable, isMaximized, isMinimizable, isModal, isOnEsc, isPlain, isResizable, maximize, minimize, moveDrag, onComponentEvent, onDetach, onEndResize, onFocus, onHide, onKeyPress, onRender, onStartResize, onWindowResize, removeWindowListener, restore, setActive, setAutoHide, setBlinkModal, setClosable, setConstrain, setContainer, setDraggable, setFocusWidget, setHeading, setInitialWidth, setMaximizable, setMinHeight, setMinimizable, setMinWidth, setModal, setOnEsc, setPagePosition, setPlain, setPosition, setResizable, setZIndex, show, showWindow, startDrag, toBack, toFront, unghost
 
Methods inherited from class com.extjs.gxt.ui.client.widget.ContentPanel
addButton, adjustBodySize, afterCollapse, afterExpand, collapse, createStyles, doAttachChildren, doDetachChildren, expand, getAnimCollapse, getBody, getBodyBorder, getBodyStyle, getBottomComponent, getButtonAlign, getButtonBar, getCollapseBtn, getCollapsible, getElement, getFrame, getFrameHeight, getFrameSize, getFrameWidth, getHeader, getHeading, getIcon, getInnerHeight, getInnerWidth, getLayoutTarget, getMinButtonWidth, getTitleCollapse, getTitleText, getTopComponent, isCollapsed, isExpanded, isFooter, isHeaderVisible, isHideCollapseTool, layoutBars, notifyHide, notifyShow, onClick, onCollapse, onDisable, onEnable, onExpand, onResize, remove, setAnimCollapse, setBodyBorder, setBodyStyle, setBodyStyleName, setBottomComponent, setButtonAlign, setCollapsible, setExpanded, setFooter, setFrame, setHeaderVisible, setHideCollapseTool, setIcon, setIconStyle, setInsetBorder, setMinButtonWidth, setTitleCollapse, setTopComponent, setUrl
 
Methods inherited from class com.extjs.gxt.ui.client.widget.LayoutContainer
add, add, addText, findComponent, getLayout, getWindowResizeDelay, insert, insert, isLayoutOnChange, isMonitorWindowResize, layout, layout, onBlur, remove, removeAll, setLayout, setLayoutData, setLayoutOnChange, setMonitorWindowResize, setWindowResizeDelay
 
Methods inherited from class com.extjs.gxt.ui.client.widget.ScrollContainer
addScrollListener, afterRender, getHScrollPosition, getScrollMode, getVScrollPosition, removeScrollListener, scrollIntoView, setHScrollPosition, setScrollMode, setVScrollPosition
 
Methods inherited from class com.extjs.gxt.ui.client.widget.Container
add, adjustIndex, adopt, createContainerEvent, disable, doLayout, doLayout, enable, findItem, getItem, getItemByItemId, getItemCount, getItems, getWidget, indexOf, insert, isLayoutNeeded, iterator, onAfterLayout, onAttach, onBeforeLayoutExcecuted, onInsert, onLayoutExcecuted, onRemove, orphan, remove, removeAll, scrollIntoView, setLayoutNeeded, wrapWidget
 
Methods inherited from class com.extjs.gxt.ui.client.widget.BoxComponent
adjustPosition, adjustSize, getBounds, getHeight, getHeight, getPosition, getPositionEl, getResizeEl, getShadow, getShadowOffset, getShadowPosition, getSize, getWidth, getWidth, hideShadow, hideShim, hideUnders, isAutoHeight, isAutoWidth, isDeferHeight, isShim, onPosition, onShow, onUnload, setAutoHeight, setAutoWidth, setBounds, setBounds, setDeferHeight, setHeight, setHeight, setPagePosition, setPixelSize, setShadow, setShadowOffset, setShadowPosition, setShim, setSize, setSize, setWidth, setWidth, sync, syncSize
 
Methods inherited from class com.extjs.gxt.ui.client.widget.Component
addAttachable, addListener, addPlugin, addStyleName, addStyleOnOver, addWidgetListener, applyState, assertAfterRender, assertPreRender, beforeRender, blur, clearState, createObservable, disableContextMenu, disableEvents, disableTextSelection, el, enableEvents, fireEvent, fireEvent, fireEvent, fly, frame, getAriaSupport, getBaseStyle, getBorders, getContextMenu, getData, getElement, getFocusEl, getFocusSupport, getHideMode, getId, getItemId, getListeners, getModel, getObservable, getPlugins, getState, getStateId, getTabIndex, getTitle, getToolTip, hasListeners, hasListeners, hideToolTip, initState, isDisabledEvents, isDisableTextSelection, isEnabled, isMasked, isRendered, isStateful, isVisible, isVisible, mask, mask, mask, onBrowserEvent, onDetachHelper, onEnsureDebugId, onHideContextMenu, onLoad, onRightClick, onShowContextMenu, previewEvent, recalculate, removeAllListeners, removeAttachagle, removeFromParent, removeListener, removeStyleName, removeStyleOnOver, removeSwallow, removeToolTip, removeWidgetListener, render, render, repaint, saveState, setAriaRole, setAriaState, setAriaSupport, setBorders, setContextMenu, setData, setEl, setElement, setElement, setEnabled, setFiresEvents, setHideMode, setId, setIntStyleAttribute, setItemId, setModel, setParent, setStateful, setStateId, setStyleAttribute, setStyleName, setTabIndex, setTitle, setToolTip, setToolTip, setVisible, sinkEvents, swallowEvent, swallowEvent, toString, unframe, unmask
 
Methods inherited from class com.google.gwt.user.client.ui.Widget
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, setLayoutData
 
Methods inherited from class com.google.gwt.user.client.ui.UIObject
addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, removeStyleDependentName, setElement, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEvent, unsinkEvents
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

OK

public static final java.lang.String OK
Button constant that displays a single OK button.

See Also:
Constant Field Values

CANCEL

public static final java.lang.String CANCEL
Button constant that displays a single CANCEL button.

See Also:
Constant Field Values

CLOSE

public static final java.lang.String CLOSE
Button constant that displays a single CLOSE button.

See Also:
Constant Field Values

OKCANCEL

public static final java.lang.String OKCANCEL
Button constant that displays a OK and CANCEL button.

See Also:
Constant Field Values

YESNO

public static final java.lang.String YESNO
Button constant that displays a YES and NO button.

See Also:
Constant Field Values

NO

public static final java.lang.String NO
Button constant for the itemId of a NO button.

See Also:
Constant Field Values

YES

public static final java.lang.String YES
Button constant for the itemId of a YES button.

See Also:
Constant Field Values

YESNOCANCEL

public static final java.lang.String YESNOCANCEL
Button constant that displays a YES, NO, and CANCEL button.

See Also:
Constant Field Values

okText

public java.lang.String okText
The OK button text (defaults to 'OK');


closeText

public java.lang.String closeText
The Close button text (defaults to 'Close').


cancelText

public java.lang.String cancelText
The Cancel button text (defaults to 'Cancel').


yesText

public java.lang.String yesText
The Yes button text (defaults to 'Yes').


noText

public java.lang.String noText
The No button text (defaults to 'No').

Constructor Detail

Dialog

public Dialog()
Method Detail

getButtons

public java.lang.String getButtons()
Returns the button's.

Returns:
the buttons the buttons

getButtonById

public Button getButtonById(java.lang.String string)

isHideOnButtonClick

public boolean isHideOnButtonClick()
Returns true if the dialog will be hidden on any button click.

Returns:
the hide on button click state

setButtons

public void setButtons(java.lang.String buttons)
Sets the buttons to display (defaults to OK). Must be one of:
 Dialog.OK
 Dialog.CANCEL
 Dialog.OKCANCEL
 Dialog.YESNO
 Dialog.YESNOCANCEL
 


setHideOnButtonClick

public void setHideOnButtonClick(boolean hideOnButtonClick)
True to hide the dialog on any button click.

Parameters:
hideOnButtonClick - true to hide

createButtons

protected void createButtons()
Creates the buttons based on button creation constant


onButtonPressed

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

Parameters:
button - the button