public class

BasicProgressBarUI

extends ProgressBarUI
java.lang.Object
   ↳ javax.swing.plaf.ComponentUI
     ↳ javax.swing.plaf.ProgressBarUI
       ↳ javax.swing.plaf.basic.BasicProgressBarUI
Known Direct Subclasses

Class Overview

A Basic L&F implementation of ProgressBarUI.

Summary

Nested Classes
class BasicProgressBarUI.ChangeHandler This inner class is marked "public" due to a compiler bug. 
Fields
protected Rectangle boxRect Used to hold the location and size of the bouncing box (returned by getBox) to be painted.
protected ChangeListener changeListener
protected JProgressBar progressBar
Public Constructors
BasicProgressBarUI()
Public Methods
static ComponentUI createUI(JComponent x)
int getBaseline(JComponent c, int width, int height)
Returns the baseline.
Component.BaselineResizeBehavior getBaselineResizeBehavior(JComponent c)
Returns an enum indicating how the baseline of the component changes as the size changes.
Dimension getMaximumSize(JComponent c)
Returns the specified component's maximum size appropriate for the look and feel.
Dimension getMinimumSize(JComponent c)
The Minimum size for this component is 10.
Dimension getPreferredSize(JComponent c)
Returns the specified component's preferred size appropriate for the look and feel.
void installUI(JComponent c)
Configures the specified component appropriate for the look and feel.
void paint(Graphics g, JComponent c)
Delegates painting to one of two methods: paintDeterminate or paintIndeterminate.
void uninstallUI(JComponent c)
Reverses configuration which was done on the specified component during installUI.
Protected Methods
int getAmountFull(Insets b, int width, int height)
This determines the amount of the progress bar that should be filled based on the percent done gathered from the model.
int getAnimationIndex()
Gets the index of the current animation frame.
Rectangle getBox(Rectangle r)
Stores the position and size of the bouncing box that would be painted for the current animation index in r and returns r.
int getBoxLength(int availableLength, int otherDimension)
Returns the length of the "bouncing box" to be painted.
int getCellLength()
Returns the width (if HORIZONTAL) or height (if VERTICAL) of each of the indivdual cells/units to be rendered in the progress bar.
int getCellSpacing()
Returns the spacing between each of the cells/units in the progress bar.
final int getFrameCount()
Returns the number of frames for the complete animation loop used by an indeterminate JProgessBar.
Dimension getPreferredInnerHorizontal()
Dimension getPreferredInnerVertical()
Color getSelectionBackground()
The "selectionBackground" is the color of the text when it is painted over an unfilled area of the progress bar.
Color getSelectionForeground()
The "selectionForeground" is the color of the text when it is painted over a filled area of the progress bar.
Point getStringPlacement(Graphics g, String progressString, int x, int y, int width, int height)
Designate the place where the progress string will be painted.
void incrementAnimationIndex()
Sets the index of the current animation frame, to the next valid value, which results in the progress bar being repainted.
void installDefaults()
void installListeners()
void paintDeterminate(Graphics g, JComponent c)
All purpose paint method that should do the right thing for almost all linear, determinate progress bars.
void paintIndeterminate(Graphics g, JComponent c)
All purpose paint method that should do the right thing for all linear bouncing-box progress bars.
void paintString(Graphics g, int x, int y, int width, int height, int amountFull, Insets b)
void setAnimationIndex(int newValue)
Sets the index of the current animation frame to the specified value and requests that the progress bar be repainted.
void setCellLength(int cellLen)
void setCellSpacing(int cellSpace)
void startAnimationTimer()
Starts the animation thread, creating and initializing it if necessary.
void stopAnimationTimer()
Stops the animation thread.
void uninstallDefaults()
void uninstallListeners()
Removes all listeners installed by this object.
[Expand]
Inherited Methods
From class javax.swing.plaf.ComponentUI
From class java.lang.Object

Fields

protected Rectangle boxRect

Used to hold the location and size of the bouncing box (returned by getBox) to be painted.

protected ChangeListener changeListener

protected JProgressBar progressBar

Public Constructors

public BasicProgressBarUI ()

Public Methods

public static ComponentUI createUI (JComponent x)

public int getBaseline (JComponent c, int width, int height)

Returns the baseline.

Parameters
c JComponent baseline is being requested for
width the width to get the baseline for
height the height to get the baseline for
Returns
  • baseline or a value < 0 indicating there is no reasonable baseline
Throws
NullPointerException
IllegalArgumentException
See Also

public Component.BaselineResizeBehavior getBaselineResizeBehavior (JComponent c)

Returns an enum indicating how the baseline of the component changes as the size changes.

Parameters
c JComponent to return baseline resize behavior for
Returns
  • an enum indicating how the baseline changes as the component size changes
Throws
NullPointerException
See Also

public Dimension getMaximumSize (JComponent c)

Returns the specified component's maximum size appropriate for the look and feel. If null is returned, the maximum size will be calculated by the component's layout manager instead (this is the preferred approach for any component with a specific layout manager installed). The default implementation of this method invokes getPreferredSize and returns that value.

Parameters
c the component whose maximum size is being queried; this argument is often ignored, but might be used if the UI object is stateless and shared by multiple components
Returns
  • a Dimension object or null

public Dimension getMinimumSize (JComponent c)

The Minimum size for this component is 10. The rationale here is that there should be at least one pixel per 10 percent.

Parameters
c the component whose minimum size is being queried; this argument is often ignored, but might be used if the UI object is stateless and shared by multiple components
Returns
  • a Dimension object or null

public Dimension getPreferredSize (JComponent c)

Returns the specified component's preferred size appropriate for the look and feel. If null is returned, the preferred size will be calculated by the component's layout manager instead (this is the preferred approach for any component with a specific layout manager installed). The default implementation of this method returns null.

Parameters
c the component whose preferred size is being queried; this argument is often ignored, but might be used if the UI object is stateless and shared by multiple components

public void installUI (JComponent c)

Configures the specified component appropriate for the look and feel. This method is invoked when the ComponentUI instance is being installed as the UI delegate on the specified component. This method should completely configure the component for the look and feel, including the following:

  1. Install any default property values for color, fonts, borders, icons, opacity, etc. on the component. Whenever possible, property values initialized by the client program should not be overridden.
  2. Install a LayoutManager on the component if necessary.
  3. Create/add any required sub-components to the component.
  4. Create/install event listeners on the component.
  5. Create/install a PropertyChangeListener on the component in order to detect and respond to component property changes appropriately.
  6. Install keyboard UI (mnemonics, traversal, etc.) on the component.
  7. Initialize any appropriate instance data.

Parameters
c the component where this UI delegate is being installed

public void paint (Graphics g, JComponent c)

Delegates painting to one of two methods: paintDeterminate or paintIndeterminate.

Parameters
g the Graphics context in which to paint
c the component being painted; this argument is often ignored, but might be used if the UI object is stateless and shared by multiple components

public void uninstallUI (JComponent c)

Reverses configuration which was done on the specified component during installUI. This method is invoked when this UIComponent instance is being removed as the UI delegate for the specified component. This method should undo the configuration performed in installUI, being careful to leave the JComponent instance in a clean state (no extraneous listeners, look-and-feel-specific property objects, etc.). This should include the following:

  1. Remove any UI-set borders from the component.
  2. Remove any UI-set layout managers on the component.
  3. Remove any UI-added sub-components from the component.
  4. Remove any UI-added event/property listeners from the component.
  5. Remove any UI-installed keyboard UI from the component.
  6. Nullify any allocated instance data objects to allow for GC.

Parameters
c the component from which this UI delegate is being removed; this argument is often ignored, but might be used if the UI object is stateless and shared by multiple components

Protected Methods

protected int getAmountFull (Insets b, int width, int height)

This determines the amount of the progress bar that should be filled based on the percent done gathered from the model. This is a common operation so it was abstracted out. It assumes that your progress bar is linear. That is, if you are making a circular progress indicator, you will want to override this method.

protected int getAnimationIndex ()

Gets the index of the current animation frame.

protected Rectangle getBox (Rectangle r)

Stores the position and size of the bouncing box that would be painted for the current animation index in r and returns r. Subclasses that add to the painting performed in this class's implementation of paintIndeterminate -- to draw an outline around the bouncing box, for example -- can use this method to get the location of the bouncing box that was just painted. By overriding this method, you have complete control over the size and position of the bouncing box, without having to reimplement paintIndeterminate.

Parameters
r the Rectangle instance to be modified; may be null
Returns
  • null if no box should be drawn; otherwise, returns the passed-in rectangle (if non-null) or a new rectangle
See Also

protected int getBoxLength (int availableLength, int otherDimension)

Returns the length of the "bouncing box" to be painted. This method is invoked by the default implementation of paintIndeterminate to get the width (if the progress bar is horizontal) or height (if vertical) of the box. For example: 

boxRect.width = getBoxLength(componentInnards.width,
                             componentInnards.height);

Parameters
availableLength the amount of space available for the bouncing box to move in; for a horizontal progress bar, for example, this should be the inside width of the progress bar (the component width minus borders)
otherDimension for a horizontal progress bar, this should be the inside height of the progress bar; this value might be used to constrain or determine the return value
Returns
  • the size of the box dimension being determined; must be no larger than availableLength
See Also

protected int getCellLength ()

Returns the width (if HORIZONTAL) or height (if VERTICAL) of each of the indivdual cells/units to be rendered in the progress bar. However, for text rendering simplification and aesthetic considerations, this function will return 1 when the progress string is being rendered.

Returns
  • the value representing the spacing between cells
See Also

protected int getCellSpacing ()

Returns the spacing between each of the cells/units in the progress bar. However, for text rendering simplification and aesthetic considerations, this function will return 0 when the progress string is being rendered.

Returns
  • the value representing the spacing between cells
See Also

protected final int getFrameCount ()

Returns the number of frames for the complete animation loop used by an indeterminate JProgessBar. The progress chunk will go from one end to the other and back during the entire loop. This visual behavior may be changed by subclasses in other Look and Feels.

Returns
  • the number of frames

protected Dimension getPreferredInnerHorizontal ()

protected Dimension getPreferredInnerVertical ()

protected Color getSelectionBackground ()

The "selectionBackground" is the color of the text when it is painted over an unfilled area of the progress bar.

protected Color getSelectionForeground ()

The "selectionForeground" is the color of the text when it is painted over a filled area of the progress bar.

protected Point getStringPlacement (Graphics g, String progressString, int x, int y, int width, int height)

Designate the place where the progress string will be painted. This implementation places it at the center of the progress bar (in both x and y). Override this if you want to right, left, top, or bottom align the progress string or if you need to nudge it around for any reason.

protected void incrementAnimationIndex ()

Sets the index of the current animation frame, to the next valid value, which results in the progress bar being repainted. The next valid value is, by default, the current animation index plus one. If the new value would be too large, this method sets the index to 0. Subclasses might need to override this method to ensure that the index does not go over the number of frames needed for the particular progress bar instance. This method is invoked by the default animation thread every X milliseconds, where X is specified by the "ProgressBar.repaintInterval" UI default.

See Also

protected void installDefaults ()

protected void installListeners ()

protected void paintDeterminate (Graphics g, JComponent c)

All purpose paint method that should do the right thing for almost all linear, determinate progress bars. By setting a few values in the defaults table, things should work just fine to paint your progress bar. Naturally, override this if you are making a circular or semi-circular progress bar.

See Also

protected void paintIndeterminate (Graphics g, JComponent c)

All purpose paint method that should do the right thing for all linear bouncing-box progress bars. Override this if you are making another kind of progress bar.

See Also

protected void paintString (Graphics g, int x, int y, int width, int height, int amountFull, Insets b)

protected void setAnimationIndex (int newValue)

Sets the index of the current animation frame to the specified value and requests that the progress bar be repainted. Subclasses that don't use the default painting code might need to override this method to change the way that the repaint method is invoked.

Parameters
newValue the new animation index; no checking is performed on its value
See Also

protected void setCellLength (int cellLen)

protected void setCellSpacing (int cellSpace)

protected void startAnimationTimer ()

Starts the animation thread, creating and initializing it if necessary. This method is invoked when an indeterminate progress bar should start animating. Reasons for this may include:

  • The progress bar is determinate and becomes displayable
  • The progress bar is displayable and becomes determinate
  • The progress bar is displayable and determinate and this UI is installed
If you implement your own animation thread, you must override this method.

See Also

protected void stopAnimationTimer ()

Stops the animation thread. This method is invoked when the indeterminate animation should be stopped. Reasons for this may include:

  • The progress bar changes to determinate
  • The progress bar is no longer part of a displayable hierarchy
  • This UI in uninstalled
If you implement your own animation thread, you must override this method.

See Also

protected void uninstallDefaults ()

protected void uninstallListeners ()

Removes all listeners installed by this object.