Spec-Zone.ru › OpenJDK 25

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

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

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

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

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

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Поля, объявленные в интерфейсе 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 с указанной меткой, задает ему указанное состояние и помещает его в указанную группу флажков.
Checkbox(String label, CheckboxGroup group, boolean state)
Создает флажок с указанной меткой, помещает его в указанную группу флажков и задает указанное состояние.

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

Модификатор и тип Метод Описание
void addItemListener(ItemListener l)
Добавляет указанный прослушиватель элементов для получения событий элементов от этого флажка.
void addNotify()
Создает peer-объект Checkbox.
AccessibleContext getAccessibleContext()
Возвращает AccessibleContext, связанный с этим Checkbox.
CheckboxGroup getCheckboxGroup()
Определяет группу этого флажка.
ItemListener[] getItemListeners()
Возвращает массив всех прослушивателей элементов, зарегистрированных для этого флажка.
String getLabel()
Возвращает метку этого флажка.
<T extends EventListener>
T[]
getListeners(Class<T> listenerType)
Возвращает массив всех объектов, зарегистрированных в данный момент как FooListeners для этого 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)
Задает для этого флажка указанное состояние.

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

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

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
Создает Checkbox с указанной меткой, задает ему указанное состояние и помещает его в указанную группу флажков.
Параметры:
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()
Создает peer-объект Checkbox. Peer-объект позволяет изменить внешний вид Checkbox, не меняя его функциональность.
Переопределяет:
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 см. в разделе Проблемы многопоточности AWT.

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

removeItemListener

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

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

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

getItemListeners

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

getListeners

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

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

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

processEvent

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

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

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

processItemEvent

protected void processItemEvent(ItemEvent e)
Обрабатывает события элементов, возникающие на этом флажке, передавая их зарегистрированным объектам ItemListener.

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

  • Зарегистрирован объект ItemListener с помощью addItemListener.
  • События элементов включены с помощью enableEvents.

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

Параметры:
e — событие элемента
Начиная с:
1.1
См. также:
  • ItemEvent
  • ItemListener
  • addItemListener(ItemListener)
  • Component.enableEvents(long)

paramString

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

getAccessibleContext

public AccessibleContext getAccessibleContext()
Возвращает AccessibleContext, связанный с этим Checkbox. Для флажков AccessibleContext имеет вид AccessibleAWTCheckbox. При необходимости создается новый AccessibleAWTCheckbox.
Определен в:
getAccessibleContext в интерфейсе Accessible
Переопределяет:
getAccessibleContext в классе Component
Возвращает:
AccessibleAWTCheckbox, выступающий в качестве AccessibleContext этого Checkbox
Начиная с:
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/Checkbox.html

Spec-Zone.ru

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