1 /* 2 * Copyright (c) 1997, 2003, Oracle and/or its affiliates. All rights reserved. 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 7 * published by the Free Software Foundation. Oracle designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Oracle in the LICENSE file that accompanied this code. 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 * 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. 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 * @since 1.2 37 */ 38 39 public interface MenuElement { 40 41 /** 42 * Processes a mouse event. <code>event</code> is a <code>MouseEvent</code> 43 * with source being the receiving element's component. 44 * <code>path</code> is the path of the receiving element in the menu 45 * hierarchy including the receiving element itself. 46 * <code>manager</code> is the <code>MenuSelectionManager</code> 47 * for the menu hierarchy. 48 * This method should process the <code>MouseEvent</code> and change 49 * the menu selection if necessary 50 * by using <code>MenuSelectionManager</code>'s API 51 * Note: you do not have to forward the event to sub-components. 52 * This is done automatically by the <code>MenuSelectionManager</code>. 53 */ 54 public void processMouseEvent(MouseEvent event,MenuElement path[],MenuSelectionManager manager); 55 56 57 /** 58 * Process a key event. 59 */ 60 public void processKeyEvent(KeyEvent event,MenuElement path[],MenuSelectionManager manager); 61 62 /** 63 * Call by the <code>MenuSelectionManager</code> when the 64 * <code>MenuElement</code> is added or remove from 65 * the menu selection. 66 */ 67 public void menuSelectionChanged(boolean isIncluded); 68 69 /** 70 * This method should return an array containing the sub-elements for the receiving menu element 71 * 72 * @return an array of MenuElements 73 */ 74 public MenuElement[] getSubElements(); 75 76 /** 77 * This method should return the java.awt.Component used to paint the receiving element. 78 * The returned component will be used to convert events and detect if an event is inside 79 * a MenuElement's component. 80 * 81 * @return the Component value 82 */ 83 public Component getComponent(); 84 }