class:BasicScrollBarUI [NONE]

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

field:minimumThumbSize [NONE]

minimumThumbSize

protected Dimension minimumThumbSize

Minimum thumb size

field:maximumThumbSize [NONE]

maximumThumbSize

protected Dimension maximumThumbSize

Maximum thumb size

field:thumbHighlightColor [NONE]

thumbHighlightColor

protected Color thumbHighlightColor

Thumb highlight color

field:thumbLightShadowColor [NONE]

thumbLightShadowColor

protected Color thumbLightShadowColor

Thumb light shadow color

field:thumbDarkShadowColor [NONE]

thumbDarkShadowColor

protected Color thumbDarkShadowColor

Thumb dark shadow color

field:thumbColor [NONE]

field:trackColor [NONE]

field:trackHighlightColor [NONE]

trackHighlightColor

protected Color trackHighlightColor

Track highlight color

field:scrollbar [NONE]

field:incrButton [NONE]

incrButton

protected JButton incrButton

Increment button

field:decrButton [NONE]

decrButton

protected JButton decrButton

Decrement button

field:isDragging [NONE]

field:trackListener [NONE]

trackListener

protected BasicScrollBarUI.TrackListener trackListener

Track listener

field:buttonListener [NONE]

buttonListener

protected BasicScrollBarUI.ArrowButtonListener buttonListener

Button listener

field:modelListener [NONE]

modelListener

protected BasicScrollBarUI.ModelListener modelListener

Model listener

field:thumbRect [NONE]

thumbRect

protected Rectangle thumbRect

Thumb rectangle

field:trackRect [NONE]

trackRect

protected Rectangle trackRect

Track rectangle

field:trackHighlight [NONE]

trackHighlight

protected int trackHighlight

Track highlight

field:NO_HIGHLIGHT [NONE]

NO_HIGHLIGHT

protected static final int NO_HIGHLIGHT

No highlight

See Also:: Constant Field Values

field:DECREASE_HIGHLIGHT [NONE]

DECREASE_HIGHLIGHT

protected static final int DECREASE_HIGHLIGHT

Decrease highlight

See Also:: Constant Field Values

field:INCREASE_HIGHLIGHT [NONE]

INCREASE_HIGHLIGHT

protected static final int INCREASE_HIGHLIGHT

Increase highlight

See Also:: Constant Field Values

field:scrollListener [NONE]

scrollListener

protected BasicScrollBarUI.ScrollListener scrollListener

Scroll listener

field:propertyChangeListener [NONE]

propertyChangeListener

protected PropertyChangeListener propertyChangeListener

Property change listener

field:scrollTimer [NONE]

field:scrollBarWidth [NONE]

scrollBarWidth

protected int scrollBarWidth

Hint as to what width (when vertical) or height (when horizontal) should be.

Since:: 1.7

field:incrGap [NONE]

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

field:decrGap [NONE]

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

constructor:BasicScrollBarUI() [NONE]

BasicScrollBarUI

public BasicScrollBarUI()

method:createUI(javax.swing.JComponent) [NONE]

createUI

public static ComponentUI createUI?(JComponent c)

Creates the UI.

Parameters:: c - the component
Returns:: the UI

method:configureScrollBarColors() [NONE]

configureScrollBarColors

protected void configureScrollBarColors()

Configures the scroll bar colors.

method:installUI(javax.swing.JComponent) [NONE]

installUI

public void installUI?(JComponent c)

Installs the UI.

Overrides:: installUI in class ComponentUI
Parameters:: c - the component
See Also:: ComponentUI.uninstallUI(javax.swing.JComponent), JComponent.setUI(javax.swing.plaf.ComponentUI), JComponent.updateUI()

method:uninstallUI(javax.swing.JComponent) [NONE]

uninstallUI

public void uninstallUI?(JComponent c)

Uninstalls the UI.

Overrides:: uninstallUI in class ComponentUI
Parameters:: c - the component
See Also:: ComponentUI.installUI(javax.swing.JComponent), JComponent.updateUI()

method:installDefaults() [NONE]

installDefaults

protected void installDefaults()

Installs the defaults.

method:installComponents() [NONE]

installComponents

protected void installComponents()

Installs the components.

method:uninstallComponents() [NONE]

uninstallComponents

protected void uninstallComponents()

Uninstalls the components.

method:installListeners() [NONE]

installListeners

protected void installListeners()

Installs the listeners.

method:installKeyboardActions() [NONE]

installKeyboardActions

protected void installKeyboardActions()

Installs the keyboard actions.

method:uninstallKeyboardActions() [NONE]

uninstallKeyboardActions

protected void uninstallKeyboardActions()

Uninstalls the keyboard actions.

method:uninstallListeners() [NONE]

uninstallListeners

protected void uninstallListeners()

Uninstall the listeners.

method:uninstallDefaults() [NONE]

uninstallDefaults

protected void uninstallDefaults()

Uninstalls the defaults.

method:createTrackListener() [NONE]

createTrackListener

protected BasicScrollBarUI.TrackListener createTrackListener()

Creates a track listener.

Returns:: a track listener

method:createArrowButtonListener() [NONE]

createArrowButtonListener

protected BasicScrollBarUI.ArrowButtonListener createArrowButtonListener()

Creates an arrow button listener.

Returns:: an arrow button listener

method:createModelListener() [NONE]

createModelListener

protected BasicScrollBarUI.ModelListener createModelListener()

Creates a model listener.

Returns:: a model listener

method:createScrollListener() [NONE]

createScrollListener

protected BasicScrollBarUI.ScrollListener createScrollListener()

Creates a scroll listener.

Returns:: a scroll listener

method:createPropertyChangeListener() [NONE]

createPropertyChangeListener

protected PropertyChangeListener createPropertyChangeListener()

Creates a property change listener.

Returns:: a property change listener

method:setThumbRollover(boolean) [NONE]

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

method:isThumbRollover() [NONE]

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

method:paint(java.awt.Graphics,javax.swing.JComponent) [NONE]

paint

public void paint?(Graphics g, JComponent c)

Description copied from class: ComponentUI

Paints the specified component appropriately for the look and feel. This method is invoked from the ComponentUI.update method when the specified component is being painted. Subclasses should override this method and use the specified Graphics object to render the content of the component.

Overrides:: paint in class ComponentUI
Parameters:: g - the Graphics context in which to paint; c - 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)

method:getPreferredSize(javax.swing.JComponent) [NONE]

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
See Also:: getMaximumSize(javax.swing.JComponent), ComponentUI.getMinimumSize(javax.swing.JComponent)

method:getMaximumSize(javax.swing.JComponent) [NONE]

getMaximumSize

public Dimension getMaximumSize?(JComponent c)

Description copied from class: ComponentUI

Returns the specified component's maximum size appropriate for the look and feel. If null 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 invokes getPreferredSize and returns that value.

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);
See Also:: ComponentUI.getMinimumSize(javax.swing.JComponent), getPreferredSize(javax.swing.JComponent)

method:createDecreaseButton(int) [NONE]

createDecreaseButton

protected JButton createDecreaseButton?(int orientation)

Creates a decrease button.

Parameters:: orientation - the orientation
Returns:: a decrease button

method:createIncreaseButton(int) [NONE]

createIncreaseButton

protected JButton createIncreaseButton?(int orientation)

Creates an increase button.

Parameters:: orientation - the orientation
Returns:: an increase button

method:paintDecreaseHighlight(java.awt.Graphics) [NONE]

paintDecreaseHighlight

protected void paintDecreaseHighlight?(Graphics g)

Paints the decrease highlight.

Parameters:: g - the graphics

method:paintIncreaseHighlight(java.awt.Graphics) [NONE]

paintIncreaseHighlight

protected void paintIncreaseHighlight?(Graphics g)

Paints the increase highlight.

Parameters:: g - the graphics

method:paintTrack(java.awt.Graphics,javax.swing.JComponent,java.awt.Rectangle) [NONE]

paintTrack

protected void paintTrack?(Graphics g, JComponent c, Rectangle trackBounds)

Paints the track.

Parameters:: g - the graphics; c - the component; trackBounds - the track bounds

method:paintThumb(java.awt.Graphics,javax.swing.JComponent,java.awt.Rectangle) [NONE]

paintThumb

protected void paintThumb?(Graphics g, JComponent c, Rectangle thumbBounds)

Paints the thumb.

Parameters:: g - the graphics; c - the component; thumbBounds - the thumb bounds

method:getMinimumThumbSize() [NONE]

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

method:getMaximumThumbSize() [NONE]

getMaximumThumbSize

protected Dimension getMaximumThumbSize()

Returns 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.
See Also:: getMinimumThumbSize()

method:addLayoutComponent(java.lang.String,java.awt.Component) [NONE]

addLayoutComponent

public void addLayoutComponent?(String name, Component child)

Description copied from interface: LayoutManager

If the layout manager uses a per-component string, adds the component comp to the layout, associating it with the string specified by name.

Specified by:: addLayoutComponent in interface LayoutManager
Parameters:: name - the string to be associated with the component; child - the component to be added

method:removeLayoutComponent(java.awt.Component) [NONE]

removeLayoutComponent

public void removeLayoutComponent?(Component child)

Description copied from interface: LayoutManager

Removes the specified component from the layout.

Specified by:: removeLayoutComponent in interface LayoutManager
Parameters:: child - the component to be removed

method:preferredLayoutSize(java.awt.Container) [NONE]

preferredLayoutSize

public Dimension preferredLayoutSize?(Container scrollbarContainer)

Description copied from interface: LayoutManager

Calculates the preferred size dimensions for the specified container, given the components it contains.

Specified by:: preferredLayoutSize in interface LayoutManager
Parameters:: scrollbarContainer - the container to be laid out
Returns:: the preferred dimension for the container
See Also:: LayoutManager.minimumLayoutSize(java.awt.Container)

method:minimumLayoutSize(java.awt.Container) [NONE]

minimumLayoutSize

public Dimension minimumLayoutSize?(Container scrollbarContainer)

Description copied from interface: LayoutManager

Calculates the minimum size dimensions for the specified container, given the components it contains.

Specified by:: minimumLayoutSize in interface LayoutManager
Parameters:: scrollbarContainer - the component to be laid out
Returns:: the minimum dimension for the container
See Also:: LayoutManager.preferredLayoutSize(java.awt.Container)

method:layoutVScrollbar(javax.swing.JScrollBar) [NONE]

layoutVScrollbar

protected void layoutVScrollbar?(JScrollBar sb)

Laysouts a vertical scroll bar.

Parameters:: sb - the scroll bar

method:layoutHScrollbar(javax.swing.JScrollBar) [NONE]

layoutHScrollbar

protected void layoutHScrollbar?(JScrollBar sb)

Laysouts a vertical scroll bar.

Parameters:: sb - the scroll bar

method:layoutContainer(java.awt.Container) [NONE]

layoutContainer

public void layoutContainer?(Container scrollbarContainer)

Description copied from interface: LayoutManager

Lays out the specified container.

Specified by:: layoutContainer in interface LayoutManager
Parameters:: scrollbarContainer - the container to be laid out

method:setThumbBounds(int,int,int,int) [NONE]

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 thumb; y - set the y location of the thumb; width - set the width of the thumb; height - set the height of the thumb
See Also:: getThumbBounds()

method:getThumbBounds() [NONE]

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)

method:getTrackBounds() [NONE]

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:: layoutContainer(java.awt.Container)

method:scrollByBlock(int) [NONE]

scrollByBlock

protected void scrollByBlock?(int direction)

Scrolls by block.

Parameters:: direction - the direction to scroll

method:scrollByUnit(int) [NONE]

scrollByUnit

protected void scrollByUnit?(int direction)

Scrolls by unit.

Parameters:: direction - the direction to scroll

method:getSupportsAbsolutePositioning() [NONE]

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