BasicProgressBarUI (Java Platform SE 6)

This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.

Overview

Package

Class

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.swing.plaf.basic
class BasicProgressBarUI

java.lang.Object
  javax.swing.plaf.ComponentUI
      javax.swing.plaf.ProgressBarUI
          javax.swing.plaf.basic.BasicProgressBarUI

Direct Known Subclasses:: MetalProgressBarUI

public class BasicProgressBarUI
extends ProgressBarUI

A Basic L&F implementation of ProgressBarUI.

Nested Class Summary
`class`	`BasicProgressBarUI.ChangeHandler` This inner class is marked "public" due to a compiler bug.

Field Summary
`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`

Constructor Summary
`BasicProgressBarUI()`

Method Summary
`static ComponentUI`	`createUI(JComponent x)`
`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.
`protected int`	`getAnimationIndex()` Gets the index of the current animation frame.
`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.
`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`.
`protected int`	`getBoxLength(int availableLength, int otherDimension)` Returns the length of the "bouncing box" to be painted.
`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.
`protected int`	`getCellSpacing()` Returns the spacing between each of the cells/units in the progress bar.
`protected int`	`getFrameCount()` Returns the number of frames for the complete animation loop used by an indeterminate JProgessBar.
`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.
`protected Dimension`	`getPreferredInnerHorizontal()`
`protected Dimension`	`getPreferredInnerVertical()`
`Dimension`	`getPreferredSize(JComponent c)` Returns the specified component's preferred size appropriate for the look and feel.
`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.
`protected void`	`incrementAnimationIndex()` Sets the index of the current animation frame, to the next valid value, which results in the progress bar being repainted.
`protected void`	`installDefaults()`
`protected void`	`installListeners()`
`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.
`protected void`	`paintDeterminate(Graphics g, JComponent c)` All purpose paint method that should do the right thing for almost all linear, determinate progress bars.
`protected void`	`paintIndeterminate(Graphics g, JComponent c)` All purpose paint method that should do the right thing for all linear bouncing-box progress bars.
`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.
`protected void`	`setCellLength(int cellLen)`
`protected void`	`setCellSpacing(int cellSpace)`
`protected void`	`startAnimationTimer()` Starts the animation thread, creating and initializing it if necessary.
`protected void`	`stopAnimationTimer()` Stops the animation thread.
`protected void`	`uninstallDefaults()`
`protected void`	`uninstallListeners()` Removes all listeners installed by this object.
`void`	`uninstallUI(JComponent c)` Reverses configuration which was done on the specified component during `installUI`.

Methods inherited from class javax.swing.plaf.ComponentUI
`contains, createUI, getAccessibleChild, getAccessibleChildrenCount, getBaseline, getBaselineResizeBehavior, getMaximumSize, getMinimumSize, getPreferredSize, installUI, paint, uninstallUI, update`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

boxRect

protected Rectangle boxRect

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

changeListener

protected ChangeListener changeListener

progressBar

protected JProgressBar progressBar

Constructor Detail

BasicProgressBarUI

public BasicProgressBarUI()

Method Detail

createUI

public static ComponentUI createUI(JComponent x)

Parameters:: x

getAmountFull

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.

Parameters:: b; width; height

getAnimationIndex

protected int getAnimationIndex()

Gets the index of the current animation frame.

getBaseline

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

Returns the baseline.

Overrides:: getBaseline in class ComponentUI
Parameters:: c; width; height

getBaselineResizeBehavior

public Component.BaselineResizeBehavior getBaselineResizeBehavior(JComponent c)

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

Overrides:: getBaselineResizeBehavior in class ComponentUI
Parameters:: c

getBox

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

getBoxLength

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

getCellLength

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

getCellSpacing

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

getFrameCount

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

getMaximumSize

public Dimension getMaximumSize(JComponent c)

Overrides:: getMaximumSize in class ComponentUI
Parameters:: c

getMinimumSize

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.

Overrides:: getMinimumSize in class ComponentUI
Parameters:: c

getPreferredInnerHorizontal

protected Dimension getPreferredInnerHorizontal()

getPreferredInnerVertical

protected Dimension getPreferredInnerVertical()

getPreferredSize

public Dimension getPreferredSize(JComponent c)

Overrides:: getPreferredSize in class ComponentUI
Parameters:: c

getSelectionBackground

protected Color getSelectionBackground()

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

getSelectionForeground

protected Color getSelectionForeground()

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

getStringPlacement

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.

Parameters:: g; progressString; x; y; width; height

incrementAnimationIndex

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.

installDefaults

protected void installDefaults()

installListeners

protected void installListeners()

installUI

public void installUI(JComponent c)

Overrides:: installUI in class ComponentUI
Parameters:: c

paint

public void paint(Graphics g,
                  JComponent c)

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

Overrides:: paint in class ComponentUI
Parameters:: g; c

paintDeterminate

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.

Parameters:: g; c

paintIndeterminate

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.

Parameters:: g; c

paintString

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

Parameters:: g; x; y; width; height; amountFull; b

setAnimationIndex

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

setCellLength

protected void setCellLength(int cellLen)

Parameters:: cellLen

setCellSpacing

protected void setCellSpacing(int cellSpace)

Parameters:: cellSpace

startAnimationTimer

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.

stopAnimationTimer

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