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

    1   /*
    2    * Copyright (c) 1997, 2002, 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;
   27   
   28   import javax.swing.event;
   29   
   30   /**
   31    * A model that supports at most one indexed selection.
   32    *
   33    * @author Dave Moore
   34    */
   35   public interface SingleSelectionModel {
   36       /**
   37        * Returns the model's selection.
   38        *
   39        * @return  the model's selection, or -1 if there is no selection
   40        * @see     #setSelectedIndex
   41        */
   42       public int getSelectedIndex();
   43   
   44       /**
   45        * Sets the model's selected index to <I>index</I>.
   46        *
   47        * Notifies any listeners if the model changes
   48        *
   49        * @param index an int specifying the model selection
   50        * @see   #getSelectedIndex
   51        * @see   #addChangeListener
   52        */
   53       public void setSelectedIndex(int index);
   54   
   55       /**
   56        * Clears the selection (to -1).
   57        */
   58       public void clearSelection();
   59   
   60       /**
   61        * Returns true if the selection model currently has a selected value.
   62        * @return true if a value is currently selected
   63        */
   64       public boolean isSelected();
   65   
   66       /**
   67        * Adds <I>listener</I> as a listener to changes in the model.
   68        * @param listener the ChangeListener to add
   69        */
   70       void addChangeListener(ChangeListener listener);
   71   
   72       /**
   73        * Removes <I>listener</I> as a listener to changes in the model.
   74        * @param listener the ChangeListener to remove
   75        */
   76       void removeChangeListener(ChangeListener listener);
   77   }

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