com.sencha.gxt.widget.core.client.box

Class MessageBox

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

com.sencha.gxt.widget.core.client.box.MessageBox

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, HasIcon, HasItemId

Direct Known Subclasses:

AbstractInputMessageBox, AlertMessageBox, AutoProgressMessageBox, ConfirmMessageBox, ProgressMessageBox

public class MessageBox
extends Dialog
implements HasIcon

Custom Dialog for displaying information to the user.

Note that the MessageBox is asynchronous. Unlike a regular JavaScript alert (which will halt browser execution), showing a MessageBox will not cause the code to stop.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MessageBox.MessageBoxAppearance
static interface	MessageBox.MessageBoxIcons

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

Dialog.DefaultDialogMessages, Dialog.DialogMessages, Dialog.PredefinedButton

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

Modifier and Type	Field and Description
protected ImageResource	icon
static MessageBox.MessageBoxIcons	ICONS The basic icons used to decorate the message box.

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
MessageBox(SafeHtml headingHtml) Creates a message box with the specified heading text.
MessageBox(SafeHtml headingHtml, SafeHtml messageHtml) Creates a message box with the default message box appearance and the specified heading and message HTML.
MessageBox(SafeHtml headingHtml, SafeHtml messageHtml, Window.WindowAppearance windowAppearance, MessageBox.MessageBoxAppearance messageBoxAppearance) Creates a message box with the specified heading HTML, message HTML and windowAppearance.
MessageBox(String headingText) Creates a message box with the specified heading text.
MessageBox(String headingText, String messageText) Creates a message box with the specified heading and message text.

Method Summary

Modifier and Type	Method and Description
ImageResource	getIcon() Returns the icon.
MessageBox.MessageBoxAppearance	getMessageBoxAppearance() Returns the message box appearance.
protected void	onResize(int width, int height) Called after the widget is resized, this method is empty by default but can be implemented by any subclass that needs to perform custom logic after a resize occurs.
protected void	resizeContents() Resize contents on show() and onResize(int, int)
void	setIcon(ImageResource icon) Sets the icon.
void	setMessage(SafeHtml message) Sets the message.
void	setMessage(String message) Sets the message.
void	show() Shows the window, rendering it first if necessary, or activates it and brings it to front if hidden.

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

addDialogHideHandler, createButtons, getButton, getDialogMessages, getPredefinedButton, getPredefinedButtons, getText, hide, isHideOnButtonClick, onButtonPressed, setDialogMessages, setHideOnButtonClick, setPredefinedButtons

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

Field Detail

ICONS

public static MessageBox.MessageBoxIcons ICONS

The basic icons used to decorate the message box.

icon

protected ImageResource icon

Constructor Detail

MessageBox

public MessageBox(String headingText)

Creates a message box with the specified heading text.

Parameters:

headingText - the text to display for the message box heading.

MessageBox

public MessageBox(SafeHtml headingHtml)

Creates a message box with the specified heading text.

Parameters:

headingHtml - the html to display for the message box heading

MessageBox

public MessageBox(String headingText,
                  String messageText)

Creates a message box with the specified heading and message text.

Parameters:

headingText - the text to display for the message box heading

messageText - the text to display in the message box

MessageBox

public MessageBox(SafeHtml headingHtml,
                  SafeHtml messageHtml)

Creates a message box with the default message box appearance and the specified heading and message HTML.

Parameters:

headingHtml - the HTML to display for the message box heading

messageHtml - the HTML to display in the message box

MessageBox

public MessageBox(SafeHtml headingHtml,
                  SafeHtml messageHtml,
                  Window.WindowAppearance windowAppearance,
                  MessageBox.MessageBoxAppearance messageBoxAppearance)

Creates a message box with the specified heading HTML, message HTML and windowAppearance. It is the caller's responsibility to ensure the HTML is CSS safe.

Parameters:

headingHtml - the HTML to display for the message box heading

messageHtml - the HTML to display in the message box

windowAppearance - the message box window windowAppearance

messageBoxAppearance - the message box content windowAppearance

Method Detail

getIcon

public ImageResource getIcon()

Description copied from interface: HasIcon

Returns the icon.

Specified by:

getIcon in interface HasIcon

Returns:

the icon

getMessageBoxAppearance

public MessageBox.MessageBoxAppearance getMessageBoxAppearance()

Returns the message box appearance.

Returns:

the message box appearance

setIcon

public void setIcon(ImageResource icon)

Description copied from interface: HasIcon

Sets the icon.

Specified by:

setIcon in interface HasIcon

Parameters:

icon - the icon

setMessage

public void setMessage(String message)

Sets the message. HTML in the message is escaped. Use setMessage(SafeHtml) to display HTML.

Parameters:

message - the message

setMessage

public void setMessage(SafeHtml message)

Sets the message.

Parameters:

message - the message

onResize

protected void onResize(int width,
                        int height)

Description copied from class: Component

Called after the widget is resized, this method is empty by default but can be implemented by any subclass that needs to perform custom logic after a resize occurs.

Overrides:

onResize in class ContentPanel

Parameters:

width - the width

height - the height

show

public void show()

Description copied from class: Window

Shows the window, rendering it first if necessary, or activates it and brings it to front if hidden.

Overrides:

show in class Window

resizeContents

protected void resizeContents()

Resize contents on show() and onResize(int, int)