|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.google.gwt.user.client.ui.UIObject
com.google.gwt.user.client.ui.Widget
com.smartgwt.client.widgets.BaseWidget
com.smartgwt.client.widgets.Canvas
com.smartgwt.client.widgets.StatefulCanvas
com.smartgwt.client.widgets.StretchImg
com.smartgwt.client.widgets.Progressbar
public class Progressbar
The Progressbar widget class extends the StretchImg class to implement image-based progress bars (graphical bars whose lengths represent percentages, typically of task completion).
Nested Class Summary |
---|
Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject |
---|
UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled |
Field Summary |
---|
Fields inherited from class com.smartgwt.client.widgets.BaseWidget |
---|
config, configOnly, id, isElementSet, scClassName |
Fields inherited from class com.google.gwt.user.client.ui.UIObject |
---|
DEBUG_ID_PREFIX |
Constructor Summary | |
---|---|
Progressbar()
|
|
Progressbar(JavaScriptObject jsObj)
|
Method Summary | |
---|---|
HandlerRegistration |
addPercentChangedHandler(PercentChangedHandler handler)
Add a percentChanged handler. |
protected JavaScriptObject |
create()
|
int |
getBreadth()
Thickness of the progressbar in pixels. |
int |
getLength()
Length of the progressbar in pixels. |
static Progressbar |
getOrCreateRef(JavaScriptObject jsObj)
|
int |
getPercentDone()
Number from 0 to 100, inclusive, for the percentage to be displayed graphically in this progressbar. |
String |
getSrc()
The base file name for the progressbar image. |
Boolean |
getVertical()
Indicates whether this is a vertical or horizontal progressbar. |
void |
setBreadth(int breadth)
Thickness of the progressbar in pixels. |
void |
setLength(int length)
Length of the progressbar in pixels. |
void |
setPercentDone(int percentDone)
Number from 0 to 100, inclusive, for the percentage to be displayed graphically in this progressbar. |
void |
setSrc(String src)
The base file name for the progressbar image. |
void |
setVertical(Boolean vertical)
Indicates whether this is a vertical or horizontal progressbar. |
Methods inherited from class com.smartgwt.client.widgets.StretchImg |
---|
getCapSize, getHSrc, getImageType, getItemBaseStyle, getShowGrip, getShowTitle, getVSrc, setCapSize, setHSrc, setImageType, setItemBaseStyle, setShowGrip, setShowTitle, setState, setState, setVSrc |
Methods inherited from class com.google.gwt.user.client.ui.Widget |
---|
addDomHandler, addHandler, delegateEvent, doAttachChildren, doDetachChildren, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onBrowserEvent, onDetach, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents |
Methods inherited from class com.google.gwt.user.client.ui.UIObject |
---|
addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getStyleElement, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, setElement, setPixelSize, setSize, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, unsinkEvents |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface com.google.gwt.event.shared.HasHandlers |
---|
fireEvent |
Constructor Detail |
---|
public Progressbar()
public Progressbar(JavaScriptObject jsObj)
Method Detail |
---|
public static Progressbar getOrCreateRef(JavaScriptObject jsObj)
protected JavaScriptObject create()
create
in class StretchImg
public void setPercentDone(int percentDone)
percentDone
- percent to show as done (0-100). Default value is 0public int getPercentDone()
public void setLength(int length) throws IllegalStateException
This property must be set instead of setting width
or height
.
Sets the length of the progressbar to newLength. This is the width of a horizontal progressbar, or the height of a vertical progressbar.
length
- the new length of the progressbar. Default value is 100
IllegalStateException
- this property cannot be changed after the component has been createdpublic int getLength()
This property must be set instead of setting width
or height
.
public void setBreadth(int breadth) throws IllegalStateException
This property must be set instead of setting width
or height
.
Sets the breadth of the progressbar to newLength. This is the height of a horizontal progressbar, or the width of a vertical progressbar.
breadth
- the new breadth of the progressbar. Default value is 20
IllegalStateException
- this property cannot be changed after the component has been createdpublic int getBreadth()
This property must be set instead of setting width
or height
.
public void setVertical(Boolean vertical)
setVertical
in class StretchImg
vertical
- vertical Default value is falsepublic Boolean getVertical()
getVertical
in class StretchImg
public void setSrc(String src)
setSrc
in class StretchImg
src
- src Default value is "[SKIN]progressbar.gif"public String getSrc()
getSrc
in class StretchImg
public HandlerRegistration addPercentChangedHandler(PercentChangedHandler handler)
This method is called when the percentDone value changes. Observe this method to be notified upon a change to the percentDone value.
addPercentChangedHandler
in interface HasPercentChangedHandlers
handler
- the percentChanged handler
HandlerRegistration
used to remove this handler
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |