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

Instances of the receiver represent 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 not intended to be subclassed.

See Also:

ProgressBar snippets, SWT Example: ControlExample, Sample code and further information

Structure Diagram

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static int	DELAY
(package private) static int	MINIMUM_WIDTH
(package private) static TCHAR	ProgressBarClass
(package private) static int	ProgressBarProc
(package private) static int	TIMER_ID

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

accessible, background, backgroundImage, cursor, drawCount, font, foreground, handle, layoutData, menu, parent, region, toolTipText

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

CANVAS, data, DEFAULT_HEIGHT, DEFAULT_WIDTH, DISABLED, display, DISPOSE_SENT, DISPOSED, DRAG_DETECT, DRAW_BACKGROUND, eventTable, FOREIGN_HANDLE, HIDDEN, IGNORE_WM_CHANGEUISTATE, KEYED_DATA, LAYOUT_CHANGED, LAYOUT_CHILD, LAYOUT_NEEDED, MAJOR, MINOR, MOVE_DEFERRED, MOVE_OCCURRED, PARENT_BACKGROUND, RELEASED, RESIZE_DEFERRED, RESIZE_OCCURRED, SKIN_NEEDED, state, style, THEME_BACKGROUND, TRACK_MOUSE

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
(package private) int	callWindowProc(int hwnd, int msg, int wParam, int lParam)
(package private) static int	checkStyle(int style)
Point	computeSize(int wHint, int hHint, boolean changed) Returns the preferred size of the receiver.
(package private) void	createHandle()
(package private) int	defaultForeground()
int	getMaximum() Returns the maximum value which the receiver will allow.
int	getMinimum() Returns the minimum value which the receiver will allow.
int	getSelection() Returns the single 'selection' that is the receiver's position.
int	getState() Returns the state of the receiver.
(package private) void	releaseWidget()
(package private) void	setBackgroundPixel(int pixel)
(package private) void	setForegroundPixel(int pixel)
void	setMaximum(int value) Sets the maximum value that the receiver will allow.
void	setMinimum(int value) Sets the minimum value that the receiver will allow.
void	setSelection(int value) Sets the single 'selection' that is the receiver's position to the argument which must be greater than or equal to zero.
void	setState(int state) Sets the state of the receiver.
(package private) void	startTimer()
(package private) void	stopTimer()
(package private) int	widgetStyle()
(package private) TCHAR	windowClass()
(package private) int	windowProc()
(package private) LRESULT	WM_GETDLGCODE(int wParam, int lParam)
(package private) LRESULT	WM_SIZE(int wParam, int lParam)
(package private) LRESULT	WM_TIMER(int wParam, int lParam)

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

addControlListener, addDragDetectListener, addFocusListener, addGestureListener, addHelpListener, addKeyListener, addMenuDetectListener, addMouseListener, addMouseMoveListener, addMouseTrackListener, addMouseWheelListener, addPaintListener, addTouchListener, addTraverseListener, binarySearch, borderHandle, checkBackground, checkBorder, checkBuffered, checkComposited, checkGesture, checkHandle, checkMirrored, computeSize, computeTabGroup, computeTabList, computeTabRoot, createWidget, defaultBackground, defaultFont, deregister, destroyWidget, dragDetect, dragDetect, dragDetect, drawBackground, drawBackground, drawBackground, drawImageBackground, drawThemeBackground, enableDrag, enableWidget, fillBackground, fillImageBackground, fillThemeBackground, findBackgroundControl, findBrush, findCursor, findImageControl, findMenus, findMnemonic, findThemeControl, fixChildren, fixFocus, forceFocus, forceResize, getAccessible, getBackground, getBackgroundImage, getBackgroundPixel, getBorderWidth, getBounds, getClipboardText, getCodePage, getCursor, getDragDetect, getDrawing, getEnabled, getFont, getForeground, getForegroundPixel, getLayoutData, getLocation, getMenu, getMonitor, getOrientation, getParent, getPath, getRegion, getShell, getSize, getToolTipText, getTouchEnabled, getVisible, hasCursor, hasFocus, internal_dispose_GC, internal_new_GC, isActive, isEnabled, isFocusAncestor, isFocusControl, isReparentable, isShowing, isTabGroup, isTabItem, isVisible, mapEvent, markLayout, menuShell, mnemonicHit, mnemonicMatch, moveAbove, moveBelow, new_Accessible, new_GC, pack, pack, print, printWidget, redraw, redraw, redraw, redrawChildren, register, releaseHandle, releaseParent, removeControlListener, removeDragDetectListener, removeFocusListener, removeGestureListener, removeHelpListener, removeKeyListener, removeMenuDetectListener, removeMouseListener, removeMouseMoveListener, removeMouseTrackListener, removeMouseWheelListener, removePaintListener, removeTouchListener, removeTraverseListener, sendFocusEvent, sendGestureEvent, sendMove, sendResize, sendTouchEvent, setBackground, setBackground, setBackgroundImage, setBackgroundImage, setBounds, setBounds, setBounds, setBounds, setCapture, setCursor, setCursor, setDefaultFont, setDragDetect, setEnabled, setFocus, setFont, setForeground, setLayoutData, setLocation, setLocation, setMenu, setOrientation, setParent, setRadioFocus, setRadioSelection, setRedraw, setRegion, setSavedFocus, setSize, setSize, setTabItemFocus, setToolTipText, setToolTipText, setTouchEnabled, setVisible, showWidget, sort, subclass, toControl, toControl, toDisplay, toDisplay, topHandle, translateAccelerator, translateMnemonic, translateMnemonic, translateTraversal, traverse, traverse, traverse, traverse, traverse, traverseEscape, traverseGroup, traverseItem, traverseMnemonic, traversePage, traverseReturn, unsubclass, update, update, updateBackgroundColor, updateBackgroundImage, updateBackgroundMode, updateFont, updateImages, updateLayout, updateOrientation, widgetCreateStruct, widgetExtStyle, widgetParent, windowProc, WM_ACTIVATE, WM_CAPTURECHANGED, WM_CHANGEUISTATE, WM_CHAR, WM_CLEAR, WM_CLOSE, WM_COMMAND, WM_CONTEXTMENU, WM_CTLCOLOR, WM_CUT, WM_DESTROY, WM_DRAWITEM, WM_ENDSESSION, WM_ENTERIDLE, WM_ERASEBKGND, WM_GESTURE, WM_GETFONT, WM_GETMINMAXINFO, WM_GETOBJECT, WM_HELP, WM_HOTKEY, WM_HSCROLL, WM_IME_CHAR, WM_IME_COMPOSITION_START, WM_IME_COMPOSITION, WM_IME_ENDCOMPOSITION, WM_INITMENUPOPUP, WM_INPUTLANGCHANGE, 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_MOUSEHWHEEL, WM_MOUSELEAVE, WM_MOUSEMOVE, WM_MOUSEWHEEL, WM_MOVE, WM_NCACTIVATE, WM_NCCALCSIZE, WM_NCHITTEST, WM_NCLBUTTONDOWN, WM_NCPAINT, WM_NOTIFY, WM_PAINT, WM_PALETTECHANGED, WM_PARENTNOTIFY, WM_PASTE, WM_PRINT, 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_SYSCHAR, WM_SYSCOLORCHANGE, WM_SYSCOMMAND, WM_SYSKEYDOWN, WM_SYSKEYUP, WM_TABLET_FLICK, WM_TOUCH, WM_UNDO, WM_UNINITMENUPOPUP, WM_UPDATEUISTATE, WM_VSCROLL, WM_WINDOWPOSCHANGED, WM_WINDOWPOSCHANGING, WM_XBUTTONDBLCLK, WM_XBUTTONDOWN, WM_XBUTTONUP, wmColorChild, wmCommandChild, wmDrawChild, wmMeasureChild, wmNotify, wmNotifyChild, wmScrollChild

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

_addListener, addDisposeListener, addListener, checkBits, checkOpened, checkOrientation, checkParent, checkSubclass, checkWidget, DeferWindowPos, dispose, dragDetect, error, filters, findItem, fixMnemonic, fixMnemonic, getData, getData, getDisplay, getListeners, getName, getNameText, getStyle, hooks, isDisposed, isListening, isValidSubclass, isValidThread, notifyListeners, postEvent, postEvent, release, releaseChildren, removeDisposeListener, removeListener, removeListener, reskin, reskinChildren, reskinWidget, sendDragEvent, sendDragEvent, sendEvent, sendEvent, sendEvent, sendEvent, sendKeyEvent, sendKeyEvent, sendMouseEvent, sendMouseEvent, sendMouseWheelEvent, sendSelectionEvent, sendSelectionEvent, setData, setData, setInputState, setKeyState, setLocationMask, setTabGroupFocus, SetWindowPos, showMenu, showMenu, toString, updateMenuLocation, wmCaptureChanged, wmChar, wmContextMenu, wmIMEChar, wmKeyDown, wmKeyUp, wmKillFocus, wmLButtonDblClk, wmLButtonDown, wmLButtonUp, wmMButtonDblClk, wmMButtonDown, wmMButtonUp, wmMouseHover, wmMouseHWheel, wmMouseLeave, wmMouseMove, wmMouseWheel, wmNCPaint, wmPaint, wmPrint, wmRButtonDblClk, wmRButtonDown, wmRButtonUp, wmSetFocus, wmSysChar, wmSysKeyDown, wmSysKeyUp, wmXButtonDblClk, wmXButtonDown, wmXButtonUp

Methods inherited from class java.lang.Object

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

Field Detail

DELAY

static final int DELAY

See Also:

Constant Field Values

TIMER_ID

static final int TIMER_ID

See Also:

Constant Field Values

MINIMUM_WIDTH

static final int MINIMUM_WIDTH

See Also:

Constant Field Values

ProgressBarProc

static final int ProgressBarProc

ProgressBarClass

static final TCHAR ProgressBarClass

Constructor Detail

ProgressBar

public ProgressBar(Composite parent,
           int style)

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

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the parent is null

SWTException -

• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent
• ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass

See Also:

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

Method Detail

callWindowProc

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

Overrides:

callWindowProc in class Widget

checkStyle

static int checkStyle(int style)

computeSize

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

Description copied from class: Control

Returns the preferred size of the receiver.

The preferred size of a control is the size that it would best be displayed at. The width hint and height hint arguments allow the caller to ask a control questions such as "Given a particular width, how high does the control need to be to show all of the contents?" To indicate that the caller does not wish to constrain a particular dimension, the constant SWT.DEFAULT is passed for the hint.

If the changed flag is true, it indicates that the receiver's contents have changed, therefore any caches that a layout manager containing the control may have been keeping need to be flushed. When the control is resized, the changed flag will be false, so layout manager caches can be retained.

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(boolean), "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()

Returns the maximum value which the receiver will allow.

Returns:

the maximum

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

getMinimum

public int getMinimum()

Returns the minimum value which the receiver will allow.

Returns:

the minimum

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

getSelection

public int getSelection()

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

Returns:

the selection

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

getState

public int getState()

Returns the state of the receiver. The value will be one of:

• SWT.NORMAL
• SWT.ERROR
• SWT.PAUSED

Returns:

the state

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

Since:

3.4

releaseWidget

void releaseWidget()

Overrides:

releaseWidget in class Control

startTimer

void startTimer()

stopTimer

void stopTimer()

setBackgroundPixel

void setBackgroundPixel(int pixel)

Overrides:

setBackgroundPixel in class Control

setForegroundPixel

void setForegroundPixel(int pixel)

Overrides:

setForegroundPixel in class Control

setMaximum

public void setMaximum(int value)

Sets the maximum value that the receiver will allow. This new value will be ignored if it is not greater than the receiver's current minimum value. If the new maximum is applied then the receiver's selection value will be adjusted if necessary to fall within its new range.

Parameters:

value - the new maximum, which must be greater than the current minimum

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

setMinimum

public void setMinimum(int value)

Sets the minimum value that the receiver will allow. This new value will be ignored if it is negative or is not less than the receiver's current maximum value. If the new minimum is applied then the receiver's selection value will be adjusted if necessary to fall within its new range.

Parameters:

value - the new minimum, which must be nonnegative and less than the current maximum

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

setSelection

public void setSelection(int value)

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)

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

setState

public void setState(int state)

Sets the state of the receiver. The state must be one of these values:

• SWT.NORMAL
• SWT.ERROR
• SWT.PAUSED

Note: This operation is a hint and is not supported on platforms that do not have this concept.

Parameters:

state - the new state

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

Since:

3.4

widgetStyle

int widgetStyle()

Overrides:

widgetStyle in class Control

windowClass

TCHAR windowClass()

Specified by:

windowClass in class Control

windowProc

int windowProc()

Specified by:

windowProc in class Control

WM_GETDLGCODE

LRESULT WM_GETDLGCODE(int wParam,
                    int lParam)

Overrides:

WM_GETDLGCODE in class Control

WM_SIZE

LRESULT WM_SIZE(int wParam,
              int lParam)

Overrides:

WM_SIZE in class Control

WM_TIMER

LRESULT WM_TIMER(int wParam,
               int lParam)

Overrides:

WM_TIMER in class Control