Package com.intellij.ui.components

Class JBScrollBar

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JScrollBar

com.intellij.ui.components.JBScrollBar

All Implemented Interfaces:

IdeGlassPane.TopComponent, Interpolable, java.awt.Adjustable, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

Direct Known Subclasses:

GlobalScrollBar, LocalInvisibleScrollBar

public class JBScrollBar
extends javax.swing.JScrollBar
implements IdeGlassPane.TopComponent, Interpolable

Our implementation of a scroll bar with the custom UI. Also it provides a method to create custom UI for our custom L&Fs.

See Also:

createUI(JComponent), 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

Modifier and Type	Field and Description
static java.lang.String	LEADING This constraint should be used to add a component that will be shown before the scrollbar's track.
static Key<RegionPainter<java.lang.Object>>	TRACK This key defines a region painter, which is used by the custom ScrollBarUI to draw additional paintings (i.e.
static java.lang.String	TRAILING This constraint should be used to add a component that will be shown after the scrollbar's track.

Fields inherited from class javax.swing.JScrollBar

blockIncrement, model, orientation, unitIncrement

Fields inherited from class javax.swing.JComponent

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

accessibleContext, 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

Constructors

Constructor and Description
JBScrollBar()
JBScrollBar(int orientation)
JBScrollBar(int orientation, int value, int extent, int min, int max)

Method Summary

Modifier and Type	Method and Description
protected void	addImpl(java.awt.Component component, java.lang.Object name, int index)
boolean	canBePreprocessed(java.awt.event.MouseEvent event) Notifies glass pane that it should not process mouse event above the scrollbar's thumb.
static javax.swing.plaf.ScrollBarUI	createUI(javax.swing.JComponent c) Returns a new instance of ScrollBarUI.
int	getBlockIncrement(int direction) Computes the block increment for scrolling if the viewport's view.
protected double	getDeltaAdjusted(java.awt.event.MouseWheelEvent event)
int	getTargetValue() Gets the target value.
int	getUnitIncrement(int direction) Computes the unit increment for scrolling if the viewport's view.
boolean	handleMouseWheelEvent(java.awt.event.MouseWheelEvent event) Handles the mouse wheel events to scroll the scrollbar.
void	setBlockIncrement(int increment)
void	setCurrentValue(int value) Sets the current value (synchronously).
void	setUnitIncrement(int increment)
void	setValue(int value) Sets the target value.
void	updateUI()

Methods inherited from class javax.swing.JScrollBar

addAdjustmentListener, fireAdjustmentValueChanged, getAccessibleContext, getAdjustmentListeners, getBlockIncrement, getMaximum, getMaximumSize, getMinimum, getMinimumSize, getModel, getOrientation, getUI, getUIClassID, getUnitIncrement, getValue, getValueIsAdjusting, getVisibleAmount, paramString, removeAdjustmentListener, setEnabled, setMaximum, setMinimum, setModel, setOrientation, setUI, 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, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, 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, 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, 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, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, 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, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.ui.components.Interpolable

getValue

Field Detail

TRACK

public static final Key<RegionPainter<java.lang.Object>> TRACK

This key defines a region painter, which is used by the custom ScrollBarUI to draw additional paintings (i.e. error stripes) on the scrollbar's track.

See Also:

UIUtil.putClientProperty(javax.swing.JComponent, com.intellij.openapi.util.Key<T>, T)

LEADING

public static final java.lang.String LEADING

This constraint should be used to add a component that will be shown before the scrollbar's track. Note that the previously added leading component will be removed.

See Also:

addImpl(Component, Object, int), Constant Field Values

TRAILING

public static final java.lang.String TRAILING

This constraint should be used to add a component that will be shown after the scrollbar's track. Note that the previously added trailing component will be removed.

See Also:

addImpl(Component, Object, int), Constant Field Values

Constructor Detail

JBScrollBar

public JBScrollBar()

JBScrollBar

public JBScrollBar(int orientation)

JBScrollBar

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

Method Detail

addImpl

protected void addImpl(java.awt.Component component,
                       java.lang.Object name,
                       int index)

Overrides:

addImpl in class java.awt.Container

updateUI

public void updateUI()

Overrides:

updateUI in class javax.swing.JScrollBar

createUI

public static javax.swing.plaf.ScrollBarUI createUI(javax.swing.JComponent c)

Returns a new instance of ScrollBarUI. Do not share it between different scroll bars.

Parameters:

c - a target component for this UI

Returns:

a new instance of ScrollBarUI

getUnitIncrement

public int getUnitIncrement(int direction)

Computes the unit increment for scrolling if the viewport's view. Otherwise returns super.getUnitIncrement.

Overrides:

getUnitIncrement in class javax.swing.JScrollBar

Parameters:

direction - less than zero to scroll up/left, greater than zero for down/right

Returns:

an integer, in pixels, containing the unit increment

See Also:

Scrollable.getScrollableUnitIncrement(java.awt.Rectangle, int, int)

setUnitIncrement

public void setUnitIncrement(int increment)

Specified by:

setUnitIncrement in interface java.awt.Adjustable

Overrides:

setUnitIncrement in class javax.swing.JScrollBar

getBlockIncrement

public int getBlockIncrement(int direction)

Computes the block increment for scrolling if the viewport's view. Otherwise returns super.getBlockIncrement.

Overrides:

getBlockIncrement in class javax.swing.JScrollBar

Parameters:

direction - less than zero to scroll up/left, greater than zero for down/right

Returns:

an integer, in pixels, containing the block increment

See Also:

Scrollable.getScrollableBlockIncrement(java.awt.Rectangle, int, int)

setBlockIncrement

public void setBlockIncrement(int increment)

Specified by:

setBlockIncrement in interface java.awt.Adjustable

Overrides:

setBlockIncrement in class javax.swing.JScrollBar

canBePreprocessed

public boolean canBePreprocessed(java.awt.event.MouseEvent event)

Notifies glass pane that it should not process mouse event above the scrollbar's thumb.

Specified by:

canBePreprocessed in interface IdeGlassPane.TopComponent

Parameters:

event - the mouse event

Returns:

true if glass pane can process the specified event, false otherwise

setValue

public void setValue(int value)

Description copied from interface: Interpolable

Sets the target value.

Technically, it's "setTargetValue", but we need to match the name in Swing classes.

Specified by:

setValue in interface Interpolable

Specified by:

setValue in interface java.awt.Adjustable

Overrides:

setValue in class javax.swing.JScrollBar

Parameters:

value - the target value

setCurrentValue

public void setCurrentValue(int value)

Description copied from interface: Interpolable

Sets the current value (synchronously).

Specified by:

setCurrentValue in interface Interpolable

Parameters:

value - the current value

getTargetValue

public int getTargetValue()

Description copied from interface: Interpolable

Gets the target value.

Specified by:

getTargetValue in interface Interpolable

Returns:

the target value.

handleMouseWheelEvent

public boolean handleMouseWheelEvent(java.awt.event.MouseWheelEvent event)

Handles the mouse wheel events to scroll the scrollbar.

Parameters:

event - the mouse wheel event

Returns:

true if the specified event is handled and consumed, false otherwise

getDeltaAdjusted

protected double getDeltaAdjusted(java.awt.event.MouseWheelEvent event)