KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > nextapp > echo2 > app > list > ListSelectionModel


1 /*
2  * This file is part of the Echo Web Application Framework (hereinafter "Echo").
3  * Copyright (C) 2002-2005 NextApp, Inc.
4  *
5  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
6  *
7  * The contents of this file are subject to the Mozilla Public License Version
8  * 1.1 (the "License"); you may not use this file except in compliance with
9  * the License. You may obtain a copy of the License at
10  * http://www.mozilla.org/MPL/
11  *
12  * Software distributed under the License is distributed on an "AS IS" basis,
13  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
14  * for the specific language governing rights and limitations under the
15  * License.
16  *
17  * Alternatively, the contents of this file may be used under the terms of
18  * either the GNU General Public License Version 2 or later (the "GPL"), or
19  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
20  * in which case the provisions of the GPL or the LGPL are applicable instead
21  * of those above. If you wish to allow use of your version of this file only
22  * under the terms of either the GPL or the LGPL, and not to allow others to
23  * use your version of this file under the terms of the MPL, indicate your
24  * decision by deleting the provisions above and replace them with the notice
25  * and other provisions required by the GPL or the LGPL. If you do not delete
26  * the provisions above, a recipient may use your version of this file under
27  * the terms of any one of the MPL, the GPL or the LGPL.
28  */
29
30 package nextapp.echo2.app.list;
31
32 import java.io.Serializable JavaDoc;
33
34 import nextapp.echo2.app.event.ChangeListener;
35
36 /**
37  * A representation of the selected items in a list component.
38  */
39 public interface ListSelectionModel
40 extends Serializable JavaDoc {
41
42     public static final int SINGLE_SELECTION = 0;
43     public static final int MULTIPLE_SELECTION = 2;
44     
45     /**
46      * Adds a <code>ChangeListenerb</code> to the selection model, which will
47      * be notified when the selection changes.
48      *
49      * @param l the <code>ChangeListener</code> to add
50      */
51     public void addChangeListener(ChangeListener l);
52     
53     /**
54      * Deselects all items.
55      */
56     public void clearSelection();
57     
58     /**
59      * Returns the maximum selected index.
60      * Returns -1 when no items are selected.
61      *
62      * @return the maximum selected index
63      */
64     public int getMaxSelectedIndex();
65     
66     /**
67      * Returns the minimum selected index.
68      * Returns -1 when no items are selected.
69      *
70      * @return the minimum selected index
71      */
72     public int getMinSelectedIndex();
73     
74     /**
75      * Returns the selection mode.
76      *
77      * @return the selection mode, one of the following values:
78      * <ul>
79      * <li><code>ListSelectionModel.SINGLE_SELECTION</code>: only
80      * one list element may be selected.</li>
81      * <li><code>ListSelectionModel.MULTIPLE_SELECTION</code>:
82      * multiple list elements may be selected.</li>
83      * </ul>
84      */
85     public int getSelectionMode();
86
87     /**
88      * Determines whether an index is selected.
89      *
90      * @param index the index
91      * @return true if the index is selected
92      */
93     public boolean isSelectedIndex(int index);
94     
95     /**
96      * Determines if no items are selected.
97      *
98      * @return true if no items are selected
99      */
100     public boolean isSelectionEmpty();
101         
102     /**
103      * Removes a <code>ChangeListener</code> from being notified of when the
104      * selection changes.
105      *
106      * @param l the <code>ChangeListener</code> to remove
107      */
108     public void removeChangeListener(ChangeListener l);
109     
110     /**
111      * Sets the selection state of the given index.
112      *
113      * @param index the index
114      * @param selected the new selection state
115      */
116     public void setSelectedIndex(int index, boolean selected);
117     
118     /**
119      * Sets the selection mode.
120      *
121      * @param selectionMode the selection mode, one of the following values:
122      * <ul>
123      * <li><code>ListSelectionModel.SINGLE_SELECTION</code>: only one list element
124      * may be selected.</li>
125      * <li><code>ListSelectionModel.MULTIPLE_SELECTION</code>: multiple list elements
126      * may be selected.</li>
127      * </ul>
128      */
129     public void setSelectionMode(int selectionMode);
130 }
131
Popular Tags