OpenJDK 27 · javax.swing.MenuElement · APIdia, the JavaDoc alternative

Method Summary

Modifier and Type	Method and Description
public Component	Returns: the `Component` value getComponent() This method should return the `java.awt.Component` used to paint the receiving element.
public MenuElement[]	Returns: an array of `MenuElement`s getSubElements() This method should return an array containing the sub-elements for the receiving menu element.
public void	menuSelectionChanged(boolean can be used to indicate if this `MenuElement` is active (if it is a menu) or is on the part of the menu path that changed (if it is a menu item). isIncluded) Call by the `MenuSelectionManager` when the `MenuElement` is added or removed from the menu selection.
public void	processKeyEvent(KeyEvent a `KeyEvent` to be processed event, MenuElement[] the path of the receiving element in the menu hierarchy path, MenuSelectionManager the `MenuSelectionManager` for the menu hierarchy manager) Process a key event.
public void	processMouseEvent(MouseEvent a `MouseEvent` to be processed event, MenuElement[] the path of the receiving element in the menu hierarchy path, MenuSelectionManager the `MenuSelectionManager` for the menu hierarchy manager) Processes a mouse event.

Method Detail

getComponent back to summary

getComponent	back to summary
public Component getComponent() This method should return the `java.awt.Component` used to paint the receiving element. The returned component will be used to convert events and detect if an event is inside a `MenuElement`'s component. Returns:Component the `Component` value

public Component getComponent()

This method should return the java.awt.Component used to paint the receiving element. The returned component will be used to convert events and detect if an event is inside a MenuElement's component.

Returns:Component: the Component value

getSubElements back to summary

getSubElements	back to summary
public MenuElement[] getSubElements() This method should return an array containing the sub-elements for the receiving menu element. Returns:MenuElement[] an array of `MenuElement`s

public MenuElement[] getSubElements()

This method should return an array containing the sub-elements for the receiving menu element.

Returns:MenuElement[]: an array of MenuElements

menuSelectionChanged back to summary

menuSelectionChanged	back to summary
public void menuSelectionChanged(boolean isIncluded) Call by the `MenuSelectionManager` when the `MenuElement` is added or removed from the menu selection. Parameters isIncluded:boolean can be used to indicate if this `MenuElement` is active (if it is a menu) or is on the part of the menu path that changed (if it is a menu item).

public void menuSelectionChanged(boolean isIncluded)

Call by the MenuSelectionManager when the MenuElement is added or removed from the menu selection.

Parameters

isIncluded:boolean: can be used to indicate if this MenuElement is active (if it is a menu) or is on the part of the menu path that changed (if it is a menu item).

processKeyEvent back to summary

processKeyEvent	back to summary
public void processKeyEvent(KeyEvent event, MenuElement[] path, MenuSelectionManager manager) Process a key event. Parameters event:KeyEvent a `KeyEvent` to be processed path:MenuElement[] the path of the receiving element in the menu hierarchy manager:MenuSelectionManager the `MenuSelectionManager` for the menu hierarchy

public void processKeyEvent(KeyEvent event, MenuElement[] path, MenuSelectionManager manager)

Process a key event.

Parameters

event:KeyEvent: a KeyEvent to be processed
path:MenuElement[]: the path of the receiving element in the menu hierarchy
manager:MenuSelectionManager: the MenuSelectionManager for the menu hierarchy

processMouseEvent back to summary

processMouseEvent	back to summary
public void processMouseEvent(MouseEvent event, MenuElement[] path, MenuSelectionManager manager) Processes a mouse event. `event` is a `MouseEvent` with source being the receiving element's component. `path` is the path of the receiving element in the menu hierarchy including the receiving element itself. `manager` is the `MenuSelectionManager` for the menu hierarchy. This method should process the `MouseEvent` and change the menu selection if necessary by using `MenuSelectionManager`'s API Note: you do not have to forward the event to sub-components. This is done automatically by the `MenuSelectionManager`. Parameters event:MouseEvent a `MouseEvent` to be processed path:MenuElement[] the path of the receiving element in the menu hierarchy manager:MenuSelectionManager the `MenuSelectionManager` for the menu hierarchy

public void processMouseEvent(MouseEvent event, MenuElement[] path, MenuSelectionManager manager)

Processes a mouse event. event is a MouseEvent with source being the receiving element's component. path is the path of the receiving element in the menu hierarchy including the receiving element itself. manager is the MenuSelectionManager for the menu hierarchy. This method should process the MouseEvent and change the menu selection if necessary by using MenuSelectionManager's API Note: you do not have to forward the event to sub-components. This is done automatically by the MenuSelectionManager.

Parameters

event:MouseEvent: a MouseEvent to be processed
path:MenuElement[]: the path of the receiving element in the menu hierarchy
manager:MenuSelectionManager: the MenuSelectionManager for the menu hierarchy

public Interface MenuElement

Method Summary

Method Detail