Class BasicScrollBarUI
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
Implementation of ScrollBarUI for the Basic Look and Feel
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprotected classListener for cursor keys.protected classA listener to listen for model changes.classProperty change handlerprotected classListener for scrolling events initiated in theScrollPane.protected classTrack mouse drags. -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected BasicScrollBarUI.ArrowButtonListenerButton listenerprotected JButtonDecrement buttonprotected static final intDecrease highlightprotected intDistance between the decrement button and the track.protected JButtonIncrement buttonprotected static final intIncrease highlightprotected intDistance between the increment button and the track.protected booleanDraggingprotected DimensionMaximum thumb sizeprotected DimensionMinimum thumb sizeprotected BasicScrollBarUI.ModelListenerModel listenerprotected static final intNo highlightprotected PropertyChangeListenerProperty change listenerprotected JScrollBarScrollbarprotected intHint as to what width (when vertical) or height (when horizontal) should be.protected BasicScrollBarUI.ScrollListenerScroll listenerprotected TimerScroll timerprotected ColorThumb colorprotected ColorThumb dark shadow colorprotected ColorThumb highlight colorprotected ColorThumb light shadow colorprotected RectangleThumb rectangleprotected ColorTrack colorprotected intTrack highlightprotected ColorTrack highlight colorprotected BasicScrollBarUI.TrackListenerTrack listenerprotected RectangleTrack rectangleFields 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 -
Method Summary
Modifier and TypeMethodDescriptionvoidaddLayoutComponent(String name, Component child) If the layout manager uses a per-component string, adds the componentcompto the layout, associating it with the string specified byname.protected voidConfigures the scroll bar colors.protected BasicScrollBarUI.ArrowButtonListenerCreates an arrow button listener.protected JButtoncreateDecreaseButton(int orientation) Creates a decrease button.protected JButtoncreateIncreaseButton(int orientation) Creates an increase button.protected BasicScrollBarUI.ModelListenerCreates a model listener.protected PropertyChangeListenerCreates a property change listener.protected BasicScrollBarUI.ScrollListenerCreates a scroll listener.protected BasicScrollBarUI.TrackListenerCreates a track listener.static ComponentUICreates the UI.Returns the specified component's maximum size appropriate for the look and feel.protected DimensionReturns the largest acceptable size for the thumb.protected DimensionReturns the smallest acceptable size for the thumb.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.booleanIndicates whether the user can absolutely position the thumb with a mouse gesture (usually the middle mouse button).protected RectangleReturn the current size/location of the thumb.protected RectangleReturns the current bounds of the track, i.e. the space in between the increment and decrement buttons, less the insets.protected voidInstalls the components.protected voidInstalls the defaults.protected voidInstalls the keyboard actions.protected voidInstalls the listeners.voidInstalls the UI.booleanReturns true if the mouse is currently over the thumb.voidlayoutContainer(Container scrollbarContainer) Lays out the specified container.protected voidLays out a horizontal scroll bar.protected voidLays out a vertical scroll bar.minimumLayoutSize(Container scrollbarContainer) Calculates the minimum size dimensions for the specified container, given the components it contains.protected voidPaints the decrease highlight.protected voidPaints 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.preferredLayoutSize(Container scrollbarContainer) Calculates the preferred size dimensions for the specified container, given the components it contains.voidremoveLayoutComponent(Component child) Removes the specified component from the layout.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 voidUninstalls the components.protected voidUninstalls the defaults.protected voidUninstalls the keyboard actions.protected voidUninstall the listeners.voidUninstalls the UI.Methods declared in class javax.swing.plaf.ComponentUI
contains, getAccessibleChild, getAccessibleChildrenCount, getBaseline, getBaselineResizeBehavior, getMinimumSize, paint, update
-
Field Details
-
minimumThumbSize
Minimum thumb size -
maximumThumbSize
Maximum thumb size -
thumbHighlightColor
Thumb highlight color -
thumbLightShadowColor
Thumb light shadow color -
thumbDarkShadowColor
Thumb dark shadow color -
thumbColor
Thumb color -
trackColor
Track color -
trackHighlightColor
Track highlight color -
scrollbar
Scrollbar -
incrButton
Increment button -
decrButton
Decrement button -
isDragging
protected boolean isDraggingDragging -
trackListener
Track listener -
buttonListener
Button listener -
modelListener
Model listener -
thumbRect
Thumb rectangle -
trackRect
Track rectangle -
trackHighlight
protected int trackHighlightTrack highlight -
NO_HIGHLIGHT
protected static final int NO_HIGHLIGHTNo highlight- See Also:
-
DECREASE_HIGHLIGHT
protected static final int DECREASE_HIGHLIGHTDecrease highlight- See Also:
-
INCREASE_HIGHLIGHT
protected static final int INCREASE_HIGHLIGHTIncrease highlight- See Also:
-
scrollListener
Scroll listener -
propertyChangeListener
Property change listener -
scrollTimer
Scroll timer -
scrollBarWidth
protected int scrollBarWidthHint as to what width (when vertical) or height (when horizontal) should be.- Since:
- 1.7
-
incrGap
protected int incrGapDistance 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 decrGapDistance 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
-
-
Constructor Details
-
BasicScrollBarUI
public BasicScrollBarUI()Constructs aBasicScrollBarUI.
-
-
Method Details
-
createUI
Creates the UI.- Parameters:
c- the component- Returns:
- the UI
-
configureScrollBarColors
protected void configureScrollBarColors()Configures the scroll bar colors. -
installUI
Installs the UI.- Overrides:
installUIin classComponentUI- Parameters:
c- the component- See Also:
-
uninstallUI
Uninstalls the UI.- Overrides:
uninstallUIin classComponentUI- Parameters:
c- the component- See Also:
-
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
Creates a track listener.- Returns:
- a track listener
-
createArrowButtonListener
Creates an arrow button listener.- Returns:
- an arrow button listener
-
createModelListener
Creates a model listener.- Returns:
- a model listener
-
createScrollListener
Creates a scroll listener.- Returns:
- a scroll listener
-
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
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
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:
-
createDecreaseButton
Creates a decrease button.- Parameters:
orientation- the orientation- Returns:
- a decrease button
-
createIncreaseButton
Creates an increase button.- Parameters:
orientation- the orientation- Returns:
- an increase button
-
paintDecreaseHighlight
Paints the decrease highlight.- Parameters:
g- the graphics
-
paintIncreaseHighlight
Paints the increase highlight.- Parameters:
g- the graphics
-
paintTrack
Paints the track.- Parameters:
g- the graphicsc- the componenttrackBounds- the track bounds
-
paintThumb
Paints the thumb.- Parameters:
g- the graphicsc- the componentthumbBounds- the thumb bounds
-
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
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:
-
addLayoutComponent
Description copied from interface:LayoutManagerIf the layout manager uses a per-component string, adds the componentcompto the layout, associating it with the string specified byname.- Specified by:
addLayoutComponentin interfaceLayoutManager- Parameters:
name- the string to be associated with the componentchild- the component to be added
-
removeLayoutComponent
Description copied from interface:LayoutManagerRemoves the specified component from the layout.- Specified by:
removeLayoutComponentin interfaceLayoutManager- Parameters:
child- the component to be removed
-
preferredLayoutSize
Description copied from interface:LayoutManagerCalculates the preferred size dimensions for the specified container, given the components it contains.- Specified by:
preferredLayoutSizein interfaceLayoutManager- Parameters:
scrollbarContainer- the container to be laid out- Returns:
- the preferred dimension for the container
- See Also:
-
minimumLayoutSize
Description copied from interface:LayoutManagerCalculates the minimum size dimensions for the specified container, given the components it contains.- Specified by:
minimumLayoutSizein interfaceLayoutManager- Parameters:
scrollbarContainer- the component to be laid out- Returns:
- the minimum dimension for the container
- See Also:
-
layoutVScrollbar
Lays out a vertical scroll bar.- Parameters:
sb- the scroll bar
-
layoutHScrollbar
Lays out a horizontal scroll bar.- Parameters:
sb- the scroll bar
-
layoutContainer
Description copied from interface:LayoutManagerLays out the specified container.- Specified by:
layoutContainerin interfaceLayoutManager- Parameters:
scrollbarContainer- the container to be laid out
-
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
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:
-
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:
-
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
-