public interface

MenuElement

javax.swing.MenuElement
Known Indirect Subclasses

Class Overview

Any component that can be placed into a menu should implement this interface. This interface is used by MenuSelectionManager to handle selection and navigation in menu hierarchies.

Summary

Public Methods
abstract Component getComponent()
This method should return the java.awt.Component used to paint the receiving element.
abstract MenuElement[] getSubElements()
This method should return an array containing the sub-elements for the receiving menu element
abstract void menuSelectionChanged(boolean isIncluded)
Call by the MenuSelectionManager when the MenuElement is added or remove from the menu selection.
abstract void processKeyEvent(KeyEvent event, MenuElement[] path, MenuSelectionManager manager)
Process a key event.
abstract void processMouseEvent(MouseEvent event, MenuElement[] path, MenuSelectionManager manager)
Processes a mouse event.

Public Methods

public abstract 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
  • the Component value

public abstract MenuElement[] getSubElements ()

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

Returns
  • an array of MenuElements

public abstract void menuSelectionChanged (boolean isIncluded)

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

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

Process a key event.

public abstract 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.