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^TM has been added to the java.beans package. Please see {@link java.beans.XMLEncoder}. 

Also see:

setOrientation

Also see:

setBorderPainted

Also see:

setModel

Also see:

setString
setStringPainted

Also see:

setStringPainted
setString

Also see:

fireStateChanged

Also see:

createChangeListener

 public JProgressBar() 
{
        this(defaultOrientation);
}

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.

Also see:

setOrientation
setBorderPainted
setStringPainted
setString
setIndeterminate

 public JProgressBar(int orient) 
{
        this(orient, defaultMinimum, defaultMaximum);
}

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.

Parameters:

orient - the desired orientation of the progress bar

Throws:

IllegalArgumentException - if {@code orient} is an illegal value

Also see:

setOrientation
setBorderPainted
setStringPainted
setString
setIndeterminate

 public JProgressBar(BoundedRangeModel newModel) 
{
        setModel(newModel);
        updateUI();
        setOrientation(defaultOrientation);  // see setOrientation()
        setBorderPainted(true);              // see setBorderPainted()
        setStringPainted(false);             // see setStringPainted
        setString(null);                     // see getString
        setIndeterminate(false);             // see setIndeterminate
}

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 - the data model for the progress bar

Also see:

setOrientation
setBorderPainted
setStringPainted
setString
setIndeterminate

 public JProgressBar(int min,
    int max) 
{
        this(defaultOrientation, min, 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.

Parameters:

min - the minimum value of the progress bar

max - the maximum value of the progress bar

Also see:

BoundedRangeModel
setOrientation
setBorderPainted
setStringPainted
setString
setIndeterminate

 public JProgressBar(int orient,
    int min,
    int max) 
{
        // 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
}

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.

Parameters:

orient - the desired orientation of the progress bar

min - the minimum value of the progress bar

max - the maximum value of the progress bar

Throws:

IllegalArgumentException - if {@code orient} is an illegal value

Also see:

BoundedRangeModel
setOrientation
setBorderPainted
setStringPainted
setString
setIndeterminate

 public  void addChangeListener(ChangeListener l) 
{
        listenerList.add(ChangeListener.class, l);
}

Adds the specified ChangeListener to the progress bar.

 protected ChangeListener createChangeListener() 
{
        return new ModelListener();
}

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.

 protected  void fireStateChanged() 
{
        // 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);
            }
        }
}

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}.

 public AccessibleContext getAccessibleContext() 
{
        if (accessibleContext == null) {
            accessibleContext = new AccessibleJProgressBar();
        }
        return accessibleContext;
}

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.

 public ChangeListener[] getChangeListeners() 
{
        return listenerList.getListeners(ChangeListener.class);
}

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

 public int getMaximum() 
{
 return getModel().getMaximum();
}

Returns the progress bar's {@code maximum} value from the BoundedRangeModel.

 public int getMinimum() 
{
 return getModel().getMinimum();
}

Returns the progress bar's {@code minimum} value from the BoundedRangeModel.

 public BoundedRangeModel getModel() 
{
        return model;
}

Returns the data model used by this progress bar.

 public int getOrientation() 
{
        return orientation;
}

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

 public double getPercentComplete() 
{
        long span = model.getMaximum() - model.getMinimum();
        double currentValue = model.getValue();
        double pc = (currentValue - model.getMinimum()) / span;
        return pc;
}

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

 public String getString() 
{
        if (progressString != null) {
            return progressString;
        } else {
            if (format == null) {
                format = NumberFormat.getPercentInstance();
            }
            return format.format(new Double(getPercentComplete()));
        }
}

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}.

 public ProgressBarUI getUI() 
{
        return (ProgressBarUI)ui;
}

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

 public String getUIClassID() 
{
        return uiClassID;
}

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

 public int getValue() 
{
 return getModel().getValue();
}

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

 public boolean isBorderPainted() 
{
        return paintBorder;
}

Returns the borderPainted property.

 public boolean isIndeterminate() 
{
        return indeterminate;
}

Returns the value of the indeterminate property.

 public boolean isStringPainted() 
{
        return paintString;
}

Returns the value of the stringPainted property.

 protected  void paintBorder(Graphics g) 
{
        if (isBorderPainted()) {
            super.paintBorder(g);
        }
}

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

 protected String paramString() 
{
        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;
}

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.

 public  void removeChangeListener(ChangeListener l) 
{
        listenerList.remove(ChangeListener.class, l);
}

Removes a ChangeListener from the progress bar.

 public  void setBorderPainted(boolean b) 
{
        boolean oldValue = paintBorder;
        paintBorder = b;
        firePropertyChange("borderPainted", oldValue, paintBorder);
        if (paintBorder != oldValue) {
            repaint();
        }
}

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.

 public  void setIndeterminate(boolean newValue) 
{
        boolean oldValue = indeterminate;
        indeterminate = newValue;
        firePropertyChange("indeterminate", oldValue, indeterminate);
}

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.

 public  void setMaximum(int n) 
{
 getModel().setMaximum(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.

 public  void setMinimum(int n) 
{
 getModel().setMinimum(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.

 public  void setModel(BoundedRangeModel newModel) 
{
        // 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 : Integer.valueOf(oldModel.getValue())),
                        (newModel== null
                         ? null : Integer.valueOf(newModel.getValue())));
            }
            if (model != null) {
                model.setExtent(0);
            }
            repaint();
        }
}

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}.

 public  void setOrientation(int newOrientation) 
{
        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();
        }
}

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}.

 public  void setString(String s) 
{
        String oldValue = progressString;
        progressString = s;
        firePropertyChange("string", oldValue, progressString);
        if (progressString == null || oldValue == null || !progressString.equals(oldValue)) {
            repaint();
        }
}

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.

 public  void setStringPainted(boolean b) 
{
        //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();
        }
}

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.

 public  void setUI(ProgressBarUI ui) 
{
        super.setUI(ui);
}

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

 public  void setValue(int n) 
{
        BoundedRangeModel brm = getModel();
        int oldValue = brm.getValue();
        brm.setValue(n);
        if (accessibleContext != null) {
            accessibleContext.firePropertyChange(
                    AccessibleContext.ACCESSIBLE_VALUE_PROPERTY,
                    Integer.valueOf(oldValue),
                    Integer.valueOf(brm.getValue()));
        }
}

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.

 public  void updateUI() 
{
        setUI((ProgressBarUI)UIManager.getUI(this));
}

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