Package docking.menu

Class MenuHandler

  • All Implemented Interfaces:
    java.util.EventListener, javax.swing.event.MenuListener, javax.swing.event.PopupMenuListener
    Direct Known Subclasses:
    MenuBarMenuHandler, PopupMenuHandler
    public abstract class MenuHandler
extends java.lang.Object
implements javax.swing.event.MenuListener, javax.swing.event.PopupMenuListener
    MenuHandler provides a listener interface for menus. This interface has been provided to allow the listener to manage focus and help behavior.

    • Constructor Summary

      Constructors 
      Constructor Description
      MenuHandler()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void menuCanceled​(javax.swing.event.MenuEvent e)
      Invoked when a menu is cancelled (not sure if this is ever invoked)
      void menuDeselected​(javax.swing.event.MenuEvent e)
      Invoked when a menu is no longer selected.
      void menuItemEntered​(DockingActionIf action)
      Invoked when the mouse highlights a menu item.
      void menuItemExited​(DockingActionIf action)
      Invoked when the mouse exits a menu item.
      void menuSelected​(javax.swing.event.MenuEvent e)
      Invoked when a menu is selected.
      void popupMenuCanceled​(javax.swing.event.PopupMenuEvent e)
      This method is called when the popup menu is canceled
      void popupMenuWillBecomeInvisible​(javax.swing.event.PopupMenuEvent e)
      This method is called before the popup menu becomes invisible Note that a JPopupMenu can become invisible any time
      void popupMenuWillBecomeVisible​(javax.swing.event.PopupMenuEvent e)
      This method is called before the popup menu becomes visible
      void processMenuAction​(DockingActionIf action, java.awt.event.ActionEvent event)
      Invoked when a menu action item is selected.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • MenuHandler

        public MenuHandler()

    • Method Detail

      • processMenuAction

        public void processMenuAction​(DockingActionIf action,
                              java.awt.event.ActionEvent event)
        Invoked when a menu action item is selected.
        Parameters:
        action - associated action.
        event - event details.

      • menuItemEntered

        public void menuItemEntered​(DockingActionIf action)
        Invoked when the mouse highlights a menu item.
        Parameters:
        action - associated action.

      • menuItemExited

        public void menuItemExited​(DockingActionIf action)
        Invoked when the mouse exits a menu item.
        Parameters:
        action - associated action.

      • menuCanceled

        public void menuCanceled​(javax.swing.event.MenuEvent e)
        Invoked when a menu is cancelled (not sure if this is ever invoked)
        Specified by:
        menuCanceled in interface javax.swing.event.MenuListener
        See Also:
        MenuListener.menuCanceled(javax.swing.event.MenuEvent)

      • menuDeselected

        public void menuDeselected​(javax.swing.event.MenuEvent e)
        Invoked when a menu is no longer selected. This is always preceeded by a menuSelected invocation. This is invoked prior to the processMenuAction if an action item is selected.
        Specified by:
        menuDeselected in interface javax.swing.event.MenuListener
        See Also:
        MenuListener.menuDeselected(javax.swing.event.MenuEvent)

      • menuSelected

        public void menuSelected​(javax.swing.event.MenuEvent e)
        Invoked when a menu is selected.
        Specified by:
        menuSelected in interface javax.swing.event.MenuListener
        See Also:
        MenuListener.menuSelected(javax.swing.event.MenuEvent)

      • popupMenuWillBecomeVisible

        public void popupMenuWillBecomeVisible​(javax.swing.event.PopupMenuEvent e)
        This method is called before the popup menu becomes visible
        Specified by:
        popupMenuWillBecomeVisible in interface javax.swing.event.PopupMenuListener
        See Also:
        PopupMenuListener.popupMenuWillBecomeVisible(javax.swing.event.PopupMenuEvent)

      • popupMenuWillBecomeInvisible

        public void popupMenuWillBecomeInvisible​(javax.swing.event.PopupMenuEvent e)
        This method is called before the popup menu becomes invisible Note that a JPopupMenu can become invisible any time
        Specified by:
        popupMenuWillBecomeInvisible in interface javax.swing.event.PopupMenuListener
        See Also:
        PopupMenuListener.popupMenuWillBecomeInvisible(javax.swing.event.PopupMenuEvent)

      • popupMenuCanceled

        public void popupMenuCanceled​(javax.swing.event.PopupMenuEvent e)
        This method is called when the popup menu is canceled
        Specified by:
        popupMenuCanceled in interface javax.swing.event.PopupMenuListener
        See Also:
        PopupMenuListener.popupMenuCanceled(javax.swing.event.PopupMenuEvent)