org.eclipse.jface.dialogs
Class ProgressIndicator

java.lang.Object
  |
  +--org.eclipse.swt.widgets.Widget
        |
        +--org.eclipse.swt.widgets.Control
              |
              +--org.eclipse.swt.widgets.Scrollable
                    |
                    +--org.eclipse.swt.widgets.Composite
                          |
                          +--org.eclipse.jface.dialogs.ProgressIndicator

All Implemented Interfaces:

Drawable

public class ProgressIndicator

extends Composite

A control for showing progress feedback for a long running operation. In contrast to the native SWT ProgressBar control this control supports a so called "ANIMATED" mode where we don't have to know the total amount of work in advance and no worked method needs to be called.

Field Summary

Fields inherited from class org.eclipse.swt.widgets.Control

handle

Constructor Summary

ProgressIndicator(Composite parent)
Create a ProgressIndicator as a child under the given parent.

Method Summary

void	beginAnimatedTask() Initialize the progress bar to be animated.
void	beginTask(int totalWork) Initialize the progress bar.
void	done() Progress is done.
void	sendRemainingWork() Moves the progress indicator to the end.
void	worked(double work) Moves the progress indicator by the given amount of work units

Methods inherited from class org.eclipse.swt.widgets.Composite

checkSubclass, computeSize, getChildren, getLayout, getTabList, layout, layout, setFocus, setLayout, setTabList

Methods inherited from class org.eclipse.swt.widgets.Scrollable

computeTrim, getClientArea, getHorizontalBar, getVerticalBar

Methods inherited from class org.eclipse.swt.widgets.Control

addControlListener, addFocusListener, addHelpListener, addKeyListener, addMouseListener, addMouseMoveListener, addMouseTrackListener, addPaintListener, addTraverseListener, computeSize, forceFocus, getAccessible, getBackground, getBorderWidth, getBounds, getDisplay, getEnabled, getFont, getForeground, getLayoutData, getLocation, getMenu, getParent, getShell, getSize, getToolTipText, getVisible, internal_dispose_GC, internal_new_GC, isDisposed, isEnabled, isFocusControl, isReparentable, isVisible, moveAbove, moveBelow, pack, pack, redraw, redraw, removeControlListener, removeFocusListener, removeHelpListener, removeKeyListener, removeMouseListener, removeMouseMoveListener, removeMouseTrackListener, removePaintListener, removeTraverseListener, setBackground, setBounds, setBounds, setCapture, setCursor, setEnabled, setFont, setForeground, setLayoutData, setLocation, setLocation, setMenu, setParent, setRedraw, setSize, setSize, setToolTipText, setVisible, toControl, toDisplay, traverse, update

Methods inherited from class org.eclipse.swt.widgets.Widget

addDisposeListener, addListener, checkWidget, dispose, getData, getData, getStyle, isListening, notifyListeners, removeDisposeListener, removeListener, removeListener, setData, setData, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ProgressIndicator

public ProgressIndicator(Composite parent)

Create a ProgressIndicator as a child under the given parent.

Parameters:

parent - The widgets parent

Method Detail

beginAnimatedTask

public void beginAnimatedTask()

Initialize the progress bar to be animated.

beginTask

public void beginTask(int totalWork)

Initialize the progress bar.

done

public void done()

Progress is done.

sendRemainingWork

public void sendRemainingWork()

Moves the progress indicator to the end.

worked

public void worked(double work)

Moves the progress indicator by the given amount of work units