Класс JScrollBar
- Все реализованные интерфейсы:
-
Adjustable,ImageObserver,MenuContainer,Serializable,Accessible
- Прямые известные подклассы:
JScrollPane.ScrollBar
@JavaBean(defaultProperty="UI", description="A component that helps determine the visible content range of an area.") public class JScrollBar extends JComponent implements Adjustable, Accessible
Обычно при изменении положения ползунка в полосе прокрутки происходит соответствующее изменение положения JViewport на базовом представлении, изменяя содержимое JViewport.
Предупреждение: Swing не потокобезопасен. Более подробная информация см. в Политике потоков Swing.
Предупреждение: Сериализованные объекты этого класса не будут совместимы с будущими выпусками Swing. Текущая поддержка сериализации подходит для кратковременного хранения или RMI между приложениями, использующими ту же версию Swing. Начиная с версии 1.4, поддержка долговременного хранения всех JavaBeans была добавлена в пакет java.beans. Пожалуйста, см. XMLEncoder.
- С момента:
- 1.2
- См. также:
Краткое описание вложенных классов
| Модификатор и тип | Класс | Описание |
|---|---|---|
protected class |
JScrollBar.AccessibleJScrollBar |
Этот класс реализует поддержку доступности для класса JScrollBar. |
Вложенные классы/интерфейсы, объявленные в классе javax.swing.JComponent
JComponent.AccessibleJComponent
Вложенные классы/интерфейсы, объявленные в классе java.awt.Container
Container.AccessibleAWTContainer
Вложенные классы/интерфейсы, объявленные в классе java.awt.Component
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy
Краткое описание полей
| Модификатор и тип | Поле | Описание |
|---|---|---|
protected int |
blockIncrement |
|
protected BoundedRangeModel |
model |
Модель, представляющая минимальное, максимальное, текущее значение и размер видимой области скроллбара. |
protected int |
orientation |
|
protected int |
unitIncrement |
Поля, объявленные в классе 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.Adjustable
HORIZONTAL, NO_ORIENTATION, VERTICAL
Поля, объявленные в интерфейсе java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
Краткое описание конструкторов
| Конструктор | Описание |
|---|---|
JScrollBar() |
Создаёт вертикальный скроллбар со следующими начальными значениями: |
JScrollBar |
Создаёт скроллбар с указанной ориентацией и следующими начальными значениями: |
JScrollBar |
Создаёт скроллбар с указанной ориентацией, значением, размером видимой области, минимумом и максимумом. |
Краткое описание методов
| Модификатор и тип | Метод | Описание |
|---|---|---|
void |
addAdjustmentListener |
Добавляет обработчик AdjustmentListener. |
protected void |
fireAdjustmentValueChanged |
Уведомляет слушателей о том, что модель скроллбара изменилась. |
AccessibleContext |
getAccessibleContext() |
Возвращает AccessibleContext, связанный с этим JScrollBar. |
AdjustmentListener[] |
getAdjustmentListeners() |
Возвращает массив всех обработчиков AdjustmentListener, добавленных к этому JScrollBar с помощью addAdjustmentListener(). |
int |
getBlockIncrement() |
Для обратной совместимости с java.awt.Scrollbar. |
int |
getBlockIncrement |
Возвращает количество, на которое необходимо изменить значение скроллбара в случае запроса на прокрутку на страницу (обычно "страница") вверх/вниз. |
int |
getMaximum() |
Максимальное значение скроллбара равно maximum - extent. |
Dimension |
getMaximumSize() |
Скроллбар гибкий вдоль оси прокрутки и жёсткий вдоль другой оси. |
int |
getMinimum() |
Возвращает минимальное значение, поддерживаемое скроллбаром (обычно ноль). |
Dimension |
getMinimumSize() |
Скроллбар гибкий вдоль оси прокрутки и жёсткий вдоль другой оси. |
BoundedRangeModel |
getModel() |
Возвращает модель данных, которая обрабатывает четыре основных свойства скроллбара: минимум, максимум, значение, размер видимой области. |
int |
getOrientation() |
Возвращает ориентацию компонента (горизонтальная или вертикальная). |
ScrollBarUI |
getUI() |
Возвращает делегат, реализующий вид и ощущение для этого компонента. |
String |
getUIClassID() |
Возвращает имя класса LookAndFeel для этого компонента. |
int |
getUnitIncrement() |
Для обратной совместимости с java.awt.Scrollbar. |
int |
getUnitIncrement |
Возвращает количество, на которое необходимо изменить значение скроллбара в случае запроса на прокрутку на единицу вверх/вниз. |
int |
getValue() |
Возвращает значение скроллбара. |
boolean |
getValueIsAdjusting() |
Истина, если ползунок скроллбара перетаскивается. |
int |
getVisibleAmount() |
Возвращает размер видимой области скроллбара. |
protected String |
paramString() |
Возвращает строковое представление этого JScrollBar. |
void |
removeAdjustmentListener |
Удаляет обработчик AdjustmentEvent. |
void |
setBlockIncrement |
Устанавливает свойство blockIncrement. |
void |
setEnabled |
Включает компонент, чтобы положение ползунка можно было изменить. |
void |
setMaximum |
Устанавливает свойство максимума модели. |
void |
setMinimum |
Устанавливает свойство минимума модели. |
void |
setModel |
Устанавливает модель, которая обрабатывает четыре основных свойства скроллбара: минимум, максимум, значение, размер видимой области. |
void |
setOrientation |
Устанавливает ориентацию скроллбара на VERTICAL или HORIZONTAL. |
void |
setUI |
Устанавливает объект L&F, который отрисовывает этот компонент. |
void |
setUnitIncrement |
Устанавливает свойство unitIncrement. |
void |
setValue |
Устанавливает значение скроллбара. |
void |
setValueIsAdjusting |
Устанавливает свойство valueIsAdjusting модели. |
void |
setValues |
Устанавливает четыре свойства BoundedRangeModel после принудительного соблюдения обычных ограничений: |
void |
setVisibleAmount |
Устанавливает свойство extent модели. |
void |
updateUI() |
Переопределяет JComponent.updateUI. |
Методы, объявленные в классе 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, 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, isValidateRoot, 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, 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, setLayout, 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, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
Подробное описание полей
model
protected BoundedRangeModel model
- См. также:
orientation
protected int orientation
- См. также:
unitIncrement
protected int unitIncrement
- См. также:
blockIncrement
protected int blockIncrement
- См. также:
Подробное описание конструкторов
JScrollBar
public JScrollBar(int orientation, int value, int extent, int min, int max)
Примечание: Используйте setBlockIncrement для установки шага блочной прокрутки, немного меньшего, чем размер видимой области. Таким образом, при переходе пользователем к соседнему положению, часть оригинального содержимого остаётся в области просмотра.
- Параметры:
-
orientation- ориентация полосы прокрутки -
value- текущее значение -
extent- величина изменения значения при "прыжке" -
min- минимальное значение -
max- максимальное значение - Исключения:
-
IllegalArgumentException- если ориентация не VERTICAL или HORIZONTAL - См. также:
JScrollBar
public JScrollBar(int orientation)
minimum = 0 maximum = 100 value = 0 extent = 10
- Параметры:
-
orientation- ориентация полосы прокрутки
JScrollBar
public JScrollBar()
minimum = 0 maximum = 100 value = 0 extent = 10
Подробное описание методов
setUI
@BeanProperty(hidden=true, visualUpdate=true, description="The UI object that implements the Component\'s LookAndFeel") public void setUI(ScrollBarUI ui)
- Параметры:
-
ui- объект L&F - С тех пор:
- 1.4
- См. также:
getUI
public ScrollBarUI getUI()
- Переопределяет:
-
getUIв классеJComponent - Возвращает:
- текущий UI полосы прокрутки.
- См. также:
updateUI
public void updateUI()
JComponent.updateUI.- Переопределяет:
-
updateUIв классеJComponent - См. также:
getUIClassID
@BeanProperty(bound=false) public String getUIClassID()
- Переопределяет:
-
getUIClassIDв классеJComponent - Возвращает:
- "ScrollBarUI"
- См. также:
getOrientation
public int getOrientation()
- Указано в:
-
getOrientationв интерфейсеAdjustable - Возвращает:
- VERTICAL или HORIZONTAL
- См. также:
setOrientation
@BeanProperty(preferred=true, visualUpdate=true, enumerationValues={"JScrollBar.VERTICAL","JScrollBar.HORIZONTAL"}, description="The scrollbar\'s orientation.") public void setOrientation(int orientation) - Параметры:
-
orientation- ориентация полосы прокрутки - Исключения:
-
IllegalArgumentException- если ориентация не VERTICAL или HORIZONTAL - См. также:
getModel
public BoundedRangeModel getModel()
- Возвращает:
- модель данных
- См. также:
setModel
@BeanProperty(expert=true, description="The scrollbar\'s BoundedRangeModel.") public void setModel(BoundedRangeModel newModel)
- Параметры:
-
newModel- новая модель - См. также:
getUnitIncrement
public int getUnitIncrement(int direction)
Компонента JScrollPane создаёт полосы прокрутки (по умолчанию), которые переопределяют этот метод и передают запрос в Scrollable view области просмотра, если она есть. Интерфейс Scrollable предоставляет более специализированную версию этого метода.
Некоторые реализации вид и ощущений, обеспечивающие настраиваемое поведение прокрутки, игнорируют этот параметр.
- Параметры:
-
direction- -1 или 1 соответственно для вверх/вниз - Возвращает:
- значение свойства unitIncrement
- См. также:
setUnitIncrement
@BeanProperty(preferred=true, description="The scrollbar\'s unit increment.") public void setUnitIncrement(int unitIncrement)
Примечание, что если аргумент равен Integer.MIN_VALUE, то большинство реализаций вид и ощущений не обеспечат прокрутку вправо/вниз.
Некоторые реализации вид и ощущений, обеспечивающие настраиваемое поведение прокрутки, игнорируют этот параметр.
- Указано в:
-
setUnitIncrementв интерфейсеAdjustable - Параметры:
-
unitIncrement- шаг единичной прокрутки - См. также:
getBlockIncrement
public int getBlockIncrement(int direction)
Компонента JScrollPane создаёт полосы прокрутки (по умолчанию), которые переопределяют этот метод и передают запрос в Scrollable view области просмотра, если она есть. Интерфейс Scrollable предоставляет более специализированную версию этого метода.
Некоторые реализации вид и ощущений, обеспечивающие настраиваемое поведение прокрутки, игнорируют этот параметр.
- Параметры:
-
direction- -1 или 1 соответственно для вверх/вниз - Возвращает:
- значение свойства blockIncrement
- См. также:
setBlockIncrement
@BeanProperty(preferred=true, description="The scrollbar\'s block increment.") public void setBlockIncrement(int blockIncrement)
Обратите внимание, что если аргумент равен значению Integer.MIN_VALUE, то большинство реализаций внешнего вида не будут обеспечивать прокрутку вправо/вниз.
Некоторые реализации внешнего вида, предоставляющие пользовательское поведение прокрутки, игнорируют это свойство.
- Указано в:
-
setBlockIncrementв интерфейсеAdjustable - Параметры:
-
blockIncrement- приращение блока - См. также:
getUnitIncrement
public int getUnitIncrement()
- Указано в:
-
getUnitIncrementв интерфейсеAdjustable - Возвращает:
- приращение единичного значения для настраиваемого объекта
- См. также:
getBlockIncrement
public int getBlockIncrement()
- Указано в:
-
getBlockIncrementв интерфейсеAdjustable - Возвращает:
- приращение значения блока для настраиваемого объекта
- См. также:
getValue
public int getValue()
- Указано в:
-
getValueв интерфейсеAdjustable - Возвращает:
- свойство значения модели
- См. также:
setValue
@BeanProperty(bound=false, preferred=true, description="The scrollbar\'s current value.") public void setValue(int value)
- Указано в:
-
setValueв интерфейсеAdjustable - Параметры:
-
value- текущее значение, междуminimumиmaximum-visibleAmount - См. также:
getVisibleAmount
public int getVisibleAmount()
- Указано в:
-
getVisibleAmountв интерфейсеAdjustable - Возвращает:
- значение свойства области модели
- См. также:
setVisibleAmount
@BeanProperty(bound=false, preferred=true, description="The amount of the view that is currently visible.") public void setVisibleAmount(int extent)
- Указано в:
-
setVisibleAmountв интерфейсеAdjustable - Параметры:
-
extent- длина индикатора - См. также:
getMinimum
public int getMinimum()
- Указано в:
-
getMinimumв интерфейсеAdjustable - Возвращает:
- значение свойства минимума модели
- См. также:
setMinimum
@BeanProperty(bound=false, preferred=true, description="The scrollbar\'s minimum value.") public void setMinimum(int minimum)
- Указано в:
-
setMinimumв интерфейсеAdjustable - Параметры:
-
minimum- минимальное значение - См. также:
getMaximum
public int getMaximum()
- Указано в:
-
getMaximumв интерфейсеAdjustable - Возвращает:
- значение свойства максимума модели
- См. также:
setMaximum
@BeanProperty(bound=false, preferred=true, description="The scrollbar\'s maximum value.") public void setMaximum(int maximum)
- Указано в:
-
setMaximumв интерфейсеAdjustable - Параметры:
-
maximum- максимальное значение - См. также:
getValueIsAdjusting
public boolean getValueIsAdjusting()
- Возвращает:
- значение свойства valueIsAdjusting модели
- См. также:
setValueIsAdjusting
@BeanProperty(bound=false, expert=true, description="True if the scrollbar thumb is being dragged.") public void setValueIsAdjusting(boolean b)
- Параметры:
-
b-trueесли предстоящие изменения свойства значения являются частью серии - См. также:
setValues
public void setValues(int newValue, int newExtent, int newMin, int newMax)
minimum ≤ value ≤ value+extent ≤ maximum
- Параметры:
-
newValue- целое число, представляющее текущее значение -
newExtent- целое число, представляющее величину "скачка" значения -
newMin- целое число, представляющее минимальное значение -
newMax- целое число, представляющее максимальное значение - См. также:
addAdjustmentListener
public void addAdjustmentListener(AdjustmentListener l)
Обратите внимание, что свойство типа AdjustmentEvents всегда будет иметь значение по умолчанию AdjustmentEvent.TRACK, так как все изменения значения BoundedRangeModels считаются эквивалентными. Чтобы изменить значение BoundedRangeModel, просто установите свойство value, т.е. model.setValue(123). Информация об источнике изменения, например, об уменьшении блока, не предоставляется. Мы не пытаемся вычислить источник изменения здесь.
- Указано в:
-
addAdjustmentListenerв интерфейсеAdjustable - Параметры:
-
l- добавляемый AdjustmentLister - См. также:
removeAdjustmentListener
public void removeAdjustmentListener(AdjustmentListener l)
- Указано в:
-
removeAdjustmentListenerв интерфейсеAdjustable - Параметры:
-
l- удаляемый AdjustmentLister - См. также:
getAdjustmentListeners
@BeanProperty(bound=false) public AdjustmentListener[] getAdjustmentListeners()
AdjustmentListener добавленных к этому JScrollBar с помощью addAdjustmentListener().- Возвращает:
- все добавленные
AdjustmentListenerили пустой массив, если слушатели не были добавлены - С:
- 1.4
fireAdjustmentValueChanged
protected void fireAdjustmentValueChanged(int id, int type, int value)
- Parameters:
-
id- целое число, указывающее тип события. -
type- целое число, указывающее тип изменения. -
value- текущее значение изменения - See Also:
getMinimumSize
public Dimension getMinimumSize()
- Overrides:
-
getMinimumSizein classJComponent - Returns:
- значение свойства
minimumSize - See Also:
getMaximumSize
public Dimension getMaximumSize()
- Overrides:
-
getMaximumSizein classJComponent - Returns:
- значение свойства
maximumSize - See Also:
setEnabled
public void setEnabled(boolean x)
- Overrides:
-
setEnabledin classJComponent - Parameters:
-
x- логическое значение, где true включает компонент, а false отключает его - See Also:
paramString
protected String paramString()
null.- Overrides:
-
paramStringin classJComponent - Returns:
- строковое представление JScrollBar.
getAccessibleContext
@BeanProperty(bound=false) public AccessibleContext getAccessibleContext()
- Specified by:
-
getAccessibleContextin interfaceAccessible - Overrides:
-
getAccessibleContextin classComponent - Returns:
- AccessibleJScrollBar, который служит AccessibleContext для этого JScrollBar
© 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/javax/swing/JScrollBar.html