javax.swing

Class JProgressBar

Implemented Interfaces:
Accessible, ImageObserver, MenuContainer, Serializable, SwingConstants

public class JProgressBar
extends JComponent
implements SwingConstants, Accessible

The ProgressBar is a widget that displays in two modes. In determinate mode, it displays fills a percentage of its bar based on its current value. In indeterminate mode, it creates box and bounces it between its bounds.

JProgressBars have the following properties:

Property Stored in Bound?
borderPainted progressBar yes
changeListeners progressBar no
indeterminate progressBar yes
maximum model no
minimum model no
model progressBar no
orientation progressBar yes
percentComplete progressBar no
string progressBar yes
stringPainted progressBar yes
value model no
See Also:
Serialized Form

Nested Class Summary

protected class
JProgressBar.AccessibleJProgressBar
AccessibleJProgressBar

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

protected ChangeEvent
changeEvent
The static changeEvent passed to all ChangeListeners.
protected ChangeListener
changeListener
The ChangeListener that listens to the model.
protected BoundedRangeModel
model
The model describing this ProgressBar.
protected int
orientation
The orientation of the ProgressBar
protected boolean
paintBorder
Whether borders should be painted.
protected boolean
paintString
Whether the string should be painted.
protected String
progressString
The string that is displayed by the ProgressBar.

Fields inherited from class javax.swing.JComponent

TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW, accessibleContext, listenerList, ui

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Fields inherited from interface javax.swing.SwingConstants

BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

Constructor Summary

JProgressBar()
Creates a new horizontally oriented JProgressBar object with a minimum of 0 and a maximum of 100.
JProgressBar(int orientation)
Creates a new JProgressBar object with a minimum of 0, a maximum of 100, and the given orientation.
JProgressBar(int minimum, int maximum)
Creates a new horizontally oriented JProgressBar object with the given minimum and maximum.
JProgressBar(int orientation, int minimum, int maximum)
Creates a new JProgressBar object with the given minimum, maximum, and orientation.
JProgressBar(BoundedRangeModel model)
Creates a new horizontally oriented JProgressBar object with the given model.

Method Summary

void
addChangeListener(ChangeListener listener)
This method adds a ChangeListener to this JProgressBar.
protected ChangeListener
createChangeListener()
This method returns a ChangeListener that gets registered model.
protected void
fireStateChanged()
This method is called when the JProgressBar receives a ChangeEvent from its model.
AccessibleContext
getAccessibleContext()
DOCUMENT ME!
ChangeListener[]
getChangeListeners()
This method returns an array of all ChangeListeners listening to this progress bar.
int
getMaximum()
This method returns the maximum value of this JProgressBar.
int
getMinimum()
This method returns the minimum value of this JProgressBar.
BoundedRangeModel
getModel()
This method returns the model used with this JProgressBar.
int
getOrientation()
This method returns the orientation of the JProgressBar.
double
getPercentComplete()
This method returns the percent of the bar that is "complete".
String
getString()
This method returns the string that is painted if the stringPainted property is set to true.
ProgressBarUI
getUI()
This method returns the JProgressBar's UI delegate.
String
getUIClassID()
This method returns the identifier to allow the UIManager to pick the correct class to act as the UI for this JProgressBar.
int
getValue()
This method returns the current value of the JProgressBar.
boolean
isBorderPainted()
This method returns whether the border is painted.
boolean
isIndeterminate()
This method returns whether the JProgressBar is indeterminate.
boolean
isStringPainted()
This method returns whether the progressString will be painted.
protected void
paintBorder(Graphics graphics)
This method paints the border of the JProgressBar
protected String
paramString()
This method returns a string that can be used to describe this JProgressBar.
void
removeChangeListener(ChangeListener listener)
This method removes a ChangeListener from this JProgressBar.
void
setBorderPainted(boolean painted)
This method changes the borderPainted property.
void
setIndeterminate(boolean newValue)
This method changes the indeterminate property.
void
setMaximum(int maximum)
This method sets the maximum value of this JProgressBar.
void
setMinimum(int minimum)
This method sets the minimum value of this JProgressBar.
void
setModel(BoundedRangeModel model)
This method changes the model property for this JProgressBar.
void
setOrientation(int orientation)
This method changes the orientation property.
void
setString(String string)
This method changes the string property.
void
setStringPainted(boolean painted)
This method changes the stringPainted property.
void
setUI(ProgressBarUI ui)
This method changes the UI property for this JProgressBar.
void
setValue(int value)
This method sets the value of the JProgressBar.
void
updateUI()
This method reverts the UI delegate for this JProgressBar to the default for this Look and Feel.

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addNotify, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getInsets, getLayout, getListeners, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, paramString, preferredSize, print, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, removeNotify, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setFont, setLayout, swapComponents, transferFocusDownCycle, update, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, deliverEvent, disable, disableEvents, dispatchEvent, doLayout, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, getAccessibleContext, getAlignmentX, getAlignmentY, getBackground, getBounds, getBounds, getColorModel, getComponentAt, getComponentAt, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeys, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMaximumSize, getMinimumSize, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, invalidate, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusCycleRoot, isFocusOwner, isFocusTraversable, isFocusable, isFontSet, isForegroundSet, isLightweight, isOpaque, isShowing, isValid, isVisible, keyDown, keyUp, layout, list, list, list, list, list, locate, location, lostFocus, minimumSize, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paint, paintAll, paramString, postEvent, preferredSize, prepareImage, prepareImage, print, printAll, processComponentEvent, processEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusTraversalKeys, setFocusTraversalKeysEnabled, setFocusable, setFont, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle, update, validate

Methods inherited from class java.lang.Object

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

Field Details

changeEvent

protected ChangeEvent changeEvent
The static changeEvent passed to all ChangeListeners.

changeListener

protected ChangeListener changeListener
The ChangeListener that listens to the model.

model

protected BoundedRangeModel model
The model describing this ProgressBar.

orientation

protected int orientation
The orientation of the ProgressBar

paintBorder

protected boolean paintBorder
Whether borders should be painted.

paintString

protected boolean paintString
Whether the string should be painted.

progressString

protected String progressString
The string that is displayed by the ProgressBar.

Constructor Details

JProgressBar

public JProgressBar()
Creates a new horizontally oriented JProgressBar object with a minimum of 0 and a maximum of 100.

JProgressBar

public JProgressBar(int orientation)
Creates a new JProgressBar object with a minimum of 0, a maximum of 100, and the given orientation.
Parameters:
orientation - The orientation of the JProgressBar.

JProgressBar

public JProgressBar(int minimum,
                    int maximum)
Creates a new horizontally oriented JProgressBar object with the given minimum and maximum.
Parameters:
minimum - The minimum of the JProgressBar.
maximum - The maximum of the JProgressBar.

JProgressBar

public JProgressBar(int orientation,
                    int minimum,
                    int maximum)
Creates a new JProgressBar object with the given minimum, maximum, and orientation.
Parameters:
orientation - The orientation of the JProgressBar.
minimum - The minimum of the JProgressBar.
maximum - The maximum of the JProgressBar.

JProgressBar

public JProgressBar(BoundedRangeModel model)
Creates a new horizontally oriented JProgressBar object with the given model.
Parameters:
model - The model to be used with the JProgressBar.

Method Details

addChangeListener

public void addChangeListener(ChangeListener listener)
This method adds a ChangeListener to this JProgressBar.
Parameters:
listener - The ChangeListener to add to this JProgressBar.

createChangeListener

protected ChangeListener createChangeListener()
This method returns a ChangeListener that gets registered model. By default, the ChangeListener, propagates the ChangeEvents to the ChangeListeners of the JProgressBar.
Returns:
A new ChangeListener.

fireStateChanged

protected void fireStateChanged()
This method is called when the JProgressBar receives a ChangeEvent from its model. This simply propagates the event (changing the source to the JProgressBar) to the JProgressBar's listeners.

getAccessibleContext

public AccessibleContext getAccessibleContext()
DOCUMENT ME!
Specified by:
getAccessibleContext in interface Accessible
Overrides:
getAccessibleContext in interface JComponent
Returns:
DOCUMENT ME!

getChangeListeners

public ChangeListener[] getChangeListeners()
This method returns an array of all ChangeListeners listening to this progress bar.
Returns:
An array of ChangeListeners listening to this progress bar.

getMaximum

public int getMaximum()
This method returns the maximum value of this JProgressBar.
Returns:
The maximum value of this JProgressBar.

getMinimum

public int getMinimum()
This method returns the minimum value of this JProgressBar.
Returns:
The minimum value of this JProgressBar.

getModel

public BoundedRangeModel getModel()
This method returns the model used with this JProgressBar.
Returns:
The model used with this JProgressBar.

getOrientation

public int getOrientation()
This method returns the orientation of the JProgressBar.
Returns:
The orientation of the JProgressBar.

getPercentComplete

public double getPercentComplete()
This method returns the percent of the bar that is "complete". (This is the amount value / (max - min)).
Returns:
DOCUMENT ME!

getString

public String getString()
This method returns the string that is painted if the stringPainted property is set to true. If there is no string set, it will return a string containing the JProgressBar's value as a percent.
Returns:
The string that is painted.

getUI

public ProgressBarUI getUI()
This method returns the JProgressBar's UI delegate.
Returns:
This JProgressBar's UI delegate.

getUIClassID

public String getUIClassID()
This method returns the identifier to allow the UIManager to pick the correct class to act as the UI for this JProgressBar.
Overrides:
getUIClassID in interface JComponent
Returns:
The UIClassID: "ProgressBarUI".

getValue

public int getValue()
This method returns the current value of the JProgressBar.
Returns:
The current value of the JProgressBar.

isBorderPainted

public boolean isBorderPainted()
This method returns whether the border is painted.
Returns:
Whether the border is painted.

isIndeterminate

public boolean isIndeterminate()
This method returns whether the JProgressBar is indeterminate.
Returns:
Whether this JProgressBar is indeterminate.

isStringPainted

public boolean isStringPainted()
This method returns whether the progressString will be painted.
Returns:
Whether the string is painted.

paintBorder

protected void paintBorder(Graphics graphics)
This method paints the border of the JProgressBar
Overrides:
paintBorder in interface JComponent
Parameters:
graphics - The graphics object to paint with.

paramString

protected String paramString()
This method returns a string that can be used to describe this JProgressBar. This method is usually only used for debugging purposes.
Overrides:
paramString in interface JComponent
Returns:
A string that describes this JProgressBar.

removeChangeListener

public void removeChangeListener(ChangeListener listener)
This method removes a ChangeListener from this JProgressBar.
Parameters:
listener - The ChangeListener to remove from this JProgressBar.

setBorderPainted

public void setBorderPainted(boolean painted)
This method changes the borderPainted property.
Parameters:
painted - Whether the border is painted.

setIndeterminate

public void setIndeterminate(boolean newValue)
This method changes the indeterminate property. If the JProgressBar is determinate, it paints a percentage of the bar described by its value. If it is indeterminate, it simply bounces a box between the ends of the bar; the value of the JProgressBar is ignored.
Parameters:
newValue - Whether the JProgressBar is indeterminate.

setMaximum

public void setMaximum(int maximum)
This method sets the maximum value of this JProgressBar.
Parameters:
maximum - The maximum value of this JProgressBar.

setMinimum

public void setMinimum(int minimum)
This method sets the minimum value of this JProgressBar.
Parameters:
minimum - The minimum value of this JProgressBar.

setModel

public void setModel(BoundedRangeModel model)
This method changes the model property for this JProgressBar.
Parameters:
model - The model to use with this JProgressBar.

setOrientation

public void setOrientation(int orientation)
This method changes the orientation property. The orientation of the JProgressBar can be either horizontal or vertical.
Parameters:
orientation - The orientation of the JProgressBar.

setString

public void setString(String string)
This method changes the string property. The string given will be the one painted. If you want to revert to the default string given, set the string to null.
Parameters:
string - The string to be painted.

setStringPainted

public void setStringPainted(boolean painted)
This method changes the stringPainted property.
Parameters:
painted - Whether the string is painted.

setUI

public void setUI(ProgressBarUI ui)
This method changes the UI property for this JProgressBar.
Parameters:
ui - The new UI delegate.

setValue

public void setValue(int value)
This method sets the value of the JProgressBar.
Parameters:
value - The value of the JProgressBar.

updateUI

public void updateUI()
This method reverts the UI delegate for this JProgressBar to the default for this Look and Feel.
Overrides:
updateUI in interface JComponent

JProgressBar.java -- Copyright (C) 2002, 2004, 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.