Класс CheckboxMenuItem

java.awt.CheckboxMenuItem

Все реализуемые интерфейсы:: ItemSelectable, Serializable, Accessible

public class CheckboxMenuItem extends MenuItem implements ItemSelectable, Accessible

Этот класс представляет флажок, который можно включить в меню. При выборе флажка в меню его состояние меняется с «включено» на «выключено» или с «выключено» на «включено».

На следующем рисунке показано меню, содержащее экземпляр CheckBoxMenuItem:

Menu labeled Examples, containing items Basic, Simple, Check, and More
Examples. The Check item is a CheckBoxMenuItem instance, in the off state.

Элемент с меткой Check показывает флажок меню в состоянии «выключено».

При выборе элемента-флажка AWT отправляет этому элементу событие элемента. Поскольку это событие является экземпляром ItemEvent, метод processEvent анализирует событие и передает его методу processItemEvent. Последний метод направляет событие всем объектам ItemListener, которые зарегистрировали интерес к событиям элементов, создаваемым этим элементом меню.

Начиная с версии:

1.0

См. также:

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

Модификатор и тип	Класс	Описание
`protected class`	`CheckboxMenuItem.AccessibleAWTCheckboxMenuItem`	Внутренний класс CheckboxMenuItem, обеспечивающий поддержку специальных возможностей по умолчанию.

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

MenuItem.AccessibleAWTMenuItem

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

MenuComponent.AccessibleAWTMenuComponent

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

Конструктор	Описание
`CheckboxMenuItem()`	Создает элемент-флажок меню с пустой меткой.
`CheckboxMenuItem(String label)`	Создает элемент-флажок меню с указанной меткой.
`CheckboxMenuItem(String label, boolean state)`	Создает элемент-флажок меню с указанной меткой и состоянием.

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

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

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

addActionListener, deleteShortcut, disable, disableEvents, enable, enable, enableEvents, getActionCommand, getActionListeners, getLabel, getShortcut, isEnabled, processActionEvent, removeActionListener, setActionCommand, setEnabled, setLabel, setShortcut

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

dispatchEvent, getFont, getName, getParent, getTreeLock, postEvent, removeNotify, setFont, setName, toString

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

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

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

CheckboxMenuItem

public CheckboxMenuItem() throws HeadlessException

Создает элемент-флажок меню с пустой меткой. Изначально элемент находится в выключенном состоянии.

Вызывает исключение:

HeadlessException — если GraphicsEnvironment.isHeadless() возвращает true

Начиная с версии:

1.1

См. также:

CheckboxMenuItem

public CheckboxMenuItem(String label) throws HeadlessException

Создает элемент-флажок меню с указанной меткой. Изначально элемент находится в выключенном состоянии.

Параметры:

label — строковая метка элемента-флажка меню или null для элемента меню без метки.

Вызывает исключение:

HeadlessException — если GraphicsEnvironment.isHeadless() возвращает true

См. также:

CheckboxMenuItem

public CheckboxMenuItem(String label, boolean state) throws HeadlessException

Создает элемент-флажок меню с указанной меткой и состоянием.

Параметры:

label — строковая метка элемента-флажка меню или null для элемента меню без метки.

state — начальное состояние элемента меню, где true означает «включено», а false — «выключено».

Вызывает исключение:

HeadlessException — если GraphicsEnvironment.isHeadless() возвращает true

Начиная с версии:

1.1

См. также:

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

addNotify

public void addNotify()

Создает peer-объект элемента-флажка. Этот peer-объект позволяет изменить внешний вид элемента-флажка, не меняя его функциональность. Большинство приложений не вызывают этот метод напрямую.

Переопределяет:

addNotify в классе MenuItem

См. также:

getState

public boolean getState()

Определяет, находится ли этот элемент-флажок меню во включенном или выключенном состоянии.

Возвращает:

состояние этого элемента-флажка меню, где true означает «включено», а false — «выключено»

См. также:

setState

public void setState(boolean b)

Устанавливает для этого элемента-флажка меню указанное состояние. Логическое значение true означает «включено», а false — «выключено».

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

Параметры:

b — true, если флажок меню установлен, иначе false

См. также:

getSelectedObjects

public Object[] getSelectedObjects()

Возвращает массив (длиной 1), содержащий метку элемента-флажка меню, или null, если флажок не установлен.

Определено в:

getSelectedObjects в интерфейсе ItemSelectable

Возвращает:

список выбранных объектов или null

См. также:

addItemListener

public void addItemListener(ItemListener l)

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

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

Определено в:

addItemListener в интерфейсе ItemSelectable

Параметры:

l — прослушиватель элементов

Начиная с версии:

1.1

См. также:

removeItemListener

public void removeItemListener(ItemListener l)

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

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

Определено в:

removeItemListener в интерфейсе ItemSelectable

Параметры:

l — прослушиватель элементов

Начиная с версии:

1.1

См. также:

getItemListeners

public ItemListener[] getItemListeners()

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

Возвращает:

все ItemListeners этого элемента-флажка меню или пустой массив, если в данный момент не зарегистрировано ни одного прослушивателя элементов

Начиная с версии:

1.4

См. также:

getListeners

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

Возвращает массив всех объектов, зарегистрированных в данный момент как FooListeners для этого CheckboxMenuItem. Регистрация FooListeners выполняется с помощью метода addFooListener.

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

ItemListener[] ils = (ItemListener[])(c.getListeners(ItemListener.class));

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

Переопределяет:

getListeners в классе MenuItem

Параметры типа:

T — тип прослушивателей

Параметры:

listenerType — тип запрашиваемых прослушивателей; этот параметр должен указывать интерфейс, производный от java.util.EventListener

Возвращает:

массив всех объектов, зарегистрированных как FooListeners для этого элемента-флажка меню, или пустой массив, если такие прослушиватели не добавлены

Вызывает исключение:

ClassCastException — если listenerType не указывает класс или интерфейс, реализующий java.util.EventListener

Начиная с версии:

1.3

См. также:

processEvent

protected void processEvent(AWTEvent e)

Обрабатывает события этого элемента-флажка меню. Если событие является экземпляром ItemEvent, этот метод вызывает метод processItemEvent. Если событие не является событием элемента, метод вызывает processEvent в суперклассе.

Элементы-флажки меню в настоящее время поддерживают только события элементов.

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

Переопределяет:

processEvent в классе MenuItem

Параметры:

e — событие

Начиная с версии:

1.1

См. также:

processItemEvent

protected void processItemEvent(ItemEvent e)

Обрабатывает события элементов, возникающие для этого элемента-флажка меню, передавая их всем зарегистрированным объектам ItemListener.

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

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

Параметры:

e — событие элемента

Начиная с версии:

1.1

См. также:

paramString

public String paramString()

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

Переопределяет:: paramString в классе MenuItem
Возвращает:: строка параметров этого элемента-флажка меню

getAccessibleContext

public AccessibleContext getAccessibleContext()

Возвращает AccessibleContext, связанный с этим CheckboxMenuItem. Для элементов-флажков меню AccessibleContext представлен в виде AccessibleAWTCheckboxMenuItem. При необходимости создается новый AccessibleAWTCheckboxMenuItem.

Определено в:: getAccessibleContext в интерфейсе Accessible
Переопределяет:: getAccessibleContext в классе MenuItem
Возвращает:: AccessibleAWTCheckboxMenuItem, выполняющий роль AccessibleContext этого CheckboxMenuItem
Начиная с версии:: 1.3

© 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/CheckboxMenuItem.html