org.gnu.gtk
Class ProgressBar

java.lang.Object
  extended byorg.gnu.glib.GObject
      extended byorg.gnu.gtk.GtkObject
          extended byorg.gnu.gtk.Widget
              extended byorg.gnu.gtk.Progress
                  extended byorg.gnu.gtk.ProgressBar

public class ProgressBar
extends Progress

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.


Field Summary
 
Fields inherited from class org.gnu.glib.GObject
eventsInitialized
 
Constructor Summary
ProgressBar()
          Constructs a new ProgressBar widget
ProgressBar(Handle handle)
          Construct a new ProgressBar passing a handle to a native widget resource.
 
Method Summary
 EllipsizeMode getEllipsize()
          Returns the ellipsizing position.
 double getFraction()
          Returns the current value of the display.
static Type getType()
          Retrieve the runtime type used by the GLib library.
protected static double gtk_progress_bar_get_fraction(Handle pbar)
           
protected static int gtk_progress_bar_get_orientation(Handle pbar)
           
protected static double gtk_progress_bar_get_pulse_step(Handle pbar)
           
protected static java.lang.String gtk_progress_bar_get_text(Handle pbar)
           
protected static int gtk_progress_bar_get_type()
           
protected static Handle gtk_progress_bar_new()
           
protected static void gtk_progress_bar_pulse(Handle pbar)
           
protected static void gtk_progress_bar_set_fraction(Handle pbar, double fraction)
           
protected static void gtk_progress_bar_set_orientation(Handle pbar, int orientation)
           
protected static void gtk_progress_bar_set_pulse_step(Handle pbar, double fraction)
           
protected static void gtk_progress_bar_set_text(Handle pbar, java.lang.String text)
           
 void pulse()
          Indicates that some progress is made, but you don't know how much.
 void setEllipsize(EllipsizeMode mode)
          Sets the mode used to ellipsize (add an ellipsis: "...") the text if there is not enough space to render the entire string.
 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.gtk.Progress
getActivityMode, getAdjustment, getFormat, getOffscreenPixmap, getShowText, getUseTextFormat, getXAlign, getYAlign
 
Methods inherited from class org.gnu.gtk.Widget
activate, addListener, addListener, addListener, addListener, addListener, addListener, addListener, addListener, canActivateAccel, createContext, createLayout, destroy, draw, drawArea, drawArea, findListener, finish, fireBooleanLifeCycleEvent, fireDragDestinationEvent, fireDragSourceEvent, fireExposeEvent, fireFocusEvent, fireKeyEvent, fireLifeCycleEvent, fireMouseEvent, fireMouseMotionEvent, getAccessible, getColormap, getContext, getData, getDisplay, getEventListenerClass, getEventType, getModifierStyle, getName, getParent, getParentWindow, getPointer, getRootWindow, getScreen, getSensitive, getStyle, getToplevel, getWindow, grabDefault, grabFocus, gtk_drag_dest_set, gtk_drag_dest_unset, gtk_drag_finish, gtk_drag_get_data, gtk_drag_highlight, gtk_drag_source_set_icon_pixbuf, gtk_drag_source_set_icon_stock, gtk_drag_source_set_icon, gtk_drag_source_set, gtk_drag_source_unset, gtk_drag_unhighlight, gtk_widget_activate, gtk_widget_add_accelerator, gtk_widget_add_events, gtk_widget_add_mnemonic_label, gtk_widget_can_activate_accel, gtk_widget_child_focus, gtk_widget_child_notify, gtk_widget_class_path, gtk_widget_create_pango_context, gtk_widget_create_pango_layout, gtk_widget_destroy, gtk_widget_destroyed, gtk_widget_ensure_style, gtk_widget_event, gtk_widget_freeze_child_notify, gtk_widget_get_accessible, gtk_widget_get_ancestor, gtk_widget_get_child_requisition, gtk_widget_get_child_visible, gtk_widget_get_colormap, gtk_widget_get_composite_name, gtk_widget_get_default_colormap, gtk_widget_get_default_direction, gtk_widget_get_default_style, gtk_widget_get_default_visual, gtk_widget_get_direction, gtk_widget_get_display, gtk_widget_get_events, gtk_widget_get_extension_events, gtk_widget_get_modifier_style, gtk_widget_get_name, gtk_widget_get_pango_context, gtk_widget_get_parent_window, gtk_widget_get_parent, gtk_widget_get_pointer, gtk_widget_get_root_window, gtk_widget_get_screen, gtk_widget_get_sensitive, gtk_widget_get_settings, gtk_widget_get_size_request, gtk_widget_get_style, gtk_widget_get_toplevel, gtk_widget_get_type, gtk_widget_get_visual, gtk_widget_get_window, gtk_widget_grab_default, gtk_widget_grab_focus, gtk_widget_has_screen, gtk_widget_hide_all, gtk_widget_hide_on_delete, gtk_widget_hide, gtk_widget_intersect, gtk_widget_is_ancestor, gtk_widget_is_focus, gtk_widget_list_accel_closures, gtk_widget_list_mnemonic_labels, gtk_widget_map, gtk_widget_mnemonic_activate, gtk_widget_modify_base, gtk_widget_modify_bg, gtk_widget_modify_fg, gtk_widget_modify_font, gtk_widget_modify_style, gtk_widget_modify_text, gtk_widget_path, gtk_widget_pop_colormap, gtk_widget_pop_composite_child, gtk_widget_push_colormap, gtk_widget_push_composite_child, gtk_widget_queue_draw_area, gtk_widget_queue_draw, gtk_widget_queue_resize, gtk_widget_realize, gtk_widget_ref, gtk_widget_region_intersect, gtk_widget_remove_accelerator, gtk_widget_remove_mnemonic_label, gtk_widget_render_icon, gtk_widget_reparent, gtk_widget_reset_rc_styles, gtk_widget_send_expose, gtk_widget_set_accel_path, gtk_widget_set_app_paintable, gtk_widget_set_child_visible, gtk_widget_set_colormap, gtk_widget_set_composite_name, gtk_widget_set_default_colormap, gtk_widget_set_default_direction, gtk_widget_set_direction, gtk_widget_set_double_buffered, gtk_widget_set_events, gtk_widget_set_extension_events, gtk_widget_set_name, gtk_widget_set_parent_window, gtk_widget_set_parent, gtk_widget_set_redraw_on_allocate, gtk_widget_set_scroll_adjustments, gtk_widget_set_sensitive, gtk_widget_set_size_request, gtk_widget_set_state, gtk_widget_set_style, gtk_widget_shape_combine_mask, gtk_widget_show_all, gtk_widget_show_now, gtk_widget_show, gtk_widget_size_allocate, gtk_widget_size_request, gtk_widget_style_get_property, gtk_widget_thaw_child_notify, gtk_widget_translate_coordinates, gtk_widget_unmap, gtk_widget_unparent, gtk_widget_unrealize, gtk_widget_unref, handleButtonPressed, handleButtonReleased, handleDelete, handleDragDataGet, handleDragDestination, handleExpose, handleFocusIn, handleFocusOut, handleHide, handleKeyPressed, handleKeyReleased, handleMap, handleMouseEnter, handleMouseLeave, handleMouseMotion, handleNoExpose, handleRealize, handleScroll, handleShow, handleUnmap, hasFocus, hasScreen, hide, hideAll, highlight, intersect, isAncestor, makeWidget, modifyStyle, popColormap, pushColormap, realize, removeListener, removeListener, removeListener, removeListener, removeListener, removeListener, removeListener, removeListener, reparent, setBackgroundColor, setBaseColor, setColormap, setDoubleBuffered, setDragDestination, setDragIcon, setDragIconPixbuf, setDragIconStock, setDragSource, setFont, setForegroundColor, setMinimumSize, setName, setNoDragDestination, setNoDragSource, setSensitive, setTextColor, shapeCombineMask, show, showAll, unHighlight
 
Methods inherited from class org.gnu.gtk.GtkObject
getFlags, gtk_object_destroy, gtk_object_get_type, gtk_object_sink, setFlags, sink
 
Methods inherited from class org.gnu.glib.GObject
addEventHandler, addEventHandler, addEventHandler, addEventHandler, addEventHandler, addEventHandler, addListener, equals, freezeNotify, getBooleanProperty, getData, getData, getDoubleProperty, getFloatProperty, getGObjectFromHandle, getHandle, getIntFromHandle, getIntProperty, getJavaObjectProperty, getLongProperty, getNullHandle, getPixbufProperty, getProperty, getStringFromHandle, getStringProperty, hashCode, hasProperty, instantiateJGObjectFromGType, notify, removeEventHandler, removeListener, retrieveGObject, setBooleanProperty, setData, setData, setDoubleProperty, setFloatProperty, setHandle, setIntProperty, setJavaObjectProperty, setLongProperty, setPixbufProperty, setProperty, setStringProperty, thawNotify
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ProgressBar

public ProgressBar()
Constructs a new ProgressBar widget


ProgressBar

public ProgressBar(Handle handle)
Construct a new ProgressBar passing a handle to a native widget resource.

Parameters:
handle - The handle to the native ProgressBar.
Method Detail

pulse

public void pulse()
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 by setPulseStep(double)).


setText

public void setText(java.lang.String text)
Causes the given text to appear superimposed on the progress bar.

Parameters:
text - The string to appear on the progress bar

setFraction

public void setFraction(double fraction)
Causes the progress bar to "fill in" the given fraction of the bar. The fraction should be between 0.0 and 1.0, inclusive.

Parameters:
fraction - The fraction of the progress bar which should be filled in,

getFraction

public double getFraction()
Returns the current value of the display. This value will be returned as a value between 0.0 and 1.0.


setPulseStep

public void setPulseStep(double fraction)
Sets the fraction of total progress bar length to move the bouncing block for each call to pulse().

Parameters:
fraction - fraction between 0.0 and 1.0

setOrientation

public 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).

See Also:
ProgressBarOrientation

setEllipsize

public void setEllipsize(EllipsizeMode mode)
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

getEllipsize

public EllipsizeMode getEllipsize()
Returns the ellipsizing position.

Since:
2.6

getType

public static Type getType()
Retrieve the runtime type used by the GLib library.


gtk_progress_bar_get_type

protected static final int gtk_progress_bar_get_type()

gtk_progress_bar_new

protected static final Handle gtk_progress_bar_new()

gtk_progress_bar_pulse

protected static final void gtk_progress_bar_pulse(Handle pbar)

gtk_progress_bar_set_text

protected static final void gtk_progress_bar_set_text(Handle pbar,
                                                      java.lang.String text)

gtk_progress_bar_set_fraction

protected static final void gtk_progress_bar_set_fraction(Handle pbar,
                                                          double fraction)

gtk_progress_bar_set_pulse_step

protected static final void gtk_progress_bar_set_pulse_step(Handle pbar,
                                                            double fraction)

gtk_progress_bar_set_orientation

protected static final void gtk_progress_bar_set_orientation(Handle pbar,
                                                             int orientation)

gtk_progress_bar_get_text

protected static final java.lang.String gtk_progress_bar_get_text(Handle pbar)

gtk_progress_bar_get_fraction

protected static final double gtk_progress_bar_get_fraction(Handle pbar)

gtk_progress_bar_get_pulse_step

protected static final double gtk_progress_bar_get_pulse_step(Handle pbar)

gtk_progress_bar_get_orientation

protected static final int gtk_progress_bar_get_orientation(Handle pbar)