public class

MenuSelectionManager

extends Object
java.lang.Object
   ↳ javax.swing.MenuSelectionManager

Class Overview

A MenuSelectionManager owns the selection in menu hierarchy.

Summary

Fields
protected ChangeEvent changeEvent Only one ChangeEvent is needed per button model instance since the event's only state is the source property.
protected EventListenerList listenerList
Public Constructors
MenuSelectionManager()
Public Methods
void addChangeListener(ChangeListener l)
Adds a ChangeListener to the button.
void clearSelectedPath()
Tell the menu selection to close and unselect all the menu components.
Component componentForPoint(Component source, Point sourcePoint)
Returns the component in the currently selected path which contains sourcePoint.
static MenuSelectionManager defaultManager()
Returns the default menu selection manager.
ChangeListener[] getChangeListeners()
Returns an array of all the ChangeListeners added to this MenuSelectionManager with addChangeListener().
MenuElement[] getSelectedPath()
Returns the path to the currently selected menu item
boolean isComponentPartOfCurrentMenu(Component c)
Return true if c is part of the currently used menu
void processKeyEvent(KeyEvent e)
When a MenuElement receives an event from a KeyListener, it should never process the event directly.
void processMouseEvent(MouseEvent event)
When a MenuElement receives an event from a MouseListener, it should never process the event directly.
void removeChangeListener(ChangeListener l)
Removes a ChangeListener from the button.
void setSelectedPath(MenuElement[] path)
Changes the selection in the menu hierarchy.
Protected Methods
void fireStateChanged()
Notifies all listeners that have registered interest for notification on this event type.
[Expand]
Inherited Methods
From class java.lang.Object

Fields

protected ChangeEvent changeEvent

Only one ChangeEvent is needed per button model instance since the event's only state is the source property. The source of events generated is always "this".

protected EventListenerList listenerList

Public Constructors

public MenuSelectionManager ()

Public Methods

public void addChangeListener (ChangeListener l)

Adds a ChangeListener to the button.

Parameters
l the listener to add

public void clearSelectedPath ()

Tell the menu selection to close and unselect all the menu components. Call this method when a choice has been made

public Component componentForPoint (Component source, Point sourcePoint)

Returns the component in the currently selected path which contains sourcePoint.

Parameters
source The component in whose coordinate space sourcePoint is given
sourcePoint The point which is being tested
Returns
  • The component in the currently selected path which contains sourcePoint (relative to the source component's coordinate space. If sourcePoint is not inside a component on the currently selected path, null is returned.

public static MenuSelectionManager defaultManager ()

Returns the default menu selection manager.

Returns
  • a MenuSelectionManager object

public ChangeListener[] getChangeListeners ()

Returns an array of all the ChangeListeners added to this MenuSelectionManager with addChangeListener().

Returns
  • all of the ChangeListeners added or an empty array if no listeners have been added

public MenuElement[] getSelectedPath ()

Returns the path to the currently selected menu item

Returns
  • an array of MenuElement objects representing the selected path

public boolean isComponentPartOfCurrentMenu (Component c)

Return true if c is part of the currently used menu

public void processKeyEvent (KeyEvent e)

When a MenuElement receives an event from a KeyListener, it should never process the event directly. Instead all MenuElements should call this method with the event.

Parameters
e a KeyEvent object

public void processMouseEvent (MouseEvent event)

When a MenuElement receives an event from a MouseListener, it should never process the event directly. Instead all MenuElements should call this method with the event.

Parameters
event a MouseEvent object

public void removeChangeListener (ChangeListener l)

Removes a ChangeListener from the button.

Parameters
l the listener to remove

public void setSelectedPath (MenuElement[] path)

Changes the selection in the menu hierarchy. The elements in the array are sorted in order from the root menu element to the currently selected menu element.

Note that this method is public but is used by the look and feel engine and should not be called by client applications.

Parameters
path an array of MenuElement objects specifying the selected path

Protected Methods

protected void fireStateChanged ()

Notifies all listeners that have registered interest for notification on this event type. The event instance is created lazily.

See Also