- java.lang.Object
-
- javax.swing.plaf.ComponentUI
-
- javax.swing.plaf.ProgressBarUI
-
- javax.swing.plaf.basic.BasicProgressBarUI
-
- Direct Known Subclasses:
- MetalProgressBarUI, SynthProgressBarUI
public class BasicProgressBarUI extends ProgressBarUI
A Basic L&F implementation of ProgressBarUI.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description class
BasicProgressBarUI.ChangeHandler
This class should be treated as a "protected" inner class.
-
Field Summary
Fields Modifier and Type Field and Description 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
Constructors Constructor and Description BasicProgressBarUI()
-
Method Summary
Methods Modifier and Type Method and Description 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 inr
and returnsr
.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 appropriately 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 duringinstallUI
.-
Methods inherited from class javax.swing.plaf.ComponentUI
contains, getAccessibleChild, getAccessibleChildrenCount, update
-
-
-
-
Field Detail
-
progressBar
protected JProgressBar progressBar
-
changeListener
protected ChangeListener changeListener
-
boxRect
protected Rectangle boxRect
Used to hold the location and size of the bouncing box (returned by getBox) to be painted.- Since:
- 1.5
-
-
Method Detail
-
createUI
public static ComponentUI createUI(JComponent x)
-
installUI
public void installUI(JComponent c)
Description copied from class:ComponentUI
Configures the specified component appropriately for the look and feel. This method is invoked when theComponentUI
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:- Install 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.
- Install a
LayoutManager
on the component if necessary. - Create/add any required sub-components to the component.
- Create/install event listeners on the component.
- Create/install a
PropertyChangeListener
on the component in order to detect and respond to component property changes appropriately. - Install keyboard UI (mnemonics, traversal, etc.) on the component.
- Initialize any appropriate instance data.
- Overrides:
installUI
in classComponentUI
- Parameters:
c
- the component where this UI delegate is being installed- See Also:
ComponentUI.uninstallUI(javax.swing.JComponent)
,JComponent.setUI(javax.swing.plaf.ComponentUI)
,JComponent.updateUI()
-
uninstallUI
public void uninstallUI(JComponent c)
Description copied from class:ComponentUI
Reverses configuration which was done on the specified component duringinstallUI
. This method is invoked when thisUIComponent
instance is being removed as the UI delegate for the specified component. This method should undo the configuration performed ininstallUI
, being careful to leave theJComponent
instance in a clean state (no extraneous listeners, look-and-feel-specific property objects, etc.). This should include the following:- Remove any UI-set borders from the component.
- Remove any UI-set layout managers on the component.
- Remove any UI-added sub-components from the component.
- Remove any UI-added event/property listeners from the component.
- Remove any UI-installed keyboard UI from the component.
- Nullify any allocated instance data objects to allow for GC.
- Overrides:
uninstallUI
in classComponentUI
- 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- See Also:
ComponentUI.installUI(javax.swing.JComponent)
,JComponent.updateUI()
-
installDefaults
protected void installDefaults()
-
uninstallDefaults
protected void uninstallDefaults()
-
installListeners
protected void installListeners()
-
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
- Since:
- 1.4
- See Also:
stopAnimationTimer()
-
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
- Since:
- 1.4
- See Also:
startAnimationTimer()
-
uninstallListeners
protected void uninstallListeners()
Removes all listeners installed by this object.
-
getBaseline
public int getBaseline(JComponent c, int width, int height)
Returns the baseline.- Overrides:
getBaseline
in classComponentUI
- Parameters:
c
-JComponent
baseline is being requested forwidth
- the width to get the baseline forheight
- the height to get the baseline for- Returns:
- baseline or a value < 0 indicating there is no reasonable baseline
- Throws:
NullPointerException
- ifc
isnull
IllegalArgumentException
- if width or height is < 0- Since:
- 1.6
- See Also:
JComponent.getBaseline(int, int)
-
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 classComponentUI
- Parameters:
c
-JComponent
to return baseline resize behavior for- Returns:
- an enum indicating how the baseline changes as the component size changes
- Throws:
NullPointerException
- ifc
isnull
- Since:
- 1.6
- See Also:
JComponent.getBaseline(int, int)
-
getPreferredInnerHorizontal
protected Dimension getPreferredInnerHorizontal()
-
getPreferredInnerVertical
protected Dimension getPreferredInnerVertical()
-
getSelectionForeground
protected Color getSelectionForeground()
The "selectionForeground" is the color of the text when it is painted over a filled area of the progress bar.
-
getSelectionBackground
protected Color getSelectionBackground()
The "selectionBackground" is the color of the text when it is painted over an unfilled area of the progress bar.
-
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
- See Also:
setCellLength(int)
,JProgressBar.isStringPainted()
-
setCellLength
protected void setCellLength(int cellLen)
-
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
- See Also:
setCellSpacing(int)
,JProgressBar.isStringPainted()
-
setCellSpacing
protected void setCellSpacing(int cellSpace)
-
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.
-
paint
public void paint(Graphics g, JComponent c)
Delegates painting to one of two methods: paintDeterminate or paintIndeterminate.- Overrides:
paint
in classComponentUI
- Parameters:
g
- theGraphics
context in which to paintc
- the component being painted; this argument is often ignored, but might be used if the UI object is stateless and shared by multiple components- See Also:
ComponentUI.update(java.awt.Graphics, javax.swing.JComponent)
-
getBox
protected Rectangle getBox(Rectangle r)
Stores the position and size of the bouncing box that would be painted for the current animation index inr
and returnsr
. Subclasses that add to the painting performed in this class's implementation ofpaintIndeterminate
-- 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 reimplementpaintIndeterminate
.- Parameters:
r
- the Rectangle instance to be modified; may benull
- Returns:
null
if no box should be drawn; otherwise, returns the passed-in rectangle (if non-null) or a new rectangle- Since:
- 1.4
- See Also:
setAnimationIndex(int)
-
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 ofpaintIndeterminate
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
- Since:
- 1.5
- See Also:
SwingUtilities.calculateInnerArea(javax.swing.JComponent, java.awt.Rectangle)
-
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.- Since:
- 1.4
- See Also:
paintDeterminate(java.awt.Graphics, javax.swing.JComponent)
-
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.- Since:
- 1.4
- See Also:
paintIndeterminate(java.awt.Graphics, javax.swing.JComponent)
-
paintString
protected void paintString(Graphics g, int x, int y, int width, int height, int amountFull, Insets b)
-
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.
-
getPreferredSize
public Dimension getPreferredSize(JComponent c)
Description copied from class:ComponentUI
Returns the specified component's preferred size appropriate for the look and feel. Ifnull
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 returnsnull
.- Overrides:
getPreferredSize
in classComponentUI
- 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- See Also:
JComponent.getPreferredSize()
,LayoutManager.preferredLayoutSize(java.awt.Container)
-
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 classComponentUI
- 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 ornull
- See Also:
JComponent.getMinimumSize()
,LayoutManager.minimumLayoutSize(java.awt.Container)
,ComponentUI.getPreferredSize(javax.swing.JComponent)
-
getMaximumSize
public Dimension getMaximumSize(JComponent c)
Description copied from class:ComponentUI
Returns the specified component's maximum size appropriate for the look and feel. Ifnull
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 invokesgetPreferredSize
and returns that value.- Overrides:
getMaximumSize
in classComponentUI
- 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 ornull
- See Also:
JComponent.getMaximumSize()
,LayoutManager2.maximumLayoutSize(java.awt.Container)
-
getAnimationIndex
protected int getAnimationIndex()
Gets the index of the current animation frame.- Since:
- 1.4
-
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
- Since:
- 1.6
-
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 therepaint
method is invoked.- Parameters:
newValue
- the new animation index; no checking is performed on its value- Since:
- 1.4
- See Also:
incrementAnimationIndex()
-
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.- Since:
- 1.4
- See Also:
setAnimationIndex(int)
-
-
Deutsche Übersetzung
Sie haben gebeten, diese Seite auf Deutsch zu besuchen. Momentan ist nur die Oberfläche übersetzt, aber noch nicht der gesamte Inhalt.Wenn Sie mir bei Übersetzungen helfen wollen, ist Ihr Beitrag willkommen. Alles, was Sie tun müssen, ist, sich auf der Website zu registrieren und mir eine Nachricht zu schicken, in der Sie gebeten werden, Sie der Gruppe der Übersetzer hinzuzufügen, die Ihnen die Möglichkeit gibt, die gewünschten Seiten zu übersetzen. Ein Link am Ende jeder übersetzten Seite zeigt an, dass Sie der Übersetzer sind und einen Link zu Ihrem Profil haben.
Vielen Dank im Voraus.
Dokument erstellt 11/06/2005, zuletzt geändert 04/03/2020
Quelle des gedruckten Dokuments:https://www.gaudry.be/de/java-api-rf-javax/swing/plaf/basic/BasicProgressBarUI.html
Die Infobro ist eine persönliche Seite, deren Inhalt in meiner alleinigen Verantwortung liegt. Der Text ist unter der CreativeCommons-Lizenz (BY-NC-SA) verfügbar. Weitere Informationen auf die Nutzungsbedingungen und dem Autor.
Referenzen
Diese Verweise und Links verweisen auf Dokumente, die während des Schreibens dieser Seite konsultiert wurden, oder die zusätzliche Informationen liefern können, aber die Autoren dieser Quellen können nicht für den Inhalt dieser Seite verantwortlich gemacht werden.
Der Autor Diese Website ist allein dafür verantwortlich, wie die verschiedenen Konzepte und Freiheiten, die mit den Nachschlagewerken gemacht werden, hier dargestellt werden. Denken Sie daran, dass Sie mehrere Quellinformationen austauschen müssen, um das Risiko von Fehlern zu reduzieren.