01 /*
02 * Copyright 1997-2002 Sun Microsystems, Inc. All Rights Reserved.
03 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
04 *
05 * This code is free software; you can redistribute it and/or modify it
06 * under the terms of the GNU General Public License version 2 only, as
07 * published by the Free Software Foundation. Sun designates this
08 * particular file as subject to the "Classpath" exception as provided
09 * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22 * CA 95054 USA or visit www.sun.com if you need additional information or
23 * have any 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 * @version 1.26 05/05/07
34 * @author Dave Moore
35 */
36 public interface SingleSelectionModel {
37 /**
38 * Returns the model's selection.
39 *
40 * @return the model's selection, or -1 if there is no selection
41 * @see #setSelectedIndex
42 */
43 public int getSelectedIndex();
44
45 /**
46 * Sets the model's selected index to <I>index</I>.
47 *
48 * Notifies any listeners if the model changes
49 *
50 * @param index an int specifying the model selection
51 * @see #getSelectedIndex
52 * @see #addChangeListener
53 */
54 public void setSelectedIndex(int index);
55
56 /**
57 * Clears the selection (to -1).
58 */
59 public void clearSelection();
60
61 /**
62 * Returns true if the selection model currently has a selected value.
63 * @return true if a value is currently selected
64 */
65 public boolean isSelected();
66
67 /**
68 * Adds <I>listener</I> as a listener to changes in the model.
69 * @param listener the ChangeListener to add
70 */
71 void addChangeListener(ChangeListener listener);
72
73 /**
74 * Removes <I>listener</I> as a listener to changes in the model.
75 * @param listener the ChangeListener to remove
76 */
77 void removeChangeListener(ChangeListener listener);
78 }
|