Spec-Zone.ru › OpenJDK 17

Класс 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 см. в AWT Threading Issues.

Параметры:
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.

Вы можете указать аргумент listenerType с помощью литерала класса, такого как 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, 2021, 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/17/docs/api/java.desktop/java/awt/MenuItem.html

Spec-Zone.ru

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