001 /*
002 * Copyright 1998-2004 Sun Microsystems, Inc. All Rights Reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation. Sun designates this
008 * particular file as subject to the "Classpath" exception as provided
009 * by Sun in the LICENSE file that accompanied this code.
010 *
011 * This code is distributed in the hope that it will be useful, but WITHOUT
012 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
014 * version 2 for more details (a copy is included in the LICENSE file that
015 * accompanied this code).
016 *
017 * You should have received a copy of the GNU General Public License version
018 * 2 along with this work; if not, write to the Free Software Foundation,
019 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020 *
021 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022 * CA 95054 USA or visit www.sun.com if you need additional information or
023 * have any questions.
024 */
025
026 package javax.swing.plaf.basic;
027
028 import java.awt.event.MouseListener;
029 import java.awt.event.MouseMotionListener;
030 import java.awt.event.KeyListener;
031 import javax.swing.JList;
032
033 /**
034 * The interface which defines the methods required for the implementation of the popup
035 * portion of a combo box.
036 * <p>
037 * <strong>Warning:</strong>
038 * Serialized objects of this class will not be compatible with
039 * future Swing releases. The current serialization support is
040 * appropriate for short term storage or RMI between applications running
041 * the same version of Swing. As of 1.4, support for long term storage
042 * of all JavaBeans<sup><font size="-2">TM</font></sup>
043 * has been added to the <code>java.beans</code> package.
044 * Please see {@link java.beans.XMLEncoder}.
045 *
046 * @version 1.23 05/05/07
047 * @author Tom Santos
048 */
049 public interface ComboPopup {
050 /**
051 * Shows the popup
052 */
053 public void show();
054
055 /**
056 * Hides the popup
057 */
058 public void hide();
059
060 /**
061 * Returns true if the popup is visible (currently being displayed).
062 *
063 * @return <code>true</code> if the component is visible; <code>false</code> otherwise.
064 */
065 public boolean isVisible();
066
067 /**
068 * Returns the list that is being used to draw the items in the combo box.
069 * This method is highly implementation specific and should not be used
070 * for general list manipulation.
071 */
072 public JList getList();
073
074 /**
075 * Returns a mouse listener that will be added to the combo box or null.
076 * If this method returns null then it will not be added to the combo box.
077 *
078 * @return a <code>MouseListener</code> or null
079 */
080 public MouseListener getMouseListener();
081
082 /**
083 * Returns a mouse motion listener that will be added to the combo box or null.
084 * If this method returns null then it will not be added to the combo box.
085 *
086 * @return a <code>MouseMotionListener</code> or null
087 */
088 public MouseMotionListener getMouseMotionListener();
089
090 /**
091 * Returns a key listener that will be added to the combo box or null.
092 * If this method returns null then it will not be added to the combo box.
093 */
094 public KeyListener getKeyListener();
095
096 /**
097 * Called to inform the ComboPopup that the UI is uninstalling.
098 * If the ComboPopup added any listeners in the component, it should remove them here.
099 */
100 public void uninstallingUI();
101 }
|