Spec-Zone.ru › OpenJDK 25

Класс 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, предоставляющий поддержку специальных возможностей по умолчанию.

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

MenuComponent.AccessibleAWTMenuComponent

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

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

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

Модификатор и тип Метод Описание
void addActionListener(ActionListener l)
Добавляет указанный прослушиватель действий для получения событий действия от этого элемента меню.
void addNotify()
Создает peer-объект элемента меню.
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, связанный с этим элементом меню.

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

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

Методы, объявленные в классе 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()
Создает peer-объект элемента меню. Peer-объект позволяет изменять внешний вид элемента меню, не меняя его функциональность.

getLabel

public String getLabel()
Получает метку этого элемента меню.
Возвращает:
метку этого элемента меню или null, если у элемента меню нет метки.
Начиная с:
1.0
См. также:
  • setLabel(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(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(AWTEvent)
  • disableEvents(long)
  • Component.enableEvents(long)

disableEvents

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

setActionCommand

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

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

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

getActionCommand

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

addActionListener

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

Дополнительные сведения о модели многопоточности AWT см. в разделе Проблемы многопоточности AWT.

Параметры:
l — прослушиватель действий.
Начиная с:
1.1
См. также:
  • removeActionListener(ActionListener)
  • getActionListeners()
  • ActionEvent
  • ActionListener

removeActionListener

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

Дополнительные сведения о модели многопоточности AWT см. в разделе Проблемы многопоточности AWT.

Параметры:
l — прослушиватель действий.
Начиная с:
1.1
См. также:
  • addActionListener(ActionListener)
  • getActionListeners()
  • ActionEvent
  • ActionListener

getActionListeners

public ActionListener[] getActionListeners()
Возвращает массив всех прослушивателей действий, зарегистрированных для этого элемента меню.
Возвращает:
все ActionListeners этого элемента меню или пустой массив, если в данный момент прослушиватели действий не зарегистрированы
Начиная с:
1.4
См. также:
  • addActionListener(ActionListener)
  • removeActionListener(ActionListener)
  • ActionEvent
  • ActionListener

getListeners

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

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

ActionListener[] als = (ActionListener[])(m.getListeners(ActionListener.class));
Если таких прослушивателей нет, этот метод возвращает пустой массив.
Параметры типа:
T — тип прослушивателей
Параметры:
listenerType — тип запрашиваемых прослушивателей; этот параметр должен задавать интерфейс, производный от java.util.EventListener
Возвращает:
массив всех объектов, зарегистрированных как FooListener для этого элемента меню, или пустой массив, если такие прослушиватели не добавлены
Выбрасывает:
ClassCastException — если listenerType не задает класс или интерфейс, реализующий java.util.EventListener
Начиная с:
1.3
См. также:
  • getActionListeners()

processEvent

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

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

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

Переопределяет:
processEvent в классе MenuComponent
Параметры:
e — событие
Начиная с:
1.1
См. также:
  • processActionEvent(ActionEvent)

processActionEvent

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

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

Параметры:
e — событие действия
Начиная с:
1.1
См. также:
  • ActionEvent
  • ActionListener
  • enableEvents(long)

paramString

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

getAccessibleContext

public AccessibleContext getAccessibleContext()
Получает AccessibleContext, связанный с этим MenuItem. Для элементов меню AccessibleContext представлен объектом AccessibleAWTMenuItem. При необходимости создается новый экземпляр AccessibleAWTMenuItem.
Определен в:
getAccessibleContext в интерфейсе Accessible
Переопределяет:
getAccessibleContext в классе MenuComponent
Возвращает:
AccessibleAWTMenuItem, выступающий в качестве AccessibleContext этого MenuItem
Начиная с:
1.3

Сообщить об ошибке или предложить улучшение
Дополнительные справочные материалы по API и документацию для разработчиков см. в разделе Документация Java SE, содержащем более подробные описания для разработчиков, обзоры концепций, определения терминов, обходные решения и примеры работающего кода. Другие версии.
Java является товарным знаком или зарегистрированным товарным знаком Oracle и/или ее аффилированных лиц в США и других странах.
Авторское право © 1993, 2025, Oracle и/или ее аффилированные лица, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
Все права защищены. Использование регулируется условиями лицензии и политикой распространения документации.

© 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.
https://docs.oracle.com/en/java/javase/25/docs/api/java.desktop/java/awt/MenuItem.html

Spec-Zone.ru

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