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   /**
54    * processMouseEvent
55    * @param event TODO
56    * @param path TODO
57    * @param manager TODO
58    */
processMouseEvent(MouseEvent event, MenuElement[] path, MenuSelectionManager manager)59   void processMouseEvent(MouseEvent event, MenuElement[] path,
60                          MenuSelectionManager manager);
61 
62   /**
63    * processKeyEvent
64    * @param event TODO
65    * @param path TODO
66    * @param manager TODO
67    */
processKeyEvent(KeyEvent event, MenuElement[] path, MenuSelectionManager manager)68   void processKeyEvent(KeyEvent event, MenuElement[] path,
69                        MenuSelectionManager manager);
70 
71   /**
72    * menuSelectionChanged
73    * @param included TODO
74    */
menuSelectionChanged(boolean included)75   void menuSelectionChanged(boolean included);
76 
77   /**
78    * getSubElements
79    * @returns MenuElement[]
80    */
getSubElements()81   MenuElement[] getSubElements();
82 
83   /**
84    * getComponent
85    * @returns Component
86    */
getComponent()87   Component getComponent();
88 
89 }
90