com.smartgwt.client.widgets
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.smartgwt.client.widgets.BaseWidget
              extended by com.smartgwt.client.widgets.Canvas
                  extended by com.smartgwt.client.widgets.layout.Layout
                      extended by com.smartgwt.client.widgets.layout.VLayout
                          extended by com.smartgwt.client.widgets.Window
                              extended by com.smartgwt.client.widgets.Dialog
All Implemented Interfaces:
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.HasVisibility, com.google.gwt.user.client.ui.IsWidget, LogicalStructure, HasButtonClickHandlers, HasClickHandlers, HasCloseClickHandlers, HasDoubleClickHandlers, HasDragMoveHandlers, HasDragRepositionMoveHandlers, HasDragRepositionStartHandlers, HasDragRepositionStopHandlers, HasDragResizeMoveHandlers, HasDragResizeStartHandlers, HasDragResizeStopHandlers, HasDragStartHandlers, HasDragStopHandlers, HasDropHandlers, HasDropMoveHandlers, HasDropOutHandlers, HasDropOverHandlers, HasFocusChangedHandlers, HasHoverHandlers, HasHoverHiddenHandlers, HasKeyDownHandlers, HasKeyPressHandlers, HasMaximizeClickHandlers, HasMinimizeClickHandlers, HasMouseDownHandlers, HasMouseMoveHandlers, HasMouseOutHandlers, HasMouseOverHandlers, HasMouseStillDownHandlers, HasMouseUpHandlers, HasMouseWheelHandlers, HasMovedHandlers, HasParentMovedHandlers, HasResizedHandlers, HasRestoreClickHandlers, HasRightMouseDownHandlers, HasScrolledHandlers, HasShowContextMenuHandlers, HasVisibilityChangedHandlers, HasMembersChangedHandlers

public class Dialog
extends Window
implements HasButtonClickHandlers

Dialogs are a specialized version of Window used for small windows that contain just a text message or a text mesage with some standard buttons.

Many typical modal dialogs such as alerts and confirmations are built into the system with convenience APIs - see isc.say, isc.warn and isc.askForValue.

Dialogs can be modal or non-modal according to isModal.

NOTE: If you are building a dialog that will involve more than just buttons and a message, consider starting from the Window class instead, where arbitrary components can be added to the body area via Window.addItem. This is an example of creating a custom dialog:

  final Dialog dialog = new Dialog();
  dialog.setMessage("Please choose whether to proceed");
  dialog.setIcon("[SKIN]ask.png");
  dialog.setButtons(new Button("OK"), new Button("Cancel"));
  dialog.addButtonClickHandler(new ButtonClickHandler() {
      public void onButtonClick(ButtonClickEvent event) {
          dialog.hide();
      }
  });
  dialog.draw();
  


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 Button APPLY
          APPLY Button object.
static Button CANCEL
          CANCEL Button object.
static Button DONE
          DONE Button object.
static Button NO
          NO Button object.
static Button OK
          OK Button object.
static Button YES
          YES Button object.
 
Fields inherited from class com.smartgwt.client.widgets.BaseWidget
config, configOnly, id, nativeObject, scClassName
 
Fields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX
 
Constructor Summary
Dialog()
           
Dialog(com.google.gwt.core.client.JavaScriptObject jsObj)
           
 
Method Summary
 com.google.gwt.event.shared.HandlerRegistration addButtonClickHandler(ButtonClickHandler handler)
          Add a buttonClick handler.
static void changeAutoChildDefaults(java.lang.String autoChildName, Canvas defaults)
          Changes the defaults for Canvas AutoChildren named autoChildName.
static void changeAutoChildDefaults(java.lang.String autoChildName, FormItem defaults)
          Changes the defaults for FormItem AutoChildren named autoChildName.
protected  com.google.gwt.core.client.JavaScriptObject create()
           
 java.lang.Boolean getAutoFocus()
          If a toolbar is showing, automatically place keyboard focus in the first button.
 int getDefaultWidth()
          For custom components, establishes a default width for the component.
 java.lang.String getIcon()
          Icon to show in this dialog - see message.
 int getIconSize()
          Size of the icon to show in this dialog.
 com.smartgwt.logicalstructure.core.LogicalStructureObject getLogicalStructure()
           
 java.lang.String getMessage()
          Message to show in this dialog.
 Img getMessageIcon()
          AutoChild that shows icon.
 Label getMessageLabel()
          AutoChild that shows message.
 Layout getMessageStack()
          AutoChild that combines message and icon.
static Dialog getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
           
 java.lang.Boolean getShowToolbar()
          Whether to show a toolbar of buttons at the bottom of the Dialog.
 java.lang.String getStyleName()
          Style of the Dialog background
 Toolbar getToolbar()
          com.smartgwt.client.types.AutoChild of type Toolbar used to create the toolbarButtons.
 void setAutoFocus(java.lang.Boolean autoFocus)
          If a toolbar is showing, automatically place keyboard focus in the first button.
 void setButtons(Button... buttons)
          Array of Buttons to show in the toolbar, if shown.
static void setDefaultProperties(Dialog dialogProperties)
          Class level method to set the default properties of this class.
 void setDefaultWidth(int defaultWidth)
          For custom components, establishes a default width for the component.
 void setIcon(java.lang.String icon)
          Icon to show in this dialog - see message.
 void setIconSize(int iconSize)
          Size of the icon to show in this dialog.
 com.smartgwt.logicalstructure.core.LogicalStructureObject setLogicalStructure(com.smartgwt.logicalstructure.widgets.DialogLogicalStructure s)
           
 void setMessage(java.lang.String message)
          Message to show in this dialog.
 void setMessageStyle(java.lang.String messageStyle)
          Style to apply to the message text shown in the center of the dialog
 void setShowToolbar(java.lang.Boolean showToolbar)
          Whether to show a toolbar of buttons at the bottom of the Dialog.
 void setStyleName(java.lang.String styleName)
          Style of the Dialog background
 void setToolbarButtons(Button... toolbarButtons)
          This is a synonym for buttons

If this method is called after the component has been drawn/initialized: Set the toolbarButtons for this dialog.
 void setToolbarButtons(Button toolbarButtons)
          This is a synonym for buttons

If this method is called after the component has been drawn/initialized: Set the toolbarButtons for this dialog.
 void setToolbarButtons(Canvas... toolbarButtons)
          Array of Buttons to show in the showToolbar, if shown.
 
Methods inherited from class com.smartgwt.client.widgets.Window
addCloseClickHandler, addItem, addItem, addMaximizeClickHandler, addMember, addMember, addMinimizeClickHandler, addRestoreClickHandler, centerInPage, close, flash, getAnimateMinimize, getAutoCenter, getAutoSize, getBody, getBodyColor, getBodyStyle, getCanDragReposition, getCanDragResize, getCanFocusInHeaderButtons, getCloseButton, getContentLayout, getContentsType, getDefaultMinimizeHeight, getDismissOnEscape, getDismissOnOutsideClick, getFooter, getFooterHeight, getHeader, getHeaderBackground, getHeaderIcon, getHeaderLabel, getHeaderSrc, getHeaderStyle, getHiliteBodyColor, getHiliteHeaderSrc, getHiliteHeaderStyle, getIsModal, getItems, getMaximizeButton, getMaximized, getMinimizeAcceleration, getMinimizeButton, getMinimized, getMinimizeHeight, getMinimizeTime, getModalMask, getModalMaskOpacity, getModalMaskStyle, getOpacity, getPrintBodyStyle, getPrintHeaderStyle, getResizer, getRestoreButton, getShowBody, getShowCloseButton, getShowFooter, getShowHeader, getShowHeaderBackground, getShowHeaderIcon, getShowMaximizeButton, getShowMinimizeButton, getShowModalMask, getShowResizer, getShowStatusBar, getShowTitle, getSrc, getStatus, getStatusBar, getTitle, getUseBackMask, maximize, minimize, preloadImages, removeItem, restore, setAnimateMinimize, setAutoCenter, setAutoSize, setBodyColor, setBodyDefaults, setBodyStyle, setCanDragReposition, setCanDragResize, setCanFocusInHeaderButtons, setContentLayout, setContentsType, setDefaultMinimizeHeight, setDefaultProperties, setDismissOnEscape, setDismissOnOutsideClick, setFooterControls, setFooterHeight, setHeaderControls, setHeaderIcon, setHeaderIcon, setHeaderIconDefaults, setHeaderIconProperties, setHeaderSrc, setHeaderStyle, setHiliteBodyColor, setHiliteHeaderSrc, setHiliteHeaderStyle, setIsModal, setKeepInParentRect, setKeepInParentRect, setLogicalStructure, setMaximized, setMinimizeAcceleration, setMinimized, setMinimizeHeight, setMinimizeTime, setModalMaskOpacity, setModalMaskStyle, setOpacity, setPrintBodyStyle, setPrintHeaderStyle, setShowBody, setShowCloseButton, setShowFooter, setShowHeader, setShowHeaderBackground, setShowHeaderIcon, setShowMaximizeButton, setShowMinimizeButton, setShowModalMask, setShowResizer, setShowStatusBar, setShowTitle, setSrc, setStatus, setTitle, setUseBackMask, shouldDismissOnEscape
 
Methods inherited from class com.smartgwt.client.widgets.layout.VLayout
setDefaultProperties, setLogicalStructure
 
Methods inherited from class com.smartgwt.client.widgets.layout.Layout
addMember, addMember, addMember, addMemberPostCreate, addMemberPostCreate, addMemberPreCreate, addMemberPreCreate, addMembers, addMembers, addMembersChangedHandler, getAnimateMembers, getAnimateMemberTime, getCanDropComponents, getDefaultResizeBars, getDropComponent, getDropLine, getDropLineThickness, getDropPosition, getEnforcePolicy, getHPolicy, getLayoutBottomMargin, getLayoutLeftMargin, getLayoutMargin, getLayoutRightMargin, getLayoutTopMargin, getLeaveScrollbarGap, getLocateMembersBy, getLocateMembersType, getManagePercentBreadth, getMember, getMember, getMemberDefaultBreadth, getMemberNumber, getMemberNumber, getMemberOverlap, getMembers, getMembersMargin, getMinMemberSize, getOverflow, getPaddingAsLayoutMargin, getResizeBarClass, getResizeBarSize, getReverseOrder, getShowDragPlaceHolder, getShowDropLines, getStackZIndex, getVertical, getVPolicy, hasMember, hideDropLine, hideMember, hideMember, onInit_Layout, onInit, reflow, reflow, reflowNow, removeMember, removeMembers, removeMembers, reorderMember, reorderMembers, setAlign, setAlign, setAnimateMembers, setAnimateMemberTime, setCanDropComponents, setDefaultLayoutAlign, setDefaultLayoutAlign, setDefaultProperties, setDefaultResizeBars, setDropLineProperties, setDropLineThickness, setEnforcePolicy, setHPolicy, setLayoutBottomMargin, setLayoutLeftMargin, setLayoutMargin, setLayoutRightMargin, setLayoutTopMargin, setLeaveScrollbarGap, setLocateMembersBy, setLocateMembersType, setLogicalStructure, setManagePercentBreadth, setMemberOverlap, setMembers, setMembersMargin, setMinMemberSize, setOverflow, setPaddingAsLayoutMargin, setPlaceHolderDefaults, setPlaceHolderProperties, setResizeBarClass, setResizeBarSize, setReverseOrder, setShowDragPlaceHolder, setShowDropLines, setStackZIndex, setVertical, setVisibleMember, setVPolicy, showMember, showMember
 
Methods inherited from class com.smartgwt.client.widgets.Canvas
addChild, addChild, addChild, addChild, addChild, addClickHandler, addDoubleClickHandler, addDragMoveHandler, addDragRepositionMoveHandler, addDragRepositionStartHandler, addDragRepositionStopHandler, addDragResizeMoveHandler, addDragResizeStartHandler, addDragResizeStopHandler, addDragStartHandler, addDragStopHandler, addDropHandler, addDropMoveHandler, addDropOutHandler, addDropOverHandler, addFocusChangedHandler, addHoverHandler, addHoverHiddenHandler, addKeyDownHandler, addKeyPressHandler, addMouseDownHandler, addMouseMoveHandler, addMouseOutHandler, addMouseOverHandler, addMouseStillDownHandler, addMouseUpHandler, addMouseWheelHandler, addMovedHandler, addParentMovedHandler, addPeer, addPeer, addPeer, addPeer, addResizedHandler, addRightMouseDownHandler, addScrolledHandler, addShowContextMenuHandler, addStyleName, addVisibilityChangedHandler, adjustForContent, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateHide, animateHide, animateHide, animateMove, animateMove, animateMove, animateMove, animateRect, animateRect, animateRect, animateRect, animateResize, animateResize, animateResize, animateResize, animateScroll, animateScroll, animateScroll, animateScroll, animateScroll, animateScroll, animateShow, animateShow, animateShow, animateShow, animateShow, animateShow, asSGWTComponent, blur, bringToFront, clear, clickMaskUp, clickMaskUp, contains, contains, containsEvent, containsFocus, containsPoint, containsPoint, deparent, depeer, disable, enable, focus, focusInNextTabElement, focusInPreviousTabElement, getAbsoluteLeft, getAbsoluteTop, getAccessKey, getAnimateAcceleration, getAnimateFadeTime, getAnimateHideAcceleration, getAnimateHideTime, getAnimateMoveAcceleration, getAnimateMoveTime, getAnimateRectAcceleration, getAnimateRectTime, getAnimateResizeAcceleration, getAnimateResizeTime, getAnimateScrollAcceleration, getAnimateScrollTime, getAnimateShowAcceleration, getAnimateShowEffect, getAnimateShowTime, getAnimateTime, getAppImgDir, getAriaRole, getAutoDraw, getAutoShowParent, getBackgroundColor, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorder, getBottom, getById, getByJSObject, getByLocalId, getCanAcceptDrop, getCanDrag, getCanDragScroll, getCanDrop, getCanDropBefore, getCanFocus, getCanHover, getCanSelectText, getCanvasAutoChild, getCanvasItem, getChildren, getChildrenSnapResizeToGrid, getChildrenSnapToGrid, getClassName, getContentElement, getContents, getContextMenu, getCursor, getDataPath, getDefaultHeight, getDestroyed, getDestroying, getDisabled, getDisabledCursor, getDoubleClickDelay, getDragAppearance, getDragIntersectStyle, getDragMaskType, getDragOpacity, getDragRepositionAppearance, getDragRepositionCursor, getDragResizeAppearance, getDragScrollDelay, getDragStartDistance, getDragTarget, getDragType, getDropTypes, getDropTypesAsString, getDynamicContents, getEdgeBackgroundColor, getEdgeCenterBackgroundColor, getEdgeImage, getEdgeMarginSize, getEdgeOffset, getEdgeOpacity, getEdgeShowCenter, getEdgeSize, getElement, getElement, getEventEdge, getEventEdge, getExtraSpace, getFacetId, getFormItemAutoChild, getFullDataPath, getGroupBorderCSS, getGroupLabelBackgroundColor, getGroupLabelStyleName, getGroupTitle, getHeight, getHeightAsString, getHideUsingDisplayNone, getHoverAlign, getHoverAutoDestroy, getHoverComponent, getHoverDelay, getHoverHeight, getHoverHTML, getHoverMoveWithMouse, getHoverOpacity, getHoverStyle, getHoverVAlign, getHoverWidth, getHoverWrap, getHSnapOrigin, getHSnapOrigin, getHSnapPosition, getHSnapPosition, getHtmlElement, getHtmlPosition, getImage, getImgURL, getImgURL, getInnerContentHeight, getInnerContentWidth, getInnerHeight, getInnerWidth, getIsGroup, getKeepInParentRect, getLayoutAlign, getLeft, getLeftAsString, getLocateChildrenBy, getLocateChildrenType, getLocatePeersBy, getLocatePeersType, getMargin, getMasterCanvas, getMasterElement, getMatchElement, getMaxHeight, getMaxWidth, getMenuConstructor, getMinHeight, getMinWidth, getMomentumScrollMinSpeed, getMouseStillDownDelay, getMouseStillDownInitialDelay, getNextZIndex, getNoDoubleClicks, getOffsetHeight, getOffsetWidth, getOffsetX, getOffsetY, getOuterElement, getPadding, getPageBottom, getPageLeft, getPageRect, getPageRight, getPageTop, getParentCanvas, getParentElement, getPeers, getPercentBox, getPercentSource, getPosition, getPrefix, getPrintChildrenAbsolutelyPositioned, getPrintHTML, getPrintHTML, getPrompt, getRect, getRedrawOnResize, getResizeBarTarget, getResizeFrom, getRight, getScrollbarSize, getScrollBottom, getScrollHeight, getScrollLeft, getScrollRight, getScrollTop, getScrollWidth, getShadowDepth, getShadowImage, getShadowOffset, getShadowSoftness, getShouldPrint, getShowCustomScrollbars, getShowDragShadow, getShowEdges, getShowHover, getShowHoverComponents, getShowResizeBar, getShowShadow, getShrinkElementOnHide, getSkinImgDir, getSnapAxis, getSnapEdge, getSnapHDirection, getSnapHGap, getSnapOffsetLeft, getSnapOffsetTop, getSnapOnDrop, getSnapResizeToGrid, getSnapTo, getSnapToGrid, getSnapVDirection, getSnapVGap, getTabIndex, getTestInstance, getTooltip, getTop, getTopAsString, getTopElement, getUseDragMask, getUseNativeDrag, getUseOpacityFilter, getValuesManager, getViewportHeight, getViewportWidth, getVisibility, getVisibleHeight, getVisibleWidth, getVSnapOrigin, getVSnapOrigin, getVSnapPosition, getVSnapPosition, getWidth, getWidthAsString, getZIndex, getZIndex, handleHover, hide, hideClickMask, hideClickMask, hideContextMenu, imgHTML, imgHTML, imgHTML, intersects, isDirty, isDisabled, isDrawn, isVisible, keyUp, layoutChildren, linkHTML, linkHTML, linkHTML, linkHTML, linkHTML, linkHTML, markForDestroy, markForRedraw, markForRedraw, moveAbove, moveBelow, moveBy, moveTo, onAttach, onDetach, parentResized, printComponents, redraw, redraw, removeChild, removeChild, removePeer, removePeer, resizeBy, resizeTo, resizeTo, scrollBy, scrollByPercent, scrollTo, scrollTo, scrollTo, scrollToBottom, scrollToLeft, scrollToPercent, scrollToRight, scrollToTop, sendToBack, setAccessKey, setAllowExternalFilters, setAnimateAcceleration, setAnimateFadeTime, setAnimateHideAcceleration, setAnimateHideTime, setAnimateMoveAcceleration, setAnimateMoveTime, setAnimateRectAcceleration, setAnimateRectTime, setAnimateResizeAcceleration, setAnimateResizeTime, setAnimateScrollAcceleration, setAnimateScrollTime, setAnimateShowAcceleration, setAnimateShowEffect, setAnimateShowTime, setAnimateTime, setAppImgDir, setAriaRole, setAriaState, setAutoChildConstructor, setAutoChildProperties, setAutoChildProperties, setAutoChildVisibility, setAutoDraw, setAutoHeight, setAutoShowParent, setAutoWidth, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBottom, setCanAcceptDrop, setCanDrag, setCanDragScroll, setCanDrop, setCanDropBefore, setCanFocus, setCanHover, setCanSelectText, setChildren, setChildrenSnapResizeToGrid, setChildrenSnapToGrid, setContents, setContextMenu, setCursor, setDataPath, setDefaultHeight, setDefaultProperties, setDisabled, setDisabledCursor, setDoubleClickDelay, setDragAppearance, setDragIntersectStyle, setDragMaskType, setDragOpacity, setDragRepositionAppearance, setDragRepositionCursor, setDragResizeAppearance, setDragScrollDelay, setDragStartDistance, setDragTarget, setDragType, setDropTypes, setDropTypes, setDynamicContents, setEdgeBackgroundColor, setEdgeCenterBackgroundColor, setEdgeImage, setEdgeMarginSize, setEdgeOffset, setEdgeOpacity, setEdgeShowCenter, setEdgeSize, setElement, setExtraSpace, setFacetId, setGroupBorderCSS, setGroupLabelBackgroundColor, setGroupLabelStyleName, setGroupTitle, setHeight, setHeight, setHeight, setHeight100, setHideUsingDisplayNone, setHoverAlign, setHoverAutoDestroy, setHoverDelay, setHoverHeight, setHoverMoveWithMouse, setHoverOpacity, setHoverStyle, setHoverVAlign, setHoverWidth, setHoverWrap, setHtmlElement, setHtmlPosition, setImage, setImage, setInitHandler, setIsGroup, setKeepInParentRect, setLayoutAlign, setLayoutAlign, setLeft, setLeft, setLocateChildrenBy, setLocateChildrenType, setLocatePeersBy, setLocatePeersType, setLogicalStructure, setMargin, setMatchElement, setMaxHeight, setMaxWidth, setMenuConstructor, setMinHeight, setMinWidth, setMomentumScrollMinSpeed, setMouseStillDownDelay, setMouseStillDownInitialDelay, setNeverUseFilters, setNoDoubleClicks, setPadding, setPageLeft, setPageTop, setParentCanvas, setParentElement, setPeers, setPercentBox, setPercentSource, setPosition, setPrefix, setPrintChildrenAbsolutelyPositioned, setPrompt, setRect, setRect, setRedrawOnResize, setResizeBarTarget, setResizeFrom, setResizeFrom, setRight, setScrollbarConstructor, setScrollbarSize, setShadowDepth, setShadowImage, setShadowOffset, setShadowSoftness, setShouldPrint, setShowCustomScrollbars, setShowDragShadow, setShowEdges, setShowHover, setShowHoverComponents, setShowResizeBar, setShowShadow, setShrinkElementOnHide, setSkinImgDir, setSmoothFade, setSnapAxis, setSnapEdge, setSnapHDirection, setSnapHGap, setSnapOffsetLeft, setSnapOffsetTop, setSnapOnDrop, setSnapResizeToGrid, setSnapTo, setSnapToGrid, setSnapVDirection, setSnapVGap, setTabIndex, setTooltip, setTop, setTop, setUseDragMask, setUseNativeDrag, setUseOpacityFilter, setValuesManager, setVisibility, setVisible, setWidth, setWidth, setWidth, setWidth100, setZIndex, shouldDragScroll, show, showClickMask, showNextTo, showNextTo, showNextTo, showNextTo, showPrintPreview, showPrintPreview, showPrintPreview, showPrintPreview, showRecursively, updateEditNode, updateHover, updateHover, updateShadow, visibleAtPoint, willAcceptDrop
 
Methods inherited from class com.smartgwt.client.widgets.BaseWidget
addDrawHandler, destroy, doAddHandler, doInit, doOnRender, draw, equals, error, errorIfNotCreated, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDateArray, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsFloatArray, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getConfig, getDOM, getHandlerCount, getID, getInnerHTML, getJsObj, getOrCreateJsObj, getRef, getScClassName, hasAutoAssignedID, hashCode, initNativeObject, internalSetID, internalSetID, isConfigOnly, isCreated, onBind, onDestroy, onDraw, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setConfig, setConfigOnly, setDragTracker, setID, setJavaScriptObject, setLogicalStructure, setNullProperty, setPosition, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setScClassName, toString
 
Methods inherited from class com.google.gwt.user.client.ui.Widget
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getLayoutData, getParent, isAttached, isOrWasAttached, onBrowserEvent, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents
 
Methods inherited from class com.google.gwt.user.client.ui.UIObject
addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getStyleElement, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEvent, unsinkEvents
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 

Field Detail

OK

public static Button OK
OK Button object. To handle click use addButtonClickHandler method.


APPLY

public static Button APPLY
APPLY Button object. To handle click use addButtonClickHandler method.


YES

public static Button YES
YES Button object. To handle click use addButtonClickHandler method.


NO

public static Button NO
NO Button object. To handle click use addButtonClickHandler method.


CANCEL

public static Button CANCEL
CANCEL Button object. To handle click use addButtonClickHandler method.


DONE

public static Button DONE
DONE Button object. To handle click use addButtonClickHandler method.

Constructor Detail

Dialog

public Dialog()

Dialog

public Dialog(com.google.gwt.core.client.JavaScriptObject jsObj)
Method Detail

getOrCreateRef

public static Dialog getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)

changeAutoChildDefaults

public static void changeAutoChildDefaults(java.lang.String autoChildName,
                                           Canvas defaults)
Changes the defaults for Canvas AutoChildren named autoChildName.

Parameters:
autoChildName - name of an AutoChild to customize the defaults for.
defaults - Canvas defaults to apply. These defaults override any existing properties without destroying or wiping out non-overridden properties.
See Also:
AutoChildUsage

changeAutoChildDefaults

public static void changeAutoChildDefaults(java.lang.String autoChildName,
                                           FormItem defaults)
Changes the defaults for FormItem AutoChildren named autoChildName.

Parameters:
autoChildName - name of an AutoChild to customize the defaults for.
defaults - FormItem defaults to apply. These defaults override any existing properties without destroying or wiping out non-overridden properties.
See Also:
AutoChildUsage

create

protected com.google.gwt.core.client.JavaScriptObject create()
Overrides:
create in class Window

setAutoFocus

public void setAutoFocus(java.lang.Boolean autoFocus)
                  throws java.lang.IllegalStateException
If a toolbar is showing, automatically place keyboard focus in the first button.

Parameters:
autoFocus - Default value is true
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created
See Also:
Appearance overview and related methods

getAutoFocus

public java.lang.Boolean getAutoFocus()
If a toolbar is showing, automatically place keyboard focus in the first button.

Returns:
Boolean
See Also:
Appearance overview and related methods

setDefaultWidth

public void setDefaultWidth(int defaultWidth)
                     throws java.lang.IllegalStateException
Description copied from class: Canvas
For custom components, establishes a default width for the component.

For a component that should potentially be sized automatically by a Layout, set this property rather than width directly, because Layouts regard a width setting as an explicit size that shouldn't be changed.

Note : This is an advanced setting

Overrides:
setDefaultWidth in class Canvas
Parameters:
defaultWidth - Default value is 360
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created
See Also:
Appearance overview and related methods

getDefaultWidth

public int getDefaultWidth()
Description copied from class: Canvas
For custom components, establishes a default width for the component.

For a component that should potentially be sized automatically by a Layout, set this property rather than width directly, because Layouts regard a width setting as an explicit size that shouldn't be changed.

Overrides:
getDefaultWidth in class Canvas
Returns:
int
See Also:
Appearance overview and related methods

setIcon

public void setIcon(java.lang.String icon)
             throws java.lang.IllegalStateException
Icon to show in this dialog - see message.

Parameters:
icon - See SCImgURL . Default value is null
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

getIcon

public java.lang.String getIcon()
Icon to show in this dialog - see message.

Returns:
See SCImgURL

setIconSize

public void setIconSize(int iconSize)
                 throws java.lang.IllegalStateException
Size of the icon to show in this dialog.

Parameters:
iconSize - Default value is 32
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

getIconSize

public int getIconSize()
Size of the icon to show in this dialog.

Returns:
int

setMessage

public void setMessage(java.lang.String message)
                throws java.lang.IllegalStateException
Message to show in this dialog.

If a message is set the primary purpose of the dialog will be assumed to be to show a message with buttons - auto-sizing to the message text will be enabled, and, if icon has also been set, the messageLabel and messageIcon AutoChildren will be created and placed together in the messageStack AutoChild, with the toolbar underneath as usual. If any of these behaviors are inconvenient or you want more precise control over a message and some custom widgets, start from the superclass Window instead, and add controls via Window.addItem.

The message string may contain "${loadingImage}", if so, the standard loading spinner will appear at that location in the text (see loadingImageSrc).

The message will be styled with the messageStyle.

Parameters:
message - See HTMLString . Default value is null
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

getMessage

public java.lang.String getMessage()
Message to show in this dialog.

If a message is set the primary purpose of the dialog will be assumed to be to show a message with buttons - auto-sizing to the message text will be enabled, and, if icon has also been set, the messageLabel and messageIcon AutoChildren will be created and placed together in the messageStack AutoChild, with the toolbar underneath as usual. If any of these behaviors are inconvenient or you want more precise control over a message and some custom widgets, start from the superclass Window instead, and add controls via Window.addItem.

The message string may contain "${loadingImage}", if so, the standard loading spinner will appear at that location in the text (see loadingImageSrc).

The message will be styled with the messageStyle.

Returns:
See HTMLString

getMessageIcon

public Img getMessageIcon()
                   throws java.lang.IllegalStateException
AutoChild that shows icon.

For an overview of how to use and configure AutoChildren, see Using AutoChildren.

Returns:
Img
Throws:
java.lang.IllegalStateException - if this widget has not yet been rendered.

getMessageLabel

public Label getMessageLabel()
                      throws java.lang.IllegalStateException
AutoChild that shows message.

For an overview of how to use and configure AutoChildren, see Using AutoChildren.

Returns:
Label
Throws:
java.lang.IllegalStateException - if this widget has not yet been rendered.

getMessageStack

public Layout getMessageStack()
                       throws java.lang.IllegalStateException
AutoChild that combines message and icon.

For an overview of how to use and configure AutoChildren, see Using AutoChildren.

Returns:
Layout
Throws:
java.lang.IllegalStateException - if this widget has not yet been rendered.

setShowToolbar

public void setShowToolbar(java.lang.Boolean showToolbar)
                    throws java.lang.IllegalStateException
Whether to show a toolbar of buttons at the bottom of the Dialog. Default of null will cause the value to be resolved automatically to true or false when the Dialog is first drawn according as toolbarButtons contains buttons or not.

Parameters:
showToolbar - Default value is null
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created
See Also:
Appearance overview and related methods

getShowToolbar

public java.lang.Boolean getShowToolbar()
Whether to show a toolbar of buttons at the bottom of the Dialog. Default of null will cause the value to be resolved automatically to true or false when the Dialog is first drawn according as toolbarButtons contains buttons or not.

Returns:
Boolean
See Also:
Appearance overview and related methods

setStyleName

public void setStyleName(java.lang.String styleName)
Style of the Dialog background

Overrides:
setStyleName in class Canvas
Parameters:
styleName - See CSSStyleName . Default value is "dialogBackground"
See Also:
Appearance overview and related methods

getStyleName

public java.lang.String getStyleName()
Style of the Dialog background

Overrides:
getStyleName in class Canvas
Returns:
See CSSStyleName
See Also:
Appearance overview and related methods

getToolbar

public Toolbar getToolbar()
                   throws java.lang.IllegalStateException
com.smartgwt.client.types.AutoChild of type Toolbar used to create the toolbarButtons.

For an overview of how to use and configure AutoChildren, see Using AutoChildren.

Returns:
Toolbar
Throws:
java.lang.IllegalStateException - if this widget has not yet been rendered.

setToolbarButtons

public void setToolbarButtons(Button... toolbarButtons)
                       throws java.lang.IllegalStateException
This is a synonym for buttons

If this method is called after the component has been drawn/initialized: Set the toolbarButtons for this dialog. Synonym for Dialog.setButtons.

Parameters:
toolbarButtons - buttons for the toolbar. Default value is null
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

setToolbarButtons

public void setToolbarButtons(Button toolbarButtons)
                       throws java.lang.IllegalStateException
This is a synonym for buttons

If this method is called after the component has been drawn/initialized: Set the toolbarButtons for this dialog. Synonym for Dialog.setButtons.

Parameters:
toolbarButtons - buttons for the toolbar. Default value is null
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

addButtonClickHandler

public com.google.gwt.event.shared.HandlerRegistration addButtonClickHandler(ButtonClickHandler handler)
Add a buttonClick handler.

Fires when any button in this Dialog's toolbar is clicked. Default implementation does nothing.

Specified by:
addButtonClickHandler in interface HasButtonClickHandlers
Parameters:
handler - the buttonClick handler
Returns:
HandlerRegistration used to remove this handler

setDefaultProperties

public static void setDefaultProperties(Dialog dialogProperties)
Class level method to set the default properties of this class. If set, then all existing and subsequently created instances of this class will automatically have default properties corresponding to the properties set on the SmartGWT class instance passed to this function before its underlying SmartClient JS object was created. This is a powerful feature that eliminates the need for users to create a separate hierarchy of subclasses that only alter the default properties of this class. Can also be used for skinning / styling purposes.

Note: This method is intended for setting default attributes only and will affect all instances of the underlying class (including those automatically generated in JavaScript). This method should not be used to apply standard EventHandlers or override methods for a class - use a custom subclass instead. Calling this method after instances have been created can result in undefined behavior, since it bypasses any setters and a class instance may have already examined a particular property and not be expecting any changes through this route.

Parameters:
dialogProperties - properties that should be used as new defaults when instances of this class are created

setToolbarButtons

public void setToolbarButtons(Canvas... toolbarButtons)
Array of Buttons to show in the showToolbar, if shown.

The set of buttons to use is typically set by calling one of the shortcuts.

Parameters:
toolbarButtons - the toolbar buttons
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been rendered

setMessageStyle

public void setMessageStyle(java.lang.String messageStyle)
                     throws java.lang.IllegalStateException
Style to apply to the message text shown in the center of the dialog

Note : This is an advanced setting

Parameters:
messageStyle - messageStyle Default value is "normal"
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

setButtons

public void setButtons(Button... buttons)
                throws java.lang.IllegalStateException
Array of Buttons to show in the toolbar, if shown.

The set of buttons to use is typically set by calling one of the shortcuts such as isc.say or isc.confirm. A custom set of buttons can be passed to these shortcuts methods via the "properties" argument, or to a directly created Dialog.

In both cases, a mixture of built-in buttons, custom buttons, and other components (such as a LayoutSpacer) can be passed. Built-in buttons can be referred to as isc.Dialog.OK, for example:


 isc.Dialog.create({
    buttons:[
       isc.Dialog.OK, 
       isc.Dialog.CANCEL, 

 isc.LayoutSpacer.create({width:50}), 
       { title:"Not now", click:"doSomething()" }
    ]
 })

 
Built-in buttons will call standard methods on the Dialog itself, such as Dialog.cancelClick, as explained in the list of built-in buttons.

Parameters:
buttons - buttons Default value is null
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

setLogicalStructure

public com.smartgwt.logicalstructure.core.LogicalStructureObject setLogicalStructure(com.smartgwt.logicalstructure.widgets.DialogLogicalStructure s)

getLogicalStructure

public com.smartgwt.logicalstructure.core.LogicalStructureObject getLogicalStructure()
Specified by:
getLogicalStructure in interface LogicalStructure
Overrides:
getLogicalStructure in class Window