Spec-Zone.ru › OpenJDK 21

Класс 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

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

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

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

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

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

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

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

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

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

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

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

NO_ORIENTATION

Поля, объявленные в интерфейсе java.awt.image.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()
Создаёт виджет полосы прокрутки.
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)
Устанавливает видимый объём этой полосы прокрутки.

Методы, объявленные в классе java.awt.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

Методы, объявленные в классе java.lang.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
Создаёт новую вертикальную полосу прокрутки. Стандартные свойства полосы прокрутки перечислены в следующей таблице:
Стандартные свойства полосы прокрутки
Свойство Описание Значение по умолчанию
orientation указывает, является ли полоса прокрутки вертикальной или горизонтальной Scrollbar.VERTICAL
value значение, которое контролирует положение пузырька полосы прокрутки 0
видимая область видимая область диапазона полосы прокрутки, обычно представленная размером пузырька полосы прокрутки 10
минимум минимальное значение полосы прокрутки 0
максимум максимальное значение полосы прокрутки 100
шаг изменения значения величина изменения значения при нажатии клавиш "Вверх" или "Вниз", или при щелчке стрелок полосы прокрутки 1
шаг изменения блока величина изменения значения при нажатии клавиш "Прокрутка страницы вверх" или "Прокрутка страницы вниз", или при щелчке области полосы прокрутки по обе стороны от пузырька 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) полосы прокрутки. Виджет позволяет изменять внешний вид полосы прокрутки без изменения её функциональности.
Переопределяет:
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.

Specified by:
setMaximum в интерфейсе Adjustable
Parameters:
newMaximum - новое максимальное значение для этого ползунка
Since:
1.1
See Also:
  • setValues(int, int, int, int)
  • setMinimum(int)

getVisibleAmount

public int getVisibleAmount()
Получает видимое количество этого ползунка.

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

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

Specified by:
getVisibleAmount в интерфейсе Adjustable
Returns:
видимое количество этого ползунка
Since:
1.1
See Also:
  • setVisibleAmount(int)

getVisible

@Deprecated public int getVisible()
Устарело.
С версии JDK 1.1 заменено на getVisibleAmount().
Возвращает видимое количество этого ползунка.
Returns:
видимое количество этого ползунка

setVisibleAmount

public void setVisibleAmount(int newAmount)
Устанавливает видимое количество этого ползунка.

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

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

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

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

Specified by:
setVisibleAmount в интерфейсе Adjustable
Parameters:
newAmount - новое видимое количество
Since:
1.1
See Also:
  • getVisibleAmount()
  • setValues(int, int, int, int)

setUnitIncrement

public void setUnitIncrement(int v)
Устанавливает единичный шаг увеличения для этого ползунка.

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

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

Specified by:
setUnitIncrement в интерфейсе Adjustable
Parameters:
v - величина увеличения или уменьшения значения ползунка
Since:
1.1
See Also:
  • getUnitIncrement()

setLineIncrement

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

getUnitIncrement

public int getUnitIncrement()
Получает единичный шаг увеличения для этого ползунка.

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

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

Specified by:
getUnitIncrement в интерфейсе Adjustable
Returns:
единичный шаг увеличения этого ползунка
Since:
1.1
See Also:
  • setUnitIncrement(int)

getLineIncrement

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

setBlockIncrement

public void setBlockIncrement(int v)
Устанавливает шаг блока для этого ползунка.

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

Specified by:
setBlockIncrement в интерфейсе Adjustable
Parameters:
v - величина увеличения или уменьшения значения ползунка
Since:
1.1
See Also:
  • getBlockIncrement()

setPageIncrement

@Deprecated public void setPageIncrement(int v)
Устарело.
С версии JDK 1.1 заменено на setBlockIncrement().
Устанавливает шаг блока для этого ползунка.
Parameters:
v - шаг блока

getBlockIncrement

public int getBlockIncrement()
Получает шаг блока для этого ползунка.

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

Specified by:
getBlockIncrement в интерфейсе Adjustable
Returns:
шаг блока этого ползунка
Since:
1.1
See Also:
  • setBlockIncrement(int)

getPageIncrement

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

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.

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

getValueIsAdjusting

public boolean getValueIsAdjusting()
Возвращает true, если значение изменяется в результате действий пользователя.
Returns:
значение свойства valueIsAdjusting
Since:
1.4
See Also:
  • setValueIsAdjusting(boolean)

setValueIsAdjusting

public void setValueIsAdjusting(boolean b)
Устанавливает свойство valueIsAdjusting.
Parameters:
b - новый статус изменения
Since:
1.4
See Also:
  • getValueIsAdjusting()

addAdjustmentListener

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

См. Вопросы многопоточности AWT для получения подробностей о модели многопоточности AWT.

Specified by:
addAdjustmentListener в интерфейсе Adjustable
Parameters:
l - слушатель изменения
Since:
1.1
See Also:
  • removeAdjustmentListener(java.awt.event.AdjustmentListener)
  • getAdjustmentListeners()
  • AdjustmentEvent
  • AdjustmentListener

removeAdjustmentListener

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

См. Вопросы многопоточности AWT для получения подробностей о модели многопоточности AWT.

Specified by:
removeAdjustmentListener в интерфейсе Adjustable
Parameters:
l - слушатель изменения
Since:
1.1
See Also:
  • addAdjustmentListener(java.awt.event.AdjustmentListener)
  • getAdjustmentListeners()
  • AdjustmentEvent
  • AdjustmentListener

getAdjustmentListeners

public AdjustmentListener[] getAdjustmentListeners()
Возвращает массив всех слушателей изменения, зарегистрированных на этой полосе прокрутки.
Returns:
все слушатели изменения этой полосы прокрутки или пустой массив, если слушатели изменения не зарегистрированы
Since:
1.4
See Also:
  • addAdjustmentListener(java.awt.event.AdjustmentListener)
  • removeAdjustmentListener(java.awt.event.AdjustmentListener)
  • AdjustmentEvent
  • AdjustmentListener

getListeners

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

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

MouseListener[] mls = (MouseListener[])(c.getListeners(MouseListener.class));
Если таких слушателей нет, этот метод возвращает пустой массив.
Overrides:
getListeners в классе Component
Type Parameters:
T - тип слушателей
Parameters:
listenerType - тип запрашиваемых слушателей; этот параметр должен указать интерфейс, унаследованный от java.util.EventListener
Returns:
массив всех объектов, зарегистрированных в качестве FooListener на этом компоненте, или пустой массив, если такие слушатели не были добавлены
Throws:
ClassCastException - если listenerType не указывает класс или интерфейс, реализующий java.util.EventListener
Since:
1.3
See Also:
  • 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, поведение не определено и может привести к исключению.

Overrides:
processEvent в классе Component
Parameters:
e - событие
Since:
1.1
See Also:
  • AdjustmentEvent
  • processAdjustmentEvent(java.awt.event.AdjustmentEvent)

processAdjustmentEvent

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

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

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

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

Parameters:
e - событие изменения
Since:
1.1
See Also:
  • AdjustmentEvent
  • AdjustmentListener
  • addAdjustmentListener(java.awt.event.AdjustmentListener)
  • Component.enableEvents(long)

paramString

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

getAccessibleContext

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

© 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/java/awt/Scrollbar.html

Spec-Zone.ru

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