Source for javax.swing.MenuElement

   1: /* MenuElement.java --
   2:    Copyright (C) 2002, 2004 Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: package javax.swing;
  39: 
  40: import java.awt.Component;
  41: import java.awt.event.KeyEvent;
  42: import java.awt.event.MouseEvent;
  43: 
  44: /**
  45:  * Defines the methods that any menu element in a {@link JMenu} must
  46:  * implement.
  47:  *
  48:  * @author Andrew Selkirk
  49:  */
  50: public interface MenuElement {
  51: 
  52:     //-------------------------------------------------------------
  53:     // Methods ----------------------------------------------------
  54:     //-------------------------------------------------------------
  55: 
  56:     /**
  57:      * processMouseEvent
  58:      * @param event TODO
  59:      * @param path TODO
  60:      * @param manager TODO
  61:      */
  62:     void processMouseEvent(MouseEvent event,
  63:             MenuElement[] path, MenuSelectionManager manager);
  64: 
  65:     /**
  66:      * processKeyEvent
  67:      * @param event TODO
  68:      * @param path TODO
  69:      * @param manager TODO
  70:      */
  71:     void processKeyEvent(KeyEvent event, 
  72:             MenuElement[] path, MenuSelectionManager manager);
  73: 
  74:     /**
  75:      * menuSelectionChanged
  76:      * @param included TODO
  77:      */
  78:     void menuSelectionChanged(boolean included);
  79: 
  80:     /**
  81:      * getSubElements
  82:      * @returns MenuElement[]
  83:      */
  84:     MenuElement[] getSubElements();
  85: 
  86:     /**
  87:      * getComponent
  88:      * @returns Component
  89:      */
  90:     Component getComponent();
  91: 
  92: 
  93: } // MenuElement