Spec-Zone.ru › OpenJDK 21

Класс MenuItem

java.lang.Object
java.awt.MenuComponent
java.awt.MenuItem
Все реализованные интерфейсы:
Serializable, Accessible
Прямые известные подклассы:
CheckboxMenuItem, Menu 
public class MenuItem extends MenuComponent implements Accessible
Все элементы меню должны принадлежать классу MenuItem, или одному из его подклассов.

По умолчанию MenuItem представляет собой простой элемент меню с меткой.

На этой картинке показана строка меню с пятью элементами: The following text describes this graphic.
Два первых элемента — это простые элементы меню с метками "Basic" и "Simple". После них идет разделитель, который сам по себе является элементом меню, созданным с меткой "-". Далее следует экземпляр CheckboxMenuItem с меткой "Check". Последний элемент меню — подменю с меткой "More Examples", и это подменю является экземпляром Menu.

При выборе элемента меню AWT отправляет событие действия элементу меню. Поскольку событие является экземпляром ActionEvent, метод processEvent проверяет событие и передает его дальше processActionEvent. Последний метод перенаправляет событие любым ActionListener объектам, которые зарегистрировали интерес к событиям действий, сгенерированным этим элементом меню.

Обратите внимание, что подкласс Menu переопределяет это поведение и не отправляет никакого события в фрейм, пока один из его подэлементов не будет выбран.

См. также:
  • Сериализованная форма

Краткое описание вложенных классов

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

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

MenuComponent.AccessibleAWTMenuComponent

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

Конструктор Описание
MenuItem()
Создает новый MenuItem с пустой меткой и без сочетания клавиш.
MenuItem(String label)
Создает новый MenuItem с заданной меткой и без сочетания клавиш.
MenuItem(String label, MenuShortcut s)
Создает элемент меню с ассоциированным сочетанием клавиш.

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

Модификатор и тип Метод Описание
void addActionListener(ActionListener l)
Добавляет указанный обработчик действий для получения событий действий от этого элемента меню.
void addNotify()
Создает объект-представителя элемента меню.
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)
Включает доставку событий в этот элемент меню для событий, определенных параметром маски событий.
AccessibleContext getAccessibleContext()
Получает AccessibleContext, связанный с этим элементом MenuItem.
String getActionCommand()
Получает имя команды события действия, которое генерируется этим элементом меню.
ActionListener[] getActionListeners()
Возвращает массив всех обработчиков действий, зарегистрированных на этом элементе меню.
String getLabel()
Получает метку для этого элемента меню.
<T extends EventListener>
T[]		 getListeners(Class<T> listenerType)
Возвращает массив всех объектов, в настоящее время зарегистрированных как FooListener для этого MenuItem.
MenuShortcut getShortcut()
Получает объект MenuShortcut, связанный с этим элементом меню.
boolean isEnabled()
Проверяет, включен ли этот элемент меню.
String paramString()
Возвращает строку, представляющую состояние этого MenuItem.
protected void processActionEvent(ActionEvent e)
Обрабатывает события действий, возникающие в этом элементе меню, путем их распределения по любым зарегистрированным ActionListener объектам.
protected void processEvent(AWTEvent e)
Обрабатывает события в этом элементе меню.
void removeActionListener(ActionListener l)
Удаляет указанный обработчик действий, чтобы он больше не получал события действий от этого элемента меню.
void setActionCommand(String command)
Устанавливает имя команды события действия, которое генерируется этим элементом меню.
void setEnabled(boolean b)
Устанавливает, может ли этот элемент меню быть выбран.
void setLabel(String label)
Устанавливает метку для этого элемента меню на заданную метку.
void setShortcut(MenuShortcut s)
Устанавливает объект MenuShortcut, связанный с этим элементом меню.

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

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

MenuItem

public MenuItem() throws HeadlessException
Создаёт новый элемент меню MenuItem с пустым меткой и без сочетания клавиш.
Исключение:
HeadlessException - если GraphicsEnvironment.isHeadless() возвращает true.
С момента:
1.1
См. также:
  • GraphicsEnvironment.isHeadless()

MenuItem

public MenuItem(String label) throws HeadlessException
Создаёт новый элемент меню MenuItem с заданной меткой и без сочетания клавиш. Обратите внимание, что использование "-" в метке зарезервировано для обозначения разделителя между элементами меню. По умолчанию все элементы меню, кроме разделителей, включены.
Параметры:
label - метка для этого элемента меню.
Исключение:
HeadlessException - если GraphicsEnvironment.isHeadless() возвращает true.
С момента:
1.0
См. также:
  • GraphicsEnvironment.isHeadless()

MenuItem

public MenuItem(String label, MenuShortcut s) throws HeadlessException
Создаёт элемент меню с ассоциированным сочетанием клавиш. Обратите внимание, что использование "-" в метке зарезервировано для обозначения разделителя между элементами меню. По умолчанию все элементы меню, кроме разделителей, включены.
Параметры:
label - метка для этого элемента меню.
s - экземпляр MenuShortcut , связанный с этим элементом меню.
Исключение:
HeadlessException - если GraphicsEnvironment.isHeadless() возвращает true.
С момента:
1.1
См. также:
  • GraphicsEnvironment.isHeadless()

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

addNotify

public void addNotify()
Создаёт виджет элемента меню. Виджет позволяет изменять внешний вид элемента меню, не изменяя его функциональность.

getLabel

public String getLabel()
Возвращает метку для этого элемента меню.
Возвращает:
метку этого элемента меню или null , если у этого элемента меню нет метки.
С момента:
1.0
См. также:
  • setLabel(java.lang.String)

setLabel

public void setLabel(String label)
Устанавливает метку для этого элемента меню на указанную метку.
Параметры:
label - новая метка или null для отсутствия метки.
С момента:
1.0
См. также:
  • getLabel()

isEnabled

public boolean isEnabled()
Проверяет, включён ли этот элемент меню.
Возвращает:
true , если элемент включён; в противном случае false
С момента:
1.0
См. также:
  • setEnabled(boolean)

setEnabled

public void setEnabled(boolean b)
Устанавливает, можно ли выбрать этот элемент меню.
Параметры:
b - если true, включает этот элемент меню; если false, отключает его.
С момента:
1.1
См. также:
  • isEnabled()

enable

@Deprecated public void enable()
Устаревшее.
Начиная с версии JDK 1.1, заменено на setEnabled(boolean).

enable

@Deprecated public void enable(boolean b)
Устаревшее.
Начиная с версии JDK 1.1, заменено на setEnabled(boolean).
Устанавливает, можно ли выбрать этот элемент меню.
Параметры:
b - если true, включает этот элемент меню; в противном случае отключает его

disable

@Deprecated public void disable()
Устаревшее.
Начиная с версии JDK 1.1, заменено на setEnabled(boolean).

getShortcut

public MenuShortcut getShortcut()
Получить объект MenuShortcut , связанный с этим элементом меню,
Возвращает:
сочетание клавиш меню, связанное с этим элементом меню, или null , если оно не указано.
С момента:
1.1
См. также:
  • setShortcut(java.awt.MenuShortcut)

setShortcut

public void setShortcut(MenuShortcut s)
Установить объект MenuShortcut , связанный с этим элементом меню. Если сочетание клавиш уже связано с этим элементом меню, оно заменяется.
Параметры:
s - сочетание клавиш для связи с этим элементом меню.
С момента:
1.1
См. также:
  • getShortcut()

deleteShortcut

public void deleteShortcut()
Удалить любой объект MenuShortcut , связанный с этим элементом меню.
С момента:
1.1

enableEvents

protected final void enableEvents(long eventsToEnable)
Включает доставку событий в этот элемент меню для событий, которые определяются заданным параметром маски событий

Поскольку типы событий автоматически включаются при добавлении слушателя для этого типа в элемент меню, этот метод должен вызываться только подклассами MenuItem, которые хотят, чтобы заданные типы событий доставлялись в processEvent независимо от того, зарегистрирован ли слушатель.

Параметры:
eventsToEnable - маска событий, определяющая типы событий
С момента:
1.1
См. также:
  • processEvent(java.awt.AWTEvent)
  • disableEvents(long)
  • Component.enableEvents(long)

disableEvents

protected final void disableEvents(long eventsToDisable)
Отключает доставку событий в этот элемент меню для событий, определённых указанным параметром маски событий.
Параметры:
eventsToDisable - маска событий, определяющая типы событий
С момента:
1.1
См. также:
  • processEvent(java.awt.AWTEvent)
  • enableEvents(long)
  • Component.disableEvents(long)

setActionCommand

public void setActionCommand(String command)
Устанавливает имя команды события действия, которое генерируется этим элементом меню.

По умолчанию имя команды действия устанавливается в метку элемента меню.

Параметры:
command - имя команды действия, которое нужно установить для этого элемента меню.
С момента:
1.1
См. также:
  • getActionCommand()

getActionCommand

public String getActionCommand()
Возвращает имя команды события действия, которое генерируется этим элементом меню.
Возвращает:
имя команды действия
С момента:
1.1
См. также:
  • setActionCommand(java.lang.String)

addActionListener

public void addActionListener(ActionListener l)
Добавляет указанного слушателя действий для получения событий действий от этого элемента меню. Если l равно null, исключение не выбрасывается, и никаких действий не выполняется.

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

Параметры:
l - слушатель действий.
С момента:
1.1
См. также:
  • removeActionListener(java.awt.event.ActionListener)
  • getActionListeners()
  • ActionEvent
  • ActionListener

removeActionListener

public void removeActionListener(ActionListener l)
Удаляет указанного обработчика событий действия, чтобы он больше не получал события действия от этого пункта меню. Если l равно null, исключение не выбрасывается, и действие не выполняется.

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

Parameters:
l - обработчик событий действия.
Since:
1.1
See Also:
  • addActionListener(java.awt.event.ActionListener)
  • getActionListeners()
  • ActionEvent
  • ActionListener

getActionListeners

public ActionListener[] getActionListeners()
Возвращает массив всех зарегистрированных обработчиков событий действия для этого пункта меню.
Returns:
все обработчики событий действия этого пункта меню или пустой массив, если обработчики событий действия не зарегистрированы
Since:
1.4
See Also:
  • addActionListener(java.awt.event.ActionListener)
  • removeActionListener(java.awt.event.ActionListener)
  • ActionEvent
  • ActionListener

getListeners

public <T extends EventListener> T[] getListeners(Class<T> listenerType)
Возвращает массив всех объектов, зарегистрированных в качестве обработчиков событий для этого пункта меню. Обработчики регистрируются с помощью метода addFooListener.

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

ActionListener[] als = (ActionListener[])(m.getListeners(ActionListener.class));
Если таких обработчиков нет, метод возвращает пустой массив.
Type Parameters:
T - тип обработчиков
Parameters:
listenerType - тип запрашиваемых обработчиков; этот параметр должен указывать интерфейс, унаследованный от java.util.EventListener
Returns:
массив всех зарегистрированных обработчиков событий для этого пункта меню или пустой массив, если обработчики не добавлены
Throws:
ClassCastException - если listenerType не указывает класс или интерфейс, реализующий java.util.EventListener
Since:
1.3
See Also:
  • getActionListeners()

processEvent

protected void processEvent(AWTEvent e)
Обрабатывает события этого пункта меню. Если событие является экземпляром ActionEvent, вызывается processActionEvent, другой метод, определенный в MenuItem.

В настоящее время пункты меню поддерживают только события действия.

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

Overrides:
processEvent в классе MenuComponent
Parameters:
e - событие
Since:
1.1
See Also:
  • processActionEvent(java.awt.event.ActionEvent)

processActionEvent

protected void processActionEvent(ActionEvent e)
Обрабатывает события действий, происходящие в этом пункте меню, рассылая их всем зарегистрированным обработчикам событий. Этот метод не вызывается, если события действий не включены для данного компонента. События действия включены, когда происходит одно из следующих условий:
  • Объект ActionListener зарегистрирован с помощью addActionListener.
  • События действия включены с помощью enableEvents.

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

Parameters:
e - событие действия
Since:
1.1
See Also:
  • ActionEvent
  • ActionListener
  • enableEvents(long)

paramString

public String paramString()
Возвращает строку, представляющую состояние этого пункта меню. Этот метод предназначен только для отладки, и содержимое и формат возвращаемой строки могут отличаться в разных реализациях. Возвращаемая строка может быть пустой, но не null.
Overrides:
paramString в классе MenuComponent
Returns:
строка параметров этого пункта меню

getAccessibleContext

public AccessibleContext getAccessibleContext()
Получает AccessibleContext, связанный с этим пунктом меню. Для пунктов меню AccessibleContext принимает форму AccessibleAWTMenuItem. Новый экземпляр AccessibleAWTMenuItem создается при необходимости.
Specified by:
getAccessibleContext в интерфейсе Accessible
Overrides:
getAccessibleContext в классе MenuComponent
Returns:
AccessibleAWTMenuItem, служащий AccessibleContext для этого пункта меню
Since:
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/MenuItem.html

Spec-Zone.ru

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