001/* ComboPopup.java --
002   Copyright (C) 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
038
039package javax.swing.plaf.basic;
040
041import java.awt.event.KeyListener;
042import java.awt.event.MouseListener;
043import java.awt.event.MouseMotionListener;
044
045import javax.swing.JList;
046
047public interface ComboPopup
048{
049  /**
050   * This method display popup menu containing list of JComboBox's items to
051   * the screen
052   */
053  void show();
054
055  /**
056   * This method hides popup menu with list of JComboBox's item from the
057   * screen
058   */
059  void hide();
060
061  /**
062   * Retursn true if popup menu with JComboBOx's item is currently visible on
063   * the screen and false otherwise
064   *
065   * @return true if JComboBox's popup menu with list of items is currently
066   *         visible on the screen and false otherwise.
067   */
068  boolean isVisible();
069
070  /**
071   * Return JList that is used to draw cells of the JComboBox.
072   *
073   * @return JList that is used to draw cells of the JcomboBox
074   */
075  JList getList();
076
077  /**
078   * This method returns MouseListener that listen's to mouse events occuring
079   * in the combo box
080   *
081   * @return MouseListenere
082   */
083  MouseListener getMouseListener();
084
085  /**
086   * This method returns MouseListener that listen's to mouse events occuring
087   * in the combo box.
088   *
089   * @return MouseMotionListener
090   */
091  MouseMotionListener getMouseMotionListener();
092
093  /**
094   * This method returns KeyListener that listen's to key events  occuring in
095   * the combo box.
096   *
097   * @return KeyListener
098   */
099  KeyListener getKeyListener();
100
101  /* This method removes any listeners that were installed */
102  void uninstallingUI();
103}