Home » openjdk-7 » javax » swing » plaf » basic » [javadoc | source]

    1   /*
    2    * Copyright (c) 1998, 2004, 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<sup><font size="-2">TM</font></sup>
   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   public interface ComboPopup {
   50       /**
   51        * Shows the popup
   52        */
   53       public void show();
   54   
   55       /**
   56        * Hides the popup
   57        */
   58       public void hide();
   59   
   60       /**
   61        * Returns true if the popup is visible (currently being displayed).
   62        *
   63        * @return <code>true</code> if the component is visible; <code>false</code> otherwise.
   64        */
   65       public boolean isVisible();
   66   
   67       /**
   68        * Returns the list that is being used to draw the items in the combo box.
   69        * This method is highly implementation specific and should not be used
   70        * for general list manipulation.
   71        */
   72       public JList getList();
   73   
   74       /**
   75        * Returns a mouse listener that will be added to the combo box or null.
   76        * If this method returns null then it will not be added to the combo box.
   77        *
   78        * @return a <code>MouseListener</code> or null
   79        */
   80       public MouseListener getMouseListener();
   81   
   82       /**
   83        * Returns a mouse motion listener that will be added to the combo box or null.
   84        * If this method returns null then it will not be added to the combo box.
   85        *
   86        * @return a <code>MouseMotionListener</code> or null
   87        */
   88       public MouseMotionListener getMouseMotionListener();
   89   
   90       /**
   91        * Returns a key listener that will be added to the combo box or null.
   92        * If this method returns null then it will not be added to the combo box.
   93        */
   94       public KeyListener getKeyListener();
   95   
   96       /**
   97        * Called to inform the ComboPopup that the UI is uninstalling.
   98        * If the ComboPopup added any listeners in the component, it should remove them here.
   99        */
  100       public void uninstallingUI();
  101   }

Home » openjdk-7 » javax » swing » plaf » basic » [javadoc | source]