Класс 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
См. также:
ItemEvent, ItemListener, Сериализованная форма

Вложенные классы

Модификатор и тип Класс Описание
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()

Создаёт виджет (peer) элемента с флажком.
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
См. также:
GraphicsEnvironment.isHeadless()

CheckboxMenuItem

public CheckboxMenuItem(String label)
                 throws HeadlessException

Создаёт элемент меню типа флажок с заданной меткой. Состояние элемента по умолчанию установлено в «выключено».

Параметры:
label - строковая метка для элемента меню типа флажок, или null для элемента меню без метки.
Исключения:
HeadlessException - если GraphicsEnvironment.isHeadless() возвращает true
См. также:
GraphicsEnvironment.isHeadless()

CheckboxMenuItem

public CheckboxMenuItem(String label,
                        boolean state)
                 throws HeadlessException

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

Параметры:
label - строковая метка для элемента меню типа флажок, или null для элемента меню без метки.
state - начальное состояние элемента меню, где true означает «включено», а false означает «выключено».
Исключения:
HeadlessException - если GraphicsEnvironment.isHeadless() возвращает true
С момента:
1.1
См. также:
GraphicsEnvironment.isHeadless()

Методы

addNotify

public void addNotify()

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

Переопределяет:
addNotify в классе MenuItem
См. также:
Component.getToolkit()

getState

public boolean getState()

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

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

setState

public void setState(boolean b)

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

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

Параметры:
b - true если элемент меню типа флажок включен, в противном случае false
См. также:
getState()

getSelectedObjects

public Object[] getSelectedObjects()

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

Определяется в:
getSelectedObjects в интерфейсе ItemSelectable
Возвращает:
список выбранных объектов, или null
См. также:
ItemSelectable

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)

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

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

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

processEvent

protected void processEvent(AWTEvent e)

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

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

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

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

processItemEvent

protected void processItemEvent(ItemEvent e)

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

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

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

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

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

paramString

public String paramString()

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

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

getAccessibleContext

public AccessibleContext getAccessibleContext()

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

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

© 1993, 2020, 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/11/docs/api/java.desktop/java/awt/CheckboxMenuItem.html

Spec-Zone .ru
спецификации, руководства, описания, API