Spec-Zone.ru › OpenJDK 8

Класс 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 , которые зарегистрировали интерес к событиям элементов, генерируемым этим элементом меню.

С момента:
JDK1.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, getPeer, 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
С тех пор:
JDK1.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
С тех пор:
JDK1.1
См. также:
GraphicsEnvironment.isHeadless()

Методы

addNotify

public void addNotify()

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

Переопределяет:
addNotify в классе MenuItem
См. также:
Toolkit.createCheckboxMenuItem(java.awt.CheckboxMenuItem), 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
См. также:
ItemSelectable

addItemListener

public void addItemListener(ItemListener l)

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

См. Проблемы с потоками AWT для получения подробной информации о модели потоков AWT.

Определено в:
addItemListener в интерфейсе ItemSelectable
Параметры:
l - обработчик событий элементов
С тех пор:
JDK1.1
См. также:
removeItemListener(java.awt.event.ItemListener), getItemListeners(), setState(boolean), ItemEvent, ItemListener

removeItemListener

public void removeItemListener(ItemListener l)

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

См. Проблемы с потоками AWT для получения подробной информации о модели потоков AWT.

Определено в:
removeItemListener в интерфейсе ItemSelectable
Параметры:
l - обработчик событий элементов
С тех пор:
JDK1.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
Параметры:
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 - событие
С тех пор:
JDK1.1
См. также:
ItemEvent, processItemEvent(java.awt.event.ItemEvent)

processItemEvent

protected void processItemEvent(ItemEvent e)

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

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

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

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

Параметры:
e - событие элемента
С тех пор:
JDK1.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, 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.

Spec-Zone.ru

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