-
- All Known Implementing Classes:
BasicComboPopup,BasicInternalFrameTitlePane.SystemMenuBar,JCheckBoxMenuItem,JMenu,JMenuBar,JMenuItem,JPopupMenu,JRadioButtonMenuItem,MetalComboBoxUI.MetalComboPopup
public interface MenuElementAny component that can be placed into a menu should implement this interface. This interface is used byMenuSelectionManagerto handle selection and navigation in menu hierarchies.- Since:
- 1.2
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ComponentgetComponent()This method should return thejava.awt.Componentused to paint the receiving element.MenuElement[]getSubElements()This method should return an array containing the sub-elements for the receiving menu element.voidmenuSelectionChanged(boolean isIncluded)Call by theMenuSelectionManagerwhen theMenuElementis added or removed from the menu selection.voidprocessKeyEvent(KeyEvent event, MenuElement[] path, MenuSelectionManager manager)Process a key event.voidprocessMouseEvent(MouseEvent event, MenuElement[] path, MenuSelectionManager manager)Processes a mouse event.
-
-
-
Method Detail
-
processMouseEvent
void processMouseEvent(MouseEvent event, MenuElement[] path, MenuSelectionManager manager)
Processes a mouse event.eventis aMouseEventwith source being the receiving element's component.pathis the path of the receiving element in the menu hierarchy including the receiving element itself.manageris theMenuSelectionManagerfor the menu hierarchy. This method should process theMouseEventand change the menu selection if necessary by usingMenuSelectionManager's API Note: you do not have to forward the event to sub-components. This is done automatically by theMenuSelectionManager.- Parameters:
event- aMouseEventto be processedpath- the path of the receiving element in the menu hierarchymanager- theMenuSelectionManagerfor the menu hierarchy
-
processKeyEvent
void processKeyEvent(KeyEvent event, MenuElement[] path, MenuSelectionManager manager)
Process a key event.- Parameters:
event- aKeyEventto be processedpath- the path of the receiving element in the menu hierarchymanager- theMenuSelectionManagerfor the menu hierarchy
-
menuSelectionChanged
void menuSelectionChanged(boolean isIncluded)
Call by theMenuSelectionManagerwhen theMenuElementis added or removed from the menu selection.- Parameters:
isIncluded- can be used to indicate if thisMenuElementis active (if it is a menu) or is on the part of the menu path that changed (if it is a menu item).
-
getSubElements
MenuElement[] getSubElements()
This method should return an array containing the sub-elements for the receiving menu element.- Returns:
- an array of
MenuElements
-
getComponent
Component getComponent()
This method should return thejava.awt.Componentused to paint the receiving element. The returned component will be used to convert events and detect if an event is inside aMenuElement's component.- Returns:
- the
Componentvalue
-
-