---

Overview  Package    Class   Use  Tree  Deprecated  Index  Help		Eclipse Platform Release 3.5
PREV CLASS    NEXT CLASS	NO FRAMES
SUMMARY: NESTED |  FIELD |  CONSTR |  METHOD	DETAIL: FIELD |  CONSTR |  METHOD

---

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
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
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	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, computeSize, getBackgroundMode, getChildren, getLayout, getLayoutDeferred, getTabList, isLayoutDeferred, layout, layout, layout, layout, setBackgroundMode, setFocus, setLayout, setLayoutDeferred, setTabList

 

Methods inherited from class org.eclipse.swt.widgets. Scrollable
computeTrim, getClientArea, getHorizontalBar, getVerticalBar

 

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

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

 

Methods inherited from class org.eclipse.swt.widgets. Widget
addDisposeListener, addListener, checkWidget, dispose, getData, getData, getDisplay, getListeners, getStyle, isDisposed, 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

---

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 Detail

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.

---

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

---

Overview  Package    Class   Use  Tree  Deprecated  Index  Help		Eclipse Platform Release 3.5
PREV CLASS    NEXT CLASS	NO FRAMES
SUMMARY: NESTED |  FIELD |  CONSTR |  METHOD	DETAIL: FIELD |  CONSTR |  METHOD

---

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.