1 /* 2 * Copyright (c) 1998, 2014, 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 26 package javax.swing.plaf.basic; 27 28 import java.awt.event.MouseListener; 29 import java.awt.event.MouseMotionListener; 30 import java.awt.event.KeyListener; 31 import javax.swing.JList; 32 33 34 /** 35 * The interface which defines the methods required for the implementation of the popup 36 * portion of a combo box. 37 * <p> 38 * <strong>Warning:</strong> 39 * Serialized objects of this class will not be compatible with 40 * future Swing releases. The current serialization support is 41 * appropriate for short term storage or RMI between applications running 42 * the same version of Swing. As of 1.4, support for long term storage 43 * of all JavaBeans™ 44 * has been added to the <code>java.beans</code> package. 45 * Please see {@link java.beans.XMLEncoder}. 46 * 47 * @author Tom Santos 48 */ 49 @SuppressWarnings("serial") // Same-version serialization only 50 public interface ComboPopup { 51 /** 52 * Shows the popup 53 */ show()54 public void show(); 55 56 /** 57 * Hides the popup 58 */ hide()59 public void hide(); 60 61 /** 62 * Returns true if the popup is visible (currently being displayed). 63 * 64 * @return <code>true</code> if the component is visible; <code>false</code> otherwise. 65 */ isVisible()66 public boolean isVisible(); 67 68 /** 69 * Returns the list that is being used to draw the items in the combo box. 70 * This method is highly implementation specific and should not be used 71 * for general list manipulation. 72 * 73 * @return the list that is being used to draw the items in the combo box 74 */ getList()75 public JList<Object> getList(); 76 77 /** 78 * Returns a mouse listener that will be added to the combo box or null. 79 * If this method returns null then it will not be added to the combo box. 80 * 81 * @return a <code>MouseListener</code> or null 82 */ getMouseListener()83 public MouseListener getMouseListener(); 84 85 /** 86 * Returns a mouse motion listener that will be added to the combo box or null. 87 * If this method returns null then it will not be added to the combo box. 88 * 89 * @return a <code>MouseMotionListener</code> or null 90 */ getMouseMotionListener()91 public MouseMotionListener getMouseMotionListener(); 92 93 /** 94 * Returns a key listener that will be added to the combo box or null. 95 * If this method returns null then it will not be added to the combo box. 96 * 97 * @return a key listener that will be added to the combo box or null 98 */ getKeyListener()99 public KeyListener getKeyListener(); 100 101 /** 102 * Called to inform the ComboPopup that the UI is uninstalling. 103 * If the ComboPopup added any listeners in the component, it should remove them here. 104 */ uninstallingUI()105 public void uninstallingUI(); 106 } 107