Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
GObject
org.gnu.gtk.GtkObject
org.gnu.gtk.Widget
org.gnu.gtk.Progress
org.gnu.gtk.ProgressBar
public class ProgressBar
extends Progress
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()
periodically 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 | |
| |
|
Method Summary | |
EllipsizeMode |
|
double |
|
static ProgressBar |
|
static Type |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
public ProgressBar()
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
Constructs a new ProgressBar widget
public ProgressBar(Handle handle)
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
Construct a new ProgressBar passing a handle to a native widget resource.
- Parameters:
handle
- The handle to the native ProgressBar.
public EllipsizeMode getEllipsize()
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
Returns the ellipsizing position.
- Since:
- 2.6
public double getFraction()
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
Returns the current value of the display. This value will be returned as a value between 0.0 and 1.0.
public static ProgressBar getProgressBar(Handle handle)
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
Internal static factory method to be used by Java-Gnome only.
public static Type getType()
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
Retrieve the runtime type used by the GLib library.
public void pulse()
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
Indicates that some progress is made, but you don't know how much. Causes the progress bar to enter "activity mode," where a block bounces back and forth. Each call to pulse() causes the block to move by a little bit (the amount of movement per pulse is determined bysetPulseStep(double)
).
public void setEllipsize(EllipsizeMode mode)
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
Sets the mode used to ellipsize (add an ellipsis: "...") the text if there is not enough space to render the entire string.
- Since:
- 2.6
public void setFraction(double fraction)
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
Causes the progress bar to "fill in" the given fraction of the bar. The fraction should be between 0.0 and 1.0, inclusive. Any value less than 0.0 will be considered as 0.0, and any value bigger than 1.0 will be considered as 1.0. The reason why this is done is because Java has a strict implementation of doubles and floats, and sometimes that can cause unwanted rounding of numbers.
For example, you may think '0.9 + 0.1 = 1.0', but the fact is that could actually result in 1.00001, or anything like that.
- Parameters:
fraction
- The fraction of the progress bar which should be filled in
public void setOrientation(ProgressBarOrientation orientation)
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
Causes the progress bar to switch to a different orientation (left-to-right, right-to-left, top-to-bottom, or bottom-to-top).
- See Also:
ProgressBarOrientation
public void setPulseStep(double fraction)
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
Sets the fraction of total progress bar length to move the bouncing block for each call topulse()
.
- Parameters:
fraction
- fraction between 0.0 and 1.0
public void setText(String text)
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
Causes the given text to appear superimposed on the progress bar.
- Parameters:
text
- The string to appear on the progress bar