com.sencha.gxt.widget.core.client

Class Status

java.lang.Object

Widget

com.sencha.gxt.widget.core.client.Component

com.sencha.gxt.widget.core.client.Status

All Implemented Interfaces:

HasGestureRecognizers, BeforeHideEvent.HasBeforeHideHandlers, BeforeShowContextMenuEvent.HasBeforeShowContextMenuHandler, BeforeShowEvent.HasBeforeShowHandlers, BlurEvent.HasBlurHandlers, DisableEvent.HasDisableHandlers, EnableEvent.HasEnableHandlers, FocusEvent.HasFocusHandlers, HideEvent.HasHideHandlers, MoveEvent.HasMoveHandlers, ShowContextMenuEvent.HasShowContextMenuHandler, ShowEvent.HasShowHandlers, HasFocusSupport, HasIcon, HasItemId

public class Status
extends Component
implements HasIcon

A widget that displays a status message and icon, typically used in a tool bar.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Status.BoxStatusAppearance
static interface	Status.StatusAppearance

Field Summary

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, resizeHandler, shim, tabIndex, toolTip, toolTipConfig, top, width, windowResizeDelay, windowResizeTask

Constructor Summary

Constructors

Constructor and Description
Status() Creates a status component with the default appearance.
Status(Status.StatusAppearance appearance) Creates a status component with the specified appearance.

Method Summary

Modifier and Type	Method and Description
void	clearStatus(SafeHtml html) Clears the current status by removing the current icon and change the html.
void	clearStatus(String text) Clears the current status by removing the current icon and change the text.
Status.StatusAppearance	getAppearance()
String	getHTML() Returns the status html.
ImageResource	getIcon() Returns the icon.
SafeHtml	getSafeHtml() Returns the status html.
String	getText() Returns the status text.
void	setBusy(SafeHtml html) Enables a busy icon and displays the given html.
void	setBusy(String text) Enables a busy icon and displays the given text.
void	setHTML(SafeHtml html) Sets the status html.
void	setIcon(ImageResource icon) Sets the icon.
void	setText(String text) Sets the status text.

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, disable, disableContextMenu, disableEvents, enable, enableEvents, fireCancellableEvent, fireEvent, focus, getData, getElement, getFocusEl, getFocusSupport, getGestureRecognizer, getGestureRecognizerCount, getHideMode, getId, getItemId, getOffsetHeight, getOffsetWidth, getPositionEl, getShadow, getShadowPosition, getStateId, getTabIndex, getToolTip, hide, hideShadow, hideToolTip, isAllowTextSelection, isAutoHeight, isAutoWidth, isDeferHeight, isEnabled, isMonitorWindowResize, isRendered, isStateful, isVisible, isVisible, mask, mask, notifyHide, notifyShow, onAfterFirstAttach, onAttach, onBlur, onBrowserEvent, onDetach, onDisable, onEnable, onFocus, onHide, onHideContextMenu, onLoad, onPosition, onResize, onRightClick, onShow, onShowContextMenu, onTouch, onUnload, onWindowResize, removeStyleDependentName, removeStyleOnOver, removeToolTip, setAllowTextSelection, setBorders, setBounds, setBounds, setContextMenu, setData, setDeferHeight, setEnabled, setHeight, setHeight, setHideMode, setId, setItemId, setMonitorWindowResize, setPagePosition, setPixelSize, setPosition, setShadow, setShadowPosition, setSize, setStateful, setStateId, setStyleDependentName, setTabIndex, setToolTip, setToolTipConfig, setVisible, setWidth, setWidth, show, sync, syncSize, unmask

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Status

public Status()

Creates a status component with the default appearance.

Status

public Status(Status.StatusAppearance appearance)

Creates a status component with the specified appearance.

Parameters:

appearance - the appearance of the status widget.

Method Detail

clearStatus

public void clearStatus(String text)

Clears the current status by removing the current icon and change the text.

Parameters:

text - the new text value

clearStatus

public void clearStatus(SafeHtml html)

Clears the current status by removing the current icon and change the html.

Parameters:

html - the new html value

getAppearance

public Status.StatusAppearance getAppearance()

setBusy

public void setBusy(String text)

Enables a busy icon and displays the given text.

Parameters:

text - the text to display

setBusy

public void setBusy(SafeHtml html)

Enables a busy icon and displays the given html.

Parameters:

html - the html to display

getIcon

public ImageResource getIcon()

Description copied from interface: HasIcon

Returns the icon.

Specified by:

getIcon in interface HasIcon

Returns:

the icon

setIcon

public void setIcon(ImageResource icon)

Description copied from interface: HasIcon

Sets the icon.

Specified by:

setIcon in interface HasIcon

Parameters:

icon - the icon

getText

public String getText()

Returns the status text. If text was set that contained reserved html characters, the return value will be html escaped. If html was set instead, the return value will be html.

Returns:

the text or html, depending on what was set

See Also:

getHTML()

setText

public void setText(String text)

Sets the status text. Text that contains reserved html characters will be escaped.

Parameters:

text - the text

getSafeHtml

public SafeHtml getSafeHtml()

Returns the status html.

Returns:

the html

getHTML

public String getHTML()

Returns the status html.

Returns:

the html

setHTML

public void setHTML(SafeHtml html)

Sets the status html.

Parameters:

html - the html