com.sage.swt.client.widget
Class SwtProgress

java.lang.Object
  com.google.gwt.user.client.ui.UIObject
      com.google.gwt.user.client.ui.Widget
          com.google.gwt.user.client.ui.Composite
              com.sage.swt.client.widget.AbstractSwtWidget
                  com.sage.swt.client.widget.SwtProgress

All Implemented Interfaces:

com.google.gwt.event.dom.client.HasAllMouseHandlers, com.google.gwt.event.dom.client.HasMouseDownHandlers, com.google.gwt.event.dom.client.HasMouseMoveHandlers, com.google.gwt.event.dom.client.HasMouseOutHandlers, com.google.gwt.event.dom.client.HasMouseOverHandlers, com.google.gwt.event.dom.client.HasMouseUpHandlers, com.google.gwt.event.dom.client.HasMouseWheelHandlers, com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.EventHandler, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.IsWidget, HasPropertyChangeHandlers, PropertyBag, SwtProgressContinueHandler, SwtProgressEndedHandler, SwtProgressHandler, HasAfterWidgetKeyChangedHandlers, HasBeforeWidgetKeyChangedHandlers, SwtWidget

Deprecated. Use {@link com.sage.swt.client.widget.SwtProgressDialog) instead

public class SwtProgress
extends AbstractSwtWidget
implements SwtProgressHandler

A progress widget that acts as a SwtProgressHandler and that can either be placed on a UI or be used in a progress dialog such as the SwtProgressDialog.

Nested Class Summary

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

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

Field Summary

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

DEBUG_ID_PREFIX

Constructor Summary

SwtProgress()
Deprecated. Default constructor.

SwtProgress(WidgetKey widgetKey, SwtErrorStack errorStack)
Deprecated. Constructor.

Method Summary

Caption	getCaption() Deprecated. Gets the caption for this progress widget.
static WidgetCategory	getDesignerCategory() Deprecated. Gets the widget's category in the designer.
static ImageBundleMgr.BundledImage	getDesignerImage() Deprecated. Get the image ENUM that will be used to render a graphic for this widget in the Widget List in UI Designer
static java.lang.String	getDesignerTooltip() Deprecated. Gets the widget's tooltip in the designer.
static java.lang.String	getDesignerTypeName() Deprecated. Gets the widget's type name as displayed in the designer.
java.util.Collection<Property>	getProperties() Deprecated. Gets the collection of properties contained in this bag.
protected com.google.gwt.user.client.ui.Widget	getWidget() Deprecated. Gets the topmost underlying widget that is being wrapped by this SWT widget.
static SwtWidgetCreator	getWidgetCreator() Deprecated. Gets the widget creator for this widget.
void	onProgress(SwtProgressContinueEvent event) Deprecated. Fired when a progress step happens.
void	onProgressEnded(SwtProgressEndedEvent event) Deprecated. Notification that no more progress information will be received for the operation in question (for example, when the invocation of a service operation has completed).
void	setCaption(Caption caption) Deprecated. Sets the caption for this progress widget.
void	setCaption(java.lang.String text, boolean isHTML) Deprecated. Sets the caption for this progress widget.
protected void	setElementID() Deprecated. Set Element ID for this widget.
void	setPropertyValue(Property property, java.lang.Object newValue) Deprecated. Sets the value of a property.
protected void	setupPropertyDefaultValues() Deprecated. Stores the current value of the widget properties as the default values.

Methods inherited from class com.sage.swt.client.widget.AbstractSwtWidget

addAfterWidgetKeyChangedHandler, addBeforeWidgetKeyChangedHandler, addMouseDownHandler, addMouseMoveHandler, addMouseOutHandler, addMouseOverHandler, addMouseUpHandler, addMouseWheelHandler, addPropertyChangeHandler, changeAlignmentInParent, forceBrowserRepaint, getDatasourceID, getDefaultProperties, getErrorStack, getHelpID, getHorizontalAlignmentInParent, getInstanceContext, getPreferenceBinding, getPreferenceStoreID, getPropertyDefaultValue, getPropertyValue, getSymbolID, getTitle, getVerticalAlignmentInParent, getWidgetHelper, getWidgetKey, isEnabled, isVisible, setClientProperty, setDatasourceID, setDefaultPropertyValue, setEnabled, setHelpID, setHorizontalAlignmentInParent, setInstanceContext, setPreferenceBinding, setPreferenceStoreID, setPropertyDefaultValue, setSymbolID, setTitle, setupAlignmentInParentProperties, setupDefaultAlignmentInParentProperties, setupDefaultHeightProperty, setupDefaultWidthProperty, setVerticalAlignmentInParent, setVisible, setWidgetKey

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

initWidget, isAttached, onAttach, onBrowserEvent, onDetach, setWidget

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

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getHandlerCount, getLayoutData, getParent, isOrWasAttached, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents

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

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, setWidth, sinkBitlessEvent, toString, unsinkEvents

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.gwt.event.shared.HasHandlers

fireEvent

Constructor Detail

SwtProgress

public SwtProgress()

Deprecated.

Default constructor.

SwtProgress

public SwtProgress(WidgetKey widgetKey,
                   SwtErrorStack errorStack)

Deprecated.

Constructor.

Parameters:

widgetKey - The WidgetKey for the widget.

errorStack - The SwtErrorStack that stores the list of UI errors.

Method Detail

getWidget

protected com.google.gwt.user.client.ui.Widget getWidget()

Deprecated.

Gets the topmost underlying widget that is being wrapped by this SWT widget.

Specified by:

getWidget in class AbstractSwtWidget

Returns:

The topmost underlying widget that is being wrapped by this SWT widget.

getDesignerTypeName

public static java.lang.String getDesignerTypeName()

Deprecated.

Gets the widget's type name as displayed in the designer. (For example, a "SpecialButton" class might have "Special Button" as the type name displayed in the designer.)

Returns:

The widget's displayed type name.

getDesignerTooltip

public static java.lang.String getDesignerTooltip()

Deprecated.

Gets the widget's tooltip in the designer. (For example, a "SpecialButton" class might have a tooltip of "Button that does something special".)

Returns:

The widget's designer tooltip.

getDesignerImage

public static ImageBundleMgr.BundledImage getDesignerImage()

Deprecated.

Get the image ENUM that will be used to render a graphic for this widget in the Widget List in UI Designer

Returns:

The image ENUM

getDesignerCategory

public static WidgetCategory getDesignerCategory()

Deprecated.

Gets the widget's category in the designer. The widget's are grouped in widget area with respect to category.

Returns:

The category of the widget.

getWidgetCreator

public static SwtWidgetCreator getWidgetCreator()

Deprecated.

Gets the widget creator for this widget.

Returns:

The widget creator for this widget.

getCaption

public Caption getCaption()

Deprecated.

Gets the caption for this progress widget.

This caption is shown in the frame surrounding the rest of the progress information.

Returns:

The caption for this progress widget.

setCaption

public void setCaption(java.lang.String text,
                       boolean isHTML)

Deprecated.

Sets the caption for this progress widget.

This caption is shown in the frame surrounding the rest of the progress information.

Parameters:

text - The text for the caption.

isHTML - Whether the specified text is HTML.

setCaption

public void setCaption(Caption caption)

Deprecated.

Sets the caption for this progress widget.

This caption is shown in the frame surrounding the rest of the progress information.

Parameters:

caption - The caption for the progress widget.

setElementID

protected void setElementID()

Deprecated.

Set Element ID for this widget.

Overrides:

setElementID in class AbstractSwtWidget

setPropertyValue

public void setPropertyValue(Property property,
                             java.lang.Object newValue)

Deprecated.

Sets the value of a property.

Specified by:

setPropertyValue in interface PropertyBag

Parameters:

property - The property in question.

newValue - The new value of the property.

getProperties

public java.util.Collection<Property> getProperties()

Deprecated.

Gets the collection of properties contained in this bag.

Specified by:

getProperties in interface PropertyBag

Overrides:

getProperties in class AbstractSwtWidget

Returns:

The collection of properties contained in this bag. Implementors should make sure that this collection is unmodifiable.

setupPropertyDefaultValues

protected void setupPropertyDefaultValues()

Deprecated.

Stores the current value of the widget properties as the default values. This information is then used when saving the declarative layout to determine whether or not the user has changed the value of that property to something other than the default (if they haven't - then the property is not saved). If there is no default value for a property - and the user changes it to a non-null, non-blank value, then the property will be saved.

The "default value" concept is only applicable for those properties that have an initial (i.e. non-null, non-blank) value. This value can be set automatically by the DOM or by code within the widget.

Properties that are not set to an initial value by the DOM or GWT or the widget programmer, do not belong in this function.

For example: when a widget is first created in the DOM - it has an intrinsic value for the Enabled property (true). Therefore, the Enabled property has a default value of true. The Title property on the other hand does not have an initial value in the DOM - so it does not have a default value, and should not be included in this method.

Note: This function should be called immediately after your widget has been created and its initial properties have been set. Only properties that are not set by parameters in your widget's constructor should be specified here (i.e. optional properties).

Overrides:

setupPropertyDefaultValues in class AbstractSwtWidget

onProgress

public void onProgress(SwtProgressContinueEvent event)

Deprecated.

Fired when a progress step happens.

Specified by:

onProgress in interface SwtProgressContinueHandler

Parameters:

event - the event

onProgressEnded

public void onProgressEnded(SwtProgressEndedEvent event)

Deprecated.

Notification that no more progress information will be received for the operation in question (for example, when the invocation of a service operation has completed).

Specified by:

onProgressEnded in interface SwtProgressEndedHandler