Класс 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, используемый для обеспечения стандартной поддержки доступности.

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

MenuItem.AccessibleAWTMenuItem

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

MenuComponent.AccessibleAWTMenuComponent

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

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

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

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

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

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

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

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

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

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

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

addNotify в классе MenuItem

См. также:

getState

public boolean getState()

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

Возвращает:

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

См. также:

setState

public void setState(boolean b)

Устанавливает состояние элемента меню типа флажок. Значение boolean 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()

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

Возвращает:

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

С тех пор:

1.4

См. также:

getListeners

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

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

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

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

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

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

getListeners в классе MenuItem

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

T - тип слушателей

Параметры:

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

Возвращает:

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

Возбуждает:

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.

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

Parameters:

e - событие изменения выбора

Since:

1.1

See Also:

paramString

public String paramString()

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

Overrides:: paramString в классе MenuItem
Returns:: строка параметров этого пункта меню флажка

getAccessibleContext

public AccessibleContext getAccessibleContext()

Получает AccessibleContext, связанный с этим элементом CheckboxMenuItem. Для элементов checkbox menu item AccessibleContext принимает вид AccessibleAWTCheckboxMenuItem. Новый AccessibleAWTCheckboxMenuItem создается при необходимости.

Specified by:: getAccessibleContext в интерфейсе Accessible
Overrides:: getAccessibleContext в классе MenuItem
Returns:: AccessibleAWTCheckboxMenuItem, который служит AccessibleContext для данного элемента CheckboxMenuItem
Since:: 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://download.java.net/java/early_access/jdk24/docs/api/java.desktop/java/awt/CheckboxMenuItem.html