Класс JScrollPane

javax.swing.JScrollPane

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

@JavaBean(defaultProperty="UI", description="A specialized container that manages a viewport, optional scrollbars and headers") public class JScrollPane extends JComponent implements ScrollPaneConstants, Accessible

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

Пример:

The following text describes this image.

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

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

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

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

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

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

Распространённая операция — установка цвета фона, который будет использоваться, если область просмотра основной области просмотра меньше области просмотра или она не непрозрачна. Это можно сделать, установив цвет фона области просмотра через setBackground. Причина установки цвета фона области просмотра, а не панели прокрутки, заключается в том, что по умолчанию JViewport непрозрачен, что, среди прочего, означает, что он будет полностью заполнять свой фон, используя свой цвет фона. Следовательно, когда JScrollPane рисует свой фон, область просмотра обычно нарисуется поверх него.

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

Если представление реализует Scrollable, используется сочетание getViewSize, getSize и setViewSize, в противном случае
используется getSize.

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

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

С:

1.2

См. также:

END_OF_DOCUMENT_MARKER

Краткое описание вложенных классов

Модификатор и тип	Класс	Описание
`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

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

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

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

Краткое описание конструкторов

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

Краткое описание методов

Modifier and Type	Method	Описание
`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 с viewport (если он есть), а затем добавляет его в scroll pane.
`void`	`setColumnHeaderView(Component view)`	Создаёт viewport для заголовка колонки при необходимости, устанавливает его представление и затем добавляет viewport для заголовка колонки в scrollpane.
`void`	`setComponentOrientation(ComponentOrientation co)`	Устанавливает ориентацию для вертикальной и горизонтальной полос прокрутки, как определено аргументом `ComponentOrientation`.
`void`	`setCorner(String key, Component corner)`	Добавляет потомка, который будет отображаться в одном из углов полос прокрутки, если есть место.
`void`	`setHorizontalScrollBar(JScrollBar horizontalScrollBar)`	Добавляет полосу прокрутки, управляющую горизонтальным положением просмотра области просмотра, в scrollpane.
`void`	`setHorizontalScrollBarPolicy(int policy)`	Определяет, когда появляется горизонтальная полоса прокрутки в scrollpane.
`void`	`setLayout(LayoutManager layout)`	Устанавливает менеджер компоновки для этого `JScrollPane`.
`void`	`setRowHeader(JViewport rowHeader)`	Удаляет старый rowHeader, если он существует; если новый rowHeader не `null`, синхронизирует координату y его viewPosition с viewport (если он есть), а затем добавляет его в scroll pane.
`void`	`setRowHeaderView(Component view)`	Создаёт viewport для заголовка строки при необходимости, устанавливает его представление и затем добавляет viewport для заголовка строки в scrollpane.
`void`	`setUI(ScrollPaneUI ui)`	Устанавливает объект `ScrollPaneUI`, который предоставляет внешний вид (L&F) для этого компонента.
`void`	`setVerticalScrollBar(JScrollBar verticalScrollBar)`	Добавляет полосу прокрутки, управляющую вертикальным положением просмотра области просмотра, в scrollpane.
`void`	`setVerticalScrollBarPolicy(int policy)`	Определяет, когда появляется вертикальная полоса прокрутки в scrollpane.
`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, 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, 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, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, 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.

См. также:

horizontalScrollBarPolicy

protected int horizontalScrollBarPolicy

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

См. также:

viewport

protected JViewport viewport

Элемент-вьюпорт полосы прокрутки. По умолчанию пустой JViewport.

См. также:

verticalScrollBar

protected JScrollBar verticalScrollBar

Элемент-вертикальная полоса прокрутки полосы прокрутки. По умолчанию JScrollBar.

См. также:

horizontalScrollBar

protected JScrollBar horizontalScrollBar

Элемент-горизонтальная полоса прокрутки полосы прокрутки. По умолчанию JScrollBar.

См. также:

rowHeader

protected JViewport rowHeader

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

См. также:

columnHeader

protected JViewport columnHeader

Элемент-заголовок столбцов. По умолчанию null.

См. также:

lowerLeft

protected Component lowerLeft

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

См. также:

lowerRight

protected Component lowerRight

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

См. также:

upperLeft

protected Component upperLeft

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

См. также:

upperRight

protected Component upperRight

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

См. также:

Подробное описание конструкторов

JScrollPane

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

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

Параметры:

view - компонент для отображения в ёмкости полосы прокрутки

vsbPolicy - целое число, определяющее политику вертикальной полосы прокрутки

hsbPolicy - целое число, определяющее политику горизонтальной полосы прокрутки

См. также:

JScrollPane

public JScrollPane(Component view)

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

Параметры:

view - компонент для отображения в ёмкости полосы прокрутки

См. также:

JScrollPane

public JScrollPane(int vsbPolicy, int hsbPolicy)

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

Параметры:

vsbPolicy - целое число, определяющее политику вертикальной полосы прокрутки

hsbPolicy - целое число, определяющее политику горизонтальной полосы прокрутки

См. также:

JScrollPane

public JScrollPane()

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

Подробное описание методов

getUI

@BeanProperty(hidden=true, visualUpdate=true, description="The UI object that implements the Component\'s LookAndFeel.") public ScrollPaneUI getUI()

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

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

getUI в классе JComponent

Возвращает:

объект темы и ощущения (L&F), который отображает этот компонент

См. также:

setUI

public void setUI(ScrollPaneUI ui)

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

Параметры:

ui - объект темы и ощущения (L&F)

См. также:

updateUI

public void updateUI()

Заменяет текущий объект темы и ощущений (L&F) на версию из текущей темы и ощущений по умолчанию. Вызывается при изменении темы и ощущений по умолчанию.

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

updateUI в классе JComponent

См. также:

getUIClassID

@BeanProperty(bound=false, hidden=true) public String getUIClassID()

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

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

getUIClassID в классе JComponent

Возвращает:

"ScrollPaneUI"

См. также:

setLayout

public void setLayout(LayoutManager layout)

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

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

setLayout в классе Container

Параметры:

layout - указанный менеджер компоновки

Исключения:

ClassCastException - если менеджер компоновки не является ScrollPaneLayout

См. также:

isValidateRoot

@BeanProperty(hidden=true) public boolean isValidateRoot()

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

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

isValidateRoot в классе JComponent

Возвращает:

true

См. также:

getVerticalScrollBarPolicy

public int getVerticalScrollBarPolicy()

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

Возвращает:

свойство verticalScrollBarPolicy

См. также:

setVerticalScrollBarPolicy

@BeanProperty(preferred=true, enumerationValues={"ScrollPaneConstants.VERTICAL_SCROLLBAR_AS_NEEDED","ScrollPaneConstants.VERTICAL_SCROLLBAR_NEVER","ScrollPaneConstants.VERTICAL_SCROLLBAR_ALWAYS"}, description="The scrollpane vertical scrollbar policy") public void setVerticalScrollBarPolicy(int policy)

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

ScrollPaneConstants.VERTICAL_SCROLLBAR_AS_NEEDED
ScrollPaneConstants.VERTICAL_SCROLLBAR_NEVER
ScrollPaneConstants.VERTICAL_SCROLLBAR_ALWAYS

Параметры:

policy - одно из трёх значений, указанных выше

Исключение:

IllegalArgumentException - если policy не является одним из допустимых значений, указанных выше

См. также:

getHorizontalScrollBarPolicy

public int getHorizontalScrollBarPolicy()

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

Возвращает:

свойство horizontalScrollBarPolicy

См. также:

setHorizontalScrollBarPolicy

@BeanProperty(preferred=true, enumerationValues={"ScrollPaneConstants.HORIZONTAL_SCROLLBAR_AS_NEEDED","ScrollPaneConstants.HORIZONTAL_SCROLLBAR_NEVER","ScrollPaneConstants.HORIZONTAL_SCROLLBAR_ALWAYS"}, description="The scrollpane scrollbar policy") public void setHorizontalScrollBarPolicy(int policy)

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

ScrollPaneConstants.HORIZONTAL_SCROLLBAR_AS_NEEDED
ScrollPaneConstants.HORIZONTAL_SCROLLBAR_NEVER
ScrollPaneConstants.HORIZONTAL_SCROLLBAR_ALWAYS

Параметры:

policy - одно из трёх значений, указанных выше

Исключение:

IllegalArgumentException - если policy не является одним из допустимых значений, указанных выше

См. также:

getViewportBorder

public Border getViewportBorder()

Возвращает объект Border, окружающий область просмотра.

Возвращает:

свойство viewportBorder

См. также:

setViewportBorder

@BeanProperty(preferred=true, description="The border around the viewport.") public void setViewportBorder(Border viewportBorder)

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

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

Параметры:

viewportBorder - граница, которая должна быть добавлена

См. также:

getViewportBorderBounds

@BeanProperty(bound=false) public Rectangle getViewportBorderBounds()

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

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

createHorizontalScrollBar

public JScrollBar createHorizontalScrollBar()

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

Возвращает:

объект JScrollBar с горизонтальной ориентацией

См. также:

getHorizontalScrollBar

public JScrollBar getHorizontalScrollBar()

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

Возвращает:

свойство horizontalScrollBar

См. также:

setHorizontalScrollBar

@BeanProperty(expert=true, description="The horizontal scrollbar.") public void setHorizontalScrollBar(JScrollBar horizontalScrollBar)

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

Параметры:

horizontalScrollBar - добавляемая горизонтальная полоса прокрутки

См. также:

createVerticalScrollBar

public JScrollBar createVerticalScrollBar()

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

Возвращает:

объект JScrollBar с вертикальной ориентацией

См. также:

getVerticalScrollBar

public JScrollBar getVerticalScrollBar()

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

Возвращает:

свойство verticalScrollBar

См. также:

setVerticalScrollBar

@BeanProperty(expert=true, description="The vertical scrollbar.") public void setVerticalScrollBar(JScrollBar verticalScrollBar)

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

Параметры:

verticalScrollBar - новая вертикальная полоса прокрутки, которая должна быть добавлена

См. также:

createViewport

protected JViewport createViewport()

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

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

getViewport

public JViewport getViewport()

Возвращает текущую область просмотра.

Возвращает:

свойство viewport

См. также:

setViewport

@BeanProperty(expert=true, visualUpdate=true, description="The viewport child for this scrollpane") public void setViewport(JViewport viewport)

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

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

Параметры:

viewport - новая область просмотра для использования; если область просмотра null, старая область просмотра всё равно удаляется, а новая устанавливается в null

См. также:

setViewportView

public void setViewportView(Component view)

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

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

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

Параметры:

view - компонент, который должен быть добавлен в область просмотра

См. также:

getRowHeader

public JViewport getRowHeader()

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

Возвращает:

свойство rowHeader

См. также:

setRowHeader

@BeanProperty(expert=true, description="The row header child for this scrollpane") public void setRowHeader(JViewport rowHeader)

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

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

Parameters:

rowHeader - новый заголовок строки, который будет использоваться; если null старый заголовок строки все равно удаляется, а новый rowHeader устанавливается в null

See Also:

setRowHeaderView

public void setRowHeaderView(Component view)

Создаёт viewport заголовка строки, если необходимо, устанавливает его представление, а затем добавляет viewport заголовка строки в scrollpane. Например:

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

Parameters:

view - компонент, отображаемый как заголовок строки

See Also:

getColumnHeader

public JViewport getColumnHeader()

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

Returns:

свойство columnHeader

See Also:

setColumnHeader

@BeanProperty(visualUpdate=true, description="The column header child for this scrollpane") public void setColumnHeader(JViewport columnHeader)

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

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

Parameters:

columnHeader - a JViewport — новый заголовок столбца

See Also:

setColumnHeaderView

public void setColumnHeaderView(Component view)

Создаёт viewport заголовка столбца, если необходимо, устанавливает его представление, а затем добавляет viewport заголовка столбца в scrollpane. Например:

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

Parameters:

view - компонент, отображаемый как заголовок столбца

See Also:

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

Parameters:

key - одно из значений, как показано выше

Returns:

компонент угла (который может быть null) по заданному ключу или null если ключ неверный

See Also:

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

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

Parameters:

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

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

нижний левый
нижний правый
верхний левый
верхний правый

Throws:

IllegalArgumentException - если ключ угла недействителен

setComponentOrientation

public void setComponentOrientation(ComponentOrientation co)

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

Overrides:

setComponentOrientation в классе Component

Parameters:

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

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

See Also:

isWheelScrollingEnabled

@BeanProperty(description="Flag for enabling/disabling mouse wheel scrolling") public boolean isWheelScrollingEnabled()

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

Returns:

true, если прокрутка колёсиком мыши включена, false в противном случае

Since:

1.4

See Also:

setWheelScrollingEnabled

@BeanProperty(description="Flag for enabling/disabling mouse wheel scrolling") public void setWheelScrollingEnabled(boolean handleWheel)

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

Parameters:

handleWheel - true если прокрутка должна выполняться автоматически для MouseWheelEvent, false в противном случае.

Since:

1.4

See Also:

paramString

protected String paramString()

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

Overrides:: paramString в классе JComponent
Returns:: строковое представление этого объекта JScrollPane.

getAccessibleContext

@BeanProperty(bound=false) public AccessibleContext getAccessibleContext()

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

Specified by:: getAccessibleContext в интерфейсе Accessible
Overrides:: getAccessibleContext в классе Component
Returns:: AccessibleJScrollPane, который служит AccessibleContext для этого JScrollPane

© 1993, 2023, 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.
https://docs.oracle.com/en/java/javase/21/docs/api/java.desktop/javax/swing/JScrollPane.html