Package com.intellij.ui.components

Class JBScrollPane

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JScrollPane

com.intellij.ui.components.JBScrollPane

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, ScrollPaneConstants

public class JBScrollPane
extends JScrollPane

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	JBScrollPane.Alignment	These client properties show a component position on a scroll pane.
static enum	JBScrollPane.Flip	These client properties modify a scroll pane layout.

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

JScrollPane.AccessibleJScrollPane, JScrollPane.ScrollBar

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

JComponent.AccessibleJComponent

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

Container.AccessibleAWTContainer

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

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field	Description
static final Key<Boolean>	BRIGHTNESS_FROM_VIEW	This key is used to specify which colors should use the scroll bars on the pane.
static final RegionPainter<Float>	MAC_THUMB_DARK_PAINTER	Deprecated.
static final RegionPainter<Float>	MAC_THUMB_PAINTER	Deprecated.
static final RegionPainter<Float>	THUMB_DARK_PAINTER	Deprecated.
static final RegionPainter<Float>	THUMB_PAINTER	Deprecated.

Fields inherited from class javax.swing.JScrollPane

columnHeader, horizontalScrollBar, horizontalScrollBarPolicy, lowerLeft, lowerRight, rowHeader, upperLeft, upperRight, verticalScrollBar, verticalScrollBarPolicy, viewport

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.image.ImageObserver

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

Fields inherited from interface javax.swing.ScrollPaneConstants

COLUMN_HEADER, HORIZONTAL_SCROLLBAR, HORIZONTAL_SCROLLBAR_ALWAYS, HORIZONTAL_SCROLLBAR_AS_NEEDED, HORIZONTAL_SCROLLBAR_NEVER, HORIZONTAL_SCROLLBAR_POLICY, LOWER_LEADING_CORNER, LOWER_LEFT_CORNER, LOWER_RIGHT_CORNER, LOWER_TRAILING_CORNER, ROW_HEADER, UPPER_LEADING_CORNER, UPPER_LEFT_CORNER, UPPER_RIGHT_CORNER, UPPER_TRAILING_CORNER, VERTICAL_SCROLLBAR, VERTICAL_SCROLLBAR_ALWAYS, VERTICAL_SCROLLBAR_AS_NEEDED, VERTICAL_SCROLLBAR_NEVER, VERTICAL_SCROLLBAR_POLICY, VIEWPORT

Constructor Summary

Constructors

Constructor	Description
JBScrollPane()
JBScrollPane(int viewportWidth)
JBScrollPane(int vsbPolicy, int hsbPolicy)
JBScrollPane(Component view)
JBScrollPane(Component view, int vsbPolicy, int hsbPolicy)

Method Summary

Modifier and Type	Method	Description
static boolean	canBePreprocessed(MouseEvent e, JScrollBar bar)
JScrollBar	createHorizontalScrollBar()
static com.intellij.ui.components.JBScrollPane.ViewportBorder	createIndentBorder()
JScrollBar	createVerticalScrollBar()
protected JViewport	createViewport()
static JScrollPane	findScrollPane(Component c)
Color	getBackground()
boolean	isOptimizedDrawingEnabled()
protected boolean	isOverlaidScrollbar(JScrollBar scrollbar)
static boolean	isScrollEvent(MouseWheelEvent event)	Indicates whether the specified event is not consumed and does not have unexpected modifiers.
void	layout()
void	setUI(ScrollPaneUI ui)
protected void	setupCorners()

Methods inherited from class javax.swing.JScrollPane

getAccessibleContext, getColumnHeader, getCorner, getHorizontalScrollBar, getHorizontalScrollBarPolicy, getRowHeader, getUI, getUIClassID, getVerticalScrollBar, getVerticalScrollBarPolicy, getViewport, getViewportBorder, getViewportBorderBounds, isValidateRoot, isWheelScrollingEnabled, paramString, setColumnHeader, setColumnHeaderView, setComponentOrientation, setCorner, setHorizontalScrollBar, setHorizontalScrollBarPolicy, setLayout, setRowHeader, setRowHeaderView, setVerticalScrollBar, setVerticalScrollBarPolicy, setViewport, setViewportBorder, setViewportView, setWheelScrollingEnabled, updateUI

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, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, 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, setEnabled, 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, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, 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, 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, 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

Field Details

BRIGHTNESS_FROM_VIEW

public static final Key<Boolean> BRIGHTNESS_FROM_VIEW

This key is used to specify which colors should use the scroll bars on the pane. If a client property is set to true the bar's brightness will be modified according to the view's background.

See Also:

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

THUMB_PAINTER

@Deprecated
public static final RegionPainter<Float> THUMB_PAINTER

Deprecated.

THUMB_DARK_PAINTER

@Deprecated
public static final RegionPainter<Float> THUMB_DARK_PAINTER

Deprecated.

MAC_THUMB_PAINTER

@Deprecated
public static final RegionPainter<Float> MAC_THUMB_PAINTER

Deprecated.

MAC_THUMB_DARK_PAINTER

@Deprecated
public static final RegionPainter<Float> MAC_THUMB_DARK_PAINTER

Deprecated.

Constructor Details

JBScrollPane

public JBScrollPane(int viewportWidth)

JBScrollPane

public JBScrollPane()

JBScrollPane

public JBScrollPane(Component view)

JBScrollPane

public JBScrollPane(int vsbPolicy,
 int hsbPolicy)

JBScrollPane

public JBScrollPane(Component view,
 int vsbPolicy,
 int hsbPolicy)

Method Details

getBackground

public Color getBackground()

Overrides:

getBackground in class Component

findScrollPane

public static JScrollPane findScrollPane(Component c)

setupCorners

protected void setupCorners()

setUI

public void setUI(ScrollPaneUI ui)

Overrides:

setUI in class JScrollPane

isOptimizedDrawingEnabled

public boolean isOptimizedDrawingEnabled()

Overrides:

isOptimizedDrawingEnabled in class JComponent

createIndentBorder

public static com.intellij.ui.components.JBScrollPane.ViewportBorder createIndentBorder()

createVerticalScrollBar

public JScrollBar createVerticalScrollBar()

Overrides:

createVerticalScrollBar in class JScrollPane

createHorizontalScrollBar

@NotNull
public JScrollBar createHorizontalScrollBar()

Overrides:

createHorizontalScrollBar in class JScrollPane

createViewport

protected JViewport createViewport()

Overrides:

createViewport in class JScrollPane

layout

public void layout()

Overrides:

layout in class Container

isOverlaidScrollbar

protected boolean isOverlaidScrollbar(@Nullable
 JScrollBar scrollbar)

canBePreprocessed

public static boolean canBePreprocessed(MouseEvent e,
 JScrollBar bar)

isScrollEvent

public static boolean isScrollEvent(@NotNull
 MouseWheelEvent event)

Indicates whether the specified event is not consumed and does not have unexpected modifiers.

Parameters:

event - a mouse wheel event to check for validity

Returns:

true if the specified event is valid, false otherwise