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

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

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

MenuComponent.AccessibleAWTMenuComponent

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

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

Конструктор	Описание
`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

Модификатор и тип	Метод	Описание
`void`	`addActionListener(ActionListener l)`	Добавляет указанный прослушиватель действий для получения событий действий от этого пункта меню.
`void`	`deleteShortcut()`	Удаляет все объекты `MenuShortcut`, связанные с этим пунктом меню.
`void`	`disable()`	Устарел. Начиная с JDK версии 1.1 заменен на `setEnabled(boolean)`.
`protected final void`	`disableEvents(long eventsToDisable)`	Отключает доставку этому пункту меню событий, определенных указанной маской событий.
`void`	`enable()`	Устарел. Начиная с JDK версии 1.1 заменен на `setEnabled(boolean)`.
`void`	`enable(boolean b)`	Устарел. Начиная с JDK версии 1.1 заменен на `setEnabled(boolean)`.
`protected final void`	`enableEvents(long eventsToEnable)`	Включает доставку этому пункту меню событий, определяемых указанной маской событий.
`String`	`getActionCommand()`	Возвращает имя команды события действия, создаваемого этим пунктом меню.
`ActionListener[]`	`getActionListeners()`	Возвращает массив всех прослушивателей действий, зарегистрированных для этого пункта меню.
`String`	`getLabel()`	Возвращает метку этого пункта меню.
`MenuShortcut`	`getShortcut()`	Возвращает объект `MenuShortcut`, связанный с этим пунктом меню.
`boolean`	`isEnabled()`	Проверяет, включен ли этот пункт меню.
`protected void`	`processActionEvent(ActionEvent e)`	Обрабатывает события действий, возникающие для этого пункта меню, отправляя их всем зарегистрированным объектам `ActionListener`.
`void`	`removeActionListener(ActionListener l)`	Удаляет указанный прослушиватель действий, чтобы он больше не получал события действий от этого пункта меню.
`void`	`setActionCommand(String command)`	Задает имя команды события действия, создаваемого этим пунктом меню.
`void`	`setEnabled(boolean b)`	Задает, можно ли выбирать этот пункт меню.
`void`	`setLabel(String label)`	Задает для этого пункта меню указанную метку.
`void`	`setShortcut(MenuShortcut s)`	Задает объект `MenuShortcut`, связанный с этим пунктом меню.

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

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

Модификатор и тип	Метод	Описание
`final void`	`dispatchEvent(AWTEvent e)`	Передает событие этому компоненту или одному из его подкомпонентов.
`Font`	`getFont()`	Возвращает шрифт, используемый для этого компонента меню.
`String`	`getName()`	Возвращает имя компонента меню.
`MenuContainer`	`getParent()`	Возвращает родительский контейнер этого компонента меню.
`protected final Object`	`getTreeLock()`	Возвращает объект блокировки этого компонента (объект, которому принадлежит монитор синхронизации потоков) для операций с деревом компонентов и компоновкой AWT.
`boolean`	`postEvent(Event evt)`	Устарел. Начиная с JDK версии 1.1 заменен на `dispatchEvent`.
`void`	`removeNotify()`	Удаляет peer-объект компонента меню.
`void`	`setFont(Font f)`	Задает для этого компонента меню указанный шрифт.
`void`	`setName(String name)`	Задает для компонента указанную строку в качестве имени.
`String`	`toString()`	Возвращает строковое представление этого компонента меню.

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

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

Модификатор и тип	Метод	Описание
`protected Object`	`clone()`	Создает и возвращает копию этого объекта.
`boolean`	`equals(Object obj)`	Указывает, равен ли другой объект этому объекту.
`protected void`	`finalize()`	Устарел, планируется удаление: этот элемент API может быть удален в будущей версии. Финализация устарела и может быть удалена в одном из будущих выпусков.
`final Class<?>`	`getClass()`	Возвращает класс времени выполнения этого `Object`.
`int`	`hashCode()`	Возвращает хеш-код этого объекта.
`final void`	`notify()`	Пробуждает один поток, ожидающий на мониторе этого объекта.
`final void`	`notifyAll()`	Пробуждает все потоки, ожидающие на мониторе этого объекта.
`final void`	`wait()`	Приостанавливает текущий поток до его пробуждения, обычно в результате вызова notify или interrupt.
`final void`	`wait(long timeoutMillis)`	Приостанавливает текущий поток до его пробуждения, обычно в результате вызова notify или interrupt, либо до истечения заданного промежутка реального времени.
`final void`	`wait(long timeoutMillis, int nanos)`	Приостанавливает текущий поток до его пробуждения, обычно в результате вызова notify или interrupt, либо до истечения заданного промежутка реального времени.

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

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.

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

Параметры:

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.