Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

javax.swing

Class DefaultComboBoxModel

Implemented Interfaces:
ComboBoxModel, ListModel, MutableComboBoxModel, Serializable
public class DefaultComboBoxModel
extends AbstractListModel
implements MutableComboBoxModel, Serializable
A model that stores a list of elements and a selected item (which may be null). Changes to the model are signalled to listeners using ListDataEvent. This model is designed for use by the JComboBox component.
See Also:
Serialized Form

Field Summary

Fields inherited from class javax.swing.AbstractListModel

listenerList

Constructor Summary

DefaultComboBoxModel()
Creates a new model, initially empty.
DefaultComboBoxModel(Vector vector)
Creates a new model and initializes its item list to the values in the given vector.
DefaultComboBoxModel(Object[] items)
Creates a new model and initializes its item list to the values in the given array.

Method Summary

void
addElement(Object object)
Adds an element to the model's item list and sends a ListDataEvent to all registered listeners.
Object
getElementAt(int index)
Returns the element at the specified index in the model's item list.
int
getIndexOf(Object object)
Returns the index of the specified element in the model's item list.
Object
getSelectedItem()
Returns the selected item.
int
getSize()
Returns the number of items in the model's item list.
void
insertElementAt(Object object, int index)
Adds an element at the specified index in the model's item list and sends a ListDataEvent to all registered listeners.
void
removeAllElements()
Removes all the items from the model's item list, resets and selected item to null, and sends a ListDataEvent to all registered listeners.
void
removeElement(Object object)
Removes an element from the model's item list and sends a ListDataEvent to all registered listeners.
void
removeElementAt(int index)
Removes the element at the specified index from the model's item list and sends a ListDataEvent to all registered listeners.
void
setSelectedItem(Object object)
Sets the selected item for the model and sends a ListDataEvent to all registered listeners.

Methods inherited from class javax.swing.AbstractListModel

addListDataListener, extends EventListener> T[] getListeners, fireContentsChanged, fireIntervalAdded, fireIntervalRemoved, getListDataListeners, removeListDataListener

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DefaultComboBoxModel

public DefaultComboBoxModel()
Creates a new model, initially empty.

DefaultComboBoxModel

public DefaultComboBoxModel(Vector vector)
Creates a new model and initializes its item list to the values in the given vector. The selected item is set to the first item in the vector, or null if the vector length is zero.
Parameters:
vector - a vector containing items for the model (null not permitted).
Throws:
NullPointerException - if vector is null.

DefaultComboBoxModel

public DefaultComboBoxModel(Object[] items)
Creates a new model and initializes its item list to the values in the given array. The selected item is set to the first item in the array, or null if the array length is zero.
Parameters:
items - an array containing items for the model (null not permitted).
Throws:
NullPointerException - if items is null.

Method Details

addElement

public void addElement(Object object)
Adds an element to the model's item list and sends a ListDataEvent to all registered listeners. If the new element is the first item added to the list, and the selected item is null, the new element is set as the selected item.
Specified by:
addElement in interface MutableComboBoxModel
Parameters:
object - item to add to the model's item list.

getElementAt

public Object getElementAt(int index)
Returns the element at the specified index in the model's item list.
Specified by:
getElementAt in interface ListModel
Parameters:
index - the element index.
Returns:
The element at the specified index in the model's item list, or null if the index is outside the bounds of the list.

getIndexOf

public int getIndexOf(Object object)
Returns the index of the specified element in the model's item list.
Parameters:
object - the element.
Returns:
The index of the specified element in the model's item list.

getSelectedItem

public Object getSelectedItem()
Returns the selected item.
Specified by:
getSelectedItem in interface ComboBoxModel
Returns:
The selected item (possibly null).

getSize

public int getSize()
Returns the number of items in the model's item list.
Specified by:
getSize in interface ListModel
Returns:
The number of items in the model's item list.

insertElementAt

public void insertElementAt(Object object,
                            int index)
Adds an element at the specified index in the model's item list and sends a ListDataEvent to all registered listeners.
Specified by:
insertElementAt in interface MutableComboBoxModel
Parameters:
object - element to insert
index - index specifing position in the list where given element should be inserted.
Throws:
ArrayIndexOutOfBoundsException - if index is out of bounds.
See Also:
addElement(Object)

removeAllElements

public void removeAllElements()
Removes all the items from the model's item list, resets and selected item to null, and sends a ListDataEvent to all registered listeners.

removeElement

public void removeElement(Object object)
Removes an element from the model's item list and sends a ListDataEvent to all registered listeners. If the item to be removed is the current selected item, a new selected item will be set. If the element is not found in the model's item list, this method does nothing.
Specified by:
removeElement in interface MutableComboBoxModel
Parameters:
object - the element to remove.

removeElementAt

public void removeElementAt(int index)
Removes the element at the specified index from the model's item list and sends a ListDataEvent to all registered listeners. If the element removed was the selected item, then the preceding element becomes the new selected item (or the next element, if there is no preceding element).
Specified by:
removeElementAt in interface MutableComboBoxModel
Parameters:
index - the index of the item to remove.
Throws:
ArrayIndexOutOfBoundsException - if index is out of bounds.

setSelectedItem

public void setSelectedItem(Object object)
Sets the selected item for the model and sends a ListDataEvent to all registered listeners. The start and end index of the event is set to -1 to indicate the model's selection has changed, and not its contents.
Specified by:
setSelectedItem in interface ComboBoxModel
Parameters:
object - the new selected item (null permitted).
DefaultComboBoxModel.java -- Copyright (C) 2002, 2004, 2005, 2006, Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.

Overview Package Class Use Source Tree Index Deprecated About