Top Description Fields Constructors Methods
org.eclipse.swt.widgets

public Class ProgressBar

extends Control
Class Inheritance
Imports
org.eclipse.swt.*, org.eclipse.swt.graphics.*, org.eclipse.swt.internal.gtk.*, org.eclipse.swt.internal.gtk3.*
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 Note

This class is not intended to be subclassed.

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

Field Summary

Modifier and TypeField and Description
pack-priv static final int
DELAY

pack-priv int
maximum

pack-priv int
minimum

pack-priv int
selection

pack-priv int
timerId

Inherited from org.eclipse.swt.widgets.Control:
accessibleautoScalebackgroundAlphabackgroundImagecachedNoBackgroundcheckScaleFactorcssBackgroundcssForegroundcursorDISABLE_EMOJIdragDetectionQueuedragGesturedrawCountdrawRegionenableWindoweventRegionfirstFixedHandlefixedHandlefontgestureBegingestureEndgestureRotationgestureSwipegestureZoomkeyControllerlabelRelationlastInputlayoutDatamenumouseDownpanGestureparentproviderredrawWindowregionregionHandlerotateGesturetoolTipTextzoomGesture

Constructor Summary

AccessConstructor and Description
public
ProgressBar(Composite
a composite control which will be the parent of the new instance (cannot be null)
parent, int
the style of control to construct
style)

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

Method Summary

Modifier and TypeMethod and Description
pack-priv static int
checkStyle(int style)

pack-priv void
createHandle(int index)

Overrides org.eclipse.swt.widgets.Widget.createHandle.

pack-priv long
eventHandle()

Overrides org.eclipse.swt.widgets.Control.eventHandle.

public int

Returns:

the maximum
getMaximum()

Returns the maximum value which the receiver will allow.

public int

Returns:

the minimum
getMinimum()

Returns the minimum value which the receiver will allow.

public int

Returns:

the selection
getSelection()

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

public int

Returns:

the state
getState()

Returns the state of the receiver.

pack-priv long
gtk_realize(long widget)

Overrides org.eclipse.swt.widgets.Control.gtk_realize.

pack-priv void
releaseWidget()

Overrides org.eclipse.swt.widgets.Control.releaseWidget.

pack-priv Point
resizeCalculationsGTK3(long widget, int width, int height)

Overrides org.eclipse.swt.widgets.Control.resizeCalculationsGTK3.

public void
setMaximum(int
the new maximum, which must be greater than the current minimum
value)

Sets the maximum value that the receiver will allow.

public void
setMinimum(int
the new minimum, which must be nonnegative and less than the current maximum
value)

Sets the minimum value that the receiver will allow.

pack-priv void
setParentBackground()

Overrides org.eclipse.swt.widgets.Control.setParentBackground.

public void
setSelection(int
the new selection (must be zero or greater)
value)

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

public void
setState(int
the new state
state)

Sets the state of the receiver.

pack-priv long
timerProc(long widget)

Overrides org.eclipse.swt.widgets.Widget.timerProc.

pack-priv void
updateBar()

Inherited from org.eclipse.swt.widgets.Control:
_getAccessible_getShelladdControlListeneraddDragDetectListeneraddFocusListeneraddGestureListeneraddHelpListeneraddKeyListeneraddMenuDetectListeneraddMouseListeneraddMouseMoveListeneraddMouseTrackListeneraddMouseWheelListeneraddPaintListeneraddRelationaddTouchListeneraddTraverseListeneradjustChildClippingcairoClipRegioncairoCopyRegioncairoDisposeRegioncheckBackgroundcheckBordercheckBufferedcheckMirroredcheckSubwindowcleanupEnableWindowcomputeNativeSizecomputeSizecomputeSizecomputeSizeInPixelscomputeSizeInPixelscomputeTabGroupcomputeTabListcomputeTabRootcontainedInRegioncreateWidgetdefaultBackgrounddefaultFontderegisterdestroyWidgetdragDetectdragDetectdragDetectdragDetectdrawBackgrounddrawGripperdrawWidgetenableWidgetenterExitHandleeventSurfaceeventWindowfilterKeyfindBackgroundControlfindMenusfixChildrenfixFocusfixGdkEventTypeValuesfixModalfixParentGdkResourcefixStylefixStyleflushQueueOnDndfocusHandlefontHandleforceFocusforceFocusforceResizegestureBeginProcgestureEndProcgestureHandlegetAccessiblegetBackgroundgetBackgroundGdkRGBAgetBackgroundImagegetBaseGdkRGBAgetBgGdkRGBAgetBorderWidthgetBorderWidthInPixelsgetBoundsgetBoundsInPixelsgetClientWidthgetContextBackgroundGdkRGBAgetContextColorGdkRGBAgetControlgetControlOrigingetCursorgetDragDetectgetEnabledgetFontgetFontDescriptiongetForegroundgetForegroundGdkRGBAgetIMCaretPosgetLayoutDatagetLocationgetLocationInPixelsgetMenugetMonitorgetOrientationgetParentgetPathgetRegiongetShellgetSizegetSizeInPixelsgetSurfaceOrigingetTextDirectiongetThicknessgetToolTipTextgetTouchEnabledgetVisiblegetWindowOrigingtk3_show_helpgtk4_drawgtk4_enter_eventgtk4_focus_enter_eventgtk4_focus_leave_eventgtk4_focus_window_eventgtk4_key_press_eventgtk4_key_release_eventgtk4_leave_eventgtk4_motion_eventgtk4_scroll_eventgtk_button_press_eventgtk_button_press_eventgtk_button_release_eventgtk_commitgtk_css_provider_load_from_cssgtk_drawgtk_enter_notify_eventgtk_event_aftergtk_focusgtk_focus_in_eventgtk_focus_out_eventgtk_gesture_press_eventgtk_gesture_release_eventgtk_key_press_eventgtk_key_release_eventgtk_label_set_aligngtk_leave_notify_eventgtk_mnemonic_activategtk_motion_notify_eventgtk_popup_menugtk_preedit_changedgtk_scroll_eventgtk_style_context_get_bordergtk_style_context_get_paddinggtk_style_updatedgtk_unrealizegtk_widget_reparentgtk_widget_set_alignhasFocushookEventshooksPainthoverProcimHandleinternal_dispose_GCinternal_new_GCisActiveisAutoScalableisDescribedByLabelisEnabledisFocusAncestorisFocusControlisFocusHandleisReparentableisShowingisTabGroupisTabItemisVisiblemagnifyProcmarkLayoutmenuShellmnemonicHitmnemonicMatchmoveAbovemoveBelowmoveChildrenmoveHandlemustBeVisibleOnInitBoundspackpackpaintHandlepaintSurfacepaintWindowprintprintWidgetprintWindowredrawredrawredrawredrawChildrenredrawInPixelsredrawWidgetregisterreleasereleaseHandlereleaseParentremoveControlListenerremoveDragDetectListenerremoveFocusListenerremoveGestureListenerremoveHelpListenerremoveKeyListenerremoveMenuDetectListenerremoveMouseListenerremoveMouseMoveListenerremoveMouseTrackListenerremoveMouseWheelListenerremovePaintListenerremoveRelationremoveTouchListenerremoveTraverseListenerrequestLayoutresizeHandlerestackWindowrotateProcsendDragEventsendFocusEventsendGestureEventsendGestureEventsendGestureEventsendHelpEventsendLeaveNotifysendMouseEventsendMouseEventsetBackgroundsetBackgroundsetBackgroundGdkRGBAsetBackgroundGdkRGBAsetBackgroundGdkRGBAsetBackgroundImagesetBackgroundSurfacesetBoundssetBoundssetBoundssetBoundsInPixelssetBoundsInPixelssetCapturesetCursorsetCursorsetDragDetectsetEnabledsetFocussetFontsetFontDescriptionsetForegroundsetForegroundGdkRGBAsetForegroundGdkRGBAsetInitialBoundssetLayoutDatasetLocationsetLocationsetLocationInPixelssetLocationInPixelssetMenusetOrientationsetOrientationsetParentsetParentGdkResourcesetRadioSelectionsetRedrawsetRegionsetRelationssetSizesetSizesetSizeInPixelssetSizeInPixelssetTabItemFocussetTextDirectionsetToolTipTextsetToolTipTextsetTouchEnabledsetVisiblesetWidgetBackgroundsetZOrdersetZOrdershowMenushowMenushowWidgetsortswipeProctoControltoControltoDisplaytoDisplaytoDisplayInPixelstoDisplayInPixelstopHandletranslateMnemonictranslateMnemonictranslateTraversaltraversalCodetraversetraversetraversetraversetraversetraverseEscapetraverseGrouptraverseItemtraverseMnemonictraversePagetraverseReturnupdateupdateupdateBackgroundModeupdateLayoutwantDragDropDetectionwindowProc

Field Detail

DELAYback to summary
pack-priv static final int DELAY
maximumback to summary
pack-priv int maximum
minimumback to summary
pack-priv int minimum
selectionback to summary
pack-priv int selection
timerIdback to summary
pack-priv int timerId

Constructor Detail

ProgressBarback to summary
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:Composite

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

style:int

the style of control to construct

Exceptions
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

checkStyleback to summary
pack-priv static int checkStyle(int style)
createHandleback to summary
pack-priv void createHandle(int index)

Overrides org.eclipse.swt.widgets.Widget.createHandle.

Annotations
@Override
eventHandleback to summary
pack-priv long eventHandle()

Overrides org.eclipse.swt.widgets.Control.eventHandle.

Annotations
@Override
getMaximumback to summary
public int getMaximum()

Returns the maximum value which the receiver will allow.

Returns:int

the maximum

Exceptions
SWTException:
  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
getMinimumback to summary
public int getMinimum()

Returns the minimum value which the receiver will allow.

Returns:int

the minimum

Exceptions
SWTException:
  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
getSelectionback to summary
public int getSelection()

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

Returns:int

the selection

Exceptions
SWTException:
  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
getStateback to summary
public int getState()

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

Returns:int

the state

Exceptions
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
gtk_realizeback to summary
pack-priv long gtk_realize(long widget)

Overrides org.eclipse.swt.widgets.Control.gtk_realize.

Annotations
@Override
releaseWidgetback to summary
pack-priv void releaseWidget()

Overrides org.eclipse.swt.widgets.Control.releaseWidget.

Annotations
@Override
resizeCalculationsGTK3back to summary
pack-priv Point resizeCalculationsGTK3(long widget, int width, int height)

Overrides org.eclipse.swt.widgets.Control.resizeCalculationsGTK3.

Annotations
@Override
setMaximumback to summary
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:int

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

Exceptions
SWTException:
  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
setMinimumback to summary
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:int

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

Exceptions
SWTException:
  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
setParentBackgroundback to summary
pack-priv void setParentBackground()

Overrides org.eclipse.swt.widgets.Control.setParentBackground.

Annotations
@Override
setSelectionback to summary
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:int

the new selection (must be zero or greater)

Exceptions
SWTException:
  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
setStateback to summary
public void setState(int state)

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

Note

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

Parameters
state:int

the new state

Exceptions
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
timerProcback to summary
pack-priv long timerProc(long widget)

Overrides org.eclipse.swt.widgets.Widget.timerProc.

Annotations
@Override
updateBarback to summary
pack-priv void updateBar()