Класс 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 void disableEvents​(long eventsToDisable)

Отключает доставку событий в этот элемент меню для событий, определённых параметром маски событий.
void enable()

Устарело.

Начиная с версии JDK 1.1, заменено на setEnabled(boolean).
void enable​(boolean b)

Устарело.

Начиная с версии JDK 1.1, заменено на setEnabled(boolean).
protected 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.

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

removeActionListener

public void removeActionListener(ActionListener l)

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

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

Параметры:
l - слушатель событий действия.
С тех пор:
1.1
См. также:
addActionListener(java.awt.event.ActionListener), getActionListeners(), ActionEvent, ActionListener

getActionListeners

public ActionListener[] getActionListeners()

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

Возвращает:
все слушатели событий действия этого пункта меню или пустой массив, если слушатели событий действия не зарегистрированы
С тех пор:
1.4
См. также:
addActionListener(java.awt.event.ActionListener), removeActionListener(java.awt.event.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(java.awt.event.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, связанный с этим пунктом меню. Для пунктов меню AccessibleContext принимает вид AccessibleAWTMenuItem. Новый экземпляр AccessibleAWTMenuItem создаётся при необходимости.

Определено в:
getAccessibleContext в интерфейсе Accessible
Переопределяет:
getAccessibleContext в классе MenuComponent
Возвращает:
AccessibleAWTMenuItem, который служит AccessibleContext этого пункта меню
С:
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.
https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/java/awt/MenuItem.html

Spec-Zone .ru
спецификации, руководства, описания, API