com.smartgwt.client.widgets
Class Dialog

java.lang.Object
  com.google.gwt.user.client.ui.UIObject
      com.google.gwt.user.client.ui.Widget
          com.smartgwt.client.widgets.BaseWidget
              com.smartgwt.client.widgets.Canvas
                  com.smartgwt.client.widgets.layout.Layout
                      com.smartgwt.client.widgets.layout.VLayout
                          com.smartgwt.client.widgets.Window
                              com.smartgwt.client.widgets.Dialog

All Implemented Interfaces:

HasAttachHandlers, HasHandlers, EventListener, HasVisibility, 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

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 say, warn and 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

UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled

Field Summary

static Button	APPLY APPLY Button object to fire dialog's "applyClick()" method on click.
static Button	CANCEL CANCEL Button object to fire dialog's "cancelClick()" method on click.
static Button	DONE DONE Button object to fire dialog's "doneClick()" method on click.
static Button	NO NO Button object to fire dialog's "noClick()" method on click.
static Button	OK OK Button object to fire dialog's "okClick()" method on click.
static Button	YES YES Button object to fire dialog's "yesClick()" method on click

Fields inherited from class com.smartgwt.client.widgets.BaseWidget

config, configOnly, id, isElementSet, nativeObject, scClassName

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

Dialog()

Dialog(JavaScriptObject jsObj)

Method Summary

HandlerRegistration	addButtonClickHandler(ButtonClickHandler handler) Add a buttonClick handler.
void	applyClick() Handle a click on the 'apply' button of this Dialog.
void	cancelClick() Handle a click on the 'cancel' button of this Dialog.
Boolean	closeClick() Handles a click on the close button of this window.
protected JavaScriptObject	create()
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.
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()
String	getMessage() Message to show in this dialog.
static Dialog	getOrCreateRef(JavaScriptObject jsObj)
Boolean	getShowToolbar() Whether to show a toolbar of buttons at the bottom of the Dialog.
String	getStyleName() Style of the Dialog background
void	noClick() Handle a click on the 'no' button of this Dialog.
void	okClick() Handle a click on the 'ok' button of this Dialog.
void	saveData() Method to save this Dialog's data.
void	setAutoFocus(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(String icon) Icon to show in this dialog - see message.
void	setIconSize(int iconSize) Size of the icon to show in this dialog.
void	setJavaScriptObject(JavaScriptObject jsObj)
com.smartgwt.logicalstructure.core.LogicalStructureObject	setLogicalStructure(com.smartgwt.logicalstructure.widgets.DialogLogicalStructure s)
void	setMessage(String message) Message to show in this dialog.
void	setMessageStyle(String messageStyle) Style to apply to the message text shown in the center of the dialog
void	setShowToolbar(Boolean showToolbar) Whether to show a toolbar of buttons at the bottom of the Dialog.
void	setStyleName(String styleName) Style of the Dialog background
void	setToolbarButtons(Canvas... toolbarButtons) Array of Buttons to show in the showToolbar, if shown.
void	yesClick() Handle a click on the 'yes' button of this Dialog.

Methods inherited from class com.smartgwt.client.widgets.Window

addCloseClickHandler, addItem, addItem, addMaximizeClickHandler, addMember, addMember, addMinimizeClickHandler, addRestoreClickHandler, centerInPage, flash, getAnimateMinimize, getAutoCenter, getAutoSize, getBodyColor, getBodyStyle, getCanDragReposition, getCanDragResize, getCanFocusInHeaderButtons, getContentLayout, getContentsType, getDefaultMinimizeHeight, getDismissOnEscape, getDismissOnOutsideClick, getFooterHeight, getHeaderSrc, getHeaderStyle, getHiliteBodyColor, getHiliteHeaderSrc, getHiliteHeaderStyle, getIsModal, getItems, getMaximized, getMinimizeAcceleration, getMinimized, getMinimizeHeight, getMinimizeTime, getModalMaskOpacity, getModalMaskStyle, getOpacity, getShowBody, getShowCloseButton, getShowFooter, getShowHeader, getShowHeaderBackground, getShowHeaderIcon, getShowMaximizeButton, getShowMinimizeButton, getShowModalMask, getShowResizer, getShowStatusBar, getShowTitle, getSrc, getStatus, getTitle, getUseBackMask, maximize, minimize, onCloseClick, 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, 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, getAnimateMembers, getAnimateMemberTime, getCanDropComponents, getDefaultResizeBars, getDropComponent, getDropLineThickness, getDropPosition, getEnforcePolicy, getHPolicy, getLayoutBottomMargin, getLayoutLeftMargin, getLayoutMargin, getLayoutRightMargin, getLayoutTopMargin, getLeaveScrollbarGap, getLocateMembersBy, getLocateMembersType, getManagePercentBreadth, getMember, getMember, getMemberDefaultBreadth, getMemberNumber, getMemberNumber, getMemberOffset, getMemberOverlap, getMembers, getMembersMargin, getMinMemberSize, getOverflow, getPaddingAsLayoutMargin, getResizeBarClass, getResizeBarSize, getReverseOrder, getShowDragPlaceHolder, getShowDropLines, getStackZIndex, getVertical, getVPolicy, hasMember, hideDropLine, hideMember, hideMember, membersChanged, onInit_Layout, onInit, reflow, reflow, reflowNow, removeMember, 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, 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, addResizedHandler, addRightMouseDownHandler, addScrolledHandler, addShowContextMenuHandler, addStyleName, addVisibilityChangedHandler, adjustForContent, animateFade, animateFade, animateFade, animateHide, animateHide, animateHide, animateMove, animateMove, animateMove, animateMove, animateRect, animateRect, animateRect, animateResize, animateResize, animateResize, animateScroll, animateScroll, animateScroll, animateShow, animateShow, animateShow, blur, bringToFront, clear, clickMaskUp, clickMaskUp, contains, contains, containsEvent, containsFocus, containsPoint, containsPoint, convertToCanvasArray, deparent, depeer, disable, enable, focus, getAbsoluteLeft, getAbsoluteTop, getAccessKey, getAnimateAcceleration, getAnimateFadeTime, getAnimateHideAcceleration, getAnimateHideTime, getAnimateMoveAcceleration, getAnimateMoveTime, getAnimateRectAcceleration, getAnimateRectTime, getAnimateResizeAcceleration, getAnimateResizeTime, getAnimateScrollAcceleration, getAnimateScrollTime, getAnimateShowAcceleration, getAnimateShowEffect, getAnimateShowTime, getAnimateTime, getAppImgDir, getAriaRole, getAttribute, getAutoDraw, getAutoShowParent, getBackgroundColor, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorder, getBottom, getById, getCanAcceptDrop, getCanDrag, getCanDragScroll, getCanDrop, getCanDropBefore, getCanFocus, getCanHover, getCanSelectText, getCanvasItem, getChildren, getChildrenSnapResizeToGrid, getChildrenSnapToGrid, getClassName, getContents, getContextMenu, getCursor, getDataPath, getDefaultHeight, getDestroyed, getDestroying, getDisabled, getDisabledCursor, getDoubleClickDelay, getDragAppearance, getDragIntersectStyle, getDragOpacity, getDragRepositionAppearance, getDragRepositionCursor, getDragResizeAppearance, getDragScrollDelay, getDragStartDistance, getDragTarget, getDragType, getDropTypes, getDynamicContents, getEdgeBackgroundColor, getEdgeCenterBackgroundColor, getEdgeImage, getEdgeMarginSize, getEdgeOffset, getEdgeOpacity, getEdgeShowCenter, getEdgeSize, getEventEdge, getEventEdge, getExtraSpace, getFacetId, getFullDataPath, getGroupTitle, getHeight, getHeightAsString, getHoverAlign, getHoverAutoDestroy, getHoverComponent, getHoverDelay, getHoverHeight, getHoverHTML, getHoverMoveWithMouse, getHoverOpacity, getHoverStyle, getHoverVAlign, getHoverWidth, getHoverWrap, getHSnapOrigin, getHSnapOrigin, getHSnapPosition, getHSnapPosition, getHtmlPosition, getImgURL, getImgURL, getInnerContentHeight, getInnerContentWidth, getInnerHeight, getInnerWidth, getIsGroup, getKeepInParentRect, getLayoutAlign, getLeft, getLeftAsString, getLocateChildrenBy, getLocateChildrenType, getLocatePeersBy, getLocatePeersType, getMargin, getMasterElement, getMatchElement, getMaxHeight, getMaxWidth, getMenuConstructor, getMinHeight, getMinWidth, getMouseStillDownDelay, getMouseStillDownInitialDelay, getNextZIndex, getNoDoubleClicks, getOffsetHeight, getOffsetWidth, getOffsetX, getOffsetY, getPadding, getPageBottom, getPageLeft, getPageRect, getPageRight, getPageTop, getParentElement, getParentElements, 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, getSkinImgDir, getSnapAxis, getSnapEdge, getSnapHDirection, getSnapHGap, getSnapOffsetLeft, getSnapOffsetTop, getSnapOnDrop, getSnapResizeToGrid, getSnapTo, getSnapToGrid, getSnapVDirection, getSnapVGap, getTabIndex, getTooltip, getTop, getTopAsString, getTopElement, getUseOpacityFilter, getValuesManager, getViewportHeight, getViewportWidth, getVisibility, getVisibleHeight, getVisibleWidth, getVSnapOrigin, getVSnapOrigin, getVSnapPosition, getVSnapPosition, getWidth, getWidthAsString, getZIndex, handleHover, hide, hideClickMask, hideClickMask, hideContextMenu, imgHTML, imgHTML, imgHTML, intersects, isDirty, isDisabled, isDrawn, isVisible, keyUp, layoutChildren, 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, 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, setAutoDraw, setAutoHeight, setAutoShowParent, setAutoWidth, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBottom, setCanAcceptDrop, setCanDrag, setCanDragScroll, setCanDrop, setCanDropBefore, setCanFocus, setCanHover, setCanSelectText, setCanvasItem, setChildren, setChildrenSnapResizeToGrid, setChildrenSnapToGrid, setContents, setContextMenu, setCursor, setDataPath, setDefaultHeight, setDefaultProperties, setDisabled, setDisabledCursor, setDoubleClickDelay, setDragAppearance, setDragIntersectStyle, setDragOpacity, setDragRepositionAppearance, setDragRepositionCursor, setDragResizeAppearance, setDragScrollDelay, setDragStartDistance, setDragTarget, setDragType, setDropTypes, setDynamicContents, setEdgeBackgroundColor, setEdgeCenterBackgroundColor, setEdgeImage, setEdgeMarginSize, setEdgeOffset, setEdgeOpacity, setEdgeShowCenter, setEdgeSize, setExtraSpace, setFacetId, setGroupTitle, setHeight, setHeight, setHeight100, setHoverAlign, setHoverAutoDestroy, setHoverDelay, setHoverHeight, setHoverMoveWithMouse, setHoverOpacity, setHoverStyle, setHoverVAlign, setHoverWidth, setHoverWrap, setHtmlPosition, setImage, setImage, setIsGroup, setKeepInParentRect, setLayoutAlign, setLayoutAlign, setLeft, setLeft, setLocateChildrenBy, setLocateChildrenType, setLocatePeersBy, setLocatePeersType, setLogicalStructure, setMargin, setMatchElement, setMaxHeight, setMaxWidth, setMenuConstructor, setMinHeight, setMinWidth, setMouseStillDownDelay, setMouseStillDownInitialDelay, setNeverUseFilters, setNoDoubleClicks, setPadding, setPageLeft, setPageTop, setParentElement, setPeers, setPercentBox, setPercentSource, setPosition, setPrefix, setPrintChildrenAbsolutelyPositioned, setPrompt, setRect, setRect, setRedrawOnResize, setResizeBarTarget, setResizeFrom, setResizeFrom, setRight, setScrollbarSize, setShadowDepth, setShadowImage, setShadowOffset, setShadowSoftness, setShouldPrint, setShowCustomScrollbars, setShowDragShadow, setShowEdges, setShowHover, setShowHoverComponents, setShowResizeBar, setShowShadow, setSkinImgDir, setSmoothFade, setSnapAxis, setSnapEdge, setSnapHDirection, setSnapHGap, setSnapOffsetLeft, setSnapOffsetTop, setSnapOnDrop, setSnapResizeToGrid, setSnapTo, setSnapToGrid, setSnapVDirection, setSnapVGap, setTabIndex, setTooltip, setTop, setTop, setUseOpacityFilter, setValuesManager, setVisibility, setVisible, setWidth, setWidth, setWidth100, setZIndex, shouldDragScroll, show, showClickMask, showNextTo, showNextTo, showPrintPreview, showPrintPreview, showPrintPreview, showPrintPreview, showRecursively, updateHover, updateHover, updateShadow, visibleAtPoint, willAcceptDrop

Methods inherited from class com.smartgwt.client.widgets.BaseWidget

addDrawHandler, destroy, doAddHandler, doInit, doOnRender, draw, equals, error, errorIfNotCreated, fireEvent, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDateArray, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsFloatArray, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsString, getAttributeAsStringArray, getConfig, getDOM, getElement, getElement, getHandlerCount, getID, getInnerHTML, getJsObj, getOrCreateJsObj, getRef, getScClassName, hashCode, initNativeObject, isConfigOnly, isCreated, onDestroy, onDraw, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setConfig, setConfigOnly, setDragTracker, setElement, setHtmlElement, setID, 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, 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 fire dialog's "okClick()" method on click.

APPLY

public static Button APPLY

APPLY Button object to fire dialog's "applyClick()" method on click.

YES

public static Button YES

YES Button object to fire dialog's "yesClick()" method on click

NO

public static Button NO

NO Button object to fire dialog's "noClick()" method on click.

CANCEL

public static Button CANCEL

CANCEL Button object to fire dialog's "cancelClick()" method on click.

DONE

public static Button DONE

DONE Button object to fire dialog's "doneClick()" method on click.

Constructor Detail

Dialog

public Dialog()

Dialog

public Dialog(JavaScriptObject jsObj)

Method Detail

getOrCreateRef

public static Dialog getOrCreateRef(JavaScriptObject jsObj)

setJavaScriptObject

public void setJavaScriptObject(JavaScriptObject jsObj)

Overrides:

setJavaScriptObject in class Window

create

protected JavaScriptObject create()

Overrides:

create in class Window

setAutoFocus

public void setAutoFocus(Boolean autoFocus)
                  throws IllegalStateException

If a toolbar is showing, automatically place keyboard focus in the first button.

Parameters:

autoFocus - autoFocus Default value is true

Throws:

IllegalStateException - this property cannot be changed after the component has been created

See Also:

Appearance overview and related methods

getAutoFocus

public 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 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 - defaultWidth Default value is 360

Throws:

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(String icon)
             throws IllegalStateException

Icon to show in this dialog - see message.

Parameters:

icon - . See SCImgURL. Default value is null

Throws:

IllegalStateException - this property cannot be changed after the component has been created

getIcon

public String getIcon()

Icon to show in this dialog - see message.

Returns:

. See SCImgURL

setIconSize

public void setIconSize(int iconSize)
                 throws IllegalStateException

Size of the icon to show in this dialog.

Parameters:

iconSize - iconSize Default value is 32

Throws:

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(String message)
                throws 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:

IllegalStateException - this property cannot be changed after the component has been created

getMessage

public 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

setShowToolbar

public void setShowToolbar(Boolean showToolbar)
                    throws 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 - showToolbar Default value is null

Throws:

IllegalStateException - this property cannot be changed after the component has been created

See Also:

Appearance overview and related methods

getShowToolbar

public 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(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 String getStyleName()

Style of the Dialog background

Overrides:

getStyleName in class Canvas

Returns:

. See CSSStyleName

See Also:

Appearance overview and related methods

applyClick

public void applyClick()

Handle a click on the 'apply' button of this Dialog. Default implementation is to call saveData(), but NOT close the Dialog.

addButtonClickHandler

public 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

cancelClick

public void cancelClick()

Handle a click on the 'cancel' button of this Dialog. Default implementation is to return null and hide the Dialog. Override to do something else.

closeClick

public Boolean closeClick()

Handles a click on the close button of this window. The default implementation hides the window and returns false to cancel bubbling. Override this method if you want other actions to be taken.

Returns:

Return false to cancel closing the window

noClick

public void noClick()

Handle a click on the 'no' button of this Dialog. Default implementation is to return false. Override to do something else.

okClick

public void okClick()

Handle a click on the 'ok' button of this Dialog. Default implementation is to call saveData(), hide the Dialog, then return true. Override to do something else.

saveData

public void saveData()

Method to save this Dialog's data. Called from okClick(), applyClick(). No default implementation - override to perform some action if required.

yesClick

public void yesClick()

Handle a click on the 'yes' button of this Dialog. Default implementation is to return true. Override to do something else

setDefaultProperties

public static void setDefaultProperties(Dialog dialogProperties)

Class level method to set the default properties of this class. If set, then all subsequent instances of this class will automatically have the default properties that were set when this method was called. 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 effect 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.

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:

IllegalStateException - this property cannot be changed after the component has been rendered

setButtons

public void setButtons(Button... buttons)
                throws 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:

IllegalStateException - this property cannot be changed after the component has been created

setMessageStyle

public void setMessageStyle(String messageStyle)
                     throws 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:

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