BasicScrollBarUI (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 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

public class BasicScrollBarUI
extends ScrollBarUI
implements LayoutManager, SwingConstants

Implementation of ScrollBarUI for the Basic Look and Feel

Nested Class Summary
`protected class`	`BasicScrollBarUI.ArrowButtonListener` Listener for cursor keys.
`protected class`	`BasicScrollBarUI.ModelListener` A listener to listen for model changes.
`class`	`BasicScrollBarUI.PropertyChangeHandler`
`protected class`	`BasicScrollBarUI.ScrollListener` Listener for scrolling events initiated in the `ScrollPane`.
`protected class`	`BasicScrollBarUI.TrackListener` Track mouse drags.

Field Summary
`protected BasicScrollBarUI.ArrowButtonListener`	`buttonListener`
`protected JButton`	`decrButton`
`protected static int`	`DECREASE_HIGHLIGHT`
`protected JButton`	`incrButton`
`protected static int`	`INCREASE_HIGHLIGHT`
`protected boolean`	`isDragging`
`protected Dimension`	`maximumThumbSize`
`protected Dimension`	`minimumThumbSize`
`protected BasicScrollBarUI.ModelListener`	`modelListener`
`protected static int`	`NO_HIGHLIGHT`
`protected PropertyChangeListener`	`propertyChangeListener`
`protected JScrollBar`	`scrollbar`
`protected BasicScrollBarUI.ScrollListener`	`scrollListener`
`protected Timer`	`scrollTimer`
`protected Color`	`thumbColor`
`protected Color`	`thumbDarkShadowColor`
`protected Color`	`thumbHighlightColor`
`protected Color`	`thumbLightShadowColor`
`protected Rectangle`	`thumbRect`
`protected Color`	`trackColor`
`protected int`	`trackHighlight`
`protected Color`	`trackHighlightColor`
`protected BasicScrollBarUI.TrackListener`	`trackListener`
`protected Rectangle`	`trackRect`

Constructor Summary
`BasicScrollBarUI()`

Method Summary
`void`	`addLayoutComponent(String name, Component child)`
`protected void`	`configureScrollBarColors()`
`protected BasicScrollBarUI.ArrowButtonListener`	`createArrowButtonListener()`
`protected JButton`	`createDecreaseButton(int orientation)`
`protected JButton`	`createIncreaseButton(int orientation)`
`protected BasicScrollBarUI.ModelListener`	`createModelListener()`
`protected PropertyChangeListener`	`createPropertyChangeListener()`
`protected BasicScrollBarUI.ScrollListener`	`createScrollListener()`
`protected BasicScrollBarUI.TrackListener`	`createTrackListener()`
`static ComponentUI`	`createUI(JComponent c)`
`Dimension`	`getMaximumSize(JComponent c)` Returns the specified component's maximum size appropriate for the look and feel.
`protected Dimension`	`getMaximumThumbSize()` Return the largest acceptable size for the thumb.
`protected Dimension`	`getMinimumThumbSize()` Return the smallest acceptable size for the thumb.
`Dimension`	`getPreferredSize(JComponent c)` A vertical scrollbar's preferred width is the maximum of preferred widths of the (non `null`) increment/decrement buttons, and the minimum width of the thumb.
`boolean`	`getSupportsAbsolutePositioning()` Indicates whether the user can absolutely position the thumb with a mouse gesture (usually the middle mouse button).
`protected Rectangle`	`getThumbBounds()` Return the current size/location of the thumb.
`protected Rectangle`	`getTrackBounds()` Returns the current bounds of the track, i.e.
`protected void`	`installComponents()`
`protected void`	`installDefaults()`
`protected void`	`installKeyboardActions()`
`protected void`	`installListeners()`
`void`	`installUI(JComponent c)` Configures the specified component appropriate for the look and feel.
`boolean`	`isThumbRollover()` Returns true if the mouse is currently over the thumb.
`void`	`layoutContainer(Container scrollbarContainer)`
`protected void`	`layoutHScrollbar(JScrollBar sb)`
`protected void`	`layoutVScrollbar(JScrollBar sb)`
`Dimension`	`minimumLayoutSize(Container scrollbarContainer)`
`void`	`paint(Graphics g, JComponent c)` Paints the specified component appropriate for the look and feel.
`protected void`	`paintDecreaseHighlight(Graphics g)`
`protected void`	`paintIncreaseHighlight(Graphics g)`
`protected void`	`paintThumb(Graphics g, JComponent c, Rectangle thumbBounds)`
`protected void`	`paintTrack(Graphics g, JComponent c, Rectangle trackBounds)`
`Dimension`	`preferredLayoutSize(Container scrollbarContainer)`
`void`	`removeLayoutComponent(Component child)`
`protected void`	`scrollByBlock(int direction)`
`protected void`	`scrollByUnit(int direction)`
`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.
`protected void`	`setThumbRollover(boolean active)` Sets whether or not the mouse is currently over the thumb.
`protected void`	`uninstallComponents()`
`protected void`	`uninstallDefaults()`
`protected void`	`uninstallKeyboardActions()`
`protected void`	`uninstallListeners()`
`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

buttonListener

protected BasicScrollBarUI.ArrowButtonListener buttonListener

decrButton

protected JButton decrButton

DECREASE_HIGHLIGHT

protected static final int DECREASE_HIGHLIGHT

incrButton

protected JButton incrButton

INCREASE_HIGHLIGHT

protected static final int INCREASE_HIGHLIGHT

isDragging

protected boolean isDragging

maximumThumbSize

protected Dimension maximumThumbSize

minimumThumbSize

protected Dimension minimumThumbSize

modelListener

protected BasicScrollBarUI.ModelListener modelListener

NO_HIGHLIGHT

protected static final int NO_HIGHLIGHT

propertyChangeListener

protected PropertyChangeListener propertyChangeListener

scrollbar

protected JScrollBar scrollbar

scrollListener

protected BasicScrollBarUI.ScrollListener scrollListener

scrollTimer

protected Timer scrollTimer

thumbColor

protected Color thumbColor

thumbDarkShadowColor

protected Color thumbDarkShadowColor

thumbHighlightColor

protected Color thumbHighlightColor

thumbLightShadowColor

protected Color thumbLightShadowColor

thumbRect

protected Rectangle thumbRect

trackColor

protected Color trackColor

trackHighlight

protected int trackHighlight

trackHighlightColor

protected Color trackHighlightColor

trackListener

protected BasicScrollBarUI.TrackListener trackListener

trackRect

protected Rectangle trackRect

Constructor Detail

BasicScrollBarUI

public BasicScrollBarUI()

Method Detail

addLayoutComponent

public void addLayoutComponent(String name,
                               Component child)

Parameters:: name; child

configureScrollBarColors

protected void configureScrollBarColors()

createArrowButtonListener

protected BasicScrollBarUI.ArrowButtonListener createArrowButtonListener()

createDecreaseButton

protected JButton createDecreaseButton(int orientation)

Parameters:: orientation

createIncreaseButton

protected JButton createIncreaseButton(int orientation)

Parameters:: orientation

createModelListener

protected BasicScrollBarUI.ModelListener createModelListener()

createPropertyChangeListener

protected PropertyChangeListener createPropertyChangeListener()

createScrollListener

protected BasicScrollBarUI.ScrollListener createScrollListener()

createTrackListener

protected BasicScrollBarUI.TrackListener createTrackListener()

createUI

public static ComponentUI createUI(JComponent c)

Parameters:: c

getMaximumSize

public Dimension getMaximumSize(JComponent c)

Overrides:: getMaximumSize in class ComponentUI
Parameters:: c - The JScrollBar that's delegating this method to us.
Returns:: new Dimension(Integer.MAX_VALUE, Integer.MAX_VALUE);

getMaximumThumbSize

protected Dimension getMaximumThumbSize()

Return the largest acceptable size for the thumb. To create a fixed size thumb one make this method and getMinimumThumbSize return 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.

getMinimumThumbSize

protected Dimension getMinimumThumbSize()

Return 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.

getPreferredSize

public Dimension getPreferredSize(JComponent c)

A vertical scrollbar's preferred width is the maximum of preferred widths of the (non null) 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 preferredSize is only computed once, subsequent calls to this method just return a cached size.

Overrides:: getPreferredSize in class ComponentUI
Parameters:: c - the JScrollBar that's delegating this method to us
Returns:: the preferred size of a Basic JScrollBar

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

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.

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).