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:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.ScrollPaneConstants

public class JBScrollPane
extends javax.swing.JScrollPane

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JBScrollPane.Alignment These client properties show a component position on a scroll pane.
static class	JBScrollPane.Flip These client properties modify a scroll pane layout.
protected static class	JBScrollPane.Layout ScrollPaneLayout implementation that supports ScrollBar flipping and non-opaque ScrollBars.

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

javax.swing.JScrollPane.AccessibleJScrollPane, javax.swing.JScrollPane.ScrollBar

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 Key<java.lang.Boolean>	BRIGHTNESS_FROM_VIEW Deprecated. unsupported approach to control a scroll bar painting
static Key<java.lang.Boolean>	IGNORE_SCROLLBAR_IN_INSETS Supposed to be used as a client property key for scrollbar and indicates if this scrollbar should be ignored when insets for JScrollPane's content are being calculated.
protected javax.swing.JComponent	statusComponent

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

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
JBScrollPane()
JBScrollPane(java.awt.Component view)
JBScrollPane(java.awt.Component view, int vsbPolicy, int hsbPolicy)
JBScrollPane(int viewportWidth)
JBScrollPane(int vsbPolicy, int hsbPolicy)

Method Summary

Modifier and Type	Method and Description
static boolean	canBePreprocessed(java.awt.event.MouseEvent e, javax.swing.JScrollBar bar)
javax.swing.JScrollBar	createHorizontalScrollBar()
static com.intellij.ui.components.JBScrollPane.ViewportBorder	createIndentBorder()
javax.swing.JScrollBar	createVerticalScrollBar()
protected javax.swing.JViewport	createViewport()
static javax.swing.JScrollPane	findScrollPane(java.awt.Component c)
java.awt.Color	getBackground()
javax.swing.JComponent	getStatusComponent()
static RegionPainter<java.lang.Float>	getThumbPainter(java.util.function.Supplier<? extends java.awt.Component> supplier)
boolean	isOptimizedDrawingEnabled()
protected boolean	isOverlaidScrollbar(javax.swing.JScrollBar scrollbar) Deprecated. unsupported old implementation
static boolean	isScrollEvent(java.awt.event.MouseWheelEvent event) Indicates whether the specified event is not consumed and does not have unexpected modifiers.
protected void	processMouseWheelEvent(java.awt.event.MouseWheelEvent e)
void	setStatusComponent(javax.swing.JComponent statusComponent) Adds status component which's anchored to the top right corner above the right scrollbar.
void	setUI(javax.swing.plaf.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, layout, 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, 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 Detail

BRIGHTNESS_FROM_VIEW

@Deprecated
public static final Key<java.lang.Boolean> BRIGHTNESS_FROM_VIEW

Deprecated. unsupported approach to control a scroll bar painting

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(JComponent, Key, Object), UIUtil.isUnderDarcula()

IGNORE_SCROLLBAR_IN_INSETS

public static final Key<java.lang.Boolean> IGNORE_SCROLLBAR_IN_INSETS

Supposed to be used as a client property key for scrollbar and indicates if this scrollbar should be ignored when insets for JScrollPane's content are being calculated.

Without this key scrollbar's width is included to content insets when content is JList. As a result list items cannot intersect with scrollbar

Please use as a marker for scrollbars, that should be transparent and shown over content

See Also:

UIUtil.putClientProperty(JComponent, Key, Object)

statusComponent

protected javax.swing.JComponent statusComponent

Constructor Detail

JBScrollPane

public JBScrollPane(int viewportWidth)

JBScrollPane

public JBScrollPane()

JBScrollPane

public JBScrollPane(java.awt.Component view)

JBScrollPane

public JBScrollPane(int vsbPolicy,
                    int hsbPolicy)

JBScrollPane

public JBScrollPane(java.awt.Component view,
                    int vsbPolicy,
                    int hsbPolicy)

Method Detail

getBackground

public java.awt.Color getBackground()

Overrides:

getBackground in class java.awt.Component

findScrollPane

public static javax.swing.JScrollPane findScrollPane(java.awt.Component c)

setupCorners

protected void setupCorners()

setUI

public void setUI(javax.swing.plaf.ScrollPaneUI ui)

Overrides:

setUI in class javax.swing.JScrollPane

setStatusComponent

public void setStatusComponent(javax.swing.JComponent statusComponent)

Adds status component which's anchored to the top right corner above the right scrollbar. This component obeys the Flip

Parameters:

statusComponent -

getStatusComponent

public javax.swing.JComponent getStatusComponent()

isOptimizedDrawingEnabled

public boolean isOptimizedDrawingEnabled()

Overrides:

isOptimizedDrawingEnabled in class javax.swing.JComponent

createIndentBorder

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

createVerticalScrollBar

public javax.swing.JScrollBar createVerticalScrollBar()

Overrides:

createVerticalScrollBar in class javax.swing.JScrollPane

createHorizontalScrollBar

public javax.swing.JScrollBar createHorizontalScrollBar()

Overrides:

createHorizontalScrollBar in class javax.swing.JScrollPane

createViewport

protected javax.swing.JViewport createViewport()

Overrides:

createViewport in class javax.swing.JScrollPane

isOverlaidScrollbar

@Deprecated
protected boolean isOverlaidScrollbar(javax.swing.JScrollBar scrollbar)

Deprecated. unsupported old implementation

canBePreprocessed

public static boolean canBePreprocessed(java.awt.event.MouseEvent e,
                                        javax.swing.JScrollBar bar)

processMouseWheelEvent

protected void processMouseWheelEvent(java.awt.event.MouseWheelEvent e)

Overrides:

processMouseWheelEvent in class java.awt.Component

isScrollEvent

public static boolean isScrollEvent(java.awt.event.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

getThumbPainter

public static RegionPainter<java.lang.Float> getThumbPainter(java.util.function.Supplier<? extends java.awt.Component> supplier)