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

java.lang.Object
  com.google.gwt.user.client.ui.UIObject
      com.google.gwt.user.client.ui.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
                                          com.sencha.gxt.widget.core.client.box.ProgressMessageBox

All Implemented Interfaces:

HasAttachHandlers, HasResizeHandlers, HasHandlers, EventListener, AcceptsOneWidget, HasOneWidget, HasVisibility, HasWidgets, HasWidgets.ForIsWidget, IndexedPanel, IndexedPanel.ForIsWidget, IsWidget, ProvidesResize, RequiresResize, 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>, 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, Iterable<Widget>

public class ProgressMessageBox
extends MessageBox

A MessageBox which displays a ProgressBar.

Nested Class Summary

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

MessageBox.MessageBoxAppearance, MessageBox.MessageBoxIcons

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

Dialog.DialogMessages, Dialog.PredefinedButton

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

Window.WindowAppearance, Window.WindowMessages

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

ContentPanel.ContentPanelAppearance, ContentPanel.ContentPanelMessages, ContentPanel.PanelHeaderAppearance

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.HasWidgets

HasWidgets.ForIsWidget

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.IndexedPanel

IndexedPanel.ForIsWidget

Field Summary

Fields inherited from class com.sencha.gxt.widget.core.client.box.MessageBox

ICONS

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

DEBUG_ID_PREFIX

Constructor Summary

ProgressMessageBox(SafeHtml headingHtml)
Creates a progress message box with the specified heading HTML.

ProgressMessageBox(SafeHtml headingHtml, SafeHtml messageHtml)
Creates a progress message box with the specified heading and message HTML.

ProgressMessageBox(String headingHtml)
Creates a progress message box with the specified heading HTML.

ProgressMessageBox(String headingHtml, String messageHtml)
Creates a progress message box with the specified heading and message HTML.

Method Summary

int	getMinProgressWidth() Returns the minimum progress width.
ProgressBar	getProgressBar() Returns the box's progress bar.
String	getProgressText() Returns the progress text.
void	setMinProgressWidth(int minProgressWidth) The minimum width in pixels of the message box if it is a progress-style dialog.
void	setProgressText(String progressText) The text to display inside the progress bar.
void	updateProgress(double value, String text) Updates a progress-style message box's text and progress bar.

Methods inherited from class com.sencha.gxt.widget.core.client.box.MessageBox

getIcon, setIcon, setMessage

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

getButtonById, getDialogMessages, getPredefinedButtons, isHideOnButtonClick, setDialogMessages, setHideOnButtonClick, setPredefinedButtons

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

addActivateHandler, addDeactivateHandler, addMaximizeHandler, addMinimizeHandler, addRestoreHandler, alignTo, center, focus, getConstrain, getContainer, getDraggable, getFocusWidget, getHideButton, getMinHeight, getMinWidth, getResizable, hide, hide, isAutoHide, isBlinkModal, isClosable, isDraggable, isMaximizable, isMaximized, isMinimizable, isModal, isOnEsc, isResizable, maximize, minimize, onBrowserEvent, restore, setActive, setAutoHide, setBlinkModal, setClosable, setConstrain, setContainer, setDraggable, setFocusWidget, setMaximizable, setMinHeight, setMinimizable, setMinWidth, setModal, setOnEsc, setPagePosition, setPosition, setResizable, setWindowMessages, setZIndex, show, toBack, toFront

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

addBeforeCollapseHandler, addBeforeExpandHandler, addButton, addCollapseHandler, addExpandHandler, addTool, collapse, expand, getAnimationDuration, getBody, getButtonAlign, getButtonBar, getHeader, getHTML, getMessages, getMinButtonWidth, getText, isAnimCollapse, isCollapsed, isCollapsible, isExpanded, isHideCollapseTool, isTitleCollapse, setAnimationDuration, setAnimCollapse, setBodyBorder, setBodyStyle, setBodyStyleName, setButtonAlign, setCollapsible, setExpanded, setHeaderVisible, setHeadingHtml, setHeadingHtml, setHeadingText, setHideCollapseTool, setMessages, setMinButtonWidth, setTitleCollapse

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

add, add, getWidget, isResize, setResize, setWidget, setWidget

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

forceLayout, isLayoutRunning, isOrWasLayoutRunning, onResize

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

add, addAddHandler, addBeforeAddHandler, addBeforeRemoveHandler, addContainerHandler, addRemoveHandler, clear, disable, enable, findWidget, getItemByItemId, getWidget, getWidgetCount, getWidgetIndex, getWidgetIndex, iterator, remove, remove, remove

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

addBeforeHideHandler, addBeforeShowContextMenuHandler, addBeforeShowHandler, addBlurHandler, addDisableHandler, addEnableHandler, addFocusHandler, addHideHandler, addMoveHandler, addResizeHandler, addShowContextMenuHandler, addShowHandler, addStyleOnOver, clearSizeCache, disableEvents, enableEvents, fireEvent, getData, getElement, getFocusSupport, getHideMode, getId, getItemId, getOffsetHeight, getOffsetWidth, getShadow, getStateId, getToolTip, hideToolTip, isAllowTextSelection, isAutoHeight, isAutoWidth, isDeferHeight, isEnabled, isRendered, isStateful, isVisible, isVisible, mask, mask, removeToolTip, setAllowTextSelection, setBorders, setBounds, setBounds, setContextMenu, setData, setDeferHeight, setEnabled, setHeight, setHeight, setHideMode, setId, setItemId, setPixelSize, setShadow, setSize, setStateful, setStateId, setTabIndex, setToolTip, setToolTipConfig, setVisible, setWidth, setWidth, sync, syncSize, unmask

Methods inherited from class com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, getLayoutData, getParent, isAttached, removeFromParent, setLayoutData, sinkEvents

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

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getOffsetHeight, getOffsetWidth, getStyleName, getStylePrimaryName, getTitle, isVisible, removeStyleDependentName, removeStyleName, setStyleDependentName, setStyleName, setStyleName, setStylePrimaryName, setTitle, setVisible, sinkBitlessEvent, toString, unsinkEvents

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ProgressMessageBox

public ProgressMessageBox(SafeHtml headingHtml)

Creates a progress message box with the specified heading HTML.

Parameters:

headingHtml - the HTML to display for the message box heading

ProgressMessageBox

public ProgressMessageBox(SafeHtml headingHtml,
                          SafeHtml messageHtml)

Creates a progress message box with 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

ProgressMessageBox

public ProgressMessageBox(String headingHtml)

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

Parameters:

headingHtml - the HTML to display for the message box heading.

ProgressMessageBox

public ProgressMessageBox(String headingHtml,
                          String messageHtml)

Creates a progress message box with the specified heading and message HTML. 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

Method Detail

getMinProgressWidth

public int getMinProgressWidth()

Returns the minimum progress width.

Returns:

the width

getProgressBar

public ProgressBar getProgressBar()

Returns the box's progress bar.

Returns:

the progress bar

getProgressText

public String getProgressText()

Returns the progress text.

Returns:

the progress text

setMinProgressWidth

public void setMinProgressWidth(int minProgressWidth)

The minimum width in pixels of the message box if it is a progress-style dialog. This is useful for setting a different minimum width than text-only dialogs may need (defaults to 250).

Parameters:

minProgressWidth - the min progress width

setProgressText

public void setProgressText(String progressText)

The text to display inside the progress bar.

Parameters:

progressText - the progress text

updateProgress

public void updateProgress(double value,
                           String text)

Updates a progress-style message box's text and progress bar.

Parameters:

value - any number between 0 and 1 (e.g., .5)

text - the progress text to display inside the progress bar or null