Package 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. This control supports both determinate and indeterminate SWT progress bars. For indeterminate progress, 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

Constructors

Constructor	Description
ProgressIndicator(Composite parent)	Create a ProgressIndicator as a child under the given parent.
ProgressIndicator(Composite parent, int style)	Create a ProgressIndicator as a child under the given parent.

Method Summary

Modifier and Type	Method	Description
void	beginAnimatedTask()	Initialize the progress bar to be animated.
void	beginTask(int max)	Initialize the progress bar.
void	done()	Progress is done.
void	sendRemainingWork()	Moves the progress indicator to the end.
void	setWork(int max, int work)	Initializes and resets the progress bar to a specific work.
void	showError()	Show the receiver as showing an error.
void	showNormal()	Reset the progress bar to it's normal style.
void	showPaused()	Show the receiver as being paused.
void	worked(double work)	Moves the progress indicator by the given amount of work units

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

changed, checkSubclass, drawBackground, getBackgroundMode, getChildren, getLayout, getLayoutDeferred, getTabList, isLayoutDeferred, layout, layout, layout, layout, layout, setBackgroundMode, setFocus, setLayout, setLayoutDeferred, setTabList, toString

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

computeTrim, getClientArea, getHorizontalBar, getScrollbarsMode, getVerticalBar, setScrollbarsMode

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

addControlListener, addDragDetectListener, addFocusListener, addGestureListener, addHelpListener, addKeyListener, addMenuDetectListener, addMouseListener, addMouseMoveListener, addMouseTrackListener, addMouseWheelListener, addPaintListener, addTouchListener, addTraverseListener, computeSize, computeSize, dragDetect, dragDetect, forceFocus, getAccessible, getBackground, getBackgroundImage, getBorderWidth, getBounds, getCursor, getDragDetect, getEnabled, getFont, getForeground, getLayoutData, getLocation, getMenu, getMonitor, getOrientation, getParent, getRegion, getShell, getSize, getTextDirection, getToolTipText, getTouchEnabled, getVisible, internal_dispose_GC, internal_new_GC, isEnabled, isFocusControl, isReparentable, isVisible, moveAbove, moveBelow, pack, pack, print, redraw, redraw, removeControlListener, removeDragDetectListener, removeFocusListener, removeGestureListener, removeHelpListener, removeKeyListener, removeMenuDetectListener, removeMouseListener, removeMouseMoveListener, removeMouseTrackListener, removeMouseWheelListener, removePaintListener, removeTouchListener, removeTraverseListener, requestLayout, setBackground, setBackgroundImage, setBounds, setBounds, setCapture, setCursor, setDragDetect, setEnabled, setFont, setForeground, setLayoutData, setLocation, setLocation, setMenu, setOrientation, setParent, setRedraw, setRegion, setSize, setSize, setTextDirection, setToolTipText, setTouchEnabled, setVisible, toControl, toControl, toDisplay, toDisplay, traverse, traverse, traverse, update

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

addDisposeListener, addListener, addTypedListener, checkWidget, dispose, getData, getData, getDisplay, getListeners, getStyle, getTypedListeners, isAutoDirection, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, removeListener, removeTypedListener, reskin, setData, setData

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.swt.graphics.Drawable

isAutoScalable

Constructor Details

ProgressIndicator

public ProgressIndicator(Composite parent)

Create a ProgressIndicator as a child under the given parent.

Parameters:

parent - The widgets parent

ProgressIndicator

public ProgressIndicator(Composite parent,
 int style)

Create a ProgressIndicator as a child under the given parent.

Parameters:

parent - The widgets parent

style - the SWT style constants for progress monitors created by the receiver.

Since:

3.4

Method Details

beginAnimatedTask

public void beginAnimatedTask()

Initialize the progress bar to be animated.

beginTask

public void beginTask(int max)

Initialize the progress bar.

Parameters:

max - The maximum value.

setWork

public void setWork(int max,
 int work)

Initializes and resets the progress bar to a specific work. This allows to set a progress to less then the work already done.

Parameters:

max - The maximum value.

work - The work already done.

Since:

3.29

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

Parameters:

work - the amount of work to increment by.

showError

public void showError()

Show the receiver as showing an error.

Since:

3.4

showPaused

public void showPaused()

Show the receiver as being paused.

Since:

3.4

showNormal

public void showNormal()

Reset the progress bar to it's normal style.

Since:

3.4