Spec-Zone.ru › OpenJDK 17

Класс ScrollPane

java.lang.Object
java.awt.Component
java.awt.Container
java.awt.ScrollPane
Все реализованные интерфейсы:
ImageObserver, MenuContainer, Serializable, Accessible 
public class ScrollPane extends Container implements Accessible
Класс контейнера, который реализует автоматическую горизонтальную и/или вертикальную прокрутку для единственного дочернего компонента. Политика отображения полос прокрутки может быть установлена следующим образом:
  1. по мере необходимости: полосы прокрутки создаются и отображаются только при необходимости для scrollpane
  2. всегда: полосы прокрутки создаются и всегда отображаются scrollpane
  3. никогда: полосы прокрутки никогда не создаются или отображаются scrollpane

Состояние горизонтальной и вертикальной полос прокрутки представлено двумя объектами ScrollPaneAdjustable (по одному для каждого измерения), которые реализуют интерфейс Adjustable. API предоставляет методы для доступа к этим объектам, позволяя манипулировать атрибутами объекта Adjustable (такими как unitIncrement, value и т. д.).

Некоторые свойства adjustable (минимальное, максимальное, blockIncrement и visibleAmount) устанавливаются внутри scrollpane в соответствии с геометрией scrollpane и его дочернего элемента, и их не следует устанавливать программами, использующими scrollpane.

Если политика отображения полос прокрутки определена как "никогда", то scrollpane все еще может быть прокручен программно с помощью метода setScrollPosition(), и scrollpane будет перемещать и обрезать содержимое дочернего элемента соответствующим образом. Эта политика полезна, если программе необходимо создавать и управлять собственными элементами управления adjustable.

Размещение полос прокрутки контролируется платформно-специфическими свойствами, установленными пользователем вне программы.

Начальный размер этого контейнера равен 100x100, но может быть изменен с помощью setSize().

Прокрутка с помощью колесика на оборудованной колесиком мыши включена по умолчанию. Это можно отключить, используя setWheelScrollingEnabled. Настройка прокрутки колесиком может быть выполнена путем установки значения blockIncrement и unitIncrement горизонтальных и вертикальных Adjustable. Сведения о том, как обрабатываются события колесика мыши, см. в описании класса MouseWheelEvent.

Вкладки используются для определения любого пространства, используемого полосами прокрутки и любыми рамками, созданными панелью прокрутки. getInsets() может быть использован для получения текущего значения вкладок. Если значение scrollbarsAlwaysVisible равно false, тогда значение вкладок будет динамически изменяться в зависимости от того, отображаются ли полосы прокрутки в данный момент.

См. также:
  • Сериализованная форма

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

Модификатор и тип Класс Описание
protected class  ScrollPane.AccessibleAWTScrollPane
Этот класс реализует поддержку доступности для класса ScrollPane.

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

Container.AccessibleAWTContainer

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

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

Краткое описание полей

Модификатор и тип Поле Описание
static final int SCROLLBARS_ALWAYS
Указывает, что горизонтальные/вертикальные полосы прокрутки всегда должны отображаться независимо от соответствующих размеров scrollpane и дочернего элемента.
static final int SCROLLBARS_AS_NEEDED
Указывает, что горизонтальная/вертикальная полоса прокрутки должна отображаться только тогда, когда размер дочернего элемента превышает размер scrollpane в горизонтальном/вертикальном измерении.
static final int SCROLLBARS_NEVER
Указывает, что горизонтальные/вертикальные полосы прокрутки никогда не должны отображаться независимо от соответствующих размеров scrollpane и дочернего элемента.

Поля, объявленные в классе 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

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

Конструктор Описание
ScrollPane()
Создаёт новый контейнер scrollpane с политикой отображения полос прокрутки "по мере необходимости".
ScrollPane(int scrollbarDisplayPolicy)
Создаёт новый контейнер scrollpane.

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

Модификатор и тип Метод Описание
protected final void addImpl(Component comp, Object constraints, int index)
Добавляет указанный компонент в этот контейнер scroll pane.
void addNotify()
Создаёт виджет scroll pane.
void doLayout()
Выполняет выкладку этого контейнера, изменяя размер его дочернего элемента до его предпочтительного размера.
protected boolean eventTypeEnabled(int type)
Если прокрутка колесиком включена, мы возвращаем true для MouseWheelEvents
AccessibleContext getAccessibleContext()
Возвращает AccessibleContext, связанный с этим ScrollPane.
Adjustable getHAdjustable()
Возвращает объект ScrollPaneAdjustable, который представляет состояние горизонтальной полосы прокрутки.
int getHScrollbarHeight()
Возвращает высоту, занимаемую горизонтальной полосой прокрутки, независимо от того, отображается ли она в данный момент панелью прокрутки или нет.
int getScrollbarDisplayPolicy()
Возвращает политику отображения полос прокрутки.
Point getScrollPosition()
Возвращает текущее положение x,y внутри дочернего элемента, которое отображается в координатах 0,0 области просмотра прокручиваемой панели.
Adjustable getVAdjustable()
Возвращает объект ScrollPaneAdjustable, который представляет состояние вертикальной полосы прокрутки.
Dimension getViewportSize()
Возвращает текущий размер области просмотра scroll pane.
int getVScrollbarWidth()
Возвращает ширину, занимаемую вертикальной полосой прокрутки, независимо от того, отображается ли она в данный момент панелью прокрутки или нет.
boolean isWheelScrollingEnabled()
Указывает, будет ли прокрутка выполняться в ответ на вращение колесика мыши.
void layout()
Устарело.
С версии JDK 1.1 заменено на doLayout().
String paramString()
Возвращает строку, представляющую состояние этого ScrollPane.
void printComponents(Graphics g)
Печатает компонент в этом scroll pane.
protected void processMouseWheelEvent(MouseWheelEvent e)
Обрабатывает события колесика мыши, которые доставляются в этот ScrollPane, прокручивая соответствующее количество.
final void setLayout(LayoutManager mgr)
Устанавливает менеджер выкладки для этого контейнера.
void setScrollPosition(int x, int y)
Прокручивает до указанного положения внутри дочернего компонента.
void setScrollPosition(Point p)
Прокручивает до указанного положения внутри дочернего компонента.
void setWheelScrollingEnabled(boolean handleWheel)
Включает/отключает прокрутку в ответ на перемещение колесика мыши.

Методы, объявленные в классе java.awt.Container

add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getInsets, getLayout, getListeners, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, isValidateRoot, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, removeNotify, setComponentZOrder, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusDownCycle, update, validate, validateTree

Методы, объявленные в классе java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, revalidate, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setMixingCutoutShape, setName, setPreferredSize, setSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

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

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

Краткое описание полей

SCROLLBARS_AS_NEEDED

public static final int SCROLLBARS_AS_NEEDED
Указывает, что горизонтальная/вертикальная полоса прокрутки должна отображаться только тогда, когда размер дочернего элемента превышает размер панели прокрутки в горизонтальном/вертикальном измерении.
См. также:
  • Constant Field Values

SCROLLBARS_ALWAYS

public static final int SCROLLBARS_ALWAYS
Указывает, что горизонтальные/вертикальные полосы прокрутки всегда должны отображаться независимо от соответствующих размеров панели прокрутки и дочернего элемента.
См. также:
  • Constant Field Values

SCROLLBARS_NEVER

public static final int SCROLLBARS_NEVER
Указывает, что горизонтальные/вертикальные полосы прокрутки никогда не должны отображаться независимо от соответствующих размеров панели прокрутки и дочернего элемента.
См. также:
  • Constant Field Values

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

ScrollPane

public ScrollPane() throws HeadlessException
Создает новый контейнер панели прокрутки с политикой отображения полосы прокрутки "по мере необходимости".
Исключения:
HeadlessException - если GraphicsEnvironment.isHeadless() возвращает true
См. также:
  • GraphicsEnvironment.isHeadless()

ScrollPane

@ConstructorProperties("scrollbarDisplayPolicy") public ScrollPane(int scrollbarDisplayPolicy) throws HeadlessException
Создает новый контейнер панели прокрутки.
Параметры:
scrollbarDisplayPolicy - политика, определяющая, когда следует отображать полосы прокрутки
Исключения:
IllegalArgumentException - если указанная политика отображения полосы прокрутки неверна
HeadlessException - если GraphicsEnvironment.isHeadless() возвращает true
См. также:
  • GraphicsEnvironment.isHeadless()

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

addImpl

protected final void addImpl(Component comp, Object constraints, int index)
Добавляет указанный компонент в этот контейнер панели прокрутки. Если панель прокрутки имеет существующий дочерний компонент, этот компонент удаляется, и добавляется новый.
Переопределяет:
addImpl в классе Container
Параметры:
comp - компонент, который нужно добавить
constraints - не применимо
index - позиция дочернего компонента (должна быть <= 0)
См. также:
  • Container.add(Component)
  • Container.add(Component, int)
  • Container.add(Component, java.lang.Object)
  • Container.invalidate()
  • LayoutManager
  • LayoutManager2

getScrollbarDisplayPolicy

public int getScrollbarDisplayPolicy()
Возвращает политику отображения полос прокрутки.
Возвращает:
политика отображения полос прокрутки

getViewportSize

public Dimension getViewportSize()
Возвращает текущий размер окна просмотра панели прокрутки.
Возвращает:
размер окна просмотра в пикселях

getHScrollbarHeight

public int getHScrollbarHeight()
Возвращает высоту, которую занимала бы горизонтальная полоса прокрутки, независимо от того, отображается она в данный момент панелью прокрутки или нет.
Возвращает:
высота горизонтальной полосы прокрутки в пикселях

getVScrollbarWidth

public int getVScrollbarWidth()
Возвращает ширину, которую занимала бы вертикальная полоса прокрутки, независимо от того, отображается она в данный момент панелью прокрутки или нет.
Возвращает:
ширина вертикальной полосы прокрутки в пикселях

getVAdjustable

public Adjustable getVAdjustable()
Возвращает объект ScrollPaneAdjustable, который представляет состояние вертикальной полосы прокрутки. Объявленный тип возвращаемого значения этого метода — Adjustable для обеспечения обратной совместимости.
Возвращает:
состояние вертикальной полосы прокрутки
См. также:
  • ScrollPaneAdjustable

getHAdjustable

public Adjustable getHAdjustable()
Возвращает объект ScrollPaneAdjustable, который представляет состояние горизонтальной полосы прокрутки. Объявленный тип возвращаемого значения этого метода — Adjustable для обеспечения обратной совместимости.
Возвращает:
состояние горизонтальной полосы прокрутки
См. также:
  • ScrollPaneAdjustable

setScrollPosition

public void setScrollPosition(int x, int y)
Прокручивает до указанной позиции внутри дочернего компонента. Вызов этого метода действителен только в том случае, если панель прокрутки содержит дочерний элемент. Указание позиции за пределами допустимых границ прокрутки дочернего элемента приведет к прокрутке до ближайшей допустимой позиции. Допустимые границы определяются как прямоугольник: x = 0, y = 0, ширина = (ширина дочернего элемента - ширина окна просмотра), высота = (высота дочернего элемента - высота окна просмотра). Это вспомогательный метод, который взаимодействует с объектами Adjustable, которые представляют состояние полос прокрутки.
Параметры:
x - позиция x для прокрутки
y - позиция y для прокрутки
Исключения:
NullPointerException - если панель прокрутки не содержит дочерний элемент

setScrollPosition

public void setScrollPosition(Point p)
Прокручивает до указанной позиции внутри дочернего компонента. Вызов этого метода действителен только в том случае, если панель прокрутки содержит дочерний элемент, и указанная позиция находится в допустимых границах прокрутки дочернего элемента. Указание позиции за пределами допустимых границ прокрутки дочернего элемента приведет к прокрутке до ближайшей допустимой позиции. Допустимые границы определяются как прямоугольник: x = 0, y = 0, ширина = (ширина дочернего элемента - ширина окна просмотра), высота = (высота дочернего элемента - высота окна просмотра). Это вспомогательный метод, который взаимодействует с объектами Adjustable, которые представляют состояние полос прокрутки.
Параметры:
p - Point, представляющий позицию для прокрутки
Исключения:
NullPointerException - если p является null

getScrollPosition

public Point getScrollPosition()
Возвращает текущую позицию x,y внутри дочернего элемента, которая отображается в расположении 0,0 окна просмотра прокручиваемой панели. Это вспомогательный метод, который взаимодействует с регулируемыми объектами, которые представляют состояние полос прокрутки.
Возвращает:
координатная позиция для текущей позиции прокрутки
Исключения:
NullPointerException - если панель прокрутки не содержит дочерний элемент

setLayout

public final void setLayout(LayoutManager mgr)
Устанавливает менеджер компоновки для этого контейнера. Этот метод переопределен, чтобы предотвратить установку менеджера компоновки.
Переопределяет:
setLayout в классе Container
Параметры:
mgr - указанный менеджер компоновки
См. также:
  • Container.doLayout()
  • Container.getLayout()
  • Container.invalidate()

doLayout

public void doLayout()
Размещает этот контейнер, изменяя размер его дочернего элемента до его предпочтительного размера. Если новый предпочтительный размер дочернего элемента делает текущую позицию прокрутки недопустимой, позиция прокрутки устанавливается на ближайшую допустимую позицию.
Переопределяет:
doLayout в классе Container
См. также:
  • Component.validate()

layout

@Deprecated public void layout()
Устарело.
Начиная с версии JDK 1.1, заменено на doLayout().
Переопределяет:
layout в классе Container

printComponents

public void printComponents(Graphics g)
Печатает компонент в этой панели прокрутки.
Переопределяет:
printComponents в классе Container
Параметры:
g - указанное окно Graphics
См. также:
  • Component.print(java.awt.Graphics)
  • Component.printAll(java.awt.Graphics)

addNotify

public void addNotify()
Создаёт виджет полосы прокрутки.
Overrides:
addNotify в классе Container
См. также:
  • Component.isDisplayable()
  • Container.removeNotify()

paramString

public String paramString()
Возвращает строку, представляющую состояние этой полосы прокрутки. Этот метод предназначен только для отладки, и содержимое и формат возвращаемой строки могут отличаться в разных реализациях. Возвращаемая строка может быть пустой, но не null.
Overrides:
paramString в классе Container
Возвращает:
строку параметров этой полосы прокрутки

processMouseWheelEvent

protected void processMouseWheelEvent(MouseWheelEvent e)
Обрабатывает события колеса мыши, переданные этой полосе прокрутки, прокручивая её на соответствующую величину.

Обратите внимание, что если параметр события равен null, поведение не определено и может привести к исключению.

Overrides:
processMouseWheelEvent в классе Component
Параметры:
e - событие колеса мыши
С тех пор:
1.4
См. также:
  • MouseWheelEvent
  • MouseWheelListener
  • Component.addMouseWheelListener(java.awt.event.MouseWheelListener)
  • Component.enableEvents(long)

eventTypeEnabled

protected boolean eventTypeEnabled(int type)
Если прокрутка колесом включена, возвращает true для MouseWheelEvents
С тех пор:
1.4

setWheelScrollingEnabled

public void setWheelScrollingEnabled(boolean handleWheel)
Включает/выключает прокрутку при движении колеса мыши. Прокрутка колесом включена по умолчанию.
Параметры:
handleWheel - true должна ли прокрутка выполняться автоматически для MouseWheelEvent, false в противном случае.
С тех пор:
1.4
См. также:
  • isWheelScrollingEnabled()
  • MouseWheelEvent
  • MouseWheelListener

isWheelScrollingEnabled

public boolean isWheelScrollingEnabled()
Указывает, будет ли происходить прокрутка в ответ на движение колеса мыши. Прокрутка колесом включена по умолчанию.
Возвращает:
true если прокрутка колесом включена; в противном случае false
С тех пор:
1.4
См. также:
  • setWheelScrollingEnabled(boolean)

getAccessibleContext

public AccessibleContext getAccessibleContext()
Получает AccessibleContext, связанный с этой полосой прокрутки. Для полос прокрутки AccessibleContext принимает форму AccessibleAWTScrollPane. Новый экземпляр AccessibleAWTScrollPane создаётся при необходимости.
Определено в:
getAccessibleContext в интерфейсе Accessible
Overrides:
getAccessibleContext в классе Component
Возвращает:
AccessibleAWTScrollPane, служащий AccessibleContext для этой полосы прокрутки
С тех пор:
1.3

© 1993, 2021, 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/17/docs/api/java.desktop/java/awt/ScrollPane.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API