|
2
|
1 |
/*
|
|
5506
|
2 |
* Copyright (c) 1997, 2003, Oracle and/or its affiliates. All rights reserved.
|
|
2
|
3 |
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
|
|
|
4 |
*
|
|
|
5 |
* This code is free software; you can redistribute it and/or modify it
|
|
|
6 |
* under the terms of the GNU General Public License version 2 only, as
|
|
5506
|
7 |
* published by the Free Software Foundation. Oracle designates this
|
|
2
|
8 |
* particular file as subject to the "Classpath" exception as provided
|
|
5506
|
9 |
* by Oracle in the LICENSE file that accompanied this code.
|
|
2
|
10 |
*
|
|
|
11 |
* This code is distributed in the hope that it will be useful, but WITHOUT
|
|
|
12 |
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
|
13 |
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
|
|
14 |
* version 2 for more details (a copy is included in the LICENSE file that
|
|
|
15 |
* accompanied this code).
|
|
|
16 |
*
|
|
|
17 |
* You should have received a copy of the GNU General Public License version
|
|
|
18 |
* 2 along with this work; if not, write to the Free Software Foundation,
|
|
|
19 |
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
|
20 |
*
|
|
5506
|
21 |
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
|
|
|
22 |
* or visit www.oracle.com if you need additional information or have any
|
|
|
23 |
* questions.
|
|
2
|
24 |
*/
|
|
|
25 |
package javax.swing;
|
|
|
26 |
|
|
|
27 |
import java.awt.*;
|
|
|
28 |
import java.awt.event.*;
|
|
|
29 |
|
|
|
30 |
/**
|
|
|
31 |
* Any component that can be placed into a menu should implement this interface.
|
|
|
32 |
* This interface is used by <code>MenuSelectionManager</code>
|
|
|
33 |
* to handle selection and navigation in menu hierarchies.
|
|
|
34 |
*
|
|
|
35 |
* @author Arnaud Weber
|
|
|
36 |
*/
|
|
|
37 |
|
|
|
38 |
public interface MenuElement {
|
|
|
39 |
|
|
|
40 |
/**
|
|
|
41 |
* Processes a mouse event. <code>event</code> is a <code>MouseEvent</code>
|
|
|
42 |
* with source being the receiving element's component.
|
|
|
43 |
* <code>path</code> is the path of the receiving element in the menu
|
|
|
44 |
* hierarchy including the receiving element itself.
|
|
|
45 |
* <code>manager</code> is the <code>MenuSelectionManager</code>
|
|
|
46 |
* for the menu hierarchy.
|
|
|
47 |
* This method should process the <code>MouseEvent</code> and change
|
|
|
48 |
* the menu selection if necessary
|
|
|
49 |
* by using <code>MenuSelectionManager</code>'s API
|
|
|
50 |
* Note: you do not have to forward the event to sub-components.
|
|
|
51 |
* This is done automatically by the <code>MenuSelectionManager</code>.
|
|
|
52 |
*/
|
|
|
53 |
public void processMouseEvent(MouseEvent event,MenuElement path[],MenuSelectionManager manager);
|
|
|
54 |
|
|
|
55 |
|
|
|
56 |
/**
|
|
|
57 |
* Process a key event.
|
|
|
58 |
*/
|
|
|
59 |
public void processKeyEvent(KeyEvent event,MenuElement path[],MenuSelectionManager manager);
|
|
|
60 |
|
|
|
61 |
/**
|
|
|
62 |
* Call by the <code>MenuSelectionManager</code> when the
|
|
|
63 |
* <code>MenuElement</code> is added or remove from
|
|
|
64 |
* the menu selection.
|
|
|
65 |
*/
|
|
|
66 |
public void menuSelectionChanged(boolean isIncluded);
|
|
|
67 |
|
|
|
68 |
/**
|
|
|
69 |
* This method should return an array containing the sub-elements for the receiving menu element
|
|
|
70 |
*
|
|
|
71 |
* @return an array of MenuElements
|
|
|
72 |
*/
|
|
|
73 |
public MenuElement[] getSubElements();
|
|
|
74 |
|
|
|
75 |
/**
|
|
|
76 |
* This method should return the java.awt.Component used to paint the receiving element.
|
|
|
77 |
* The returned component will be used to convert events and detect if an event is inside
|
|
|
78 |
* a MenuElement's component.
|
|
|
79 |
*
|
|
|
80 |
* @return the Component value
|
|
|
81 |
*/
|
|
|
82 |
public Component getComponent();
|
|
|
83 |
}
|