Класс JScrollPane

java.lang.Object
- java.awt.Component
- - java.awt.Container
  - - javax.swing.JComponent
    - - javax.swing.JScrollPane

Все реализованные интерфейсы:: ImageObserver, MenuContainer, Serializable, Accessible, ScrollPaneConstants

public class JScrollPane
extends JComponent
implements ScrollPaneConstants, Accessible

Обеспечивает прокручиваемый вид лёгкого компонента. JScrollPane управляет областью просмотра, необязательными вертикальной и горизонтальной полосами прокрутки, а также необязательными областями заголовков строк и столбцов. Вы можете найти документацию, ориентированную на задачи, по JScrollPane в Как использовать области прокрутки, разделе учебника The Java Tutorial. Обратите внимание, что JScrollPane не поддерживает тяжёлые компоненты.

The following text describes this image.

JViewport предоставляет окно, или "область просмотра", к источнику данных — например, текстовому файлу. Этот источник данных является "прокручиваемым клиентом" (также известным как модель данных), отображаемым в JViewport просмотром. JScrollPane в основном состоит из JScrollBarов, JViewport, и соединения между ними, как показано на диаграмме справа.

Помимо полос прокрутки и области просмотра, JScrollPane может иметь заголовок столбца и заголовок строки. Каждый из них является объектом JViewport, который вы указываете с помощью setRowHeaderView, и setColumnHeaderView. Область просмотра заголовка столбца автоматически прокручивается влево и вправо, отслеживая горизонтальную прокрутку основной области просмотра. (Однако она никогда не прокручивается вертикально.) Заголовок строки действует аналогичным образом.

В точке пересечения двух полос прокрутки, заголовок строки и заголовок столбца, или полоса прокрутки и заголовок, оба компонента обрезаются до угла, оставляя прямоугольное пространство, которое по умолчанию пустое. Эти пространства могут потенциально существовать в любом из четырёх углов. На предыдущей диаграмме присутствует и выделяется пространство в правом верхнем углу под названием "компонент угла".

Любое количество этих пустых пространств может быть заменено с помощью метода setCorner, чтобы добавить компонент в определённый угол. (Примечание: один и тот же компонент не может быть добавлен в несколько углов.) Это полезно, если нужно добавить дополнительную декорацию или функцию к области прокрутки. Размер каждого компонента угла полностью определяется размером заголовков и/или полос прокрутки, окружающих его.

Компонент угла будет отображаться только в том случае, если в этом углу есть пустое пространство для его существования. Например, рассмотрите компонент, установленный в верхнем правом углу области прокрутки со заголовком столбца. Если вертикальная полоса прокрутки области прокрутки отсутствует, возможно, потому что компонент просмотра не достаточно большой, чтобы потребовать её, то компонент угла не будет отображаться (так как в этом углу нет пустого пространства, созданного пересечением заголовка и вертикальной полосы прокрутки). Принудительное отображение полосы прокрутки всегда, используя setVerticalScrollBarPolicy(VERTICAL_SCROLLBAR_ALWAYS), гарантирует, что пространство для компонента угла всегда существует.

Чтобы добавить границу вокруг основной области просмотра, вы можете использовать setViewportBorder. (Конечно, вы также можете добавить границу вокруг всей области прокрутки, используя setBorder.)

Частой операцией является установка цвета фона, который будет использоваться, если основной просматриваемый компонент меньше области просмотра или не непрозрачный. Это можно сделать, установив цвет фона области просмотра с помощью scrollPane.getViewport().setBackground(). Причина установки цвета области просмотра, а не всей области прокрутки, заключается в том, что по умолчанию JViewport непрозрачен, что, среди прочего, означает, что он полностью заполняет свой фон своим цветом фона. Поэтому, когда JScrollPane рисует свой фон, область просмотра обычно рисуется поверх него.

По умолчанию JScrollPane использует ScrollPaneLayout для обработки макета своих дочерних компонентов. ScrollPaneLayout определяет размер области просмотра одним из двух способов:

Если просматриваемый компонент реализует Scrollable, используется комбинация getPreferredScrollableViewportSize, getScrollableTracksViewportWidth и getScrollableTracksViewportHeight, в противном случае
используется getPreferredSize.

Предупреждение: Swing не потокобезопасен. Для получения дополнительной информации см. Политику потоков Swing.

Предупреждение: Сериализованные объекты этого класса не будут совместимы с будущими версиями Swing. Текущая поддержка сериализации подходит для краткосрочного хранения или RMI между приложениями, использующими одну и ту же версию Swing. Начиная с версии 1.4, поддержка долгосрочного хранения всех JavaBeans™ была добавлена в пакет java.beans. Пожалуйста, см. XMLEncoder.

См. также:: JScrollBar, JViewport, ScrollPaneLayout, Scrollable, Component.getPreferredSize(), setViewportView(java.awt.Component), setRowHeaderView(java.awt.Component), setColumnHeaderView(java.awt.Component), setCorner(java.lang.String, java.awt.Component), setViewportBorder(javax.swing.border.Border)

Вложенные классы

Модификатор и тип	Класс и описание
`protected class`	`JScrollPane.AccessibleJScrollPane` Этот класс реализует поддержку доступности для класса `JScrollPane`.
`protected class`	`JScrollPane.ScrollBar` По умолчанию `JScrollPane` создаёт полосы прокрутки, являющиеся экземплярами этого класса.

Вложенные классы/интерфейсы, унаследованные от класса javax.swing.JComponent

JComponent.AccessibleJComponent

Вложенные классы/интерфейсы, унаследованные от класса java.awt.Container

Container.AccessibleAWTContainer

Вложенные классы/интерфейсы, унаследованные от класса java.awt.Component

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

Поля

Модификатор и тип	Поле и описание
`protected JViewport`	`columnHeader` Дочерний компонент заголовка столбца.
`protected JScrollBar`	`horizontalScrollBar` Горизонтальная полоса прокрутки в качестве дочернего элемента.
`protected int`	`horizontalScrollBarPolicy` Политика отображения горизонтальной полосы прокрутки.
`protected Component`	`lowerLeft` Компонент для отображения в нижнем левом углу.
`protected Component`	`lowerRight` Компонент для отображения в нижнем правом углу.
`protected JViewport`	`rowHeader` Дочерний компонент заголовка строки.
`protected Component`	`upperLeft` Компонент для отображения в верхнем левом углу.
`protected Component`	`upperRight` Компонент для отображения в верхнем правом углу.
`protected JScrollBar`	`verticalScrollBar` Вертикальная полоса прокрутки в качестве дочернего элемента.
`protected int`	`verticalScrollBarPolicy` Политика отображения вертикальной полосы прокрутки.
`protected JViewport`	`viewport` Компонент области просмотра в качестве дочернего элемента.

Поля, унаследованные от класса javax.swing.JComponent

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

Поля, унаследованные от класса java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Поля, унаследованные от интерфейса 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

Поля, унаследованные от интерфейса java.awt.image.ImageObserver

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

Конструкторы

Конструктор и описание
`JScrollPane()` Создаёт пустую (без области просмотра) `JScrollPane` с горизонтальной и вертикальной полосами прокрутки при необходимости.
`JScrollPane(Component view)` Создаёт `JScrollPane`, отображающий содержимое указанного компонента, где обе горизонтальная и вертикальная полосы прокрутки отображаются всякий раз, когда содержимое компонента больше, чем область просмотра.
`JScrollPane(Component view, int vsbPolicy, int hsbPolicy)` Создаёт `JScrollPane`, отображающий компонент просмотра в области просмотра, позицию которой можно контролировать с помощью пары полос прокрутки.
`JScrollPane(int vsbPolicy, int hsbPolicy)` Создаёт пустую (без области просмотра) `JScrollPane` с указанными политиками полос прокрутки.

Методы

Модификатор и тип	Метод и описание
`JScrollBar`	`createHorizontalScrollBar()` Возвращает `JScrollPane.ScrollBar` по умолчанию.
`JScrollBar`	`createVerticalScrollBar()` Возвращает `JScrollPane.ScrollBar` по умолчанию.
`protected JViewport`	`createViewport()` Возвращает новый `JViewport` по умолчанию.
`AccessibleContext`	`getAccessibleContext()` Возвращает AccessibleContext, связанный с этим JScrollPane.
`JViewport`	`getColumnHeader()` Возвращает заголовок колонки.
`Component`	`getCorner(String key)` Возвращает компонент в указанном углу.
`JScrollBar`	`getHorizontalScrollBar()` Возвращает горизонтальную полосу прокрутки, которая управляет горизонтальным положением просмотра области просмотра.
`int`	`getHorizontalScrollBarPolicy()` Возвращает значение политики горизонтальной полосы прокрутки.
`JViewport`	`getRowHeader()` Возвращает заголовок строки.
`ScrollPaneUI`	`getUI()` Возвращает объект внешнего вида (L&F), который отображает этот компонент.
`String`	`getUIClassID()` Возвращает суффикс, используемый для построения имени класса L&F, используемого для отображения этого компонента.
`JScrollBar`	`getVerticalScrollBar()` Возвращает вертикальную полосу прокрутки, которая управляет вертикальным положением просмотра области просмотра.
`int`	`getVerticalScrollBarPolicy()` Возвращает значение политики вертикальной полосы прокрутки.
`JViewport`	`getViewport()` Возвращает текущий `JViewport`.
`Border`	`getViewportBorder()` Возвращает объект `Border`, который окружает область просмотра.
`Rectangle`	`getViewportBorderBounds()` Возвращает границы рамки области просмотра.
`boolean`	`isValidateRoot()` Переопределено для возвращения true, чтобы любые вызовы `revalidate` на любых потомках этого `JScrollPane` вызовут валидацию всего дерева, начиная с этого `JScrollPane`.
`boolean`	`isWheelScrollingEnabled()` Указывает, будет ли происходить прокрутка в ответ на колесо мыши.
`protected String`	`paramString()` Возвращает строковое представление этого `JScrollPane`.
`void`	`setColumnHeader(JViewport columnHeader)` Удаляет старый columnHeader, если он существует; если новый columnHeader не `null`, синхронизирует координату x его viewPosition с областью просмотра (если она существует), а затем добавляет его в JScrollPane.
`void`	`setColumnHeaderView(Component view)` Создает область просмотра заголовка столбца при необходимости, устанавливает её представление, а затем добавляет область просмотра заголовка столбца в JScrollPane.
`void`	`setComponentOrientation(ComponentOrientation co)` Устанавливает ориентацию для вертикальной и горизонтальной полос прокрутки, как определено аргументом `ComponentOrientation`.
`void`	`setCorner(String key, Component corner)` Добавляет потомка, который будет отображаться в одном из углов полосы прокрутки, если есть место.
`void`	`setHorizontalScrollBar(JScrollBar horizontalScrollBar)` Добавляет полосу прокрутки, которая управляет горизонтальным положением просмотра области просмотра, в JScrollPane.
`void`	`setHorizontalScrollBarPolicy(int policy)` Определяет, когда появляется горизонтальная полоса прокрутки в JScrollPane.
`void`	`setLayout(LayoutManager layout)` Устанавливает менеджер компоновки для этого `JScrollPane`.
`void`	`setRowHeader(JViewport rowHeader)` Удаляет старый rowHeader, если он существует; если новый rowHeader не `null`, синхронизирует координату y его viewPosition с областью просмотра (если она существует), а затем добавляет его в JScrollPane.
`void`	`setRowHeaderView(Component view)` Создаёт область просмотра заголовка строки при необходимости, устанавливает её представление, а затем добавляет область просмотра заголовка строки в JScrollPane.
`void`	`setUI(ScrollPaneUI ui)` Устанавливает объект `ScrollPaneUI`, обеспечивающий внешний вид (L&F) для этого компонента.
`void`	`setVerticalScrollBar(JScrollBar verticalScrollBar)` Добавляет полосу прокрутки, которая управляет вертикальным положением просмотра области просмотра, в JScrollPane.
`void`	`setVerticalScrollBarPolicy(int policy)` Определяет, когда появляется вертикальная полоса прокрутки в JScrollPane.
`void`	`setViewport(JViewport viewport)` Удаляет старую область просмотра (если она есть); принудительно устанавливает viewPosition новой области просмотра в квадранте +x,+y; синхронизирует заголовки строк и столбцов (если они есть) с новой областью просмотра; и, наконец, синхронизирует полосы прокрутки и заголовки с новой областью просмотра.
`void`	`setViewportBorder(Border viewportBorder)` Добавляет рамку вокруг области просмотра.
`void`	`setViewportView(Component view)` Создаёт область просмотра при необходимости, а затем устанавливает её представление.
`void`	`setWheelScrollingEnabled(boolean handleWheel)` Включает/выключает прокрутку в ответ на движение колеса мыши.
`void`	`updateUI()` Заменяет текущий объект `ScrollPaneUI` версией из текущего стандартного внешнего вида.

Методы, унаследованные от класса 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, isOptimizedDrawingEnabled, 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

Методы, унаследованные от класса 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

Методы, унаследованные от класса 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, 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, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Методы, унаследованные от класса java.lang.Object

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

Поля

verticalScrollBarPolicy

protected int verticalScrollBarPolicy

Политика отображения вертикальной полосы прокрутки. По умолчанию ScrollPaneConstants.VERTICAL_SCROLLBAR_AS_NEEDED.

См. также:: setVerticalScrollBarPolicy(int)

horizontalScrollBarPolicy

protected int horizontalScrollBarPolicy

Политика отображения горизонтальной полосы прокрутки. По умолчанию ScrollPaneConstants.HORIZONTAL_SCROLLBAR_AS_NEEDED.

См. также:: setHorizontalScrollBarPolicy(int)

viewport

protected JViewport viewport

Дочерний элемент viewport элемента scrollpane. По умолчанию пустой JViewport.

См. также:: setViewport(javax.swing.JViewport)

verticalScrollBar

protected JScrollBar verticalScrollBar

Дочерний элемент вертикальной полосы прокрутки элемента scrollpane. По умолчанию JScrollBar.

См. также:: setVerticalScrollBar(javax.swing.JScrollBar)

horizontalScrollBar

protected JScrollBar horizontalScrollBar

Дочерний элемент горизонтальной полосы прокрутки элемента scrollpane. По умолчанию JScrollBar.

См. также:: setHorizontalScrollBar(javax.swing.JScrollBar)

rowHeader

protected JViewport rowHeader

Дочерний элемент заголовка строк. По умолчанию null.

См. также:: setRowHeader(javax.swing.JViewport)

columnHeader

protected JViewport columnHeader

Дочерний элемент заголовка столбцов. По умолчанию null.

См. также:: setColumnHeader(javax.swing.JViewport)

lowerLeft

protected Component lowerLeft

Компонент для отображения в нижнем левом углу. По умолчанию null.

См. также:: setCorner(java.lang.String, java.awt.Component)

lowerRight

protected Component lowerRight

Компонент для отображения в нижнем правом углу. По умолчанию null.

См. также:: setCorner(java.lang.String, java.awt.Component)

upperLeft

protected Component upperLeft

Компонент для отображения в верхнем левом углу. По умолчанию null.

См. также:: setCorner(java.lang.String, java.awt.Component)

upperRight

protected Component upperRight

Компонент для отображения в верхнем правом углу. По умолчанию null.

См. также:: setCorner(java.lang.String, java.awt.Component)

Конструкторы

JScrollPane

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

Создает JScrollPane, который отображает компонент view в области viewport, позицию которой можно управлять с помощью пары полос прокрутки. Политики полос прокрутки определяют, когда отображаются полосы прокрутки. Например, если vsbPolicy равно VERTICAL_SCROLLBAR_AS_NEEDED, то вертикальная полоса прокрутки появляется только в том случае, если содержимое не помещается по вертикали. Доступные настройки политики перечислены в setVerticalScrollBarPolicy(int) и setHorizontalScrollBarPolicy(int).

Параметры:: view - компонент для отображения в области viewport scrollpane; vsbPolicy - целое число, определяющее политику вертикальной полосы прокрутки; hsbPolicy - целое число, определяющее политику горизонтальной полосы прокрутки
См. также:: setViewportView(java.awt.Component)

JScrollPane

public JScrollPane(Component view)

Создает JScrollPane, который отображает содержимое указанного компонента, где обе горизонтальная и вертикальная полосы прокрутки отображаются всякий раз, когда содержимое компонента больше, чем область просмотра.

Параметры:: view - компонент для отображения в области viewport scrollpane
См. также:: setViewportView(java.awt.Component)

JScrollPane

public JScrollPane(int vsbPolicy,
                   int hsbPolicy)

Создает пустой (без viewport view) JScrollPane с указанными политиками полос прокрутки. Доступные настройки политики перечислены в setVerticalScrollBarPolicy(int) и setHorizontalScrollBarPolicy(int).

Параметры:: vsbPolicy - целое число, определяющее политику вертикальной полосы прокрутки; hsbPolicy - целое число, определяющее политику горизонтальной полосы прокрутки
См. также:: setViewportView(java.awt.Component)

JScrollPane

public JScrollPane()

Создает пустой (без viewport view) JScrollPane с обеими горизонтальной и вертикальной полосами прокрутки, которые появляются при необходимости.

Методы

getUI

public ScrollPaneUI getUI()

Возвращает объект оформления (L&F), который отрисовывает этот компонент.

Возвращает:: объект ScrollPaneUI, который отрисовывает этот компонент
См. также:: setUI(javax.swing.plaf.ScrollPaneUI)

setUI

public void setUI(ScrollPaneUI ui)

Устанавливает объект ScrollPaneUI, который предоставляет внешний вид (L&F) для этого компонента.

Параметры:: ui - объект L&F ScrollPaneUI
См. также:: getUI()

updateUI

public void updateUI()

Заменяет текущий объект ScrollPaneUI версией из текущего стандартного внешнего вида. Вызывается при изменении стандартного внешнего вида.

Переопределяет:: updateUI в классе JComponent
См. также:: JComponent.updateUI(), UIManager.getUI(javax.swing.JComponent)

getUIClassID

public String getUIClassID()

Возвращает суффикс, используемый для построения имени класса L&F, используемого для отрисовки этого компонента.

Переопределяет:: getUIClassID в классе JComponent
Возвращает:: строку "ScrollPaneUI"
См. также:: JComponent.getUIClassID(), UIDefaults.getUI(javax.swing.JComponent)

setLayout

public void setLayout(LayoutManager layout)

Устанавливает менеджер компоновки для этого JScrollPane. Этот метод переопределяет setLayout в java.awt.Container для обеспечения того, что только LayoutManager , которые являются подклассами ScrollPaneLayout, могут использоваться в JScrollPane . Если layout не равен null, это вызовет syncWithScrollPane на нём.

Переопределяет:: setLayout в классе Container
Параметры:: layout - указанный менеджер компоновки
Исключения:: ClassCastException - если менеджер компоновки не является ScrollPaneLayout
См. также:: Container.getLayout(), Container.setLayout(java.awt.LayoutManager)

isValidateRoot

public boolean isValidateRoot()

Переопределено для возвращения true, поэтому любые вызовы revalidate на любых потомках этого JScrollPane приведут к валидации всего дерева, начиная с этого JScrollPane.

Переопределяет:: isValidateRoot в классе JComponent
Возвращает:: true
См. также:: Container.validate(), JComponent.revalidate(), JComponent.isValidateRoot(), Container.isValidateRoot()

getVerticalScrollBarPolicy

public int getVerticalScrollBarPolicy()

Возвращает значение политики вертикальной полосы прокрутки.

Возвращает:: свойство verticalScrollBarPolicy
См. также:: setVerticalScrollBarPolicy(int)

setVerticalScrollBarPolicy

public void setVerticalScrollBarPolicy(int policy)

Определяет, когда появляется вертикальная полоса прокрутки в scrollpane. Допустимые значения:

ScrollPaneConstants.VERTICAL_SCROLLBAR_AS_NEEDED
ScrollPaneConstants.VERTICAL_SCROLLBAR_NEVER
ScrollPaneConstants.VERTICAL_SCROLLBAR_ALWAYS

Параметры:: policy - одно из трёх значений, перечисленных выше
Исключения:: IllegalArgumentException - если policy не равно одному из допустимых значений, показанных выше
См. также:: getVerticalScrollBarPolicy()

getHorizontalScrollBarPolicy

public int getHorizontalScrollBarPolicy()

Возвращает значение политики горизонтальной полосы прокрутки.

Возвращает:: свойство horizontalScrollBarPolicy
См. также:: setHorizontalScrollBarPolicy(int)

setHorizontalScrollBarPolicy

public void setHorizontalScrollBarPolicy(int policy)

Определяет, когда появляется горизонтальная полоса прокрутки в scrollpane. Доступные значения:

ScrollPaneConstants.HORIZONTAL_SCROLLBAR_AS_NEEDED
ScrollPaneConstants.HORIZONTAL_SCROLLBAR_NEVER
ScrollPaneConstants.HORIZONTAL_SCROLLBAR_ALWAYS

Параметры:: policy - одно из трёх значений, перечисленных выше
Исключения:: IllegalArgumentException - если policy не равно одному из допустимых значений, показанных выше
См. также:: getHorizontalScrollBarPolicy()

getViewportBorder

public Border getViewportBorder()

Возвращает объект Border, который окружает viewport.

Возвращает:: свойство viewportBorder
См. также:: setViewportBorder(javax.swing.border.Border)

setViewportBorder

public void setViewportBorder(Border viewportBorder)

Добавляет границу вокруг области просмотра. Обратите внимание, что граница не задается непосредственно для области просмотра, JViewport не поддерживает свойство границы JComponent. Аналогично, установка области просмотра JScrollPane не влияет на свойство viewportBorder.

Значение по умолчанию этого свойства вычисляется реализацией внешнего вида.

Параметры:: viewportBorder - добавляемая граница
См. также:: getViewportBorder(), setViewport(javax.swing.JViewport)

getViewportBorderBounds

public Rectangle getViewportBorderBounds()

Возвращает границы границы области просмотра.

Возвращает:: объект Rectangle, определяющий границу области просмотра

createHorizontalScrollBar

public JScrollBar createHorizontalScrollBar()

Возвращает JScrollPane.ScrollBar по умолчанию. Подклассы могут переопределить этот метод, чтобы принудительно заставить реализации ScrollPaneUI использовать подкласс JScrollBar. Используется реализациями ScrollPaneUI для создания горизонтальной полосы прокрутки.

Возвращает:: объект JScrollBar с горизонтальной ориентацией
См. также:: JScrollBar

getHorizontalScrollBar

public JScrollBar getHorizontalScrollBar()

Возвращает горизонтальную полосу прокрутки, которая управляет положением горизонтального просмотра области просмотра.

Возвращает:: свойство horizontalScrollBar
См. также:: setHorizontalScrollBar(javax.swing.JScrollBar)

setHorizontalScrollBar

public void setHorizontalScrollBar(JScrollBar horizontalScrollBar)

Добавляет полосу прокрутки, управляющую положением горизонтального просмотра области просмотра, в прокручиваемый список. Обычно это не требуется, так как JScrollPane по умолчанию создает горизонтальную и вертикальную полосы прокрутки.

Параметры:: horizontalScrollBar - добавляемая горизонтальная полоса прокрутки
См. также:: createHorizontalScrollBar(), getHorizontalScrollBar()

createVerticalScrollBar

public JScrollBar createVerticalScrollBar()

Возвращает JScrollPane.ScrollBar по умолчанию. Подклассы могут переопределить этот метод, чтобы принудительно заставить реализации ScrollPaneUI использовать подкласс JScrollBar. Используется реализациями ScrollPaneUI для создания вертикальной полосы прокрутки.

Возвращает:: объект JScrollBar с вертикальной ориентацией
См. также:: JScrollBar

getVerticalScrollBar

public JScrollBar getVerticalScrollBar()

Возвращает вертикальную полосу прокрутки, которая управляет вертикальным положением просмотра.

Возвращает:: свойство verticalScrollBar
См. также:: setVerticalScrollBar(javax.swing.JScrollBar)

setVerticalScrollBar

public void setVerticalScrollBar(JScrollBar verticalScrollBar)

Добавляет полосу прокрутки, управляющую вертикальным положением просмотра, в прокручиваемый список. Обычно это не требуется, так как JScrollPane по умолчанию создает вертикальную и горизонтальную полосы прокрутки.

Параметры:: verticalScrollBar - новая вертикальная полоса прокрутки для добавления
См. также:: createVerticalScrollBar(), getVerticalScrollBar()

createViewport

protected JViewport createViewport()

По умолчанию возвращает новый JViewport. Используется для создания области просмотра (при необходимости) в setViewportView, setRowHeaderView, и setColumnHeaderView. Подклассы могут переопределить этот метод, чтобы вернуть подкласс JViewport.

Возвращает:: новый JViewport

getViewport

public JViewport getViewport()

Возвращает текущую JViewport.

Возвращает:: свойство viewport
См. также:: setViewport(javax.swing.JViewport)

setViewport

public void setViewport(JViewport viewport)

Удаляет старую область просмотра (если она есть); принудительно устанавливает viewPosition новой области просмотра в квадранте +x,+y; синхронизирует заголовки строк и столбцов (если они есть) с новой областью просмотра; и, наконец, синхронизирует полосы прокрутки и заголовки с новой областью просмотра.

Большинство приложений сочтут более удобным использовать setViewportView для добавления области просмотра и представления в прокручиваемый список.

Параметры:: viewport - новая область просмотра для использования; если область просмотра null, старая область просмотра все равно удаляется, а новая область просмотра устанавливается в null
См. также:: createViewport(), getViewport(), setViewportView(java.awt.Component)

setViewportView

public void setViewportView(Component view)

Создает область просмотра при необходимости, а затем устанавливает ее представление. Приложения, которые не предоставляют представление непосредственно конструктору JScrollPane, должны использовать этот метод для указания прокручиваемого дочернего элемента, который будет отображаться в прокручиваемом списке. Например:

JScrollPane scrollpane = new JScrollPane();
 scrollpane.setViewportView(myBigComponentToScroll);

Приложения не должны добавлять дочерние элементы напрямую в прокручиваемый список.

Параметры:: view - компонент для добавления в область просмотра
См. также:: setViewport(javax.swing.JViewport), JViewport.setView(java.awt.Component)

getRowHeader

public JViewport getRowHeader()

Возвращает заголовок строки.

Возвращает:: свойство rowHeader
См. также:: setRowHeader(javax.swing.JViewport)

setRowHeader

public void setRowHeader(JViewport rowHeader)

Удаляет старый заголовок строки, если он существует; если новый заголовок строки не null, синхронизирует координату y его viewPosition с областью просмотра (если она есть), а затем добавляет его в прокручиваемый список.

Большинство приложений сочтут более удобным использовать setRowHeaderView для добавления компонента заголовка строки и его области просмотра в прокручиваемый список.

Параметры:: rowHeader - новый заголовок строки для использования; если null, старый заголовок строки все равно удаляется, а новый заголовок строки устанавливается в null
См. также:: getRowHeader(), setRowHeaderView(java.awt.Component)

setRowHeaderView

public void setRowHeaderView(Component view)

Создает область просмотра заголовка строки при необходимости, устанавливает ее представление и добавляет область просмотра заголовка строки в прокручиваемый список. Например:

JScrollPane scrollpane = new JScrollPane();
 scrollpane.setViewportView(myBigComponentToScroll);
 scrollpane.setRowHeaderView(myBigComponentsRowHeader);

Параметры:: view - компонент для отображения в качестве заголовка строки
См. также:: setRowHeader(javax.swing.JViewport), JViewport.setView(java.awt.Component)

getColumnHeader

public JViewport getColumnHeader()

Возвращает заголовок столбца.

Возвращает:: свойство columnHeader
См. также:: setColumnHeader(javax.swing.JViewport)

setColumnHeader

public void setColumnHeader(JViewport columnHeader)

Удаляет старый заголовок столбца, если он существует; если новый заголовок столбца не null, синхронизирует координату x его viewPosition с областью просмотра (если она есть), а затем добавляет его в прокручиваемый список.

Большинство приложений сочтут более удобным использовать setColumnHeaderView для добавления компонента заголовка столбца и его области просмотра в прокручиваемый список.

См. также:: getColumnHeader(), setColumnHeaderView(java.awt.Component)

setColumnHeaderView

public void setColumnHeaderView(Component view)

Создает область просмотра заголовка столбца при необходимости, устанавливает ее представление и добавляет область просмотра заголовка столбца в прокручиваемый список. Например:

JScrollPane scrollpane = new JScrollPane();
 scrollpane.setViewportView(myBigComponentToScroll);
 scrollpane.setColumnHeaderView(myBigComponentsColumnHeader);

Параметры:: view - компонент для отображения в качестве заголовка столбца
См. также:: setColumnHeader(javax.swing.JViewport), JViewport.setView(java.awt.Component)

getCorner

public Component getCorner(String key)

Возвращает компонент в указанном углу. Значение key, определяющее угол, равно одному из следующих:

ScrollPaneConstants.LOWER_LEFT_CORNER
ScrollPaneConstants.LOWER_RIGHT_CORNER
ScrollPaneConstants.UPPER_LEFT_CORNER
ScrollPaneConstants.UPPER_RIGHT_CORNER
ScrollPaneConstants.LOWER_LEADING_CORNER
ScrollPaneConstants.LOWER_TRAILING_CORNER
ScrollPaneConstants.UPPER_LEADING_CORNER
ScrollPaneConstants.UPPER_TRAILING_CORNER

Параметры:: key - одно из значений, как показано выше
Возвращает:: компонент угла (который может быть null) по данному ключу или null если ключ недействителен
См. также:: setCorner(java.lang.String, java.awt.Component)

setCorner

public void setCorner(String key,
                      Component corner)

Добавляет дочерний элемент, который будет отображаться в одном из углов прокручиваемого списка, если есть место. Например, при отображении обеих полос прокрутки (с правой и нижней стороны прокручиваемого списка) компонент нижнего левого угла будет показан в пространстве между концами двух полос прокрутки. Допустимые значения для ключа:

ScrollPaneConstants.LOWER_LEFT_CORNER
ScrollPaneConstants.LOWER_RIGHT_CORNER
ScrollPaneConstants.UPPER_LEFT_CORNER
ScrollPaneConstants.UPPER_RIGHT_CORNER
ScrollPaneConstants.LOWER_LEADING_CORNER
ScrollPaneConstants.LOWER_TRAILING_CORNER
ScrollPaneConstants.UPPER_LEADING_CORNER
ScrollPaneConstants.UPPER_TRAILING_CORNER

Хотя «угол» не соответствует никакой подписи свойства компонентов, события PropertyChange генерируются со свойством, имя которого установлено в ключе угла.

Параметры:

key — определяет, в какой угол будет отображаться компонент

corner — один из следующих компонентов:

lowerLeft
lowerRight
upperLeft
upperRight

Исключения:

IllegalArgumentException — если ключ угла недопустим

setComponentOrientation

public void setComponentOrientation(ComponentOrientation co)

Устанавливает ориентацию для вертикальной и горизонтальной полос прокрутки в соответствии с аргументом ComponentOrientation.

Переопределяет:

setComponentOrientation в классе Component

Параметры:

co — одно из следующих значений:

java.awt.ComponentOrientation.LEFT_TO_RIGHT
java.awt.ComponentOrientation.RIGHT_TO_LEFT
java.awt.ComponentOrientation.UNKNOWN

См. также:

ComponentOrientation

isWheelScrollingEnabled

public boolean isWheelScrollingEnabled()

Указывает, будет ли происходить прокрутка при нажатии колесика мыши. Прокрутка колесиком по умолчанию включена.

С:: 1.4
См. также:: setWheelScrollingEnabled(boolean)

setWheelScrollingEnabled

public void setWheelScrollingEnabled(boolean handleWheel)

Включает/выключает прокрутку при перемещении колесика мыши. Прокрутка колесиком по умолчанию включена.

Параметры:: handleWheel — true если прокрутка должна выполняться автоматически для события MouseWheelEvent, false в противном случае.
С:: 1.4
См. также:: isWheelScrollingEnabled(), MouseWheelEvent, MouseWheelListener

paramString

protected String paramString()

Возвращает строковое представление этого JScrollPane. Этот метод предназначен только для отладки, и содержимое и формат возвращаемой строки могут отличаться в разных реализациях. Возвращаемая строка может быть пустой, но не null.

Переопределяет:: paramString в классе JComponent
Возвращает:: строковое представление этого JScrollPane.

getAccessibleContext

public AccessibleContext getAccessibleContext()

Возвращает AccessibleContext, связанный с этим JScrollPane. Для JScrollPane AccessibleContext принимает форму AccessibleJScrollPane. Новый экземпляр AccessibleJScrollPane создается при необходимости.

Определено в:: getAccessibleContext в интерфейсе Accessible
Переопределяет:: getAccessibleContext в классе Component
Возвращает:: AccessibleJScrollPane, который служит AccessibleContext этого JScrollPane

© 1993, 2020, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.