Класс JMenu

public class JMenu
extends JMenuItem
implements Accessible, MenuElement

Реализация меню — всплывающего окна, содержащего JMenuItem элементы, которое отображается при выборе пункта в JMenuBar. Помимо JMenuItem элементов, меню также может содержать JMenu разделители.

По сути, меню — это кнопка с ассоциированным JPopupMenu. При нажатии на "кнопку" появляется JPopupMenu меню. Если "кнопка" расположена в JMenuBar, меню является основным окном. Если "кнопка" — это другой пункт меню, то меню является "спускающимся справа" меню.

Настройку и, в определенной степени, управление менюми могут выполнять Action. Использование Action с меню предоставляет много преимуществ, помимо прямой настройки меню. Подробнее см. Элементы Swing, поддерживающие Action, и Как использовать действия в Руководстве по Java.

Сведения и примеры использования меню см. в Как использовать меню в Руководстве по Java.

Предупреждение: Swing не потокобезопасен. Подробнее см. Политика многопоточности Swing.

Предупреждение: Сериализованные объекты этого класса не будут совместимы с будущими версиями Swing. Текущая поддержка сериализации подходит для краткосрочного хранения или удаленного вызова методов (RMI) между приложениями, использующими одну и ту же версию Swing. Начиная с версии 1.4, поддержка долгосрочного хранения всех JavaBeans™ была добавлена в пакет java.beans. См. XMLEncoder.

Поля

popupListener

protected JMenu.WinListener popupListener

Слушатель закрытия окна всплывающего меню.

См. также:

JMenu.WinListener

Конструкторы

JMenu

public JMenu()

Создает новый JMenu без текста.

JMenu

public JMenu(String s)

Создает новый JMenu с указанной строкой в качестве текста.

Параметры:

s - текст для метки меню

JMenu

public JMenu(Action a)

Создает меню, свойства которого взяты из предоставленного Action.

Параметры:

a - объект Action

С тех пор:

1.3

JMenu

public JMenu(String s,
             boolean b)

Создает новый JMenu с указанной строкой в качестве текста и указанием, является ли это меню отрываемым.

Параметры:

s - текст для метки меню

b - можно ли оторвать меню (ещё не реализовано)

Методы

updateUI

public void updateUI()

Сбрасывает свойство UI со значением из текущего визуального представления.

Переопределяет:

updateUI в классе JMenuItem

См. также:

JComponent.updateUI()

getUIClassID

public String getUIClassID()

Возвращает имя класса L&F, который отображает этот компонент.

Переопределяет:

getUIClassID в классе JMenuItem

Возвращает:

строку "MenuUI"

См. также:

JComponent.getUIClassID(), UIDefaults.getUI(javax.swing.JComponent)

setModel

public void setModel(ButtonModel newModel)

Устанавливает модель данных для "кнопки меню" — метки, которую пользователь нажимает, чтобы открыть или закрыть меню.

Переопределяет:

setModel в классе JMenuItem

Параметры:

newModel - модель ButtonModel

См. также:

AbstractButton.getModel()

isSelected

public boolean isSelected()

Возвращает true, если меню в настоящее время выбрано (выделено).

Переопределяет:

isSelected в классе AbstractButton

Возвращает:

true, если меню выбрано, иначе false

setSelected

public void setSelected(boolean b)

Устанавливает статус выбора меню.

Переопределяет:

setSelected в классе AbstractButton

Параметры:

b - true для выбора (выделения) меню; false для отмены выбора меню

isPopupMenuVisible

public boolean isPopupMenuVisible()

Возвращает true, если всплывающее окно меню видимое.

Возвращает:

true, если меню видимое, иначе false

setPopupMenuVisible

public void setPopupMenuVisible(boolean b)

Устанавливает видимость всплывающего меню. Если меню не активное, этот метод не повлияет.

Параметры:

b - логическое значение — true для отображения меню, false для скрытия

getPopupMenuOrigin

protected Point getPopupMenuOrigin()

Вычисляет начальную точку для всплывающего меню JMenu. Этот метод использует свойства визуального представления с именами Menu.menuPopupOffsetX, Menu.menuPopupOffsetY, Menu.submenuPopupOffsetX, и Menu.submenuPopupOffsetY для корректировки точного местоположения всплывающего меню.

Возвращает:

точку Point в системе координат меню, которая должна быть использована в качестве начальной точки всплывающего меню JMenu

С тех пор:

1.3

getDelay

public int getDelay()

Возвращает рекомендуемую задержку в миллисекундах перед отображением или скрытием подменю. Каждое визуальное представление (L&F) может определить собственную политику наблюдения за свойством delay. В большинстве случаев задержка не учитывается для верхнего уровня меню или при перетаскивании. По умолчанию для delay значение 0. Этот метод является свойством кода визуального представления и используется для управления особенностями различных реализаций пользовательского интерфейса.

Возвращает:

свойство delay

setDelay

public void setDelay(int d)

Устанавливает рекомендуемую задержку перед открытием или закрытием всплывающего меню. Каждое визуальное представление (L&F) может определить собственную политику наблюдения за свойством задержки. В большинстве случаев задержка не учитывается для верхнего уровня меню или при перетаскивании. Этот метод является свойством кода визуального представления и используется для управления особенностями различных реализаций пользовательского интерфейса.

Параметры:

d - количество миллисекунд задержки

Исключения:

IllegalArgumentException - если d меньше 0

setMenuLocation

public void setMenuLocation(int x,
                            int y)

Устанавливает расположение всплывающего компонента.

Параметры:

x - координата x нового положения всплывающего меню

y - координата y нового положения всплывающего меню

add

public JMenuItem add(JMenuItem menuItem)

Добавляет элемент меню в конец этого меню. Возвращает добавленный элемент меню.

Параметры:

menuItem - добавляемый JMenuitem

Возвращает:

добавленный JMenuItem

add

public Component add(Component c)

Добавляет компонент в конец этого меню. Возвращает добавленный компонент.

Переопределяет:

add в классе Container

Параметры:

c - добавляемый Component

Возвращает:

добавленный Component

См. также:

Container.addImpl(java.awt.Component, java.lang.Object, int), Container.invalidate(), Container.validate(), JComponent.revalidate()

add

public Component add(Component c,
                     int index)

Добавляет указанный компонент в этот контейнер в заданной позиции. Если index равно -1, компонент будет добавлен в конец.

Переопределяет:

add в классе Container

Параметры:

c - добавляемый Component

index - позиция, в которую следует вставить компонент

Возвращает:

добавленный Component

См. также:

remove(javax.swing.JMenuItem), Container.add(Component, int)

add

public JMenuItem add(String s)

Создаёт новый элемент меню с указанным текстом и добавляет его в конец этого меню.

Параметры:

s - строка для добавляемого элемента меню

add

public JMenuItem add(Action a)

Создаёт новый элемент меню, привязанный к указанному объекту Action, и добавляет его в конец этого меню.

Параметры:

a - объект Action для добавляемого элемента меню

См. также:

Action

createActionComponent

protected JMenuItem createActionComponent(Action a)

Фабричный метод, создающий JMenuItem для Action , добавленных в JMenu.

Параметры:

a - объект Action для добавляемого элемента меню

Возвращает:

новый элемент меню

С тех пор:

1.3

См. также:

Action

createActionChangeListener

protected PropertyChangeListener createActionChangeListener(JMenuItem b)

Возвращает должным образом настроенного PropertyChangeListener , который обновляет управление по мере изменения Action.

addSeparator

public void addSeparator()

Добавляет новую разделительную линию в конец меню.

insert

public void insert(String s,
                   int pos)

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

Параметры:

s - текст для добавляемого элемента меню

pos - целое число, определяющее позицию добавления нового элемента меню

Исключения:

IllegalArgumentException - если значение pos < 0

insert

public JMenuItem insert(JMenuItem mi,
                        int pos)

Вставляет указанный JMenuitem в заданную позицию.

Параметры:

mi - добавляемый JMenuitem

pos - целое число, определяющее позицию вставки нового JMenuitem

Возвращает:

новый элемент меню

Исключения:

IllegalArgumentException - если значение pos < 0

insert

public JMenuItem insert(Action a,
                        int pos)

Вставляет новый элемент меню, привязанный к указанному объекту Action, в заданную позицию.

Параметры:

a - объект Action для добавляемого элемента меню

pos - целое число, определяющее позицию вставки нового элемента меню

Исключения:

IllegalArgumentException - если значение pos < 0

insertSeparator

public void insertSeparator(int index)

Вставляет разделительную линию в указанную позицию.

Параметры:

index - целое число, определяющее позицию вставки разделительной линии меню

Исключения:

IllegalArgumentException - если значение index < 0

getItem

public JMenuItem getItem(int pos)

Возвращает JMenuItem в заданной позиции. Если компонент в позиции pos не является элементом меню, возвращается null. Этот метод включён для совместимости с AWT.

Параметры:

pos - целое число, определяющее позицию

Возвращает:

элемент меню по указанной позиции; или null если элемент по указанной позиции не является элементом меню

Выбрасывает:

IllegalArgumentException - если значение pos < 0

getItemCount

public int getItemCount()

Возвращает количество элементов в меню, включая разделители. Этот метод включён для совместимости с AWT.

Возвращает:

целое число, равное количеству элементов в меню

См. также:

getMenuComponentCount()

isTearOff

public boolean isTearOff()

Возвращает true, если меню может быть отделено. Этот метод ещё не реализован.

Возвращает:

true, если меню может быть отделено, иначе false

Выбрасывает:

Error - если вызван -- этот метод ещё не реализован

remove

public void remove(JMenuItem item)

Удаляет указанный элемент меню из этого меню. Если нет всплывающего меню, этот метод не окажет никакого влияния.

Параметры:

item - элемент JMenuItem для удаления из меню

remove

public void remove(int pos)

Удаляет элемент меню по указанному индексу из этого меню.

Переопределяет:

remove в классе Container

Параметры:

pos - позиция элемента для удаления

Выбрасывает:

IllegalArgumentException - если значение pos < 0, или если pos больше количества элементов меню

См. также:

Container.add(java.awt.Component), Container.invalidate(), Container.validate(), Container.getComponentCount()

remove

public void remove(Component c)

Удаляет компонент c из этого меню.

Переопределяет:

remove в классе Container

Параметры:

c - компонент для удаления

См. также:

Container.add(java.awt.Component), Container.invalidate(), Container.validate(), Container.remove(int)

removeAll

public void removeAll()

Удаляет все элементы меню из этого меню.

Переопределяет:

removeAll в классе Container

См. также:

Container.add(java.awt.Component), Container.remove(int), Container.invalidate()

getMenuComponentCount

public int getMenuComponentCount()

Возвращает количество компонентов в меню.

Возвращает:

целое число, содержащее количество компонентов в меню

getMenuComponent

public Component getMenuComponent(int n)

Возвращает компонент по позиции n.

Параметры:

n - позиция компонента для возврата

Возвращает:

запрошенный компонент или null если нет всплывающего меню

getMenuComponents

public Component[] getMenuComponents()

Возвращает массив Component подкомпонентов меню. Обратите внимание, что это возвращает все Component во всплывающем меню, включая разделители.

Возвращает:

массив Component или пустой массив, если нет всплывающего меню

isTopLevelMenu

public boolean isTopLevelMenu()

Возвращает true, если меню является 'главным меню', то есть является прямым потомком меню-строки.

Возвращает:

true, если меню активируется из меню-строки; false, если меню активируется из элемента меню другого меню

isMenuComponent

public boolean isMenuComponent(Component c)

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

Параметры:

c - компонент для проверки

Возвращает:

true, если компонент существует, иначе false

getPopupMenu

public JPopupMenu getPopupMenu()

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

addMenuListener

public void addMenuListener(MenuListener l)

Добавляет слушатель событий меню.

Параметры:

l - слушатель для добавления

removeMenuListener

public void removeMenuListener(MenuListener l)

Удаляет слушателя событий меню.

Параметры:

l - слушатель для удаления

getMenuListeners

public MenuListener[] getMenuListeners()

Возвращает массив всех MenuListener добавленных к этому JMenu с помощью addMenuListener().

Возвращает:

все добавленные MenuListener или пустой массив, если слушатели не были добавлены

C момента:

1.4

fireMenuSelected

protected void fireMenuSelected()

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

Выбрасывает:

Error - если есть слушатель null

См. также:

EventListenerList

fireMenuDeselected

protected void fireMenuDeselected()

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

Выбрасывает:

Error - если есть слушатель null

См. также:

EventListenerList

fireMenuCanceled

protected void fireMenuCanceled()

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

Выбрасывает:

Error - если есть слушатель null

См. также:

EventListenerList

createWinListener

protected JMenu.WinListener createWinListener(JPopupMenu p)

Создаёт слушателя закрытия окна для всплывающего меню.

Параметры:

p - всплывающее JPopupMenu

Возвращает:

новый слушатель закрытия окна

См. также:

JMenu.WinListener

menuSelectionChanged

public void menuSelectionChanged(boolean isIncluded)

Получает сообщение, когда в меню-строке изменяется выделение, чтобы активировать или деактивировать это меню. Переопределяет JMenuItem.menuSelectionChanged.

Указано в:

menuSelectionChanged в интерфейсе MenuElement

Переопределяет:

menuSelectionChanged в классе JMenuItem

Параметры:

isIncluded - true, если это меню активно, false, если нет

См. также:

MenuSelectionManager.setSelectedPath(MenuElement[])

getSubElements

public MenuElement[] getSubElements()

Возвращает массив MenuElement содержащий подменю для этого компонента меню. Если всплывающее меню null возвращает пустой массив. Этот метод необходим для соответствия интерфейсу MenuElement. Обратите внимание, что, поскольку JSeparator не соответствуют интерфейсу MenuElement, этот массив будет содержать только JMenuItem.

Указано в:

getSubElements в интерфейсе MenuElement

Переопределяет:

getSubElements в классе JMenuItem

Возвращает:

массив объектов MenuElement

getComponent

public Component getComponent()

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

Указано в:

getComponent в интерфейсе MenuElement

Переопределяет:

getComponent в классе JMenuItem

Возвращает:

Component для отрисовки этого элемента меню

applyComponentOrientation

public void applyComponentOrientation(ComponentOrientation o)

Устанавливает свойство ComponentOrientation этого меню и всех компонентов, содержащихся в нём. Это включает все компоненты, возвращаемые getMenuComponents.

Переопределяет:

applyComponentOrientation в классе Container

Параметры:

o - новая ориентация компонента этого меню и компонентов, содержащихся в нём.

Выбрасывает:

NullPointerException - если orientation равно null.

C момента:

1.4

См. также:

Component.setComponentOrientation(java.awt.ComponentOrientation), Component.getComponentOrientation()

setComponentOrientation

public void setComponentOrientation(ComponentOrientation o)

Описание скопировано из класса: Component

Переопределяет:

setComponentOrientation в классе Component

См. также:

ComponentOrientation, Component.invalidate()

setAccelerator

public void setAccelerator(KeyStroke keyStroke)

setAccelerator не определено для JMenu. Используйте setMnemonic вместо этого.

Переопределяет:

setAccelerator в классе JMenuItem

Параметры:

keyStroke - комбинация клавиш, которая вызовет обработчики событий действия JMenuItem без навигации по иерархии меню

Исключения:

Error - если вызвано -- этот метод не определен для JMenu. Используйте setMnemonic вместо этого

processKeyEvent

protected void processKeyEvent(KeyEvent evt)

Обрабатывает события нажатия клавиш, такие как мнемоники и акцелераторы.

Переопределяет:

processKeyEvent в классе JComponent

Параметры:

evt - событие нажатия клавиши для обработки

См. также:

KeyEvent, KeyListener, KeyboardFocusManager, DefaultKeyboardFocusManager, Component.processEvent(java.awt.AWTEvent), Component.dispatchEvent(java.awt.AWTEvent), Component.addKeyListener(java.awt.event.KeyListener), Component.enableEvents(long), Component.isShowing()

doClick

public void doClick(int pressTime)

Выполняет "щелчок" программно. Это переопределяет метод AbstractButton.doClick для отображения всплывающего меню.

Переопределяет:

doClick в классе AbstractButton

Параметры:

pressTime - указывает количество миллисекунд, в течение которого нажималась кнопка

paramString

protected String paramString()

Возвращает строковое представление этого JMenu. Этот метод предназначен только для отладки, а содержимое и формат возвращаемой строки могут различаться в разных реализациях. Возвращаемая строка может быть пустой, но не null.

Переопределяет:

paramString в классе JMenuItem

Возвращает:

строковое представление этого JMenu.

getAccessibleContext

public AccessibleContext getAccessibleContext()

Получает AccessibleContext, связанный с этим JMenu. Для JMenu AccessibleContext представлен как AccessibleJMenu. Новый экземпляр AccessibleJMenu создается при необходимости.

Определено в:

getAccessibleContext в интерфейсе Accessible

Переопределяет:

getAccessibleContext в классе JMenuItem

Возвращает:

AccessibleJMenu, который служит AccessibleContext этого JMenu