Modifier and Type	Class and Description
protected class	JProgressBar.AccessibleJProgressBar This class implements accessibility support for the `JProgressBar` class.
private class	JProgressBar.ModelListener

Modifier and Type	Field and Description
protected transient ChangeEvent	changeEvent Only one `ChangeEvent` is needed per instance since the event's only interesting property is the immutable source, which is the progress bar.
protected ChangeListener	changeListener Listens for change events sent by the progress bar's model, redispatching them to change-event listeners registered upon this progress bar.
private static final int	defaultMaximum The default maximum for a progress bar is 100.
private static final int	defaultMinimum The default minimum for a progress bar is 0.
private static final int	defaultOrientation The default orientation for a progress bar is `HORIZONTAL`.
private transient Format	format Format used when displaying percent complete.
private boolean	indeterminate Whether the progress bar is indeterminate (`true`) or normal (`false`); the default is `false`.
protected BoundedRangeModel	model The object that holds the data for the progress bar.
protected int	orientation Whether the progress bar is horizontal or vertical.
protected boolean	paintBorder Whether to display a border around the progress bar.
protected boolean	paintString Whether to display a string of text on the progress bar.
protected String	progressString An optional string that can be displayed on the progress bar.
private static final String	uiClassID Hides javax.swing.JComponent.uiClassID.

Access	Constructor and Description
public	JProgressBar() Creates a horizontal progress bar that displays a border but no progress string.
public	JProgressBar(int the desired orientation of the progress bar orient) Creates a progress bar with the specified orientation, which can be either `SwingConstants.VERTICAL` or `SwingConstants.HORIZONTAL`.
public	JProgressBar(int the minimum value of the progress bar min, int the maximum value of the progress bar max) Creates a horizontal progress bar with the specified minimum and maximum.
public	JProgressBar(int the desired orientation of the progress bar orient, int the minimum value of the progress bar min, int the maximum value of the progress bar max) Creates a progress bar using the specified orientation, minimum, and maximum.
public	JProgressBar(BoundedRangeModel the data model for the progress bar newModel) Creates a horizontal progress bar that uses the specified model to hold the progress bar's data.

Method Summary

Modifier and Type	Method and Description
public void	addChangeListener(ChangeListener the `ChangeListener` to add l) Adds the specified `ChangeListener` to the progress bar.
protected ChangeListener	Returns: the instance of a custom `ChangeListener` implementation. createChangeListener() Subclasses that want to handle change events from the model differently can override this to return an instance of a custom `ChangeListener` implementation.
protected void	fireStateChanged() Send a `ChangeEvent`, whose source is this `JProgressBar`, to all `ChangeListener`s that have registered interest in `ChangeEvent`s.
public AccessibleContext	Returns: an `AccessibleJProgressBar` that serves as the `AccessibleContext` of this `JProgressBar` getAccessibleContext() Overrides java.awt.Component.getAccessibleContext. Implements javax.accessibility.Accessible.getAccessibleContext. Gets the `AccessibleContext` associated with this `JProgressBar`.
public ChangeListener[]	Returns: all of the `ChangeListener`s added or an empty array if no listeners have been added getChangeListeners() Returns an array of all the `ChangeListener`s added to this progress bar with `addChangeListener`.
public int	Returns: the progress bar's maximum value getMaximum() Returns the progress bar's `maximum` value from the `BoundedRangeModel`.
public int	Returns: the progress bar's minimum value getMinimum() Returns the progress bar's `minimum` value from the `BoundedRangeModel`.
public BoundedRangeModel	Returns: the `BoundedRangeModel` currently in use getModel() Returns the data model used by this progress bar.
public int	Returns: `HORIZONTAL` or `VERTICAL` getOrientation() Returns `SwingConstants.VERTICAL` or `SwingConstants.HORIZONTAL`, depending on the orientation of the progress bar.
public double	Returns: the percent complete for this progress bar getPercentComplete() Returns the percent complete for the progress bar.
public String	Returns: the value of the progress string, or a simple percentage string if the progress string is `null` getString() Returns a `String` representation of the current progress.
public ProgressBarUI	Returns: the `ProgressBarUI` object that renders this component getUI() Overrides javax.swing.JComponent.getUI. Returns the look-and-feel object that renders this component.
public String	Returns: the string "ProgressBarUI" getUIClassID() Overrides javax.swing.JComponent.getUIClassID. Returns the name of the look-and-feel class that renders this component.
public int	Returns: the current value of the progress bar getValue() Returns the progress bar's current `value` from the `BoundedRangeModel`.
public boolean	Returns: the value of the `borderPainted` property isBorderPainted() Returns the `borderPainted` property.
public boolean	Returns: the value of the `indeterminate` property isIndeterminate() Returns the value of the `indeterminate` property.
public boolean	Returns: the value of the `stringPainted` property isStringPainted() Returns the value of the `stringPainted` property.
protected void	paintBorder(Graphics the `Graphics` context within which to paint the border g) Overrides javax.swing.JComponent.paintBorder. Paints the progress bar's border if the `borderPainted` property is `true`.
protected String	Returns: a string representation of this `JProgressBar` paramString() Overrides javax.swing.JComponent.paramString. Returns a string representation of this `JProgressBar`.
public void	removeChangeListener(ChangeListener the `ChangeListener` to remove l) Removes a `ChangeListener` from the progress bar.
public void	setBorderPainted(boolean `true` if the progress bar should paint its border; otherwise, `false` b) Sets the `borderPainted` property, which is `true` if the progress bar should paint its border.
public void	setIndeterminate(boolean `true` if the progress bar should change to indeterminate mode; `false` if it should revert to normal. newValue) Sets the `indeterminate` property of the progress bar, which determines whether the progress bar is in determinate or indeterminate mode.
public void	setMaximum(int the new maximum n) Sets the progress bar's maximum value (stored in the progress bar's data model) to `n`.
public void	setMinimum(int the new minimum n) Sets the progress bar's minimum value (stored in the progress bar's data model) to `n`.
public void	setModel(BoundedRangeModel the `BoundedRangeModel` to use newModel) Sets the data model used by the `JProgressBar`.
public void	setOrientation(int `HORIZONTAL` or `VERTICAL` newOrientation) Sets the progress bar's orientation to `newOrientation`, which must be `SwingConstants.VERTICAL` or `SwingConstants.HORIZONTAL`.
public void	setString(String the value of the progress string s) Sets the value of the progress string.
public void	setStringPainted(boolean `true` if the progress bar should render a string b) Sets the value of the `stringPainted` property, which determines whether the progress bar should render a progress string.
public void	setUI(ProgressBarUI a `ProgressBarUI` object ui) Sets the look-and-feel object that renders this component.
public void	setValue(int the new value n) Sets the progress bar's current value to `n`.
public void	updateUI() Overrides javax.swing.JComponent.updateUI. Resets the UI property to a value from the current look and feel.
private void	writeObject(ObjectOutputStream the `ObjectOutputStream` in which to write s) Hides javax.swing.JComponent.writeObject. See readObject() and writeObject() in JComponent for more information about serialization in Swing.

Inherited from javax.swing.JComponent:: _paintImmediately addAncestorListener addNotify addVetoableChangeListener alwaysOnTop checkIfChildObscuredBySibling clientPropertyChanged componentInputMapChanged computeVisibleRect computeVisibleRect compWriteObjectNotify contains createToolTip disable dndDone dropLocationForPoint enable firePropertyChange firePropertyChange firePropertyChange fireVetoableChange getActionForKeyStroke getActionMap getActionMap getAlignmentX getAlignmentY getAncestorListeners getAutoscrolls getBaseline getBaselineResizeBehavior getBorder getBounds getClientProperty getComponentGraphics getComponentPopupMenu getConditionForKeyStroke getCreatedDoubleBuffer getDebugGraphicsOptions getDefaultLocale getFontMetrics getGraphics getGraphicsInvoked getHeight getInheritsPopupMenu getInputMap getInputMap getInputMap getInputVerifier getInsets getInsets getListeners getLocation getManagingFocusBackwardTraversalKeys getManagingFocusForwardTraversalKeys getMaximumSize getMinimumSize getNextFocusableComponent getPopupLocation getPreferredSize getRegisteredKeyStrokes getRootPane getSize getToolTipLocation getToolTipText getToolTipText getTopLevelAncestor getTransferHandler getVerifyInputWhenFocusTarget getVetoableChangeListeners getVisibleRect getWidth getWriteObjCounter getX getY grabFocus hide isDoubleBuffered isLightweightComponent isManagingFocus isOpaque isOptimizedDrawingEnabled isPainting isPaintingForPrint isPaintingOrigin isPaintingTile isRequestFocusEnabled isValidateRoot paint paintChildren paintComponent paintForceDoubleBuffered paintImmediately paintImmediately paintToOffscreen print printAll printBorder printChildren printComponent processComponentKeyEvent processKeyBinding processKeyBindings processKeyBindingsForAllComponents processKeyEvent processMouseEvent processMouseMotionEvent putClientProperty rectangleIsObscured registerKeyboardAction registerKeyboardAction removeAncestorListener removeNotify removeVetoableChangeListener repaint repaint requestDefaultFocus requestFocus requestFocus requestFocusInWindow requestFocusInWindow resetKeyboardActions reshape revalidate safelyGetGraphics safelyGetGraphics scrollRectToVisible setActionMap setAlignmentX setAlignmentY setAutoscrolls setBackground setBorder setComponentPopupMenu setCreatedDoubleBuffer setDebugGraphicsOptions setDefaultLocale setDoubleBuffered setDropLocation setEnabled setFocusTraversalKeys setFont setForeground setInheritsPopupMenu setInputMap setInputVerifier setMaximumSize setMinimumSize setNextFocusableComponent setOpaque setPaintingChild setPreferredSize setRequestFocusEnabled setToolTipText setTransferHandler setUI setUIProperty setVerifyInputWhenFocusTarget setVisible setWriteObjCounter shouldDebugGraphics superProcessMouseMotionEvent unregisterKeyboardAction update

Field Detail

changeEvent back to summary

changeEvent	back to summary
protected transient ChangeEvent changeEvent Only one `ChangeEvent` is needed per instance since the event's only interesting property is the immutable source, which is the progress bar. The event is lazily created the first time that an event notification is fired. See Also `fireStateChanged`

protected transient ChangeEvent changeEvent

Only one ChangeEvent is needed per instance since the event's only interesting property is the immutable source, which is the progress bar. The event is lazily created the first time that an event notification is fired.

See Also: fireStateChanged

changeListener back to summary

changeListener	back to summary
protected ChangeListener changeListener Listens for change events sent by the progress bar's model, redispatching them to change-event listeners registered upon this progress bar. See Also `createChangeListener`

protected ChangeListener changeListener

Listens for change events sent by the progress bar's model, redispatching them to change-event listeners registered upon this progress bar.

See Also: createChangeListener

defaultMaximum	back to summary
private static final int defaultMaximum The default maximum for a progress bar is 100.

defaultMinimum	back to summary
private static final int defaultMinimum The default minimum for a progress bar is 0.

defaultOrientation	back to summary
private static final int defaultOrientation The default orientation for a progress bar is `HORIZONTAL`.

format	back to summary
private transient Format format Format used when displaying percent complete.

indeterminate back to summary

indeterminate	back to summary
private boolean indeterminate Whether the progress bar is indeterminate (`true`) or normal (`false`); the default is `false`. Since 1.4 See Also `setIndeterminate`

private boolean indeterminate

Whether the progress bar is indeterminate (true) or normal (false); the default is false.

Since: 1.4
See Also: setIndeterminate

model back to summary

model	back to summary
protected BoundedRangeModel model The object that holds the data for the progress bar. See Also `setModel`

protected BoundedRangeModel model

The object that holds the data for the progress bar.

See Also: setModel

orientation back to summary

orientation	back to summary
protected int orientation Whether the progress bar is horizontal or vertical. The default is `HORIZONTAL`. See Also `setOrientation`

protected int orientation

Whether the progress bar is horizontal or vertical. The default is HORIZONTAL.

See Also: setOrientation

paintBorder back to summary

paintBorder	back to summary
protected boolean paintBorder Whether to display a border around the progress bar. The default is `true`. See Also `setBorderPainted`

protected boolean paintBorder

Whether to display a border around the progress bar. The default is true.

See Also: setBorderPainted

paintString back to summary

paintString	back to summary
protected boolean paintString Whether to display a string of text on the progress bar. The default is `false`. Setting this to `true` causes a textual display of the progress to be rendered on the progress bar. If the `progressString` is `null`, the percentage of completion is displayed on the progress bar. Otherwise, the `progressString` is rendered on the progress bar. See Also `setStringPainted`, `setString`

protected boolean paintString

Whether to display a string of text on the progress bar. The default is false. Setting this to true causes a textual display of the progress to be rendered on the progress bar. If the progressString is null, the percentage of completion is displayed on the progress bar. Otherwise, the progressString is rendered on the progress bar.

See Also: setStringPainted, setString

progressString back to summary

progressString	back to summary
protected String progressString An optional string that can be displayed on the progress bar. The default is `null`. Setting this to a non-`null` value does not imply that the string will be displayed. To display the string, `paintString` must be `true`. See Also `setString`, `setStringPainted`

protected String progressString

An optional string that can be displayed on the progress bar. The default is null. Setting this to a non-null value does not imply that the string will be displayed. To display the string, paintString must be true.

See Also: setString, setStringPainted

uiClassID back to summary

uiClassID	back to summary
private static final String uiClassID Hides javax.swing.JComponent.uiClassID. See Also `getUIClassID`

private static final String uiClassID

Hides javax.swing.JComponent.uiClassID.

See Also: getUIClassID

Constructor Detail

JProgressBar back to summary

JProgressBar	back to summary
public JProgressBar() Creates a horizontal progress bar that displays a border but no progress string. The initial and minimum values are 0, and the maximum is 100. See Also `setOrientation`, `setBorderPainted`, `setStringPainted`, `setString`, `setIndeterminate`

public JProgressBar()

Creates a horizontal progress bar that displays a border but no progress string. The initial and minimum values are 0, and the maximum is 100.

See Also: setOrientation, setBorderPainted, setStringPainted, setString, setIndeterminate

JProgressBar back to summary

JProgressBar	back to summary
public JProgressBar(int orient) Creates a progress bar with the specified orientation, which can be either `SwingConstants.VERTICAL` or `SwingConstants.HORIZONTAL`. By default, a border is painted but a progress string is not. The initial and minimum values are 0, and the maximum is 100. Parameters orient:int the desired orientation of the progress bar Exceptions IllegalArgumentException: if `orient` is an illegal value See Also `setOrientation`, `setBorderPainted`, `setStringPainted`, `setString`, `setIndeterminate`

public JProgressBar(int orient)

Creates a progress bar with the specified orientation, which can be either SwingConstants.VERTICAL or SwingConstants.HORIZONTAL. By default, a border is painted but a progress string is not. The initial and minimum values are 0, and the maximum is 100.

Parameters

orient:int: the desired orientation of the progress bar

Exceptions

IllegalArgumentException:: if orient is an illegal value

JProgressBar back to summary

JProgressBar	back to summary
public JProgressBar(int min, int max) Creates a horizontal progress bar with the specified minimum and maximum. Sets the initial value of the progress bar to the specified minimum. By default, a border is painted but a progress string is not. The `BoundedRangeModel` that holds the progress bar's data handles any issues that may arise from improperly setting the minimum, initial, and maximum values on the progress bar. See the `BoundedRangeModel` documentation for details. Parameters min:int the minimum value of the progress bar max:int the maximum value of the progress bar See Also `BoundedRangeModel`, `setOrientation`, `setBorderPainted`, `setStringPainted`, `setString`, `setIndeterminate`

public JProgressBar(int min, int max)

Creates a horizontal progress bar with the specified minimum and maximum. Sets the initial value of the progress bar to the specified minimum. By default, a border is painted but a progress string is not.

The BoundedRangeModel that holds the progress bar's data handles any issues that may arise from improperly setting the minimum, initial, and maximum values on the progress bar. See the BoundedRangeModel documentation for details.

Parameters

min:int: the minimum value of the progress bar
max:int: the maximum value of the progress bar

JProgressBar back to summary

JProgressBar	back to summary
public JProgressBar(int orient, int min, int max) Creates a progress bar using the specified orientation, minimum, and maximum. By default, a border is painted but a progress string is not. Sets the initial value of the progress bar to the specified minimum. The `BoundedRangeModel` that holds the progress bar's data handles any issues that may arise from improperly setting the minimum, initial, and maximum values on the progress bar. See the `BoundedRangeModel` documentation for details. Parameters orient:int the desired orientation of the progress bar min:int the minimum value of the progress bar max:int the maximum value of the progress bar Exceptions IllegalArgumentException: if `orient` is an illegal value See Also `BoundedRangeModel`, `setOrientation`, `setBorderPainted`, `setStringPainted`, `setString`, `setIndeterminate`

public JProgressBar(int orient, int min, int max)

Creates a progress bar using the specified orientation, minimum, and maximum. By default, a border is painted but a progress string is not. Sets the initial value of the progress bar to the specified minimum.

Parameters

orient:int: the desired orientation of the progress bar
min:int: the minimum value of the progress bar
max:int: the maximum value of the progress bar

Exceptions

IllegalArgumentException:: if orient is an illegal value

JProgressBar back to summary

JProgressBar	back to summary
public JProgressBar(BoundedRangeModel newModel) Creates a horizontal progress bar that uses the specified model to hold the progress bar's data. By default, a border is painted but a progress string is not. Parameters newModel:BoundedRangeModel the data model for the progress bar See Also `setOrientation`, `setBorderPainted`, `setStringPainted`, `setString`, `setIndeterminate`

public JProgressBar(BoundedRangeModel newModel)

Creates a horizontal progress bar that uses the specified model to hold the progress bar's data. By default, a border is painted but a progress string is not.

Parameters

newModel:BoundedRangeModel: the data model for the progress bar

Method Detail

addChangeListener back to summary

addChangeListener	back to summary
public void addChangeListener(ChangeListener l) Adds the specified `ChangeListener` to the progress bar. Parameters l:ChangeListener the `ChangeListener` to add

public void addChangeListener(ChangeListener l)

Adds the specified ChangeListener to the progress bar.

Parameters

l:ChangeListener: the ChangeListener to add

createChangeListener back to summary

createChangeListener	back to summary
protected ChangeListener createChangeListener() Subclasses that want to handle change events from the model differently can override this to return an instance of a custom `ChangeListener` implementation. The default `ChangeListener` simply calls the `fireStateChanged` method to forward `ChangeEvent`s to the `ChangeListener`s that have been added directly to the progress bar. Returns:ChangeListener the instance of a custom `ChangeListener` implementation. See Also `changeListener`, `fireStateChanged`, `javax.swing.event.ChangeListener`, `javax.swing.BoundedRangeModel`

protected ChangeListener createChangeListener()

Subclasses that want to handle change events from the model differently can override this to return an instance of a custom ChangeListener implementation. The default ChangeListener simply calls the fireStateChanged method to forward ChangeEvents to the ChangeListeners that have been added directly to the progress bar.

Returns:ChangeListener: the instance of a custom ChangeListener implementation.
See Also: changeListener, fireStateChanged, javax.swing.event.ChangeListener, javax.swing.BoundedRangeModel

fireStateChanged back to summary

fireStateChanged	back to summary
protected void fireStateChanged() Send a `ChangeEvent`, whose source is this `JProgressBar`, to all `ChangeListener`s that have registered interest in `ChangeEvent`s. This method is called each time a `ChangeEvent` is received from the model. The event instance is created if necessary, and stored in `changeEvent`. See Also `addChangeListener`, `EventListenerList`

protected void fireStateChanged()

Send a ChangeEvent, whose source is this JProgressBar, to all ChangeListeners that have registered interest in ChangeEvents. This method is called each time a ChangeEvent is received from the model.

The event instance is created if necessary, and stored in changeEvent.

See Also: addChangeListener, EventListenerList

getAccessibleContext back to summary

getAccessibleContext	back to summary
public AccessibleContext getAccessibleContext() Overrides java.awt.Component.getAccessibleContext. Implements javax.accessibility.Accessible.getAccessibleContext. Gets the `AccessibleContext` associated with this `JProgressBar`. For progress bars, the `AccessibleContext` takes the form of an `AccessibleJProgressBar`. A new `AccessibleJProgressBar` instance is created if necessary. Returns:AccessibleContext an `AccessibleJProgressBar` that serves as the `AccessibleContext` of this `JProgressBar` Annotations @BeanProperty bound:false expert:true description:The AccessibleContext associated with this ProgressBar.

public AccessibleContext getAccessibleContext()

Overrides java.awt.Component.getAccessibleContext.

Implements javax.accessibility.Accessible.getAccessibleContext.

Gets the AccessibleContext associated with this JProgressBar. For progress bars, the AccessibleContext takes the form of an AccessibleJProgressBar. A new AccessibleJProgressBar instance is created if necessary.

Returns:AccessibleContext

an AccessibleJProgressBar that serves as the AccessibleContext of this JProgressBar

Annotations

@BeanProperty
bound:false
expert:true
description:The AccessibleContext associated with this ProgressBar.

getChangeListeners back to summary

getChangeListeners	back to summary
public ChangeListener[] getChangeListeners() Returns an array of all the `ChangeListener`s added to this progress bar with `addChangeListener`. Returns:ChangeListener[] all of the `ChangeListener`s added or an empty array if no listeners have been added Annotations @BeanProperty bound:false Since 1.4

public ChangeListener[] getChangeListeners()

Returns an array of all the ChangeListeners added to this progress bar with addChangeListener.

Returns:ChangeListener[]

all of the ChangeListeners added or an empty array if no listeners have been added

Annotations

@BeanProperty
bound:false

Since

1.4

getMaximum back to summary

getMaximum	back to summary
public int getMaximum() Returns the progress bar's `maximum` value from the `BoundedRangeModel`. Returns:int the progress bar's maximum value See Also `setMaximum`, `BoundedRangeModel#getMaximum`

public int getMaximum()

Returns the progress bar's maximum value from the BoundedRangeModel.

Returns:int: the progress bar's maximum value
See Also: setMaximum, BoundedRangeModel#getMaximum

getMinimum back to summary

getMinimum	back to summary
public int getMinimum() Returns the progress bar's `minimum` value from the `BoundedRangeModel`. Returns:int the progress bar's minimum value See Also `setMinimum`, `BoundedRangeModel#getMinimum`

public int getMinimum()

Returns the progress bar's minimum value from the BoundedRangeModel.

Returns:int: the progress bar's minimum value
See Also: setMinimum, BoundedRangeModel#getMinimum

getModel back to summary

getModel	back to summary
public BoundedRangeModel getModel() Returns the data model used by this progress bar. Returns:BoundedRangeModel the `BoundedRangeModel` currently in use See Also `setModel`, `BoundedRangeModel`

public BoundedRangeModel getModel()

Returns the data model used by this progress bar.

Returns:BoundedRangeModel: the BoundedRangeModel currently in use
See Also: setModel, BoundedRangeModel

getOrientation back to summary

getOrientation	back to summary
public int getOrientation() Returns `SwingConstants.VERTICAL` or `SwingConstants.HORIZONTAL`, depending on the orientation of the progress bar. The default orientation is `SwingConstants.HORIZONTAL`. Returns:int `HORIZONTAL` or `VERTICAL` See Also `setOrientation`

public int getOrientation()

Returns SwingConstants.VERTICAL or SwingConstants.HORIZONTAL, depending on the orientation of the progress bar. The default orientation is SwingConstants.HORIZONTAL.

Returns:int: HORIZONTAL or VERTICAL
See Also: setOrientation

getPercentComplete	back to summary
public double getPercentComplete() Returns the percent complete for the progress bar. Note that this number is between 0.0 and 1.0. Returns:double the percent complete for this progress bar Annotations @BeanProperty bound:false

getPercentComplete

back to summary

public double getPercentComplete()

Returns the percent complete for the progress bar. Note that this number is between 0.0 and 1.0.

Returns:double

the percent complete for this progress bar

Annotations

@BeanProperty
bound:false

getString back to summary

getString	back to summary
public String getString() Returns a `String` representation of the current progress. By default, this returns a simple percentage `String` based on the value returned from `getPercentComplete`. An example would be the "42%". You can change this by calling `setString`. Returns:String the value of the progress string, or a simple percentage string if the progress string is `null` See Also `setString`

public String getString()

Returns a String representation of the current progress. By default, this returns a simple percentage String based on the value returned from getPercentComplete. An example would be the "42%". You can change this by calling setString.

Returns:String: the value of the progress string, or a simple percentage string if the progress string is null
See Also: setString

getUI back to summary

getUI	back to summary
public ProgressBarUI getUI() Overrides javax.swing.JComponent.getUI. Returns the look-and-feel object that renders this component. Returns:ProgressBarUI the `ProgressBarUI` object that renders this component

public ProgressBarUI getUI()

Overrides javax.swing.JComponent.getUI.

Returns the look-and-feel object that renders this component.

Returns:ProgressBarUI: the ProgressBarUI object that renders this component

getUIClassID back to summary

getUIClassID	back to summary
public String getUIClassID() Overrides javax.swing.JComponent.getUIClassID. Returns the name of the look-and-feel class that renders this component. Returns:String the string "ProgressBarUI" Annotations @BeanProperty bound:false expert:true description:A string that specifies the name of the look-and-feel class. See Also `JComponent#getUIClassID`, `UIDefaults#getUI`

public String getUIClassID()

Overrides javax.swing.JComponent.getUIClassID.

Returns the name of the look-and-feel class that renders this component.

Returns:String

the string "ProgressBarUI"

Annotations

@BeanProperty
bound:false
expert:true
description:A string that specifies the name of the look-and-feel class.

getValue back to summary

getValue	back to summary
public int getValue() Returns the progress bar's current `value` from the `BoundedRangeModel`. The value is always between the minimum and maximum values, inclusive. Returns:int the current value of the progress bar See Also `setValue`, `BoundedRangeModel#getValue`

public int getValue()

Returns the progress bar's current value from the BoundedRangeModel. The value is always between the minimum and maximum values, inclusive.

Returns:int: the current value of the progress bar
See Also: setValue, BoundedRangeModel#getValue

isBorderPainted back to summary

isBorderPainted	back to summary
public boolean isBorderPainted() Returns the `borderPainted` property. Returns:boolean the value of the `borderPainted` property See Also `setBorderPainted`

public boolean isBorderPainted()

Returns the borderPainted property.

Returns:boolean: the value of the borderPainted property
See Also: setBorderPainted

isIndeterminate back to summary

isIndeterminate	back to summary
public boolean isIndeterminate() Returns the value of the `indeterminate` property. Returns:boolean the value of the `indeterminate` property Annotations @BeanProperty bound:false description:Is the progress bar indeterminate (true) or normal (false)? Since 1.4 See Also `setIndeterminate`

public boolean isIndeterminate()

Returns the value of the indeterminate property.

Returns:boolean

the value of the indeterminate property

Annotations

@BeanProperty
bound:false
description:Is the progress bar indeterminate (true) or normal (false)?

Since

1.4

See Also

setIndeterminate

isStringPainted back to summary

isStringPainted	back to summary
public boolean isStringPainted() Returns the value of the `stringPainted` property. Returns:boolean the value of the `stringPainted` property See Also `setStringPainted`, `setString`

public boolean isStringPainted()

Returns the value of the stringPainted property.

Returns:boolean: the value of the stringPainted property
See Also: setStringPainted, setString

paintBorder back to summary

paintBorder	back to summary
protected void paintBorder(Graphics g) Overrides javax.swing.JComponent.paintBorder. Paints the progress bar's border if the `borderPainted` property is `true`. Parameters g:Graphics the `Graphics` context within which to paint the border See Also `paint`, `setBorder`, `isBorderPainted`, `setBorderPainted`

protected void paintBorder(Graphics g)

Overrides javax.swing.JComponent.paintBorder.

Paints the progress bar's border if the borderPainted property is true.

Parameters

g:Graphics: the Graphics context within which to paint the border

paramString back to summary

paramString	back to summary
protected String paramString() Overrides javax.swing.JComponent.paramString. Returns a string representation of this `JProgressBar`. This method is intended to be used only for debugging purposes. The content and format of the returned string may vary between implementations. The returned string may be empty but may not be `null`. Returns:String a string representation of this `JProgressBar`

protected String paramString()

Overrides javax.swing.JComponent.paramString.

Returns a string representation of this JProgressBar. This method is intended to be used only for debugging purposes. The content and format of the returned string may vary between implementations. The returned string may be empty but may not be null.

Returns:String: a string representation of this JProgressBar

removeChangeListener back to summary

removeChangeListener	back to summary
public void removeChangeListener(ChangeListener l) Removes a `ChangeListener` from the progress bar. Parameters l:ChangeListener the `ChangeListener` to remove

public void removeChangeListener(ChangeListener l)

Removes a ChangeListener from the progress bar.

Parameters

l:ChangeListener: the ChangeListener to remove

setBorderPainted back to summary

setBorderPainted	back to summary
public void setBorderPainted(boolean b) Sets the `borderPainted` property, which is `true` if the progress bar should paint its border. The default value for this property is `true`. Some look and feels might not implement painted borders; they will ignore this property. Parameters b:boolean `true` if the progress bar should paint its border; otherwise, `false` Annotations @BeanProperty visualUpdate:true description:Whether the progress bar should paint its border. See Also `isBorderPainted`

public void setBorderPainted(boolean b)

Sets the borderPainted property, which is true if the progress bar should paint its border. The default value for this property is true. Some look and feels might not implement painted borders; they will ignore this property.

Parameters

b:boolean: true if the progress bar should paint its border; otherwise, false

Annotations

@BeanProperty
visualUpdate:true
description:Whether the progress bar should paint its border.

See Also

isBorderPainted

setIndeterminate back to summary

setIndeterminate	back to summary
public void setIndeterminate(boolean newValue) Sets the `indeterminate` property of the progress bar, which determines whether the progress bar is in determinate or indeterminate mode. An indeterminate progress bar continuously displays animation indicating that an operation of unknown length is occurring. By default, this property is `false`. Some look and feels might not support indeterminate progress bars; they will ignore this property. See How to Monitor Progress for examples of using indeterminate progress bars. Parameters newValue:boolean `true` if the progress bar should change to indeterminate mode; `false` if it should revert to normal. Since 1.4 See Also `isIndeterminate`, `javax.swing.plaf.basic.BasicProgressBarUI`

public void setIndeterminate(boolean newValue)

Sets the indeterminate property of the progress bar, which determines whether the progress bar is in determinate or indeterminate mode. An indeterminate progress bar continuously displays animation indicating that an operation of unknown length is occurring. By default, this property is false. Some look and feels might not support indeterminate progress bars; they will ignore this property.

See How to Monitor Progress for examples of using indeterminate progress bars.

Parameters

newValue:boolean: true if the progress bar should change to indeterminate mode; false if it should revert to normal.

Since

1.4

setMaximum back to summary

setMaximum	back to summary
public void setMaximum(int n) Sets the progress bar's maximum value (stored in the progress bar's data model) to `n`. The underlying `BoundedRangeModel` handles any mathematical issues arising from assigning faulty values. See the `BoundedRangeModel` documentation for details. If the maximum value is different from the previous maximum, all change listeners are notified. Parameters n:int the new maximum Annotations @BeanProperty bound:false preferred:true description:The progress bar\'s maximum value. See Also `getMaximum`, `addChangeListener`, `BoundedRangeModel#setMaximum`

public void setMaximum(int n)

Sets the progress bar's maximum value (stored in the progress bar's data model) to n.

The underlying BoundedRangeModel handles any mathematical issues arising from assigning faulty values. See the BoundedRangeModel documentation for details.

If the maximum value is different from the previous maximum, all change listeners are notified.

Parameters

n:int: the new maximum

Annotations

@BeanProperty
bound:false
preferred:true
description:The progress bar\'s maximum value.

setMinimum back to summary

setMinimum	back to summary
public void setMinimum(int n) Sets the progress bar's minimum value (stored in the progress bar's data model) to `n`. The data model (a `BoundedRangeModel` instance) handles any mathematical issues arising from assigning faulty values. See the `BoundedRangeModel` documentation for details. If the minimum value is different from the previous minimum, all change listeners are notified. Parameters n:int the new minimum Annotations @BeanProperty bound:false preferred:true description:The progress bar\'s minimum value. See Also `getMinimum`, `addChangeListener`, `BoundedRangeModel#setMinimum`

public void setMinimum(int n)

Sets the progress bar's minimum value (stored in the progress bar's data model) to n.

The data model (a BoundedRangeModel instance) handles any mathematical issues arising from assigning faulty values. See the BoundedRangeModel documentation for details.

If the minimum value is different from the previous minimum, all change listeners are notified.

Parameters

n:int: the new minimum

Annotations

@BeanProperty
bound:false
preferred:true
description:The progress bar\'s minimum value.

setModel back to summary

setModel	back to summary
public void setModel(BoundedRangeModel newModel) Sets the data model used by the `JProgressBar`. Note that the `BoundedRangeModel`'s `extent` is not used, and is set to `0`. Parameters newModel:BoundedRangeModel the `BoundedRangeModel` to use Annotations @BeanProperty bound:false expert:true description:The data model used by the JProgressBar.

public void setModel(BoundedRangeModel newModel)

Sets the data model used by the JProgressBar. Note that the BoundedRangeModel's extent is not used, and is set to 0.

Parameters

newModel:BoundedRangeModel: the BoundedRangeModel to use

Annotations

@BeanProperty
bound:false
expert:true
description:The data model used by the JProgressBar.

setOrientation back to summary

setOrientation	back to summary
public void setOrientation(int newOrientation) Sets the progress bar's orientation to `newOrientation`, which must be `SwingConstants.VERTICAL` or `SwingConstants.HORIZONTAL`. The default orientation is `SwingConstants.HORIZONTAL`. Parameters newOrientation:int `HORIZONTAL` or `VERTICAL` Annotations @BeanProperty preferred:true visualUpdate:true description:Set the progress bar\'s orientation. Exceptions IllegalArgumentException: if `newOrientation` is an illegal value See Also `getOrientation`

public void setOrientation(int newOrientation)

Sets the progress bar's orientation to newOrientation, which must be SwingConstants.VERTICAL or SwingConstants.HORIZONTAL. The default orientation is SwingConstants.HORIZONTAL.

Parameters

newOrientation:int: HORIZONTAL or VERTICAL

Annotations

@BeanProperty
preferred:true
visualUpdate:true
description:Set the progress bar\'s orientation.

Exceptions

IllegalArgumentException:: if newOrientation is an illegal value

See Also

getOrientation

setString back to summary

setString	back to summary
public void setString(String s) Sets the value of the progress string. By default, this string is `null`, implying the built-in behavior of using a simple percent string. If you have provided a custom progress string and want to revert to the built-in behavior, set the string back to `null`. The progress string is painted only if the `isStringPainted` method returns `true`. Parameters s:String the value of the progress string Annotations @BeanProperty visualUpdate:true description:Specifies the progress string to paint See Also `getString`, `setStringPainted`, `isStringPainted`

public void setString(String s)

Sets the value of the progress string. By default, this string is null, implying the built-in behavior of using a simple percent string. If you have provided a custom progress string and want to revert to the built-in behavior, set the string back to null.

The progress string is painted only if the isStringPainted method returns true.

Parameters

s:String: the value of the progress string

Annotations

@BeanProperty
visualUpdate:true
description:Specifies the progress string to paint

setStringPainted back to summary

setStringPainted	back to summary
public void setStringPainted(boolean b) Sets the value of the `stringPainted` property, which determines whether the progress bar should render a progress string. The default is `false`, meaning no string is painted. Some look and feels might not support progress strings or might support them only when the progress bar is in determinate mode. Parameters b:boolean `true` if the progress bar should render a string Annotations @BeanProperty visualUpdate:true description:Whether the progress bar should render a string. See Also `isStringPainted`, `setString`

public void setStringPainted(boolean b)

Sets the value of the stringPainted property, which determines whether the progress bar should render a progress string. The default is false, meaning no string is painted. Some look and feels might not support progress strings or might support them only when the progress bar is in determinate mode.

Parameters

b:boolean: true if the progress bar should render a string

Annotations

@BeanProperty
visualUpdate:true
description:Whether the progress bar should render a string.

See Also

isStringPainted, setString

setUI back to summary

public void setUI(ProgressBarUI ui)

Sets the look-and-feel object that renders this component.

Parameters

ui:ProgressBarUI: a ProgressBarUI object

Annotations

@BeanProperty
hidden:true
visualUpdate:true
description:The UI object that implements the Component\'s LookAndFeel.

See Also

UIDefaults#getUI

setValue back to summary

public void setValue(int n)

Sets the progress bar's current value to n. This method forwards the new value to the model.

The data model (an instance of BoundedRangeModel) handles any mathematical issues arising from assigning faulty values. See the BoundedRangeModel documentation for details.

If the new value is different from the previous value, all change listeners are notified.

Parameters

n:int: the new value

Annotations

@BeanProperty
bound:false
preferred:true
description:The progress bar\'s current value.

updateUI back to summary

public void updateUI()

Overrides javax.swing.JComponent.updateUI.

Resets the UI property to a value from the current look and feel.

See Also: JComponent#updateUI

writeObject back to summary

private void writeObject(ObjectOutputStream s) throws IOException

Hides javax.swing.JComponent.writeObject.

See readObject() and writeObject() in JComponent for more information about serialization in Swing.

Parameters

s:ObjectOutputStream

Doc from javax.swing.JComponent.writeObject.

the ObjectOutputStream in which to write

Annotations

@Serial

Exceptions

IOException:

Doc from java.awt.Container.writeObject.

if an I/O error occurs

javax.swing back to summary

protected Class JProgressBar.AccessibleJProgressBar

Class Inheritance

extends AccessibleJComponent
implements AccessibleValue

java.lang.Object
javax.accessibility.AccessibleContext
java.awt.Component.AccessibleAWTComponent
java.awt.Container.AccessibleAWTContainer
javax.swing.JComponent.AccessibleJComponent
javax.swing.JProgressBar.AccessibleJProgressBar

All Implemented Interfaces

javax.accessibility.AccessibleValue

Annotations

@SuppressWarnings:serial

This class implements accessibility support for the JProgressBar class. It provides an implementation of the Java Accessibility API appropriate to progress bar user-interface elements.

Warning

Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. As of 1.4, support for long term storage of all JavaBeans has been added to the java.beans package. Please see java.beans.XMLEncoder.

Field Summary

Inherited from javax.swing.JComponent.AccessibleJComponent:: accessibleFocusHandler

Constructor Summary

Access	Constructor and Description
protected	AccessibleJProgressBar() Constructs an `AccessibleJProgressBar`.

Method Summary

Modifier and Type	Method and Description
public AccessibleRole	Returns: an instance of AccessibleRole describing the role of the object getAccessibleRole() Overrides javax.swing.JComponent.AccessibleJComponent.getAccessibleRole. Gets the role of this object.
public AccessibleStateSet	Returns: an instance of AccessibleState containing the current state of the object getAccessibleStateSet() Overrides javax.swing.JComponent.AccessibleJComponent.getAccessibleStateSet. Gets the state set of this object.
public AccessibleValue	Returns: this object getAccessibleValue() Overrides javax.accessibility.AccessibleContext.getAccessibleValue. Gets the `AccessibleValue` associated with this object.
public Number	Returns: the current value of this object getCurrentAccessibleValue() Implements javax.accessibility.AccessibleValue.getCurrentAccessibleValue. Gets the accessible value of this object.
public Number	Returns: the maximum value of this object getMaximumAccessibleValue() Implements javax.accessibility.AccessibleValue.getMaximumAccessibleValue. Gets the maximum accessible value of this object.
public Number	Returns: the minimum value of this object getMinimumAccessibleValue() Implements javax.accessibility.AccessibleValue.getMinimumAccessibleValue. Gets the minimum accessible value of this object.
public boolean	Returns: `true` if the value was set setCurrentAccessibleValue(Number the number to use for the value n) Implements javax.accessibility.AccessibleValue.setCurrentAccessibleValue. Sets the value of this object as a `Number`.

Inherited from javax.swing.JComponent.AccessibleJComponent:: addPropertyChangeListener getAccessibleChild getAccessibleChildrenCount getAccessibleDescription getAccessibleExtendedComponent getAccessibleKeyBinding getAccessibleName getBorderTitle getTitledBorderText getToolTipText removePropertyChangeListener

Constructor Detail

AccessibleJProgressBar	back to summary
protected AccessibleJProgressBar() Constructs an `AccessibleJProgressBar`.

Method Detail

getAccessibleRole

back to summary

public AccessibleRole getAccessibleRole()

Overrides javax.swing.JComponent.AccessibleJComponent.getAccessibleRole.

Gets the role of this object.

Returns:AccessibleRole: an instance of AccessibleRole describing the role of the object

getAccessibleStateSet back to summary

public AccessibleStateSet getAccessibleStateSet()

Overrides javax.swing.JComponent.AccessibleJComponent.getAccessibleStateSet.

Gets the state set of this object.

Returns:AccessibleStateSet: an instance of AccessibleState containing the current state of the object
See Also: AccessibleState

getAccessibleValue back to summary

public AccessibleValue getAccessibleValue()

Overrides javax.accessibility.AccessibleContext.getAccessibleValue.

Gets the AccessibleValue associated with this object. In the implementation of the Java Accessibility API for this class, returns this object, which is responsible for implementing the AccessibleValue interface on behalf of itself.

Returns:AccessibleValue: this object

getCurrentAccessibleValue

back to summary

public Number getCurrentAccessibleValue()

Implements javax.accessibility.AccessibleValue.getCurrentAccessibleValue.

Gets the accessible value of this object.

Returns:Number: the current value of this object

getMaximumAccessibleValue

back to summary

public Number getMaximumAccessibleValue()

Implements javax.accessibility.AccessibleValue.getMaximumAccessibleValue.

Gets the maximum accessible value of this object.

Returns:Number: the maximum value of this object

getMinimumAccessibleValue

back to summary

public Number getMinimumAccessibleValue()

Implements javax.accessibility.AccessibleValue.getMinimumAccessibleValue.

Gets the minimum accessible value of this object.

Returns:Number: the minimum value of this object

setCurrentAccessibleValue back to summary

public boolean setCurrentAccessibleValue(Number n)

Implements javax.accessibility.AccessibleValue.setCurrentAccessibleValue.

Sets the value of this object as a Number.

Parameters

n:Number

Doc from javax.accessibility.AccessibleValue.setCurrentAccessibleValue.

the number to use for the value

Returns:boolean

true if the value was set

public Class JProgressBar

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

protected Class JProgressBar.AccessibleJProgressBar

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private Class JProgressBar.ModelListener

Constructor Summary

Method Summary

Constructor Detail

Method Detail