|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.gnu.glib.GObject | +--org.gnu.gtk.GtkObject | +--org.gnu.gtk.Widget | +--org.gnu.gtk.Progress | +--org.gnu.gtk.ProgressBar
The ProgressBar is typically used to display the progress of a long running operation. It provides a visual clue that processing is underway. The ProgressBar can be used in two different modes: percentage mode and activity mode.
When an application can determine how much work needs to take place
(e.g. read a fixed number of bytes from a file) and can monitor its
progress, it can use the ProgressBar in percentage mode and the user
sees a growing bar indicating the percentage of the work that has been
completed. In this mode, the application is required to call
setFraction(double)
periodically to update the progress bar.
When an application has no accurate way of knowing the amount of work
to do, it can use the ProgressBar in activity mode, which shows activity
by a block moving back and forth within the progress area. In this mode,
the application is required to call pulse()
perodically to
update the progress bar.
There is quite a bit of flexibility provided to control the appearance of the ProgressBar. Functions are provided to control the orientation of the bar, optional text can be displayed along with the bar, and the step size used in activity mode can be set.
Constructor Summary | |
ProgressBar()
Constructs a new ProgressBar widget |
|
ProgressBar(int handle)
Construct a new ProgressBar passing a handle to a native widget resource. |
Method Summary | |
double |
getFraction()
Returns the current value of the display. |
static Type |
getType()
Retrieve the runtime type used by the GLib library. |
void |
pulse()
Indicates that some progress is made, but you don't know how much. |
void |
setFraction(double fraction)
Causes the progress bar to "fill in" the given fraction of the bar. |
void |
setOrientation(ProgressBarOrientation orientation)
Causes the progress bar to switch to a different orientation (left-to-right, right-to-left, top-to-bottom, or bottom-to-top). |
void |
setPulseStep(double fraction)
Sets the fraction of total progress bar length to move the bouncing block for each call to pulse() . |
void |
setText(java.lang.String text)
Causes the given text to appear superimposed on the progress bar. |
Methods inherited from class org.gnu.glib.GObject |
addEventHandler, addEventHandler, addEventHandler, addEventHandler, addEventHandler, addEventHandler, equals, getData, getHandle, removeEventHandler, setData |
Methods inherited from class java.lang.Object |
getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public ProgressBar()
public ProgressBar(int handle)
handle
- The handle to the native ProgressBar.Method Detail |
public void pulse()
setPulseStep(double)
).
public void setText(java.lang.String text)
text
- The string to appear on the progress barpublic void setFraction(double fraction)
fraction
- The fraction of the progress bar which should be filled
in,public double getFraction()
public void setPulseStep(double fraction)
pulse()
.
fraction
- fraction between 0.0 and 1.0public void setOrientation(ProgressBarOrientation orientation)
ProgressBarOrientation
public static Type getType()
|
Please send any bug reports, comments, or suggestions for the API or documentation to java-gnome-developer@lists.sf.net | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |