File	Doc	Category	Size	Date	Package
JProgressBar.java	API Doc	Java SE 6 API	37049	Tue Jun 10 00:26:38 BST 2008	javax.swing

JProgressBar

• java.lang.Object
  • java.awt.Component
    • java.awt.Container
      • javax.swing.JComponent

progressBar = new JProgressBar(0, task.getLengthOfTask());
progressBar.setValue(0);
progressBar.setStringPainted(true);

progressBar.setValue(task.getCurrent());

progressBar = new JProgressBar();
...//when the task of (initially) unknown length begins:
progressBar.setIndeterminate(true);
...//do some work; get length of task...
progressBar.setMaximum(newLength);
progressBar.setValue(newValue);
progressBar.setIndeterminate(false);

Fields Summary
private static final String	uiClassID
protected int	orientation Whether the progress bar is horizontal or vertical. The default is HORIZONTAL.
protected boolean	paintBorder Whether to display a border around the progress bar. The default is true.
protected BoundedRangeModel	model The object that holds the data for the progress bar.
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, {@code paintString} must be {@code true}.
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.
private static final int	defaultMinimum The default minimum for a progress bar is 0.
private static final int	defaultMaximum The default maximum for a progress bar is 100.
private static final int	defaultOrientation The default orientation for a progress bar is HORIZONTAL.
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.
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 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.

Constructors 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 #setOrientation see #setBorderPainted see #setStringPainted see #setString see #setIndeterminate this(defaultOrientation);
public JProgressBar(int orient) Creates a progress bar with the specified orientation, which can be either {@code SwingConstants.VERTICAL} or {@code 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. param orient the desired orientation of the progress bar throws IllegalArgumentException if {@code orient} is an illegal value see #setOrientation see #setBorderPainted see #setStringPainted see #setString see #setIndeterminate this(orient, defaultMinimum, defaultMaximum);
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 {@code BoundedRangeModel} documentation for details. param min the minimum value of the progress bar param max the maximum value of the progress bar see BoundedRangeModel see #setOrientation see #setBorderPainted see #setStringPainted see #setString see #setIndeterminate this(defaultOrientation, min, max);
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 {@code BoundedRangeModel} documentation for details. param orient the desired orientation of the progress bar param min the minimum value of the progress bar param max the maximum value of the progress bar throws IllegalArgumentException if {@code orient} is an illegal value see BoundedRangeModel see #setOrientation see #setBorderPainted see #setStringPainted see #setString see #setIndeterminate // Creating the model this way is a bit simplistic, but // I believe that it is the the most common usage of this // component - it's what people will expect. setModel(new DefaultBoundedRangeModel(min, 0, min, max)); updateUI(); setOrientation(orient); // documented with set/getOrientation() setBorderPainted(true); // documented with is/setBorderPainted() setStringPainted(false); // see setStringPainted setString(null); // see getString setIndeterminate(false); // see 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. param newModel the data model for the progress bar see #setOrientation see #setBorderPainted see #setStringPainted see #setString see #setIndeterminate setModel(newModel); updateUI(); setOrientation(defaultOrientation); // see setOrientation() setBorderPainted(true); // see setBorderPainted() setStringPainted(false); // see setStringPainted setString(null); // see getString setIndeterminate(false); // see setIndeterminate

Methods Summary
public void	addChangeListener(javax.swing.event.ChangeListener l) Adds the specified ChangeListener to the progress bar. param l the ChangeListener to add listenerList.add(ChangeListener.class, l);
protected javax.swing.event.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 {@code ChangeListener} simply calls the {@code fireStateChanged} method to forward {@code ChangeEvent}s to the {@code ChangeListener}s that have been added directly to the progress bar. see #changeListener see #fireStateChanged see javax.swing.event.ChangeListener see javax.swing.BoundedRangeModel return new ModelListener();
protected void	fireStateChanged() Send a {@code ChangeEvent}, whose source is this {@code JProgressBar}, to all {@code ChangeListener}s that have registered interest in {@code ChangeEvent}s. This method is called each time a {@code ChangeEvent} is received from the model. The event instance is created if necessary, and stored in {@code changeEvent}. see #addChangeListener see EventListenerList // Guaranteed to return a non-null array Object[] listeners = listenerList.getListenerList(); // Process the listeners last to first, notifying // those that are interested in this event for (int i = listeners.length-2; i>=0; i-=2) { if (listeners[i]==ChangeListener.class) { // Lazily create the event: if (changeEvent == null) changeEvent = new ChangeEvent(this); ((ChangeListener)listeners[i+1]).stateChanged(changeEvent); } }
public javax.accessibility.AccessibleContext	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. return an AccessibleJProgressBar that serves as the AccessibleContext of this JProgressBar beaninfo expert: true description: The AccessibleContext associated with this ProgressBar. if (accessibleContext == null) { accessibleContext = new AccessibleJProgressBar(); } return accessibleContext;
public javax.swing.event.ChangeListener[]	getChangeListeners() Returns an array of all the ChangeListeners added to this progress bar with addChangeListener. return all of the ChangeListeners added or an empty array if no listeners have been added since 1.4 return (ChangeListener[])listenerList.getListeners( ChangeListener.class);
public int	getMaximum() Returns the progress bar's {@code maximum} value from the BoundedRangeModel. return the progress bar's maximum value see #setMaximum see BoundedRangeModel#getMaximum return getModel().getMaximum();
public int	getMinimum() Returns the progress bar's {@code minimum} value from the BoundedRangeModel. return the progress bar's minimum value see #setMinimum see BoundedRangeModel#getMinimum return getModel().getMinimum();
public javax.swing.BoundedRangeModel	getModel() Returns the data model used by this progress bar. return the BoundedRangeModel currently in use see #setModel see BoundedRangeModel return model;
public int	getOrientation() Returns {@code SwingConstants.VERTICAL} or {@code SwingConstants.HORIZONTAL}, depending on the orientation of the progress bar. The default orientation is {@code SwingConstants.HORIZONTAL}. return HORIZONTAL or VERTICAL see #setOrientation return orientation;
public double	getPercentComplete() Returns the percent complete for the progress bar. Note that this number is between 0.0 and 1.0. return the percent complete for this progress bar long span = model.getMaximum() - model.getMinimum(); double currentValue = model.getValue(); double pc = (currentValue - model.getMinimum()) / span; return pc;
public java.lang.String	getString() Returns a {@code String} representation of the current progress. By default, this returns a simple percentage {@code String} based on the value returned from {@code getPercentComplete}. An example would be the "42%". You can change this by calling {@code setString}. return the value of the progress string, or a simple percentage string if the progress string is {@code null} see #setString if (progressString != null) { return progressString; } else { if (format == null) { format = NumberFormat.getPercentInstance(); } return format.format(new Double(getPercentComplete())); }
public javax.swing.plaf.ProgressBarUI	getUI() Returns the look-and-feel object that renders this component. return the ProgressBarUI object that renders this component return (ProgressBarUI)ui;
public java.lang.String	getUIClassID() Returns the name of the look-and-feel class that renders this component. return the string "ProgressBarUI" see JComponent#getUIClassID see UIDefaults#getUI beaninfo expert: true description: A string that specifies the name of the look-and-feel class. return uiClassID;
public int	getValue() Returns the progress bar's current {@code value} from the BoundedRangeModel. The value is always between the minimum and maximum values, inclusive. return the current value of the progress bar see #setValue see BoundedRangeModel#getValue return getModel().getValue();
public boolean	isBorderPainted() Returns the borderPainted property. return the value of the borderPainted property see #setBorderPainted beaninfo description: Does the progress bar paint its border return paintBorder;
public boolean	isIndeterminate() Returns the value of the indeterminate property. return the value of the indeterminate property see #setIndeterminate since 1.4 beaninfo description: Is the progress bar indeterminate (true) or normal (false)? return indeterminate;
public boolean	isStringPainted() Returns the value of the stringPainted property. return the value of the stringPainted property see #setStringPainted see #setString return paintString;
protected void	paintBorder(java.awt.Graphics g) Paints the progress bar's border if the borderPainted property is true. param g the Graphics context within which to paint the border see #paint see #setBorder see #isBorderPainted see #setBorderPainted if (isBorderPainted()) { super.paintBorder(g); }
protected java.lang.String	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. return a string representation of this JProgressBar String orientationString = (orientation == HORIZONTAL ? "HORIZONTAL" : "VERTICAL"); String paintBorderString = (paintBorder ? "true" : "false"); String progressStringString = (progressString != null ? progressString : ""); String paintStringString = (paintString ? "true" : "false"); String indeterminateString = (indeterminate ? "true" : "false"); return super.paramString() + ",orientation=" + orientationString + ",paintBorder=" + paintBorderString + ",paintString=" + paintStringString + ",progressString=" + progressStringString + ",indeterminateString=" + indeterminateString;
public void	removeChangeListener(javax.swing.event.ChangeListener l) Removes a ChangeListener from the progress bar. param l the ChangeListener to remove listenerList.remove(ChangeListener.class, l);
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. param b true if the progress bar should paint its border; otherwise, false see #isBorderPainted beaninfo bound: true attribute: visualUpdate true description: Whether the progress bar should paint its border. boolean oldValue = paintBorder; paintBorder = b; firePropertyChange("borderPainted", oldValue, paintBorder); if (paintBorder != oldValue) { repaint(); }
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. param newValue true if the progress bar should change to indeterminate mode; false if it should revert to normal. see #isIndeterminate see javax.swing.plaf.basic.BasicProgressBarUI since 1.4 beaninfo bound: true attribute: visualUpdate true description: Set whether the progress bar is indeterminate (true) or normal (false). boolean oldValue = indeterminate; indeterminate = newValue; firePropertyChange("indeterminate", oldValue, indeterminate);
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 {@code BoundedRangeModel} documentation for details. If the maximum value is different from the previous maximum, all change listeners are notified. param n the new maximum see #getMaximum see #addChangeListener see BoundedRangeModel#setMaximum beaninfo preferred: true description: The progress bar's maximum value. getModel().setMaximum(n);
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 {@code BoundedRangeModel} documentation for details. If the minimum value is different from the previous minimum, all change listeners are notified. param n the new minimum see #getMinimum see #addChangeListener see BoundedRangeModel#setMinimum beaninfo preferred: true description: The progress bar's minimum value. getModel().setMinimum(n);
public void	setModel(javax.swing.BoundedRangeModel newModel) Sets the data model used by the JProgressBar. Note that the {@code BoundedRangeModel}'s {@code extent} is not used, and is set to {@code 0}. param newModel the BoundedRangeModel to use beaninfo expert: true description: The data model used by the JProgressBar. // PENDING(???) setting the same model to multiple bars is broken; listeners BoundedRangeModel oldModel = getModel(); if (newModel != oldModel) { if (oldModel != null) { oldModel.removeChangeListener(changeListener); changeListener = null; } model = newModel; if (newModel != null) { changeListener = createChangeListener(); newModel.addChangeListener(changeListener); } if (accessibleContext != null) { accessibleContext.firePropertyChange( AccessibleContext.ACCESSIBLE_VALUE_PROPERTY, (oldModel== null ? null : new Integer(oldModel.getValue())), (newModel== null ? null : new Integer(newModel.getValue()))); } if (model != null) { model.setExtent(0); } repaint(); }
public void	setOrientation(int newOrientation) Sets the progress bar's orientation to newOrientation, which must be {@code SwingConstants.VERTICAL} or {@code SwingConstants.HORIZONTAL}. The default orientation is {@code SwingConstants.HORIZONTAL}. param newOrientation HORIZONTAL or VERTICAL exception IllegalArgumentException if newOrientation is an illegal value see #getOrientation beaninfo preferred: true bound: true attribute: visualUpdate true description: Set the progress bar's orientation. if (orientation != newOrientation) { switch (newOrientation) { case VERTICAL: case HORIZONTAL: int oldOrientation = orientation; orientation = newOrientation; firePropertyChange("orientation", oldOrientation, newOrientation); if (accessibleContext != null) { accessibleContext.firePropertyChange( AccessibleContext.ACCESSIBLE_STATE_PROPERTY, ((oldOrientation == VERTICAL) ? AccessibleState.VERTICAL : AccessibleState.HORIZONTAL), ((orientation == VERTICAL) ? AccessibleState.VERTICAL : AccessibleState.HORIZONTAL)); } break; default: throw new IllegalArgumentException(newOrientation + " is not a legal orientation"); } revalidate(); }
public void	setString(java.lang.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. param s the value of the progress string see #getString see #setStringPainted see #isStringPainted beaninfo bound: true attribute: visualUpdate true description: Specifies the progress string to paint String oldValue = progressString; progressString = s; firePropertyChange("string", oldValue, progressString); if (progressString == null || oldValue == null || !progressString.equals(oldValue)) { repaint(); }
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. param b true if the progress bar should render a string see #isStringPainted see #setString beaninfo bound: true attribute: visualUpdate true description: Whether the progress bar should render a string. //PENDING: specify that string not painted when in indeterminate mode? // or just leave that to the L&F? boolean oldValue = paintString; paintString = b; firePropertyChange("stringPainted", oldValue, paintString); if (paintString != oldValue) { revalidate(); repaint(); }
public void	setUI(javax.swing.plaf.ProgressBarUI ui) Sets the look-and-feel object that renders this component. param ui a ProgressBarUI object see UIDefaults#getUI beaninfo bound: true hidden: true attribute: visualUpdate true description: The UI object that implements the Component's LookAndFeel. super.setUI(ui);
public void	setValue(int n) Sets the progress bar's current value to {@code n}. This method forwards the new value to the model. The data model (an instance of {@code BoundedRangeModel}) handles any mathematical issues arising from assigning faulty values. See the {@code BoundedRangeModel} documentation for details. If the new value is different from the previous value, all change listeners are notified. param n the new value see #getValue see #addChangeListener see BoundedRangeModel#setValue beaninfo preferred: true description: The progress bar's current value. BoundedRangeModel brm = getModel(); int oldValue = brm.getValue(); brm.setValue(n); if (accessibleContext != null) { accessibleContext.firePropertyChange( AccessibleContext.ACCESSIBLE_VALUE_PROPERTY, new Integer(oldValue), new Integer(brm.getValue())); }
public void	updateUI() Resets the UI property to a value from the current look and feel. see JComponent#updateUI setUI((ProgressBarUI)UIManager.getUI(this));
private void	writeObject(java.io.ObjectOutputStream s) See readObject() and writeObject() in JComponent for more information about serialization in Swing. s.defaultWriteObject(); if (getUIClassID().equals(uiClassID)) { byte count = JComponent.getWriteObjCounter(this); JComponent.setWriteObjCounter(this, --count); if (count == 0 && ui != null) { ui.installUI(this); } }