com.alee.laf.scroll

Class ScrollBarPainter<E extends javax.swing.JScrollBar,U extends WebScrollBarUI>

java.lang.Object

com.alee.painter.AbstractPainter<E,U>

com.alee.laf.scroll.ScrollBarPainter<E,U>

Type Parameters:

E - component type

U - component UI type

All Implemented Interfaces:

IScrollBarPainter<E,U>, Painter<E,U>, SpecificPainter<E,U>, BorderMethods, com.alee.utils.swing.SwingMethods

Direct Known Subclasses:

NPScrollBarPainter

public class ScrollBarPainter<E extends javax.swing.JScrollBar,U extends WebScrollBarUI>
extends AbstractPainter<E,U>
implements IScrollBarPainter<E,U>

Basic painter for JScrollBar component. It is used as WebScrollBarUI default painter.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	animated Runtime variables.
protected boolean	dragged
protected java.awt.event.MouseAdapter	mouseAdapter Listeners.
protected boolean	pressed
protected boolean	rollover
protected com.alee.utils.swing.WebTimer	rolloverAnimator
protected float	rolloverState
protected java.lang.Integer	scrollBarWidth
protected java.awt.Color	thumbBackgroundColor
protected java.awt.Color	thumbBorderColor
protected java.awt.Rectangle	thumbBounds
protected java.awt.Color	thumbDisabledBackgroundColor
protected java.awt.Color	thumbDisabledBorderColor
protected java.awt.Insets	thumbMargin
protected java.awt.Insets	thumbMarginHL
protected java.awt.Insets	thumbMarginHR
protected java.awt.Insets	thumbMarginR
protected java.awt.Color	thumbPressedBackgroundColor
protected java.awt.Color	thumbPressedBorderColor
protected java.awt.Color	thumbRolloverBackgroundColor
protected java.awt.Color	thumbRolloverBorderColor
protected java.lang.Integer	thumbRound Style settings.
protected java.awt.Color	trackBackgroundColor
protected java.awt.Color	trackBorderColor
protected java.awt.Rectangle	trackBounds Painting variables.

Fields inherited from class com.alee.painter.AbstractPainter

component, listeners, ltr, propertyChangeListener, ui

Constructor Summary

Constructors

Constructor and Description
ScrollBarPainter()

Method Summary

Modifier and Type	Method and Description
java.awt.Insets	getBorders() Returns borders required for visual data provided by this painter.
protected java.awt.Color	getCurrentThumbBackgroundColor(E scrollbar) Returns current thumb background color.
protected java.awt.Color	getCurrentThumbBorderColor(E scrollbar) Returns current thumb border color.
protected java.awt.Insets	getCurrentThumbMargin(E scrollbar) Returns current thumb margin rotated into proper position.
java.awt.Dimension	getPreferredSize() Returns preferred size required for proper painting of visual data provided by this painter.
void	install(E c, U ui) Called when painter is installed onto some component.
java.lang.Boolean	isOpaque() Returns whether visual data provided by this painter is opaque or not.
boolean	isPressed() Returns whether scroll bar thumb is pressed or not.
boolean	isRollover() Returns whether scroll bar thumb is in rollover state or not.
void	paint(java.awt.Graphics2D g2d, java.awt.Rectangle bounds, E scrollbar, U ui) Paints visual data using component graphics context.
protected void	paintBackground(java.awt.Graphics2D g2d, E scrollbar, java.awt.Rectangle bounds) Paints scroll bar background.
protected void	paintThumb(java.awt.Graphics2D g2d, E scrollbar, java.awt.Rectangle bounds) Paints scroll bar thumb.
protected void	paintTrack(java.awt.Graphics2D g2d, E scrollbar, java.awt.Rectangle bounds) Paints scroll bar track.
void	repaintThumb() Forces scroll bar thumb to be repainted.
void	setDragged(boolean dragged) Sets whether scroll bar thumb is being dragged or not.
void	setPressed(boolean pressed) Sets whether scroll bar thumb is pressed or not.
void	setRollover(boolean rollover) Sets whether scroll bar thumb is in rollover state or not.
void	setThumbBounds(java.awt.Rectangle bounds) Sets scroll bar thumb bounds.
void	setTrackBounds(java.awt.Rectangle bounds) Sets scroll bar track bounds.
void	uninstall(E c, U ui) Called when painter is installed into some component.
protected void	updateThumbMargins() Updates thumb margins cache.

Methods inherited from class com.alee.painter.AbstractPainter

addPainterListener, b, borderChange, getCompleteBorder, i, i, i, installPropertyChangeListener, isSectionPainter, isSettingsUpdateAllowed, orientationChange, p, propertyChange, removePainterListener, repaint, repaint, repaint, revalidate, saveOrientation, uninstallPropertyChangeListener, updateAll, updateBorder, updateOpacity, updateOrientation

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.alee.painter.Painter

addPainterListener, removePainterListener

Field Detail

thumbRound

protected java.lang.Integer thumbRound

Style settings.

thumbMargin

protected java.awt.Insets thumbMargin

scrollBarWidth

protected java.lang.Integer scrollBarWidth

trackBorderColor

protected java.awt.Color trackBorderColor

trackBackgroundColor

protected java.awt.Color trackBackgroundColor

thumbBorderColor

protected java.awt.Color thumbBorderColor

thumbBackgroundColor

protected java.awt.Color thumbBackgroundColor

thumbDisabledBorderColor

protected java.awt.Color thumbDisabledBorderColor

thumbDisabledBackgroundColor

protected java.awt.Color thumbDisabledBackgroundColor

thumbRolloverBorderColor

protected java.awt.Color thumbRolloverBorderColor

thumbRolloverBackgroundColor

protected java.awt.Color thumbRolloverBackgroundColor

thumbPressedBorderColor

protected java.awt.Color thumbPressedBorderColor

thumbPressedBackgroundColor

protected java.awt.Color thumbPressedBackgroundColor

mouseAdapter

protected java.awt.event.MouseAdapter mouseAdapter

Listeners.

animated

protected boolean animated

Runtime variables.

rolloverAnimator

protected com.alee.utils.swing.WebTimer rolloverAnimator

rolloverState

protected float rolloverState

rollover

protected boolean rollover

pressed

protected boolean pressed

dragged

protected boolean dragged

trackBounds

protected java.awt.Rectangle trackBounds

Painting variables.

thumbBounds

protected java.awt.Rectangle thumbBounds

thumbMarginR

protected java.awt.Insets thumbMarginR

thumbMarginHL

protected java.awt.Insets thumbMarginHL

thumbMarginHR

protected java.awt.Insets thumbMarginHR

Constructor Detail

ScrollBarPainter

public ScrollBarPainter()

Method Detail

install

public void install(E c,
                    U ui)

Description copied from interface: Painter

Called when painter is installed onto some component. You might want to use this method to add custom component listeners or modify component settings.

Specified by:

install in interface Painter<E extends javax.swing.JScrollBar,U extends WebScrollBarUI>

Overrides:

install in class AbstractPainter<E extends javax.swing.JScrollBar,U extends WebScrollBarUI>

Parameters:

c - component this painter is being installed onto

ui - component UI

uninstall

public void uninstall(E c,
                      U ui)

Description copied from interface: Painter

Called when painter is installed into some component. You might want to use this method to add custom component listeners or modify component settings.

Specified by:

uninstall in interface Painter<E extends javax.swing.JScrollBar,U extends WebScrollBarUI>

Overrides:

uninstall in class AbstractPainter<E extends javax.swing.JScrollBar,U extends WebScrollBarUI>

Parameters:

c - component this painter is being uninstalled from

ui - component UI

isRollover

public boolean isRollover()

Returns whether scroll bar thumb is in rollover state or not.

Returns:

true if scroll bar thumb is in rollover state, false otherwise

setRollover

public void setRollover(boolean rollover)

Sets whether scroll bar thumb is in rollover state or not.

Parameters:

rollover - whether scroll bar thumb is in rollover state or not

isPressed

public boolean isPressed()

Returns whether scroll bar thumb is pressed or not.

Returns:

true if scroll bar thumb is pressed, false otherwise

setPressed

public void setPressed(boolean pressed)

Sets whether scroll bar thumb is pressed or not.

Parameters:

pressed - whether scroll bar thumb is pressed or not

setDragged

public void setDragged(boolean dragged)

Description copied from interface: IScrollBarPainter

Sets whether scroll bar thumb is being dragged or not. This value is updated by WebScrollBarUI when drag event starts or ends.

Specified by:

setDragged in interface IScrollBarPainter<E extends javax.swing.JScrollBar,U extends WebScrollBarUI>

Parameters:

dragged - whether scroll bar thumb is being dragged or not

setTrackBounds

public void setTrackBounds(java.awt.Rectangle bounds)

Description copied from interface: IScrollBarPainter

Sets scroll bar track bounds. This value is updated by WebScrollBarUI on each paint call to ensure that proper bounds presented.

Specified by:

setTrackBounds in interface IScrollBarPainter<E extends javax.swing.JScrollBar,U extends WebScrollBarUI>

Parameters:

bounds - new scroll bar track bounds

setThumbBounds

public void setThumbBounds(java.awt.Rectangle bounds)

Description copied from interface: IScrollBarPainter

Sets scroll bar thumb bounds. This value is updated by WebScrollBarUI on each paint call to ensure that proper bounds presented.

Specified by:

setThumbBounds in interface IScrollBarPainter<E extends javax.swing.JScrollBar,U extends WebScrollBarUI>

Parameters:

bounds - new scroll bar thumb bounds

isOpaque

public java.lang.Boolean isOpaque()

Description copied from interface: Painter

Returns whether visual data provided by this painter is opaque or not. Returned value might affect component opacity depending on painter support inside that component UI. Simply return null if you don't want to change default component opacity.

Specified by:

isOpaque in interface Painter<E extends javax.swing.JScrollBar,U extends WebScrollBarUI>

Overrides:

isOpaque in class AbstractPainter<E extends javax.swing.JScrollBar,U extends WebScrollBarUI>

Returns:

true if visual data provided by this painter is opaque, false otherwise

getBorders

public java.awt.Insets getBorders()

Description copied from interface: Painter

Returns borders required for visual data provided by this painter. These borders should not include possible component margin and padding, only borders provided by painter. These borders are added to component's margin and padding when the final component border is calculated. These borders should not take component orientation into account, painter will take care of it later.

You may pass null in case additional borders aren't needed for this painter.

Specified by:

getBorders in interface Painter<E extends javax.swing.JScrollBar,U extends WebScrollBarUI>

Overrides:

getBorders in class AbstractPainter<E extends javax.swing.JScrollBar,U extends WebScrollBarUI>

Returns:

borders required for visual data provided by this painter or null in case those aren't needed

paint

public void paint(java.awt.Graphics2D g2d,
                  java.awt.Rectangle bounds,
                  E scrollbar,
                  U ui)

Description copied from interface: Painter

Paints visual data using component graphics context. Provided graphics context and component are taken directly from component UI paint method.

It is highly recommended to honor provided painting bounds to avoid painting issues. These bounds might be representing full component size or contain just a small portion of the component.

Specified by:

paint in interface Painter<E extends javax.swing.JScrollBar,U extends WebScrollBarUI>

Parameters:

g2d - graphics context

bounds - painting bounds

scrollbar - painted component

ui - painted component UI

paintBackground

protected void paintBackground(java.awt.Graphics2D g2d,
                               E scrollbar,
                               java.awt.Rectangle bounds)

Paints scroll bar background. Background area includes the space under arrow buttons.

Parameters:

g2d - graphics context

scrollbar - scroll bar

bounds - scroll bar bounds

paintTrack

protected void paintTrack(java.awt.Graphics2D g2d,
                          E scrollbar,
                          java.awt.Rectangle bounds)

Paints scroll bar track. Track area only excludes the space under arrow buttons.

Parameters:

g2d - graphics context

scrollbar - scroll bar

bounds - track bounds

paintThumb

protected void paintThumb(java.awt.Graphics2D g2d,
                          E scrollbar,
                          java.awt.Rectangle bounds)

Paints scroll bar thumb. Thumb area is limited to thumb bounds and might be changed frequently.

Parameters:

g2d - graphics context

scrollbar - scroll bar component

bounds - thumb bounds

getCurrentThumbMargin

protected java.awt.Insets getCurrentThumbMargin(E scrollbar)

Returns current thumb margin rotated into proper position.

Parameters:

scrollbar - scroll bar component

Returns:

current thumb margin rotated into proper position

updateThumbMargins

protected void updateThumbMargins()

Updates thumb margins cache.

getCurrentThumbBorderColor

protected java.awt.Color getCurrentThumbBorderColor(E scrollbar)

Returns current thumb border color.

Parameters:

scrollbar - scroll bar component

Returns:

current thumb border color

getCurrentThumbBackgroundColor

protected java.awt.Color getCurrentThumbBackgroundColor(E scrollbar)

Returns current thumb background color.

Parameters:

scrollbar - scroll bar component

Returns:

current thumb background color

repaintThumb

public void repaintThumb()

Forces scroll bar thumb to be repainted.

getPreferredSize

public java.awt.Dimension getPreferredSize()

Description copied from interface: Painter

Returns preferred size required for proper painting of visual data provided by this painter. This should not take into account any sizes not related to the painter itself.

Specified by:

getPreferredSize in interface Painter<E extends javax.swing.JScrollBar,U extends WebScrollBarUI>

Overrides:

getPreferredSize in class AbstractPainter<E extends javax.swing.JScrollBar,U extends WebScrollBarUI>

Returns:

preferred size required for proper painting of visual data provided by this painter