Spec-Zone.ru › OpenJDK 8

Класс 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. Если вы используете полосу прокрутки для этой цели, вы, вероятно, столкнётесь с проблемами отрисовки, обработки клавиш, размеров и позиционирования.

См. также:
AdjustmentEvent, AdjustmentListener, Serialized Form

Вложенные классы

Модификатор и тип Класс и описание
protected class  Scrollbar.AccessibleAWTScrollBar

Этот класс реализует поддержку доступности для класса Scrollbar.

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

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

Поля

Модификатор и тип Поле и описание
static int HORIZONTAL

Константа, обозначающая горизонтальную полосу прокрутки.

static 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()

Создает виджет-представитель 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)

Устанавливает видимую область этой полосы прокрутки.

Методы, унаследованные от класса 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, getPeer, 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, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, revalidate, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeys, setFocusTraversalKeysEnabled, setFont, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, 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

Константа, указывающая на горизонтальную полосу прокрутки.

См. также:
Constant Field Values

VERTICAL

public static final int VERTICAL

Константа, указывающая на вертикальную полосу прокрутки.

См. также:
Constant Field Values

Конструкторы

Scrollbar

public Scrollbar()
          throws HeadlessException

Создает новую вертикальную полосу прокрутки. Свойства полосы прокрутки по умолчанию перечислены в следующей таблице:

Property Description Default Value
orientation указывает, является ли полоса прокрутки вертикальной
или горизонтальной
Scrollbar.VERTICAL
value значение, которое управляет положением
пузырька полосы прокрутки
0
visible amount видимая часть диапазона полосы прокрутки,
как правило, представленная размером
пузырька полосы прокрутки
10
minimum минимальное значение полосы прокрутки 0
maximum максимальное значение полосы прокрутки 100
unit increment величина изменения значения при нажатии
клавиши «Вверх» или «Вниз»,
или при нажатии на стрелки в конце полосы прокрутки
1
block increment величина изменения значения при нажатии
клавиши «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()

Создает одноранговый объект для Scrollbar. Одноранговый объект позволяет изменять внешний вид 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 не является допустимым значением
С:
JDK1.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 - новое минимальное значение для этой полосы прокрутки
С:
JDK1.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 - новое максимальное значение для этой полосы прокрутки
С:
JDK1.1
См. также:
setValues(int, int, int, int), setMinimum(int)

getVisibleAmount

public int getVisibleAmount()

Получает видимую часть этого ползунка прокрутки.

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

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

Указано в:
getVisibleAmount в интерфейсе Adjustable
Возвращает:
видимую часть этого ползунка прокрутки
С:
JDK1.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 - новое значение видимой части
С:
JDK1.1
См. также:
getVisibleAmount(), setValues(int, int, int, int)

setUnitIncrement

public void setUnitIncrement(int v)

Устанавливает шаг единицы для этого ползунка прокрутки.

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

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

Указано в:
setUnitIncrement в интерфейсе Adjustable
Параметры:
v - значение, на которое увеличивать или уменьшать значение ползунка прокрутки
С:
JDK1.1
См. также:
getUnitIncrement()

setLineIncrement

@Deprecated
public void setLineIncrement(int v)

Устарело. Начиная с JDK версии 1.1, заменено на setUnitIncrement(int).

getUnitIncrement

public int getUnitIncrement()

Получает шаг единицы для этого ползунка прокрутки.

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

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

Указано в:
getUnitIncrement в интерфейсе Adjustable
Возвращает:
шаг единицы этого ползунка прокрутки
С:
JDK1.1
См. также:
setUnitIncrement(int)

getLineIncrement

@Deprecated
public int getLineIncrement()

Устарело. Начиная с JDK версии 1.1, заменено на getUnitIncrement().

setBlockIncrement

public void setBlockIncrement(int v)

Устанавливает шаг блока для этого ползунка прокрутки.

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

Указано в:
setBlockIncrement в интерфейсе Adjustable
Параметры:
v - значение, на которое увеличивать или уменьшать значение ползунка прокрутки
С:
JDK1.1
См. также:
getBlockIncrement()

setPageIncrement

@Deprecated
public void setPageIncrement(int v)

Устарело. Начиная с JDK версии 1.1, заменено на setBlockIncrement().

getBlockIncrement

public int getBlockIncrement()

Получает шаг блока этого ползунка прокрутки.

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

Указано в:
getBlockIncrement в интерфейсе Adjustable
Возвращает:
шаг блока этого ползунка прокрутки
С:
JDK1.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 Threading Issues для получения подробностей о модели потоков AWT.

Указано в:
addAdjustmentListener в интерфейсе Adjustable
Параметры:
l - слушатель корректировок
С:
JDK1.1
См. также:
removeAdjustmentListener(java.awt.event.AdjustmentListener), getAdjustmentListeners(), AdjustmentEvent, AdjustmentListener

removeAdjustmentListener

public void removeAdjustmentListener(AdjustmentListener l)

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

См. AWT Threading Issues для получения подробностей о модели потоков AWT.

Указано:
removeAdjustmentListener в интерфейсе Adjustable
Параметры:
l - слушатель изменения
С:
JDK1.1
См. также:
addAdjustmentListener(java.awt.event.AdjustmentListener), getAdjustmentListeners(), AdjustmentEvent, AdjustmentListener

getAdjustmentListeners

public AdjustmentListener[] getAdjustmentListeners()

Возвращает массив всех слушателей изменений, зарегистрированных на этой полосе прокрутки.

Возвращает:
все слушатели этой полосы прокрутки или пустой массив, если слушатели изменений не зарегистрированы
С:
1.4
См. также:
addAdjustmentListener(java.awt.event.AdjustmentListener), removeAdjustmentListener(java.awt.event.AdjustmentListener), AdjustmentEvent, AdjustmentListener

getListeners

public <T extends EventListener> T[] getListeners(Class<T> listenerType)

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

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

MouseListener[] mls = (MouseListener[])(c.getListeners(MouseListener.class));
Если такие слушатели не существуют, этот метод возвращает пустой массив.
Переопределяет:
getListeners в классе Component
Параметры:
listenerType - тип запрашиваемых слушателей; этот параметр должен указать интерфейс, унаследованный от java.util.EventListener
Возвращает:
массив всех объектов, зарегистрированных как слушатели на этом компоненте, или пустой массив, если такие слушатели не были добавлены
Исключения:
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 - событие
С:
JDK1.1
См. также:
AdjustmentEvent, processAdjustmentEvent(java.awt.event.AdjustmentEvent)

processAdjustmentEvent

protected void processAdjustmentEvent(AdjustmentEvent e)

Обрабатывает события изменения, происходящие на этой полосе прокрутки, рассылая их всем зарегистрированным объектам-слушателям изменений.

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

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

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

Параметры:
e - событие изменения
С:
JDK1.1
См. также:
AdjustmentEvent, AdjustmentListener, addAdjustmentListener(java.awt.event.AdjustmentListener), Component.enableEvents(long)

paramString

protected String paramString()

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

Переопределяет:
paramString в классе Component
Возвращает:
строку параметров этой полосы прокрутки

getAccessibleContext

public AccessibleContext getAccessibleContext()

Получает AccessibleContext , связанный с этой полосой прокрутки. Для полос прокрутки AccessibleContext представлен в виде AccessibleAWTScrollBar . Новый экземпляр AccessibleAWTScrollBar создаётся при необходимости.

Указано:
getAccessibleContext в интерфейсе Accessible
Переопределяет:
getAccessibleContext в классе Component
Возвращает:
объект AccessibleAWTScrollBar, который служит AccessibleContext этой полосы прокрутки
С:
1.3

© 1993, 2020, 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.

Spec-Zone.ru

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