| J. Duke | 319a3b9 | 2007-12-01 00:00:00 +0000 | [diff] [blame^] | 1 | /* |
| 2 | * Copyright 1997-2001 Sun Microsystems, Inc. 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. Sun designates this |
| 8 | * particular file as subject to the "Classpath" exception as provided |
| 9 | * 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.ListDataListener; |
| 29 | |
| 30 | /** |
| 31 | * This interface defines the methods components like JList use |
| 32 | * to get the value of each cell in a list and the length of the list. |
| 33 | * Logically the model is a vector, indices vary from 0 to |
| 34 | * ListDataModel.getSize() - 1. Any change to the contents or |
| 35 | * length of the data model must be reported to all of the |
| 36 | * ListDataListeners. |
| 37 | * |
| 38 | * @author Hans Muller |
| 39 | * @see JList |
| 40 | */ |
| 41 | public interface ListModel |
| 42 | { |
| 43 | /** |
| 44 | * Returns the length of the list. |
| 45 | * @return the length of the list |
| 46 | */ |
| 47 | int getSize(); |
| 48 | |
| 49 | /** |
| 50 | * Returns the value at the specified index. |
| 51 | * @param index the requested index |
| 52 | * @return the value at <code>index</code> |
| 53 | */ |
| 54 | Object getElementAt(int index); |
| 55 | |
| 56 | /** |
| 57 | * Adds a listener to the list that's notified each time a change |
| 58 | * to the data model occurs. |
| 59 | * @param l the <code>ListDataListener</code> to be added |
| 60 | */ |
| 61 | void addListDataListener(ListDataListener l); |
| 62 | |
| 63 | /** |
| 64 | * Removes a listener from the list that's notified each time a |
| 65 | * change to the data model occurs. |
| 66 | * @param l the <code>ListDataListener</code> to be removed |
| 67 | */ |
| 68 | void removeListDataListener(ListDataListener l); |
| 69 | } |