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

Class AutoProgressMessageBox

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.AutoProgressMessageBox

All Implemented Interfaces:

HasAttachHandlers, HasResizeHandlers, HasHandlers, EventListener, AcceptsOneWidget, HasEnabled, 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>, 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, Iterable<Widget>

public class AutoProgressMessageBox
extends MessageBox

A MessageBox which displays an AutoProgressBar.

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

Constructors

Constructor and Description
AutoProgressMessageBox(SafeHtml headingHtml) Creates a progress message box with the specified heading HTML.
AutoProgressMessageBox(SafeHtml headingHtml, SafeHtml messageHtml) Creates a progress message box with the specified heading and message HTML.
AutoProgressMessageBox(String headingHtml) Creates a progress message box with the specified heading HTML.
AutoProgressMessageBox(String headingHtml, String messageHtml) Creates a progress message box with the specified heading and message HTML.

Method Summary

Methods

Modifier and Type	Method and Description
void	auto() Initiates an auto-updating progress bar using the current duration, increment, and interval (see getProgressBar().
int	getMinProgressWidth() Returns the minimum progress width.
AutoProgressBar	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 (defaults to "").

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

getIcon, setIcon, setMessage, setMessage, setMessageHtml

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

addDialogHideHandler, getButton, getDialogMessages, getPredefinedButton, getPredefinedButtons, hide, isHideOnButtonClick, setDialogMessages, setHideOnButtonClick, setPredefinedButtons

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

addActivateHandler, addDeactivateHandler, addMaximizeHandler, addMinimizeHandler, addRestoreHandler, alignTo, center, focus, getAppearance, getConstrain, getContainer, getDraggable, getFocusWidget, getMinHeight, getMinWidth, getResizable, 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, forceLayout, 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

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, getShadowPosition, getStateId, getTabIndex, 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, setShadowPosition, setSize, setStateful, setStateId, setTabIndex, setToolTip, 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, unsinkEvents

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

Methods inherited from class java.lang.Object

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

Constructor Detail

AutoProgressMessageBox

public AutoProgressMessageBox(SafeHtml headingHtml)

Creates a progress message box with the specified heading HTML. The progress bar auto-updates using the current duration, increment, and interval (see getProgressBar().

Parameters:

headingHtml - the HTML to display for the message box heading

AutoProgressMessageBox

public AutoProgressMessageBox(SafeHtml headingHtml,
                      SafeHtml messageHtml)

Creates a progress message box with the specified heading and message HTML. The progress bar auto-updates using the current duration, increment, and interval (see getProgressBar().

Parameters:

headingHtml - the HTML to display for the message box heading

messageHtml - the HTML to display in the message box

AutoProgressMessageBox

public AutoProgressMessageBox(String headingHtml)

Creates a progress message box with the specified heading HTML. The progress bar auto-updates using the current duration, increment, and interval (see getProgressBar(). It is the caller's responsibility to ensure the HTML is CSS safe.

Parameters:

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

AutoProgressMessageBox

public AutoProgressMessageBox(String headingHtml,
                      String messageHtml)

Creates a progress message box with the specified heading and message HTML. The progress bar auto-updates using the current duration, increment, and interval (see getProgressBar(). 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

auto

public void auto()

Initiates an auto-updating progress bar using the current duration, increment, and interval (see getProgressBar().

getMinProgressWidth

public int getMinProgressWidth()

Returns the minimum progress width.

Returns:

the width

getProgressBar

public AutoProgressBar 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 (defaults to "").

Parameters:

progressText - the progress text