Spec-Zone.ru › OpenJDK 21

Класс CheckboxMenuItem

java.lang.Object
java.awt.MenuComponent
java.awt.MenuItem
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
См. также:
  • 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()
Создаёт пэйр элемента флажка.
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 для получения подробной информации о модели потоков 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 для получения подробной информации о модели потоков 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. Слушатели регистрируются с помощью метода 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)

Обработка события ItemEvent

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

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

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

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

Параметры:
e - событие ItemEvent
С:
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. Для пунктов меню с флажком AccessibleContext принимает форму AccessibleAWTCheckboxMenuItem. Новый AccessibleAWTCheckboxMenuItem создается при необходимости.
Указано в:
getAccessibleContext в интерфейсе Accessible
Переопределяет:
getAccessibleContext в классе MenuItem
Возвращает:
AccessibleAWTCheckboxMenuItem, который служит AccessibleContext этого элемента CheckboxMenuItem
С:
1.3

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

Spec-Zone.ru

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