001/* MenuElement.java --
002   Copyright (C) 2002, 2004 Free Software Foundation, Inc.
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038package javax.swing;
039
040import java.awt.Component;
041import java.awt.event.KeyEvent;
042import java.awt.event.MouseEvent;
043
044/**
045 * Defines the methods that any menu element in a {@link JMenu} must
046 * implement.
047 *
048 * @author Andrew Selkirk
049 */
050public interface MenuElement
051{
052
053  /**
054   * processMouseEvent
055   * @param event TODO
056   * @param path TODO
057   * @param manager TODO
058   */
059  void processMouseEvent(MouseEvent event, MenuElement[] path,
060                         MenuSelectionManager manager);
061
062  /**
063   * processKeyEvent
064   * @param event TODO
065   * @param path TODO
066   * @param manager TODO
067   */
068  void processKeyEvent(KeyEvent event, MenuElement[] path,
069                       MenuSelectionManager manager);
070
071  /**
072   * menuSelectionChanged
073   * @param included TODO
074   */
075  void menuSelectionChanged(boolean included);
076
077  /**
078   * getSubElements
079   * @returns MenuElement[]
080   */
081  MenuElement[] getSubElements();
082
083  /**
084   * getComponent
085   * @returns Component
086   */
087  Component getComponent();
088
089}