This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.


javax.swing
interface MenuElement

All Known Implementing Classes:
JMenu, JMenuBar, BasicInternalFrameTitlePane.SystemMenuBar, JMenuItem, JCheckBoxMenuItem, JRadioButtonMenuItem, JPopupMenu, BasicComboPopup, MetalComboBoxUI.MetalComboPopup

public interface MenuElement

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.


Method Summary
 Component

          This method should return the java.awt.Component used to paint the receiving element.
 MenuElement[]

          This method should return an array containing the sub-elements for the receiving menu element
 void
menuSelectionChanged(boolean isIncluded)

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

          Process a key event.
 void

          Processes a mouse event.
 

Method Detail

getComponent

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:
the Component value

getSubElements

public MenuElement[] getSubElements()
This method should return an array containing the sub-elements for the receiving menu element

Returns:
an array of MenuElements

menuSelectionChanged

public void menuSelectionChanged(boolean isIncluded)
Call by the MenuSelectionManager when the MenuElement is added or remove from the menu selection.

Parameters:
isIncluded

processKeyEvent

public void processKeyEvent(KeyEvent event,
                            MenuElement[] path,
                            MenuSelectionManager manager)
Process a key event.

Parameters:
event
path
manager

processMouseEvent

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
path
manager


This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.