Spec-Zone.ru › OpenJDK 17

Класс Checkbox

java.lang.Object
java.awt.Component
java.awt.Checkbox
Все реализованные интерфейсы:
ImageObserver, ItemSelectable, MenuContainer, Serializable, Accessible
public class Checkbox extends Component implements ItemSelectable, Accessible
Флажок — это графический компонент, который может находиться в состоянии "включено" (true) или "выключено" (false). Щелчок по флажку изменяет его состояние с "включено" на "выключено" или с "выключено" на "включено".

Следующий пример кода создаёт набор флажков в макетной сетке:

 setLayout(new GridLayout(3, 1));
 add(new Checkbox("one", null, true));
 add(new Checkbox("two"));
 add(new Checkbox("three"));
 

На этом изображении показаны флажки и макетная сетка, созданные этим примером кода:

The following context describes the
 graphic.

Кнопка с надписью one находится в состоянии "включено", а две другие — в состоянии "выключено". В этом примере, использующем класс GridLayout, состояния трёх флажков устанавливаются независимо.

В качестве альтернативы, несколько флажков можно сгруппировать под управлением одного объекта, используя класс CheckboxGroup. В группе флажков одновременно может быть активен только один флажок. Щелчок по флажку, чтобы включить его, переводит любой другой флажок в той же группе, который был включён, в состояние "выключено".

С тех пор как:
1.0
См. также:
  • GridLayout
  • CheckboxGroup
  • Сериализованная форма

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

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

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

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

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

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

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

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

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

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

Конструктор Описание
Checkbox()
Создаёт флажок со пустой строкой в качестве метки.
Checkbox(String label)
Создаёт флажок с заданной меткой.
Checkbox(String label, boolean state)
Создаёт флажок с заданной меткой и устанавливает заданное состояние.
Checkbox(String label, boolean state, CheckboxGroup group)
Создаёт флажок с заданной меткой, установлен в заданное состояние и в заданной группе флажков.
Checkbox(String label, CheckboxGroup group, boolean state)
Создаёт флажок с заданной меткой, в заданной группе флажков и установлен в заданное состояние.

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

Модификатор и тип Метод Описание
void addItemListener(ItemListener l)
Добавляет указанный обработчик событий элемента для получения событий элемента от этого флажка.
void addNotify()
Создаёт виртуальный объект флажка.
AccessibleContext getAccessibleContext()
Получает AccessibleContext, связанный с этим флажком.
CheckboxGroup getCheckboxGroup()
Определяет группу этого флажка.
ItemListener[] getItemListeners()
Возвращает массив всех обработчиков событий элемента, зарегистрированных на этом флажке.
String getLabel()
Получает метку этого флажка.
<T extends EventListener>
T[]
getListeners(Class<T> listenerType)
Возвращает массив всех объектов, текущих зарегистрированных в качестве FooListener по этому Checkbox.
Object[] getSelectedObjects()
Возвращает массив (длина 1) содержащий метку флажка или null, если флажок не выбран.
boolean getState()
Определяет, находится ли этот флажок в состоянии "включено" или "выключено".
protected String paramString()
Возвращает строку, представляющую состояние этого Checkbox.
protected void processEvent(AWTEvent e)
Обрабатывает события на этом флажке.
protected void processItemEvent(ItemEvent e)
Обрабатывает события элемента, происходящие на этом флажке, рассылая их всем зарегистрированным ItemListener объектам.
void removeItemListener(ItemListener l)
Удаляет указанный обработчик событий элемента, чтобы обработчик событий элемента больше не получал события элемента от этого флажка.
void setCheckboxGroup(CheckboxGroup g)
Устанавливает группу этого флажка в указанную группу флажков.
void setLabel(String label)
Устанавливает метку этого флажка, чтобы она была строкой аргумента.
void setState(boolean state)
Устанавливает состояние этого флажка в указанное состояние.

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

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

Checkbox

public Checkbox() throws HeadlessException
Создаёт флажок с пустой строкой в качестве метки. Состояние этого флажка установлено в «выключенное», и он не входит в какую-либо группу флажков.
Вызывает:
HeadlessException - если GraphicsEnvironment.isHeadless() возвращает true
См. также:
  • GraphicsEnvironment.isHeadless()

Checkbox

public Checkbox(String label) throws HeadlessException
Создаёт флажок со заданной меткой. Состояние этого флажка установлено в «выключенное», и он не входит в какую-либо группу флажков.
Параметры:
label - строковая метка для этого флажка, или null для отсутствия метки.
Вызывает:
HeadlessException - если GraphicsEnvironment.isHeadless возвращает true
См. также:
  • GraphicsEnvironment.isHeadless()

Checkbox

public Checkbox(String label, boolean state) throws HeadlessException
Создаёт флажок со заданной меткой и устанавливает заданное состояние. Этот флажок не входит в какую-либо группу флажков.
Параметры:
label - строковая метка для этого флажка, или null для отсутствия метки
state - начальное состояние этого флажка
Вызывает:
HeadlessException - если GraphicsEnvironment.isHeadless возвращает true
См. также:
  • GraphicsEnvironment.isHeadless()

Checkbox

public Checkbox(String label, boolean state, CheckboxGroup group) throws HeadlessException
Конструирует флажок со заданной меткой, установленным состоянием и в заданной группе флажков.
Параметры:
label - строковая метка для этого флажка, или null для отсутствия метки.
state - начальное состояние этого флажка.
group - группа флажков для этого флажка, или null для отсутствия группы.
Вызывает:
HeadlessException - если GraphicsEnvironment.isHeadless возвращает true
С:
1.1
См. также:
  • GraphicsEnvironment.isHeadless()

Checkbox

public Checkbox(String label, CheckboxGroup group, boolean state) throws HeadlessException
Создаёт флажок со заданной меткой, в заданной группе флажков и установленным состоянием.
Параметры:
label - строковая метка для этого флажка, или null для отсутствия метки.
group - группа флажков для этого флажка, или null для отсутствия группы.
state - начальное состояние этого флажка.
Вызывает:
HeadlessException - если GraphicsEnvironment.isHeadless возвращает true
С:
1.1
См. также:
  • GraphicsEnvironment.isHeadless()

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

addNotify

public void addNotify()
Создаёт виджет-виртуального флажка. Виртуальный флажок позволяет изменять вид флажка без изменения его функциональности.
Переопределяет:
addNotify в классе Component
См. также:
  • Component.getToolkit()

getLabel

public String getLabel()
Возвращает метку этого флажка.
Возвращает:
метку этого флажка, или null если у этого флажка нет метки.
См. также:
  • setLabel(String)

setLabel

public void setLabel(String label)
Устанавливает метку этого флажка на строку аргумента.
Параметры:
label - строка для установки новой метки, или null для отсутствия метки.
См. также:
  • getLabel()

getState

public boolean getState()
Определяет, находится ли этот флажок в состоянии «вкл.» или «выкл.». Логическое значение true указывает состояние «вкл.», а false указывает состояние «выкл.».
Возвращает:
состояние этого флажка в виде логического значения
См. также:
  • setState(boolean)

setState

public void setState(boolean state)
Устанавливает состояние этого флажка в указанное состояние. Логическое значение true указывает состояние «вкл.», а false указывает состояние «выкл.».

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

Параметры:
state - логическое состояние флажка
См. также:
  • getState()

getSelectedObjects

public Object[] getSelectedObjects()
Возвращает массив (длины 1) содержащий метку флажка или null, если флажок не выбран.
Определено в:
getSelectedObjects в интерфейсе ItemSelectable
Возвращает:
список выбранных объектов, или null
См. также:
  • ItemSelectable

getCheckboxGroup

public CheckboxGroup getCheckboxGroup()
Определяет группу этого флажка.
Возвращает:
группу этого флажка, или null если флажок не входит в группу флажков.
См. также:
  • setCheckboxGroup(CheckboxGroup)

setCheckboxGroup

public void setCheckboxGroup(CheckboxGroup g)
Устанавливает группу этого флажка в указанную группу флажков. Если этот флажок уже входит в другую группу, он сначала удаляется из этой группы.

Если состояние этого флажка true и в новой группе уже выбран флажок, состояние этого флажка меняется на false. Если состояние этого флажка true и в новой группе нет выбранного флажка, этот флажок становится выбранным флажком для новой группы и его состояние true.

Параметры:
g - новая группа флажков, или null для удаления этого флажка из любой группы флажков
См. также:
  • getCheckboxGroup()

addItemListener

public void addItemListener(ItemListener l)
Добавляет указанного слушателя событий элементов для получения событий элементов от этого флажка. События элементов отправляются слушателям в ответ на действия пользователя, но не в ответ на вызовы setState(). Если l равно null, исключение не выброшено, и никаких действий не выполняется.

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

Определено в:
addItemListener в интерфейсе ItemSelectable
Параметры:
l - слушатель событий элементов
С:
1.1
См. также:
  • removeItemListener(java.awt.event.ItemListener)
  • getItemListeners()
  • setState(boolean)
  • ItemEvent
  • ItemListener

removeItemListener

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

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

Определено в:
removeItemListener в интерфейсе ItemSelectable
Параметры:
l - слушатель событий элементов
С:
1.1
См. также:
  • addItemListener(java.awt.event.ItemListener)
  • getItemListeners()
  • ItemEvent
  • ItemListener

getItemListeners

public ItemListener[] getItemListeners()
Возвращает массив всех зарегистрированных слушателей событий изменения состояния для этой галочки.
Возвращает:
все слушатели событий изменения состояния этой галочки или пустой массив, если слушатели не зарегистрированы
С момента:
1.4
См. также:
  • addItemListener(java.awt.event.ItemListener)
  • removeItemListener(java.awt.event.ItemListener)
  • ItemEvent
  • ItemListener

getListeners

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

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

ItemListener[] ils = (ItemListener[])(c.getListeners(ItemListener.class));
Если такие слушатели отсутствуют, этот метод возвращает пустой массив.
Переопределяет:
getListeners в классе Component
Параметры типа:
T - тип слушателей
Параметры:
listenerType - тип запрашиваемых слушателей; этот параметр должен указывать интерфейс, унаследованный от java.util.EventListener
Возвращает:
массив всех объектов, зарегистрированных в качестве слушателей для этой галочки, или пустой массив, если такие слушатели не были добавлены
Исключения:
ClassCastException - если listenerType не задаёт класс или интерфейс, реализующий java.util.EventListener
С момента:
1.3
См. также:
  • getItemListeners()

processEvent

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

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

Переопределяет:
processEvent в классе Component
Параметры:
e - событие
С момента:
1.1
См. также:
  • ItemEvent
  • processItemEvent(java.awt.event.ItemEvent)

processItemEvent

protected void processItemEvent(ItemEvent e)
Обрабатывает события изменения состояния для этой галочки, рассылая их всем зарегистрированным слушателям.

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

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

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

Параметры:
e - событие изменения состояния
С момента:
1.1
См. также:
  • ItemEvent
  • ItemListener
  • addItemListener(java.awt.event.ItemListener)
  • Component.enableEvents(long)

paramString

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

getAccessibleContext

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

© 1993, 2021, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/17/docs/api/java.desktop/java/awt/Checkbox.html

Spec-Zone.ru

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