- java.lang.Object
-
- javax.swing.plaf.ComponentUI
-
- javax.swing.plaf.ScrollBarUI
-
- javax.swing.plaf.basic.BasicScrollBarUI
-
- All Implemented Interfaces:
LayoutManager,SwingConstants
- Direct Known Subclasses:
MetalScrollBarUI,SynthScrollBarUI
public class BasicScrollBarUI extends ScrollBarUI implements LayoutManager, SwingConstants
Implementation of ScrollBarUI for the Basic Look and Feel
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected classBasicScrollBarUI.ArrowButtonListenerListener for cursor keys.protected classBasicScrollBarUI.ModelListenerA listener to listen for model changes.classBasicScrollBarUI.PropertyChangeHandlerProperty change handlerprotected classBasicScrollBarUI.ScrollListenerListener for scrolling events initiated in theScrollPane.protected classBasicScrollBarUI.TrackListenerTrack mouse drags.
-
Field Summary
Fields Modifier and Type Field Description protected BasicScrollBarUI.ArrowButtonListenerbuttonListenerButton listenerprotected JButtondecrButtonDecrement buttonprotected static intDECREASE_HIGHLIGHTDecrease highlightprotected intdecrGapDistance between the decrement button and the track.protected JButtonincrButtonIncrement buttonprotected static intINCREASE_HIGHLIGHTIncrease highlightprotected intincrGapDistance between the increment button and the track.protected booleanisDraggingDraggingprotected DimensionmaximumThumbSizeMaximum thumb sizeprotected DimensionminimumThumbSizeMinimum thumb sizeprotected BasicScrollBarUI.ModelListenermodelListenerModel listenerprotected static intNO_HIGHLIGHTNo highlightprotected PropertyChangeListenerpropertyChangeListenerProperty change listenerprotected JScrollBarscrollbarScrollbarprotected intscrollBarWidthHint as to what width (when vertical) or height (when horizontal) should be.protected BasicScrollBarUI.ScrollListenerscrollListenerScroll listenerprotected TimerscrollTimerScroll timerprotected ColorthumbColorThumb colorprotected ColorthumbDarkShadowColorThumb dark shadow colorprotected ColorthumbHighlightColorThumb highlight colorprotected ColorthumbLightShadowColorThumb light shadow colorprotected RectanglethumbRectThumb rectangleprotected ColortrackColorTrack colorprotected inttrackHighlightTrack highlightprotected ColortrackHighlightColorTrack highlight colorprotected BasicScrollBarUI.TrackListenertrackListenerTrack listenerprotected RectangletrackRectTrack rectangle-
Fields declared in interface javax.swing.SwingConstants
BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST
-
-
Constructor Summary
Constructors Constructor Description BasicScrollBarUI()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description protected voidconfigureScrollBarColors()Configures the scroll bar colors.protected BasicScrollBarUI.ArrowButtonListenercreateArrowButtonListener()Creates an arrow button listener.protected JButtoncreateDecreaseButton(int orientation)Creates a decrease button.protected JButtoncreateIncreaseButton(int orientation)Creates an increase button.protected BasicScrollBarUI.ModelListenercreateModelListener()Creates a model listener.protected PropertyChangeListenercreatePropertyChangeListener()Creates a property change listener.protected BasicScrollBarUI.ScrollListenercreateScrollListener()Creates a scroll listener.protected BasicScrollBarUI.TrackListenercreateTrackListener()Creates a track listener.static ComponentUIcreateUI(JComponent c)Creates the UI.DimensiongetMaximumSize(JComponent c)Returns the specified component's maximum size appropriate for the look and feel.protected DimensiongetMaximumThumbSize()Returns the largest acceptable size for the thumb.protected DimensiongetMinimumThumbSize()Returns the smallest acceptable size for the thumb.DimensiongetPreferredSize(JComponent c)A vertical scrollbar's preferred width is the maximum of preferred widths of the (nonnull) increment/decrement buttons, and the minimum width of the thumb.booleangetSupportsAbsolutePositioning()Indicates whether the user can absolutely position the thumb with a mouse gesture (usually the middle mouse button).protected RectanglegetThumbBounds()Return the current size/location of the thumb.protected RectanglegetTrackBounds()Returns the current bounds of the track, i.e. the space in between the increment and decrement buttons, less the insets.protected voidinstallComponents()Installs the components.protected voidinstallDefaults()Installs the defaults.protected voidinstallKeyboardActions()Installs the keyboard actions.protected voidinstallListeners()Installs the listeners.voidinstallUI(JComponent c)Installs the UI.booleanisThumbRollover()Returns true if the mouse is currently over the thumb.protected voidlayoutHScrollbar(JScrollBar sb)Laysouts a vertical scroll bar.protected voidlayoutVScrollbar(JScrollBar sb)Laysouts a vertical scroll bar.protected voidpaintDecreaseHighlight(Graphics g)Paints the decrease highlight.protected voidpaintIncreaseHighlight(Graphics g)Paints the increase highlight.protected voidpaintThumb(Graphics g, JComponent c, Rectangle thumbBounds)Paints the thumb.protected voidpaintTrack(Graphics g, JComponent c, Rectangle trackBounds)Paints the track.protected voidscrollByBlock(int direction)Scrolls by block.protected voidscrollByUnit(int direction)Scrolls by unit.protected voidsetThumbBounds(int x, int y, int width, int height)Set the bounds of the thumb and force a repaint that includes the old thumbBounds and the new one.protected voidsetThumbRollover(boolean active)Sets whether or not the mouse is currently over the thumb.protected voiduninstallComponents()Uninstalls the components.protected voiduninstallDefaults()Uninstalls the defaults.protected voiduninstallKeyboardActions()Uninstalls the keyboard actions.protected voiduninstallListeners()Uninstall the listeners.voiduninstallUI(JComponent c)Uninstalls the UI.-
Methods declared in class javax.swing.plaf.ComponentUI
contains, getAccessibleChild, getAccessibleChildrenCount, getBaseline, getBaselineResizeBehavior, getMinimumSize, paint, update
-
Methods declared in class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods declared in interface java.awt.LayoutManager
addLayoutComponent, layoutContainer, minimumLayoutSize, preferredLayoutSize, removeLayoutComponent
-
-
-
-
Field Detail
-
minimumThumbSize
protected Dimension minimumThumbSize
Minimum thumb size
-
maximumThumbSize
protected Dimension maximumThumbSize
Maximum thumb size
-
thumbHighlightColor
protected Color thumbHighlightColor
Thumb highlight color
-
thumbLightShadowColor
protected Color thumbLightShadowColor
Thumb light shadow color
-
thumbDarkShadowColor
protected Color thumbDarkShadowColor
Thumb dark shadow color
-
thumbColor
protected Color thumbColor
Thumb color
-
trackColor
protected Color trackColor
Track color
-
trackHighlightColor
protected Color trackHighlightColor
Track highlight color
-
scrollbar
protected JScrollBar scrollbar
Scrollbar
-
incrButton
protected JButton incrButton
Increment button
-
decrButton
protected JButton decrButton
Decrement button
-
isDragging
protected boolean isDragging
Dragging
-
trackListener
protected BasicScrollBarUI.TrackListener trackListener
Track listener
-
buttonListener
protected BasicScrollBarUI.ArrowButtonListener buttonListener
Button listener
-
modelListener
protected BasicScrollBarUI.ModelListener modelListener
Model listener
-
thumbRect
protected Rectangle thumbRect
Thumb rectangle
-
trackRect
protected Rectangle trackRect
Track rectangle
-
trackHighlight
protected int trackHighlight
Track highlight
-
NO_HIGHLIGHT
protected static final int NO_HIGHLIGHT
No highlight- See Also:
- Constant Field Values
-
DECREASE_HIGHLIGHT
protected static final int DECREASE_HIGHLIGHT
Decrease highlight- See Also:
- Constant Field Values
-
INCREASE_HIGHLIGHT
protected static final int INCREASE_HIGHLIGHT
Increase highlight- See Also:
- Constant Field Values
-
scrollListener
protected BasicScrollBarUI.ScrollListener scrollListener
Scroll listener
-
propertyChangeListener
protected PropertyChangeListener propertyChangeListener
Property change listener
-
scrollTimer
protected Timer scrollTimer
Scroll timer
-
scrollBarWidth
protected int scrollBarWidth
Hint as to what width (when vertical) or height (when horizontal) should be.- Since:
- 1.7
-
incrGap
protected int incrGap
Distance between the increment button and the track. This may be a negative number. If negative, then an overlap between the button and track will occur, which is useful for shaped buttons.- Since:
- 1.7
-
decrGap
protected int decrGap
Distance between the decrement button and the track. This may be a negative number. If negative, then an overlap between the button and track will occur, which is useful for shaped buttons.- Since:
- 1.7
-
-
Method Detail
-
createUI
public static ComponentUI createUI(JComponent c)
Creates the UI.- Parameters:
c- the component- Returns:
- the UI
-
configureScrollBarColors
protected void configureScrollBarColors()
Configures the scroll bar colors.
-
installUI
public void installUI(JComponent c)
Installs the UI.- Overrides:
installUIin classComponentUI- Parameters:
c- the component- See Also:
ComponentUI.uninstallUI(javax.swing.JComponent),JComponent.setUI(javax.swing.plaf.ComponentUI),JComponent.updateUI()
-
uninstallUI
public void uninstallUI(JComponent c)
Uninstalls the UI.- Overrides:
uninstallUIin classComponentUI- Parameters:
c- the component- See Also:
ComponentUI.installUI(javax.swing.JComponent),JComponent.updateUI()
-
installDefaults
protected void installDefaults()
Installs the defaults.
-
installComponents
protected void installComponents()
Installs the components.
-
uninstallComponents
protected void uninstallComponents()
Uninstalls the components.
-
installListeners
protected void installListeners()
Installs the listeners.
-
installKeyboardActions
protected void installKeyboardActions()
Installs the keyboard actions.
-
uninstallKeyboardActions
protected void uninstallKeyboardActions()
Uninstalls the keyboard actions.
-
uninstallListeners
protected void uninstallListeners()
Uninstall the listeners.
-
uninstallDefaults
protected void uninstallDefaults()
Uninstalls the defaults.
-
createTrackListener
protected BasicScrollBarUI.TrackListener createTrackListener()
Creates a track listener.- Returns:
- a track listener
-
createArrowButtonListener
protected BasicScrollBarUI.ArrowButtonListener createArrowButtonListener()
Creates an arrow button listener.- Returns:
- an arrow button listener
-
createModelListener
protected BasicScrollBarUI.ModelListener createModelListener()
Creates a model listener.- Returns:
- a model listener
-
createScrollListener
protected BasicScrollBarUI.ScrollListener createScrollListener()
Creates a scroll listener.- Returns:
- a scroll listener
-
createPropertyChangeListener
protected PropertyChangeListener createPropertyChangeListener()
Creates a property change listener.- Returns:
- a property change listener
-
setThumbRollover
protected void setThumbRollover(boolean active)
Sets whether or not the mouse is currently over the thumb.- Parameters:
active- True indicates the thumb is currently active.- Since:
- 1.5
-
isThumbRollover
public boolean isThumbRollover()
Returns true if the mouse is currently over the thumb.- Returns:
- true if the thumb is currently active
- Since:
- 1.5
-
getPreferredSize
public Dimension getPreferredSize(JComponent c)
A vertical scrollbar's preferred width is the maximum of preferred widths of the (nonnull) increment/decrement buttons, and the minimum width of the thumb. The preferred height is the sum of the preferred heights of the same parts. The basis for the preferred size of a horizontal scrollbar is similar.The
preferredSizeis only computed once, subsequent calls to this method just return a cached size.- Overrides:
getPreferredSizein classComponentUI- Parameters:
c- theJScrollBarthat's delegating this method to us- Returns:
- the preferred size of a Basic JScrollBar
- See Also:
getMaximumSize(javax.swing.JComponent),ComponentUI.getMinimumSize(javax.swing.JComponent)
-
getMaximumSize
public Dimension getMaximumSize(JComponent c)
Description copied from class:ComponentUIReturns the specified component's maximum size appropriate for the look and feel. Ifnullis 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 invokesgetPreferredSizeand returns that value.- Overrides:
getMaximumSizein classComponentUI- Parameters:
c- The JScrollBar that's delegating this method to us.- Returns:
- new Dimension(Integer.MAX_VALUE, Integer.MAX_VALUE);
- See Also:
ComponentUI.getMinimumSize(javax.swing.JComponent),getPreferredSize(javax.swing.JComponent)
-
createDecreaseButton
protected JButton createDecreaseButton(int orientation)
Creates a decrease button.- Parameters:
orientation- the orientation- Returns:
- a decrease button
-
createIncreaseButton
protected JButton createIncreaseButton(int orientation)
Creates an increase button.- Parameters:
orientation- the orientation- Returns:
- an increase button
-
paintDecreaseHighlight
protected void paintDecreaseHighlight(Graphics g)
Paints the decrease highlight.- Parameters:
g- the graphics
-
paintIncreaseHighlight
protected void paintIncreaseHighlight(Graphics g)
Paints the increase highlight.- Parameters:
g- the graphics
-
paintTrack
protected void paintTrack(Graphics g, JComponent c, Rectangle trackBounds)
Paints the track.- Parameters:
g- the graphicsc- the componenttrackBounds- the track bounds
-
paintThumb
protected void paintThumb(Graphics g, JComponent c, Rectangle thumbBounds)
Paints the thumb.- Parameters:
g- the graphicsc- the componentthumbBounds- the thumb bounds
-
getMinimumThumbSize
protected Dimension getMinimumThumbSize()
Returns the smallest acceptable size for the thumb. If the scrollbar becomes so small that this size isn't available, the thumb will be hidden.Warning : the value returned by this method should not be be modified, it's a shared static constant.
- Returns:
- The smallest acceptable size for the thumb.
- See Also:
getMaximumThumbSize()
-
getMaximumThumbSize
protected Dimension getMaximumThumbSize()
Returns the largest acceptable size for the thumb. To create a fixed size thumb one make this method andgetMinimumThumbSizereturn the same value.Warning : the value returned by this method should not be be modified, it's a shared static constant.
- Returns:
- The largest acceptable size for the thumb.
- See Also:
getMinimumThumbSize()
-
layoutVScrollbar
protected void layoutVScrollbar(JScrollBar sb)
Laysouts a vertical scroll bar.- Parameters:
sb- the scroll bar
-
layoutHScrollbar
protected void layoutHScrollbar(JScrollBar sb)
Laysouts a vertical scroll bar.- Parameters:
sb- the scroll bar
-
setThumbBounds
protected void setThumbBounds(int x, int y, int width, int height)Set the bounds of the thumb and force a repaint that includes the old thumbBounds and the new one.- Parameters:
x- set the x location of the thumby- set the y location of the thumbwidth- set the width of the thumbheight- set the height of the thumb- See Also:
getThumbBounds()
-
getThumbBounds
protected Rectangle getThumbBounds()
Return the current size/location of the thumb.Warning : the value returned by this method should not be be modified, it's a reference to the actual rectangle, not a copy.
- Returns:
- The current size/location of the thumb.
- See Also:
setThumbBounds(int, int, int, int)
-
getTrackBounds
protected Rectangle getTrackBounds()
Returns the current bounds of the track, i.e. the space in between the increment and decrement buttons, less the insets. The value returned by this method is updated each time the scrollbar is laid out (validated).Warning : the value returned by this method should not be be modified, it's a reference to the actual rectangle, not a copy.
- Returns:
- the current bounds of the scrollbar track
- See Also:
LayoutManager.layoutContainer(java.awt.Container)
-
scrollByBlock
protected void scrollByBlock(int direction)
Scrolls by block.- Parameters:
direction- the direction to scroll
-
scrollByUnit
protected void scrollByUnit(int direction)
Scrolls by unit.- Parameters:
direction- the direction to scroll
-
getSupportsAbsolutePositioning
public boolean getSupportsAbsolutePositioning()
Indicates whether the user can absolutely position the thumb with a mouse gesture (usually the middle mouse button).- Returns:
- true if a mouse gesture can absolutely position the thumb
- Since:
- 1.5
-
-