Spec-Zone.ru › OpenJDK 21

Интерфейс Scrollable

Все известные реализующие классы:
DefaultTreeCellEditor.DefaultTextField, JEditorPane, JFormattedTextField, JLayer, JList, JPasswordField, JTable, JTextArea, JTextComponent, JTextField, JTextPane, JTree
public interface Scrollable
Интерфейс, предоставляющий информацию для контейнера прокрутки, такого как JScrollPane. Сложный компонент, который, вероятно, будет использоваться для просмотра области просмотра JScrollPane (или другого контейнера прокрутки), должен реализовывать этот интерфейс.
С:
1.2
См. также:
  • JViewport
  • JScrollPane
  • JScrollBar

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

Модификатор и тип Метод Описание
Dimension getPreferredScrollableViewportSize()
Возвращает предпочтительный размер области просмотра для компонента представления.
int getScrollableBlockIncrement(Rectangle visibleRect, int orientation, int direction)
Компоненты, отображающие логические строки или столбцы, должны вычислять приращение прокрутки, которое полностью отобразит один блок строк или столбцов, в зависимости от значения ориентации.
boolean getScrollableTracksViewportHeight()
Возвращает true, если область просмотра должна всегда принудительно изменять высоту этого Scrollable, чтобы она соответствовала высоте области просмотра.
boolean getScrollableTracksViewportWidth()
Возвращает true, если область просмотра должна всегда принудительно изменять ширину этого Scrollable , чтобы она соответствовала ширине области просмотра.
int getScrollableUnitIncrement(Rectangle visibleRect, int orientation, int direction)
Компоненты, отображающие логические строки или столбцы, должны вычислять приращение прокрутки, которое полностью отобразит одну новую строку или столбец, в зависимости от значения ориентации.

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

getPreferredScrollableViewportSize

Dimension getPreferredScrollableViewportSize()
Возвращает предпочтительный размер области просмотра для компонента представления. Например, предпочтительный размер компонента JList - это размер, необходимый для размещения всех ячеек в его списке. Однако значение preferredScrollableViewportSize - это размер, необходимый для JList.getVisibleRowCount строк. Компонент без каких-либо свойств, которые повлияли бы на размер области просмотра, должен просто вернуть getPreferredSize здесь.
Возвращает:
предпочтительный размер JViewport , чьё представление является этим Scrollable
См. также:
  • JComponent.getPreferredSize()

getScrollableUnitIncrement

int getScrollableUnitIncrement(Rectangle visibleRect, int orientation, int direction)
Компоненты, отображающие логические строки или столбцы, должны вычислить приращение прокрутки, которое полностью отобразит одну новую строку или столбец, в зависимости от значения ориентации. В идеале, компоненты должны обрабатывать частично отображаемые строки или столбцы, возвращая расстояние, необходимое для полного отображения элемента.

Контейнеры прокрутки, такие как JScrollPane, будут использовать этот метод каждый раз, когда пользователь запрашивает прокрутку на единицу.

Параметры:
visibleRect - Видимая область представления в пределах области просмотра
orientation - Либо SwingConstants.VERTICAL, либо SwingConstants.HORIZONTAL.
direction - Меньше нуля для прокрутки вверх/влево, больше нуля для прокрутки вниз/вправо.
Возвращает:
Приращение "единицы" для прокрутки в указанном направлении. Это значение всегда должно быть положительным.
См. также:
  • JScrollBar.setUnitIncrement(int)

getScrollableBlockIncrement

int getScrollableBlockIncrement(Rectangle visibleRect, int orientation, int direction)
Компоненты, отображающие логические строки или столбцы, должны вычислить приращение прокрутки, которое полностью отобразит один блок строк или столбцов, в зависимости от значения ориентации.

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

Параметры:
visibleRect - Видимая область представления в пределах области просмотра
orientation - Либо SwingConstants.VERTICAL, либо SwingConstants.HORIZONTAL.
direction - Меньше нуля для прокрутки вверх/влево, больше нуля для прокрутки вниз/вправо.
Возвращает:
Приращение "блока" для прокрутки в указанном направлении. Это значение всегда должно быть положительным.
См. также:
  • JScrollBar.setBlockIncrement(int)

getScrollableTracksViewportWidth

boolean getScrollableTracksViewportWidth()
Возвращает true, если область просмотра должна всегда принудительно изменять ширину этого Scrollable , чтобы она соответствовала ширине области просмотра. Например, обычный текстовый вид, поддерживающий перенос строк, вернёт true здесь, так как нежелательно, чтобы переносимые строки исчезали за правым краем области просмотра. Обратите внимание, что возвращение true для Scrollable, предком которого является JScrollPane, фактически отключает горизонтальную прокрутку.

Контейнеры прокрутки, такие как JViewport, будут использовать этот метод каждый раз, когда они валидируются.

Возвращает:
True, если область просмотра должна принудительно изменять ширину Scrollable, чтобы она соответствовала её собственной.

getScrollableTracksViewportHeight

boolean getScrollableTracksViewportHeight()
Возвращает true, если область просмотра должна всегда принудительно изменять высоту этого Scrollable, чтобы она соответствовала высоте области просмотра. Например, текстовый вид в виде колонок, который форматировал текст слева направо, может отключить вертикальную прокрутку, вернув true здесь.

Контейнеры прокрутки, такие как JViewport, будут использовать этот метод каждый раз, когда они валидируются.

Возвращает:
True, если область просмотра должна принудительно изменять высоту Scrollable, чтобы она соответствовала её собственной.

© 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/Scrollable.html

Spec-Zone.ru

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