com.alee.laf.scroll
Class WebScrollBar

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JScrollBar
                  com.alee.laf.scroll.WebScrollBar

All Implemented Interfaces:

Styleable, SizeMethods<WebScrollBar>, SwingMethods, java.awt.Adjustable, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

public class WebScrollBar
extends javax.swing.JScrollBar
implements Styleable, SizeMethods<WebScrollBar>

This JScrollBar extension class provides a direct access to WebScrollBarUI methods.

Author:

Mikle Garin

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JScrollBar

javax.swing.JScrollBar.AccessibleJScrollBar

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields inherited from class javax.swing.JScrollBar

blockIncrement, model, orientation, unitIncrement

Fields inherited from class javax.swing.JComponent

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.Adjustable

HORIZONTAL, NO_ORIENTATION, VERTICAL

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

WebScrollBar()
Constructs new scroll bar.

WebScrollBar(int orientation)
Constructs new scroll bar with the specified orientation.

WebScrollBar(int orientation, int value, int extent, int min, int max)
Constructs new scroll bar with the specified orientation and values.

Method Summary

Painter	getDecreaseButtonPainter() Returns decrease button painter.
Painter	getIncreaseButtonPainter() Returns increase button painter.
java.awt.Insets	getMargin() Returns scroll bar content margin.
int	getMinimumHeight() Returns component minimum height.
int	getMinimumWidth() Returns component minimum width.
Painter	getPainter() Returns scroll bar painter.
int	getPreferredHeight() Returns component preferred height.
java.awt.Dimension	getPreferredSize() Returns component preferred size.
int	getPreferredWidth() Returns component preferred width.
java.lang.String	getStyleId() Returns component style ID.
WebScrollBarUI	getWebUI() Returns Web-UI applied to this class.
boolean	isPaintButtons() Returns whether scroll bar arrow buttons should be displayed or not.
boolean	isPaintTrack() Returns whether scroll bar track should be displayed or not.
WebScrollBar	setDecreaseButtonPainter(Painter painter) Sets decrease button painter.
WebScrollBar	setIncreaseButtonPainter(Painter painter) Sets increase button painter.
WebScrollBar	setMargin(java.awt.Insets margin) Sets scroll bar content margin.
WebScrollBar	setMargin(int spacing) Sets scroll bar content margin.
WebScrollBar	setMargin(int top, int left, int bottom, int right) Sets scroll bar content margin.
WebScrollBar	setMinimumHeight(int minimumHeight) Sets component minimum height.
WebScrollBar	setMinimumWidth(int minimumWidth) Sets component minimum width.
WebScrollBar	setPaintButtons(boolean paintButtons) Sets whether scroll bar arrow buttons should be displayed or not.
WebScrollBar	setPainter(Painter painter) Sets scroll bar painter.
WebScrollBar	setPaintTrack(boolean paintTrack) Sets whether scroll bar track should be displayed or not.
WebScrollBar	setPreferredHeight(int preferredHeight) Sets component preferred height.
WebScrollBar	setPreferredWidth(int preferredWidth) Sets component preferred width.
void	setStyleId(java.lang.String id) Sets custom component style ID.
void	updateUI() Installs a Web-UI into this component.

Methods inherited from class javax.swing.JScrollBar

addAdjustmentListener, fireAdjustmentValueChanged, getAccessibleContext, getAdjustmentListeners, getBlockIncrement, getBlockIncrement, getMaximum, getMaximumSize, getMinimum, getMinimumSize, getModel, getOrientation, getUI, getUIClassID, getUnitIncrement, getUnitIncrement, getValue, getValueIsAdjusting, getVisibleAmount, paramString, removeAdjustmentListener, setBlockIncrement, setEnabled, setMaximum, setMinimum, setModel, setOrientation, setUI, setUnitIncrement, setValue, setValueIsAdjusting, setValues, setVisibleAmount

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getNextFocusableComponent, getPopupLocation, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Detail

WebScrollBar

public WebScrollBar()

Constructs new scroll bar.

WebScrollBar

public WebScrollBar(int orientation)

Constructs new scroll bar with the specified orientation.

Parameters:

orientation - scroll bar orientation

WebScrollBar

public WebScrollBar(int orientation,
                    int value,
                    int extent,
                    int min,
                    int max)

Constructs new scroll bar with the specified orientation and values.

Parameters:

orientation - scroll bar orientation

value - scroll bar value

extent - scroll bar extent

min - scroll bar minimum value

max - scroll bar maximum value

Method Detail

isPaintButtons

public boolean isPaintButtons()

Returns whether scroll bar arrow buttons should be displayed or not.

Returns:

true if scroll bar arrow buttons should be displayed, false otherwise

setPaintButtons

public WebScrollBar setPaintButtons(boolean paintButtons)

Sets whether scroll bar arrow buttons should be displayed or not.

Parameters:

paintButtons - whether scroll bar arrow buttons should be displayed or not

Returns:

scroll bar

isPaintTrack

public boolean isPaintTrack()

Returns whether scroll bar track should be displayed or not.

Returns:

true if scroll bar track should be displayed, false otherwise

setPaintTrack

public WebScrollBar setPaintTrack(boolean paintTrack)

Sets whether scroll bar track should be displayed or not.

Parameters:

paintTrack - whether scroll bar track should be displayed or not

Returns:

scroll bar

getMargin

public java.awt.Insets getMargin()

Returns scroll bar content margin.

Returns:

scroll bar content margin

setMargin

public WebScrollBar setMargin(java.awt.Insets margin)

Sets scroll bar content margin.

Parameters:

margin - new scroll bar content margin

Returns:

scroll bar

setMargin

public WebScrollBar setMargin(int top,
                              int left,
                              int bottom,
                              int right)

Sets scroll bar content margin.

Parameters:

top - new scroll bar content top margin

left - new scroll bar content left margin

bottom - new scroll bar content bottom margin

right - new scroll bar content right margin

Returns:

scroll bar

setMargin

public WebScrollBar setMargin(int spacing)

Sets scroll bar content margin.

Parameters:

spacing - new scroll bar content margin

Returns:

scroll bar

getPainter

public Painter getPainter()

Returns scroll bar painter.

Returns:

scroll bar painter

setPainter

public WebScrollBar setPainter(Painter painter)

Sets scroll bar painter. Pass null to remove scroll bar painter.

Parameters:

painter - new scroll bar painter

Returns:

scroll bar

getDecreaseButtonPainter

public Painter getDecreaseButtonPainter()

Returns decrease button painter. This the button displayed at top or left side of the scroll bar.

Returns:

decrease button painter

setDecreaseButtonPainter

public WebScrollBar setDecreaseButtonPainter(Painter painter)

Sets decrease button painter. This the button displayed at top or left side of the scroll bar.

Parameters:

painter - new decrease button painter

Returns:

scroll bar

getIncreaseButtonPainter

public Painter getIncreaseButtonPainter()

Returns increase button painter. This the button displayed at bottom or right side of the scroll bar.

Returns:

increase button painter

setIncreaseButtonPainter

public WebScrollBar setIncreaseButtonPainter(Painter painter)

Sets increase button painter. This the button displayed at bottom or right side of the scroll bar.

Parameters:

painter - new increase button painter

Returns:

scroll bar

getStyleId

public java.lang.String getStyleId()

Returns component style ID. Custom ID can be specified to override default component style using "setStyleId" method. If style for such custom ID is not found in skin descriptor then default style for that component is used.

Specified by:

getStyleId in interface Styleable

Returns:

component style ID

setStyleId

public void setStyleId(java.lang.String id)

Sets custom component style ID. If style for such custom ID is not found in skin descriptor default style will be used for that component. This method forces component to instantly use component style with the specified ID.

Specified by:

setStyleId in interface Styleable

Parameters:

id - custom component style ID

getWebUI

public WebScrollBarUI getWebUI()

Returns Web-UI applied to this class.

Returns:

Web-UI applied to this class

updateUI

public void updateUI()

Installs a Web-UI into this component.

Overrides:

updateUI in class javax.swing.JScrollBar

getPreferredWidth

public int getPreferredWidth()

Returns component preferred width.

Specified by:

getPreferredWidth in interface SizeMethods<WebScrollBar>

Returns:

component preferred width

setPreferredWidth

public WebScrollBar setPreferredWidth(int preferredWidth)

Sets component preferred width. Pass -1 to let component choose preferred width on its own.

Specified by:

setPreferredWidth in interface SizeMethods<WebScrollBar>

Parameters:

preferredWidth - new component preferred width

Returns:

modified component

getPreferredHeight

public int getPreferredHeight()

Returns component preferred height.

Specified by:

getPreferredHeight in interface SizeMethods<WebScrollBar>

Returns:

component preferred height

setPreferredHeight

public WebScrollBar setPreferredHeight(int preferredHeight)

Sets component preferred height. Pass -1 to let component choose preferred height on its own.

Specified by:

setPreferredHeight in interface SizeMethods<WebScrollBar>

Parameters:

preferredHeight - new component preferred height

Returns:

modified component

getMinimumWidth

public int getMinimumWidth()

Returns component minimum width.

Specified by:

getMinimumWidth in interface SizeMethods<WebScrollBar>

Returns:

component minimum width

setMinimumWidth

public WebScrollBar setMinimumWidth(int minimumWidth)

Sets component minimum width. Pass -1 to let component choose minimum width on its own.

Specified by:

setMinimumWidth in interface SizeMethods<WebScrollBar>

Parameters:

minimumWidth - new component minimum width

Returns:

modified component

getMinimumHeight

public int getMinimumHeight()

Returns component minimum height.

Specified by:

getMinimumHeight in interface SizeMethods<WebScrollBar>

Returns:

component minimum height

setMinimumHeight

public WebScrollBar setMinimumHeight(int minimumHeight)

Sets component minimum height. Pass -1 to let component choose minimum height on its own.

Specified by:

setMinimumHeight in interface SizeMethods<WebScrollBar>

Parameters:

minimumHeight - new component minimum height

Returns:

modified component

getPreferredSize

public java.awt.Dimension getPreferredSize()

Returns component preferred size.

Specified by:

getPreferredSize in interface SizeMethods<WebScrollBar>

Overrides:

getPreferredSize in class javax.swing.JComponent

Returns:

component preferred size