org.eclipse.swt.widgets
Class ProgressBar

java.lang.Object
  |
  +--org.eclipse.swt.widgets.Widget
        |
        +--org.eclipse.swt.widgets.Control
              |
              +--org.eclipse.swt.widgets.ProgressBar

All Implemented Interfaces:

Drawable

public class ProgressBar

extends Control

Safe: Instances of the receiver represent is an unselectable user interface object that is used to display progress, typically in the form of a bar.

Styles:

SMOOTH, HORIZONTAL, VERTICAL, INDETERMINATE

Events:

(none)

Note: Only one of the styles HORIZONTAL and VERTICAL may be specified.

IMPORTANT: This class is intended to be subclassed only within the SWT implementation.

Field Summary

(package private) static int	DELAY
(package private) static org.eclipse.swt.internal.win32.TCHAR	ProgressBarClass
(package private) static int	ProgressBarProc
(package private) static int	TIMER_ID

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

ACCENTS, accessible, background, drawCount, foreground, handle, hCursor, layoutData, menu, parent, toolTipText

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

CANVAS, COMCTL32_MAJOR, COMCTL32_MINOR, data, DEFAULT_HEIGHT, DEFAULT_WIDTH, DISABLED, DISPOSED, eventTable, HIDDEN, keys, MAJOR, MINOR, Mnemonic, state, style, values

Constructor Summary

ProgressBar(Composite parent, int style)
Enabled: Constructs a new instance of this class given its parent and a style value describing its behavior and appearance.

Method Summary

(package private) int	callWindowProc(int msg, int wParam, int lParam)
(package private) static int	checkStyle(int style)
Point	computeSize(int wHint, int hHint, boolean changed) Enabled:
(package private) void	createHandle()
(package private) int	defaultForeground()
int	getMaximum() Enabled: Returns the maximum value which the receiver will allow.
int	getMinimum() Enabled: Returns the minimum value which the receiver will allow.
int	getSelection() Enabled: Returns the single selection that is the receiver's position.
(package private) void	releaseWidget()
(package private) void	setBackgroundPixel(int pixel)
boolean	setFocus() Suppressed:
(package private) void	setForegroundPixel(int pixel)
void	setMaximum(int value) Enabled: Sets the maximum value which the receiver will allow to be the argument which must be greater than or equal to zero.
void	setMinimum(int value) Enabled: Sets the minimum value which the receiver will allow to be the argument which must be greater than or equal to zero.
void	setSelection(int value) Enabled: Sets the single selection that is the receiver's position to the argument which must be greater than or equal to zero.
(package private) int	widgetStyle()
(package private) org.eclipse.swt.internal.win32.TCHAR	windowClass()
(package private) int	windowProc()
(package private) org.eclipse.swt.internal.win32.LRESULT	WM_GETDLGCODE(int wParam, int lParam)
(package private) org.eclipse.swt.internal.win32.LRESULT	WM_TIMER(int wParam, int lParam)

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

addControlListener, addFocusListener, addHelpListener, addKeyListener, addMouseListener, addMouseMoveListener, addMouseTrackListener, addPaintListener, addTraverseListener, checkOrientation, computeSize, computeTabGroup, computeTabList, computeTabRoot, createWidget, defaultBackground, defaultFont, deregister, destroyWidget, drawBackground, drawBackground, findBrush, findCursor, findMnemonic, fixFocus, forceFocus, forceResize, getAccessible, getBackground, getBackgroundPixel, getBorderWidth, getBounds, getCodePage, getDisplay, getEnabled, getFont, getForeground, getForegroundPixel, getLayoutData, getLocation, getMenu, getParent, getPath, getShell, getSize, getToolTipText, getVisible, hasCursor, hasFocus, internal_dispose_GC, internal_new_GC, isActive, isDisposed, isEnabled, isFocusAncestor, isFocusControl, isReparentable, isShowing, isTabGroup, isTabItem, isVisible, menuShell, mnemonicHit, mnemonicMatch, moveAbove, moveBelow, new_Accessible, pack, pack, redraw, redraw, register, releaseHandle, removeControlListener, removeFocusListener, removeHelpListener, removeKeyListener, removeMouseListener, removeMouseMoveListener, removeMouseTrackListener, removePaintListener, removeTraverseListener, sendKeyEvent, sendKeyEvent, sendMouseEvent, sendMouseEvent, setBackground, setBounds, setBounds, setBounds, setCapture, setCursor, setDefaultFont, setEnabled, setFont, setForeground, setLayoutData, setLocation, setLocation, setMenu, setParent, setRadioFocus, setRadioSelection, setRedraw, setSavedFocus, setSize, setSize, setTabGroupFocus, setTabItemFocus, setToolTipText, setVisible, sort, subclass, toControl, toControl, toDisplay, toDisplay, transferActive, transferFocus, translateAccelerator, translateMnemonic, translateMnemonic, translateTraversal, traverse, traverse, traverseEscape, traverseGroup, traverseItem, traverseMnemonic, traversePage, traverseReturn, unsubclass, update, update, updateFont, widgetExtStyle, windowProc, WM_ACTIVATE, WM_CHAR, WM_CLEAR, WM_CLOSE, WM_COMMAND, WM_CONTEXTMENU, WM_CTLCOLOR, WM_CUT, WM_DESTROY, WM_DRAWITEM, WM_ENDSESSION, WM_ERASEBKGND, WM_GETFONT, WM_GETOBJECT, WM_HELP, WM_HOTKEY, WM_HSCROLL, WM_IME_CHAR, WM_IME_COMPOSITION, WM_INITMENUPOPUP, WM_KEYDOWN, WM_KEYUP, WM_KILLFOCUS, WM_LBUTTONDBLCLK, WM_LBUTTONDOWN, WM_LBUTTONUP, WM_MBUTTONDBLCLK, WM_MBUTTONDOWN, WM_MBUTTONUP, WM_MEASUREITEM, WM_MENUCHAR, WM_MENUSELECT, WM_MOUSEACTIVATE, WM_MOUSEHOVER, WM_MOUSELEAVE, WM_MOUSEMOVE, WM_MOUSEWHEEL, WM_MOVE, WM_NCACTIVATE, WM_NCCALCSIZE, WM_NCHITTEST, WM_NOTIFY, WM_PAINT, WM_PALETTECHANGED, WM_PASTE, WM_PRINTCLIENT, WM_QUERYENDSESSION, WM_QUERYNEWPALETTE, WM_QUERYOPEN, WM_RBUTTONDBLCLK, WM_RBUTTONDOWN, WM_RBUTTONUP, WM_SETCURSOR, WM_SETFOCUS, WM_SETFONT, WM_SETREDRAW, WM_SETTINGCHANGE, WM_SHOWWINDOW, WM_SIZE, WM_SYSCHAR, WM_SYSCOLORCHANGE, WM_SYSCOMMAND, WM_SYSKEYDOWN, WM_SYSKEYUP, WM_UNDO, WM_VSCROLL, WM_WINDOWPOSCHANGING, wmColorChild, wmCommandChild, wmDrawChild, wmMeasureChild, wmNotifyChild, wmScrollChild

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

addDisposeListener, addListener, checkBits, checkParent, checkSubclass, checkWidget, dispose, error, filters, getData, getData, getName, getNameText, getStyle, hooks, isListening, isValidSubclass, isValidThread, mbcsToWcs, mbcsToWcs, notifyListeners, postEvent, postEvent, releaseChild, releaseResources, removeDisposeListener, removeListener, removeListener, sendEvent, sendEvent, sendEvent, sendEvent, setData, setData, setInputState, setKeyState, toString, wcsToMbcs, wcsToMbcs

Methods inherited from class java.lang.Object

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

Field Detail

DELAY

static final int DELAY

TIMER_ID

static final int TIMER_ID

ProgressBarProc

static final int ProgressBarProc

ProgressBarClass

static final org.eclipse.swt.internal.win32.TCHAR ProgressBarClass

Constructor Detail

ProgressBar

public ProgressBar(Composite parent,
                   int style)

Enabled: Constructs a new instance of this class given its parent and a style value describing its behavior and appearance.

The style value is either one of the style constants defined in class SWT which is applicable to instances of this class, or must be built by bitwise OR'ing together (that is, using the int "|" operator) two or more of those SWT style constants. The class description lists the style constants that are applicable to the class. Style bits are also inherited from superclasses.

Parameters:

parent - a composite control which will be the parent of the new instance (cannot be null)

style - the style of control to construct

See Also:

SWT.SMOOTH, SWT.HORIZONTAL, SWT.VERTICAL, Widget.checkSubclass(), Widget.getStyle()

Method Detail

callWindowProc

int callWindowProc(int msg,
                   int wParam,
                   int lParam)

Specified by:

callWindowProc in class Control

checkStyle

static int checkStyle(int style)

computeSize

public Point computeSize(int wHint,
                         int hHint,
                         boolean changed)

Enabled:

Overrides:

computeSize in class Control

Parameters:

wHint - the width hint (can be SWT.DEFAULT)

hHint - the height hint (can be SWT.DEFAULT)

changed - true if the control's contents have changed, and false otherwise

Returns:

the preferred size of the control.

See Also:

Layout, Control.getBorderWidth(), Control.getBounds(), Control.getSize(), Control.pack(), "computeTrim, getClientArea for controls that implement them"

createHandle

void createHandle()

Overrides:

createHandle in class Control

defaultForeground

int defaultForeground()

Overrides:

defaultForeground in class Control

getMaximum

public int getMaximum()

Enabled: Returns the maximum value which the receiver will allow.

Returns:

the maximum

getMinimum

public int getMinimum()

Enabled: Returns the minimum value which the receiver will allow.

Returns:

the minimum

getSelection

public int getSelection()

Enabled: Returns the single selection that is the receiver's position.

Returns:

the selection

releaseWidget

void releaseWidget()

Overrides:

releaseWidget in class Control

setBackgroundPixel

void setBackgroundPixel(int pixel)

Overrides:

setBackgroundPixel in class Control

setFocus

public boolean setFocus()

Suppressed:

Overrides:

setFocus in class Control

Returns:

true if the control got focus, and false if it was unable to.

See Also:

Control.forceFocus()

setForegroundPixel

void setForegroundPixel(int pixel)

Overrides:

setForegroundPixel in class Control

setMaximum

public void setMaximum(int value)

Enabled: Sets the maximum value which the receiver will allow to be the argument which must be greater than or equal to zero.

Parameters:

value - the new maximum (must be zero or greater)

setMinimum

public void setMinimum(int value)

Enabled: Sets the minimum value which the receiver will allow to be the argument which must be greater than or equal to zero.

Parameters:

value - the new minimum (must be zero or greater)

setSelection

public void setSelection(int value)

Enabled: Sets the single selection that is the receiver's position to the argument which must be greater than or equal to zero.

Parameters:

value - the new selection (must be zero or greater)

widgetStyle

int widgetStyle()

Overrides:

widgetStyle in class Control

windowClass

org.eclipse.swt.internal.win32.TCHAR windowClass()

Specified by:

windowClass in class Control

windowProc

int windowProc()

Specified by:

windowProc in class Control

WM_GETDLGCODE

org.eclipse.swt.internal.win32.LRESULT WM_GETDLGCODE(int wParam,
                                                     int lParam)

Overrides:

WM_GETDLGCODE in class Control

WM_TIMER

org.eclipse.swt.internal.win32.LRESULT WM_TIMER(int wParam,
                                                int lParam)

Overrides:

WM_TIMER in class Control