Spec-Zone.ru › OpenJDK 25

Класс Scrollbar

java.lang.Object
java.awt.Component
java.awt.Scrollbar
Все реализуемые интерфейсы:
Adjustable, ImageObserver, MenuContainer, Serializable, Accessible
public class Scrollbar extends Component implements Adjustable, Accessible
Класс Scrollbar представляет собой полосу прокрутки — знакомый объект пользовательского интерфейса. Полоса прокрутки позволяет пользователю удобно выбирать значение из некоторого диапазона. Следующие три вертикальные полосы прокрутки можно использовать в качестве ползунков для выбора красной, зеленой и синей составляющих цвета:

Image shows 3 vertical sliders,
side-by-side.

Каждую полосу прокрутки в этом примере можно создать с помощью кода, подобного следующему:

redSlider=new Scrollbar(Scrollbar.VERTICAL, 0, 1, 0, 255);
add(redSlider);

Кроме того, полоса прокрутки может представлять диапазон значений. Например, если полоса прокрутки используется для прокрутки текста, ширина «бегунка» (также называемого «ползунком» или «ползунком прокрутки») может показывать, какая часть текста видна. Ниже приведен пример полосы прокрутки, представляющей диапазон:

Image shows horizontal slider with starting range of 0 and ending range
of 300. The slider thumb is labeled 60.

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

ranger = new Scrollbar(Scrollbar.HORIZONTAL, 0, 60, 0, 300);
add(ranger);

Обратите внимание, что фактическое максимальное значение полосы прокрутки равно maximum за вычетом visible amount. В предыдущем примере, поскольку maximum равно 300, а visible amount равно 60, фактическое максимальное значение составляет 240. Диапазон дорожки полосы прокрутки — от 0 до 300. Левая сторона бегунка указывает значение полосы прокрутки.

Обычно пользователь меняет значение полосы прокрутки с помощью мыши. Например, пользователь может перетаскивать бегунок полосы прокрутки вверх и вниз или щелкать в областях приращения на единицу или на блок. Для полосы прокрутки также могут быть предусмотрены действия с клавиатуры. По соглашению клавиши Page Up и Page Down эквивалентны щелчкам в областях приращения и уменьшения на блок.

Когда пользователь меняет значение полосы прокрутки, полоса прокрутки получает экземпляр AdjustmentEvent. Полоса прокрутки обрабатывает это событие и передает его всем зарегистрированным слушателям.

Любой объект, которому нужно получать уведомления об изменениях значения полосы прокрутки, должен реализовать AdjustmentListener — интерфейс, определенный в пакете java.awt.event. Слушателей можно динамически добавлять и удалять вызовами методов addAdjustmentListener и removeAdjustmentListener.

Класс AdjustmentEvent определяет пять типов событий изменения, перечисленных ниже:

  • Событие AdjustmentEvent.TRACK отправляется, когда пользователь перетаскивает бегунок полосы прокрутки.
  • Событие AdjustmentEvent.UNIT_INCREMENT отправляется, когда пользователь щелкает стрелку влево горизонтальной полосы прокрутки или верхнюю стрелку вертикальной полосы прокрутки, либо выполняет эквивалентное действие с клавиатуры.
  • Событие AdjustmentEvent.UNIT_DECREMENT отправляется, когда пользователь щелкает стрелку вправо горизонтальной полосы прокрутки или нижнюю стрелку вертикальной полосы прокрутки, либо выполняет эквивалентное действие с клавиатуры.
  • Событие AdjustmentEvent.BLOCK_INCREMENT отправляется, когда пользователь щелкает дорожку слева от бегунка горизонтальной полосы прокрутки или выше бегунка вертикальной полосы прокрутки. По соглашению ему эквивалентна клавиша Page Up, если на используемой клавиатуре есть клавиша Page Up.
  • Событие AdjustmentEvent.BLOCK_DECREMENT отправляется, когда пользователь щелкает дорожку справа от бегунка горизонтальной полосы прокрутки или ниже бегунка вертикальной полосы прокрутки. По соглашению ему эквивалентна клавиша Page Down, если на используемой клавиатуре есть клавиша Page Down.

Система событий JDK 1.0 поддерживается для обратной совместимости, однако ее использование в новых версиях платформы не рекомендуется. Пять типов событий изменения, появившихся в JDK 1.1, соответствуют пяти типам событий, связанным с полосами прокрутки в предыдущих версиях платформы. В следующем списке указаны типы событий изменения и соответствующие им типы событий JDK 1.0, которые они заменяют.

  • AdjustmentEvent.TRACK заменяет Event.SCROLL_ABSOLUTE
  • AdjustmentEvent.UNIT_INCREMENT заменяет Event.SCROLL_LINE_UP
  • AdjustmentEvent.UNIT_DECREMENT заменяет Event.SCROLL_LINE_DOWN
  • AdjustmentEvent.BLOCK_INCREMENT заменяет Event.SCROLL_PAGE_UP
  • AdjustmentEvent.BLOCK_DECREMENT заменяет Event.SCROLL_PAGE_DOWN

Примечание: рекомендуется использовать Scrollbar только для выбора значения. Если вы хотите реализовать прокручиваемый компонент внутри контейнера, рекомендуется использовать ScrollPane. Использование Scrollbar с этой целью, вероятно, приведет к проблемам с отрисовкой, обработкой клавиш, размером и расположением.

Начиная с версии:
1.0
См. также:
  • AdjustmentEvent
  • AdjustmentListener
  • Сериализованная форма

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

Модификатор и тип Класс Описание
protected class  Scrollbar.AccessibleAWTScrollBar
Этот класс реализует поддержку специальных возможностей для класса Scrollbar.

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

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

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

Модификатор и тип Поле Описание
static final int HORIZONTAL
Константа, указывающая на горизонтальную полосу прокрутки.
static final int VERTICAL
Константа, указывающая на вертикальную полосу прокрутки.

Поля, объявленные в классе Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Поля, объявленные в интерфейсе Adjustable

NO_ORIENTATION

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

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

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

Конструктор Описание
Scrollbar()
Создает новую вертикальную полосу прокрутки.
Scrollbar(int orientation)
Создает новую полосу прокрутки с указанной ориентацией.
Scrollbar(int orientation, int value, int visible, int minimum, int maximum)
Создает новую полосу прокрутки с указанной ориентацией, начальным значением, видимой областью, минимальным и максимальным значениями.

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

Модификатор и тип Метод Описание
void addAdjustmentListener(AdjustmentListener l)
Добавляет указанный слушатель изменения, чтобы он получал экземпляры AdjustmentEvent от этой полосы прокрутки.
void addNotify()
Создает peer-объект для Scrollbar.
AccessibleContext getAccessibleContext()
Возвращает AccessibleContext, связанный с этим Scrollbar.
AdjustmentListener[] getAdjustmentListeners()
Возвращает массив всех слушателей изменения, зарегистрированных для этой полосы прокрутки.
int getBlockIncrement()
Возвращает приращение на блок для этой полосы прокрутки.
int getLineIncrement()
Устарел.
Начиная с JDK версии 1.1 заменен на getUnitIncrement().
<T extends EventListener>
T[]
getListeners(Class<T> listenerType)
Возвращает массив всех объектов, зарегистрированных в данный момент как FooListener для этого Scrollbar.
int getMaximum()
Возвращает максимальное значение этой полосы прокрутки.
int getMinimum()
Возвращает минимальное значение этой полосы прокрутки.
int getOrientation()
Возвращает ориентацию этой полосы прокрутки.
int getPageIncrement()
Устарел.
Начиная с JDK версии 1.1 заменен на getBlockIncrement().
int getUnitIncrement()
Возвращает приращение на единицу для этой полосы прокрутки.
int getValue()
Возвращает текущее значение этой полосы прокрутки.
boolean getValueIsAdjusting()
Возвращает true, если значение изменяется в результате действий пользователя.
int getVisible()
Устарел.
Начиная с JDK версии 1.1 заменен на getVisibleAmount().
int getVisibleAmount()
Возвращает видимую область этой полосы прокрутки.
protected String paramString()
Возвращает строку, представляющую состояние этого Scrollbar.
protected void processAdjustmentEvent(AdjustmentEvent e)
Обрабатывает события изменения, возникающие в этой полосе прокрутки, передавая их всем зарегистрированным объектам AdjustmentListener.
protected void processEvent(AWTEvent e)
Обрабатывает события этой полосы прокрутки.
void removeAdjustmentListener(AdjustmentListener l)
Удаляет указанный слушатель изменения, чтобы он больше не получал экземпляры AdjustmentEvent от этой полосы прокрутки.
void setBlockIncrement(int v)
Задает приращение на блок для этой полосы прокрутки.
void setLineIncrement(int v)
Устарел.
Начиная с JDK версии 1.1 заменен на setUnitIncrement(int).
void setMaximum(int newMaximum)
Задает максимальное значение этой полосы прокрутки.
void setMinimum(int newMinimum)
Задает минимальное значение этой полосы прокрутки.
void setOrientation(int orientation)
Задает ориентацию этой полосы прокрутки.
void setPageIncrement(int v)
Устарел.
Начиная с JDK версии 1.1 заменен на setBlockIncrement().
void setUnitIncrement(int v)
Задает приращение на единицу для этой полосы прокрутки.
void setValue(int newValue)
Задает указанное значение для этой полосы прокрутки.
void setValueIsAdjusting(boolean b)
Задает свойство valueIsAdjusting.
void setValues(int value, int visible, int minimum, int maximum)
Задает значения четырех свойств этой полосы прокрутки: value, visibleAmount, minimum и maximum.
void setVisibleAmount(int newAmount)
Задает видимую область этой полосы прокрутки.

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

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, deliverEvent, disable, disableEvents, dispatchEvent, doLayout, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAlignmentX, getAlignmentY, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentAt, getComponentAt, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeys, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMaximumSize, getMinimumSize, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, invalidate, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusCycleRoot, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, layout, list, list, list, list, list, locate, location, lostFocus, minimumSize, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paint, paintAll, postEvent, preferredSize, prepareImage, prepareImage, print, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removeNotify, 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, setFocusTraversalKeys, setFocusTraversalKeysEnabled, setFont, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setMixingCutoutShape, setName, setPreferredSize, setSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle, update, validate

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

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

Подробное описание полей

HORIZONTAL

public static final int HORIZONTAL
Константа, обозначающая горизонтальную полосу прокрутки.
См. также:
  • Значения констант полей

VERTICAL

public static final int VERTICAL
Константа, обозначающая вертикальную полосу прокрутки.
См. также:
  • Значения констант полей

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

Scrollbar

public Scrollbar() throws HeadlessException
Создаёт новую вертикальную полосу прокрутки. Свойства полосы прокрутки по умолчанию перечислены в следующей таблице:
Свойства полосы прокрутки по умолчанию
Свойство Описание Значение по умолчанию
ориентация указывает, является ли полоса прокрутки вертикальной или горизонтальной Scrollbar.VERTICAL
значение значение, задающее положение ползунка полосы прокрутки 0
видимая область видимая часть диапазона полосы прокрутки, обычно представленная размером её ползунка 10
минимум минимальное значение полосы прокрутки 0
максимум максимальное значение полосы прокрутки 100
шаг прокрутки величина изменения значения при нажатии клавиши Line Up или Line Down либо при щелчке по концевым стрелкам полосы прокрутки 1
шаг страницы величина изменения значения при нажатии клавиши Page Up или Page Down либо при щелчке по дорожке полосы прокрутки
с любой стороны от ползунка
10
Вызывает исключение:
HeadlessException - если GraphicsEnvironment.isHeadless() возвращает true.
См. также:
  • GraphicsEnvironment.isHeadless()

Scrollbar

public Scrollbar(int orientation) throws HeadlessException
Создаёт новую полосу прокрутки с указанной ориентацией.

Аргумент orientation должен принимать одно из двух значений: Scrollbar.HORIZONTAL или Scrollbar.VERTICAL, обозначающих соответственно горизонтальную или вертикальную полосу прокрутки.

Параметры:
orientation - задаёт ориентацию полосы прокрутки
Вызывает исключение:
IllegalArgumentException - если для аргумента orientation указано недопустимое значение
HeadlessException - если GraphicsEnvironment.isHeadless() возвращает true.
См. также:
  • GraphicsEnvironment.isHeadless()

Scrollbar

public Scrollbar(int orientation, int value, int visible, int minimum, int maximum) throws HeadlessException
Создаёт новую полосу прокрутки с указанными ориентацией, начальным значением, видимой областью, минимальным и максимальным значениями.

Аргумент orientation должен принимать одно из двух значений: Scrollbar.HORIZONTAL или Scrollbar.VERTICAL, обозначающих соответственно горизонтальную или вертикальную полосу прокрутки.

Параметры, передаваемые этому конструктору, должны удовлетворять ограничениям, описанным в setValues(int, int, int, int).

Параметры:
orientation - задаёт ориентацию полосы прокрутки.
value - начальное значение полосы прокрутки
visible - видимая область полосы прокрутки, обычно представленная размером ползунка
minimum - минимальное значение полосы прокрутки
maximum - максимальное значение полосы прокрутки
Вызывает исключение:
IllegalArgumentException - если для аргумента orientation указано недопустимое значение
HeadlessException - если GraphicsEnvironment.isHeadless() возвращает true.
См. также:
  • setValues(int, int, int, int)
  • GraphicsEnvironment.isHeadless()

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

addNotify

public void addNotify()
Создаёт peer-объект Scrollbar. Peer-объект позволяет изменить внешний вид Scrollbar, не меняя её функциональность.
Переопределяет:
addNotify в классе Component
См. также:
  • Component.isDisplayable()
  • Component.removeNotify()
  • Component.invalidate()

getOrientation

public int getOrientation()
Возвращает ориентацию этой полосы прокрутки.
Определён в:
getOrientation в интерфейсе Adjustable
Возвращает:
ориентацию этой полосы прокрутки: Scrollbar.HORIZONTAL или Scrollbar.VERTICAL
См. также:
  • setOrientation(int)

setOrientation

public void setOrientation(int orientation)
Задаёт ориентацию этой полосы прокрутки.
Параметры:
orientation - ориентация этой полосы прокрутки: Scrollbar.HORIZONTAL или Scrollbar.VERTICAL
Вызывает исключение:
IllegalArgumentException - если для orientation указано недопустимое значение
Добавлено в версии:
1.1
См. также:
  • getOrientation()

getValue

public int getValue()
Возвращает текущее значение этой полосы прокрутки.
Определён в:
getValue в интерфейсе Adjustable
Возвращает:
текущее значение этой полосы прокрутки
См. также:
  • getMinimum()
  • getMaximum()

setValue

public void setValue(int newValue)
Задаёт для этой полосы прокрутки указанное значение.

Если переданное значение меньше текущего minimum или больше текущего maximum - visibleAmount, вместо него используется соответственно minimum или maximum - visibleAmount.

Как правило, программе следует изменять значение полосы прокрутки только вызовом setValues. Метод setValues одновременно и синхронно задаёт минимальное, максимальное значения, видимую область и значение полосы прокрутки, обеспечивая их взаимную согласованность.

Вызов этого метода не генерирует AdjustmentEvent.

Определён в:
setValue в интерфейсе Adjustable
Параметры:
newValue - новое значение полосы прокрутки
См. также:
  • setValues(int, int, int, int)
  • getValue()
  • getMinimum()
  • getMaximum()

getMinimum

public int getMinimum()
Возвращает минимальное значение этой полосы прокрутки.
Определён в:
getMinimum в интерфейсе Adjustable
Возвращает:
минимальное значение этой полосы прокрутки
См. также:
  • getValue()
  • getMaximum()

setMinimum

public void setMinimum(int newMinimum)
Задаёт минимальное значение этой полосы прокрутки.

При вызове setMinimum изменяется минимальное значение, а остальные значения (включая максимальное значение, видимую область и текущее значение полосы прокрутки) изменяются для согласования с новым минимумом.

Как правило, программе следует изменять минимальное значение полосы прокрутки только вызовом setValues. Метод setValues одновременно и синхронно задаёт минимальное, максимальное значения, видимую область и значение полосы прокрутки, обеспечивая их взаимную согласованность.

Обратите внимание: если установить минимальное значение равным Integer.MAX_VALUE, новое минимальное значение будет установлено в Integer.MAX_VALUE - 1.

Определён в:
setMinimum в интерфейсе Adjustable
Параметры:
newMinimum - новое минимальное значение этой полосы прокрутки
Добавлено в версии:
1.1
См. также:
  • setValues(int, int, int, int)
  • setMaximum(int)

getMaximum

public int getMaximum()
Возвращает максимальное значение этой полосы прокрутки.
Определён в:
getMaximum в интерфейсе Adjustable
Возвращает:
максимальное значение этой полосы прокрутки
См. также:
  • getValue()
  • getMinimum()

setMaximum

public void setMaximum(int newMaximum)
Задаёт максимальное значение этой полосы прокрутки.

При вызове setMaximum изменяется максимальное значение, а остальные значения (включая минимальное значение, видимую область и текущее значение полосы прокрутки) изменяются для согласования с новым максимумом.

Как правило, программе следует изменять максимальное значение полосы прокрутки только вызовом setValues. Метод setValues одновременно и синхронно задаёт минимальное, максимальное значения, видимую область и значение полосы прокрутки, обеспечивая их взаимную согласованность.

Обратите внимание: если установить максимальное значение равным Integer.MIN_VALUE, новое максимальное значение будет установлено в Integer.MIN_VALUE + 1.

Определён в:
setMaximum в интерфейсе Adjustable
Параметры:
newMaximum - новое максимальное значение этой полосы прокрутки
Добавлено в версии:
1.1
См. также:
  • setValues(int, int, int, int)
  • setMinimum(int)

getVisibleAmount

public int getVisibleAmount()
Возвращает видимую область этой полосы прокрутки.

Если полоса прокрутки используется для выбора диапазона значений, видимая область представляет диапазон значений, видимых в данный момент. Размер ползунка полосы прокрутки (также называемого бегунком или прокручиваемым блоком) обычно наглядно показывает соотношение видимой области и диапазона полосы прокрутки. Обратите внимание: в зависимости от платформы размер ползунка может не отображать визуально значение свойства видимой области.

Ползунок полосы прокрутки может не отображаться, если его нельзя перемещать (например, когда он занимает всю длину дорожки полосы прокрутки или когда полоса прокрутки отключена). Наличие или отсутствие ползунка не влияет на значение, возвращаемое методом getVisibleAmount.

Определён в:
getVisibleAmount в интерфейсе Adjustable
Возвращает:
видимую область этой полосы прокрутки
Добавлено в версии:
1.1
См. также:
  • setVisibleAmount(int)

getVisible

@Deprecated public int getVisible()
Устарело.
Начиная с JDK версии 1.1 заменено методом getVisibleAmount().
Возвращает видимую область этой полосы прокрутки.
Возвращает:
видимую область этой полосы прокрутки

setVisibleAmount

public void setVisibleAmount(int newAmount)
Задаёт видимую область этой полосы прокрутки.

Если полоса прокрутки используется для выбора диапазона значений, видимая область представляет диапазон значений, видимых в данный момент. Размер ползунка полосы прокрутки (также называемого бегунком или прокручиваемым блоком) обычно наглядно показывает соотношение видимой области и диапазона полосы прокрутки. Обратите внимание: в зависимости от платформы размер ползунка может не отображать визуально значение свойства видимой области.

Ползунок полосы прокрутки может не отображаться, если его нельзя перемещать (например, когда он занимает всю длину дорожки полосы прокрутки или когда полоса прокрутки отключена). Наличие или отсутствие ползунка не влияет на значение, возвращаемое методом getVisibleAmount.

Если переданное значение видимой области меньше one или больше текущего maximum - minimum, вместо него используется соответственно one или maximum - minimum.

Как правило, программе следует изменять значение полосы прокрутки только вызовом setValues. Метод setValues одновременно и синхронно задаёт минимальное, максимальное значения, видимую область и значение полосы прокрутки, обеспечивая их взаимную согласованность.

Определён в:
setVisibleAmount в интерфейсе Adjustable
Параметры:
newAmount - новая видимая область
Добавлено в версии:
1.1
См. также:
  • getVisibleAmount()
  • setValues(int, int, int, int)

setUnitIncrement

public void setUnitIncrement(int v)
Задаёт шаг прокрутки для этой полосы прокрутки.

Шаг прокрутки — это величина, на которую значение увеличивается или уменьшается, когда пользователь активирует область шага прокрутки, обычно с помощью мыши или клавиатуры, в результате чего полоса прокрутки получает событие изменения. Шаг прокрутки должен быть больше нуля. При попытке задать шаг меньше 1 вместо него будет установлено значение 1.

В некоторых операционных системах базовые элементы управления могут игнорировать это свойство.

Определён в:
setUnitIncrement в интерфейсе Adjustable
Параметры:
v - величина увеличения или уменьшения значения полосы прокрутки
Добавлено в версии:
1.1
См. также:
  • getUnitIncrement()

setLineIncrement

@Deprecated public void setLineIncrement(int v)
Устарело.
Начиная с JDK версии 1.1 заменено методом setUnitIncrement(int).
Задаёт шаг прокрутки для этой полосы прокрутки.
Параметры:
v - величина шага

getUnitIncrement

public int getUnitIncrement()
Возвращает шаг прокрутки этой полосы прокрутки.

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

В некоторых операционных системах базовые элементы управления могут игнорировать это свойство.

Определён в:
getUnitIncrement в интерфейсе Adjustable
Возвращает:
шаг прокрутки этой полосы прокрутки
Добавлено в версии:
1.1
См. также:
  • setUnitIncrement(int)

getLineIncrement

@Deprecated public int getLineIncrement()
Устарело.
Начиная с JDK версии 1.1 заменено методом getUnitIncrement().
Возвращает шаг прокрутки этой полосы прокрутки.
Возвращает:
шаг прокрутки этой полосы прокрутки

setBlockIncrement

public void setBlockIncrement(int v)
Задаёт шаг страницы для этой полосы прокрутки.

Шаг страницы — это величина, на которую значение увеличивается или уменьшается, когда пользователь активирует область шага страницы, обычно с помощью мыши или клавиатуры, в результате чего полоса прокрутки получает событие изменения. Шаг страницы должен быть больше нуля. При попытке задать шаг меньше 1 вместо него будет установлено значение 1.

Определён в:
setBlockIncrement в интерфейсе Adjustable
Параметры:
v - величина увеличения или уменьшения значения полосы прокрутки
Добавлено в версии:
1.1
См. также:
  • getBlockIncrement()

setPageIncrement

@Deprecated public void setPageIncrement(int v)
Устарело.
Начиная с JDK версии 1.1 заменено методом setBlockIncrement().
Задаёт шаг страницы для этой полосы прокрутки.
Параметры:
v - шаг страницы

getBlockIncrement

public int getBlockIncrement()
Возвращает шаг страницы этой полосы прокрутки.

Шаг страницы — это величина, на которую значение увеличивается или уменьшается, когда пользователь активирует область шага страницы, обычно с помощью мыши или клавиатуры, в результате чего полоса прокрутки получает событие изменения. Шаг страницы должен быть больше нуля.

Определён в:
getBlockIncrement в интерфейсе Adjustable
Возвращает:
шаг страницы этой полосы прокрутки
Добавлено в версии:
1.1
См. также:
  • setBlockIncrement(int)

getPageIncrement

@Deprecated public int getPageIncrement()
Устарело.
Начиная с JDK версии 1.1 заменено методом getBlockIncrement().
Возвращает шаг страницы этой полосы прокрутки.
Возвращает:
шаг страницы этой полосы прокрутки

setValues

public void setValues(int value, int visible, int minimum, int maximum)
Задаёт значения четырёх свойств этой полосы прокрутки: value, visibleAmount, minimum и maximum. Если переданные значения этих свойств противоречивы или некорректны, они будут изменены для обеспечения согласованности.

Этот метод одновременно и синхронно задаёт значения четырёх свойств полосы прокрутки, гарантируя их взаимную согласованность. Он обеспечивает выполнение следующих ограничений: maximum должно быть больше minimum, maximum - minimum не должно быть больше Integer.MAX_VALUE, visibleAmount должно быть больше нуля. visibleAmount не должно быть больше maximum - minimum, value не должно быть меньше minimum, а value не должно быть больше maximum - visibleAmount

Вызов этого метода не генерирует AdjustmentEvent.

Параметры:
value - позиция в текущем окне
visible - видимая область полосы прокрутки
minimum - минимальное значение полосы прокрутки
maximum - максимальное значение полосы прокрутки
См. также:
  • setMinimum(int)
  • setMaximum(int)
  • setVisibleAmount(int)
  • setValue(int)

getValueIsAdjusting

public boolean getValueIsAdjusting()
Возвращает true, если значение изменяется в результате действий пользователя.
Возвращает:
значение свойства valueIsAdjusting
Добавлено в версии:
1.4
См. также:
  • setValueIsAdjusting(boolean)

setValueIsAdjusting

public void setValueIsAdjusting(boolean b)
Задаёт свойство valueIsAdjusting.
Параметры:
b - новый статус выполнения изменения
Добавлено в версии:
1.4
См. также:
  • getValueIsAdjusting()

addAdjustmentListener

public void addAdjustmentListener(AdjustmentListener l)
Добавляет указанный слушатель изменения, чтобы он получал экземпляры AdjustmentEvent от этой полосы прокрутки. Если l равно null, исключение не выбрасывается и никаких действий не выполняется.

Подробные сведения о модели многопоточности AWT см. в разделе Проблемы многопоточности AWT.

Определён в:
addAdjustmentListener в интерфейсе Adjustable
Параметры:
l - слушатель изменения
Добавлено в версии:
1.1
См. также:
  • removeAdjustmentListener(AdjustmentListener)
  • getAdjustmentListeners()
  • AdjustmentEvent
  • AdjustmentListener

removeAdjustmentListener

public void removeAdjustmentListener(AdjustmentListener l)
Удаляет указанный слушатель изменения, чтобы он больше не получал экземпляры AdjustmentEvent от этой полосы прокрутки. Если l равно null, исключение не выбрасывается и никаких действий не выполняется.

Подробные сведения о модели многопоточности AWT см. в разделе Проблемы многопоточности AWT.

Определён в:
removeAdjustmentListener в интерфейсе Adjustable
Параметры:
l - слушатель изменения
Добавлено в версии:
1.1
См. также:
  • addAdjustmentListener(AdjustmentListener)
  • getAdjustmentListeners()
  • AdjustmentEvent
  • AdjustmentListener

getAdjustmentListeners

public AdjustmentListener[] getAdjustmentListeners()
Возвращает массив всех слушателей изменения, зарегистрированных для этой полосы прокрутки.
Возвращает:
все AdjustmentListener этой полосы прокрутки или пустой массив, если в данный момент слушатели изменения не зарегистрированы
Добавлено в версии:
1.4
См. также:
  • addAdjustmentListener(AdjustmentListener)
  • removeAdjustmentListener(AdjustmentListener)
  • AdjustmentEvent
  • AdjustmentListener

getListeners

public <T extends EventListener> T[] getListeners(Class<T> listenerType)
Возвращает массив всех объектов, зарегистрированных в данный момент как FooListeners для этого Scrollbar. FooListeners регистрируются с помощью метода addFooListener.

В качестве аргумента listenerType можно указать литерал класса, например FooListener.class. Например, можно запросить у Scrollbar c его слушателей мыши с помощью следующего кода:

MouseListener[] mls = (MouseListener[])(c.getListeners(MouseListener.class));
Если таких слушателей нет, этот метод возвращает пустой массив.
Переопределяет:
getListeners в классе Component
Параметры типа:
T — тип слушателей
Параметры:
listenerType — тип запрашиваемых слушателей; этот параметр должен указывать интерфейс, наследующий java.util.EventListener
Возвращает:
массив всех объектов, зарегистрированных как FooListeners для этого компонента, или пустой массив, если такие слушатели не добавлены
Исключения:
ClassCastException — если listenerType не указывает класс или интерфейс, реализующий java.util.EventListener
Начиная с версии:
1.3
См. также:
  • Component.getComponentListeners()
  • Component.getFocusListeners()
  • Component.getHierarchyListeners()
  • Component.getHierarchyBoundsListeners()
  • Component.getKeyListeners()
  • Component.getMouseListeners()
  • Component.getMouseMotionListeners()
  • Component.getMouseWheelListeners()
  • Component.getInputMethodListeners()
  • Component.getPropertyChangeListeners()

processEvent

protected void processEvent(AWTEvent e)
Обрабатывает события этой полосы прокрутки. Если событие является экземпляром AdjustmentEvent, вызывается метод processAdjustmentEvent. В противном случае вызывается метод processEvent суперкласса.

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

Переопределяет:
processEvent в классе Component
Параметры:
e — событие
Начиная с версии:
1.1
См. также:
  • AdjustmentEvent
  • processAdjustmentEvent(AdjustmentEvent)

processAdjustmentEvent

protected void processAdjustmentEvent(AdjustmentEvent e)
Обрабатывает события изменения, возникающие в этой полосе прокрутки, передавая их всем зарегистрированным объектам AdjustmentListener.

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

  • Объект AdjustmentListener зарегистрирован с помощью addAdjustmentListener.
  • События изменения включены с помощью enableEvents.

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

Параметры:
e — событие изменения
Начиная с версии:
1.1
См. также:
  • AdjustmentEvent
  • AdjustmentListener
  • addAdjustmentListener(AdjustmentListener)
  • Component.enableEvents(long)

paramString

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

getAccessibleContext

public AccessibleContext getAccessibleContext()
Возвращает AccessibleContext, связанный с этим Scrollbar. Для полос прокрутки AccessibleContext представлен в виде AccessibleAWTScrollBar. При необходимости создается новый экземпляр AccessibleAWTScrollBar.
Определено в:
getAccessibleContext в интерфейсе Accessible
Переопределяет:
getAccessibleContext в классе Component
Возвращает:
AccessibleAWTScrollBar, выполняющий роль AccessibleContext этого ScrollBar
Начиная с версии:
1.3

Сообщить об ошибке или предложить улучшение
Дополнительные справочные материалы по API и документацию для разработчиков см. в разделе Документация Java SE, содержащем более подробные описания, ориентированные на разработчиков, с концептуальными обзорами, определениями терминов, обходными решениями и рабочими примерами кода. Другие версии.
Java является товарным знаком или зарегистрированным товарным знаком Oracle и/или ее аффилированных лиц в США и других странах.
Авторские права © 1993, 2025, Oracle и/или ее аффилированные лица, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
Все права защищены. Использование регулируется условиями лицензии и политикой распространения документации.

© 1993, 2025, 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/25/docs/api/java.desktop/java/awt/Scrollbar.html

Spec-Zone.ru

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