DefaultComboBoxModel (Java 2 Platform SE 5.0) (original) (raw)

javax.swing

Class DefaultComboBoxModel

java.lang.Object extended by javax.swing.AbstractListModel javax.swing.DefaultComboBoxModel

All Implemented Interfaces:

Serializable, ComboBoxModel, ListModel, MutableComboBoxModel

public class DefaultComboBoxModel

extends AbstractListModel

implements MutableComboBoxModel, Serializable

The default model for combo boxes.

Field Summary

Fields inherited from class javax.swing.AbstractListModel
listenerList

Constructor Summary
DefaultComboBoxModel() Constructs an empty DefaultComboBoxModel object.
DefaultComboBoxModel(Object[] items) Constructs a DefaultComboBoxModel object initialized with an array of objects.
DefaultComboBoxModel(Vector<?> v) Constructs a DefaultComboBoxModel object initialized with a vector.

Method Summary
void	addElement(Object anObject) Adds an item at the end of the model.
Object	getElementAt(int index) Returns the value at the specified index.
int	getIndexOf(Object anObject) Returns the index-position of the specified object in the list.
Object	getSelectedItem() Returns the selected item
int	getSize() Returns the length of the list.
void	[insertElementAt](../../javax/swing/DefaultComboBoxModel.html#insertElementAt%28java.lang.Object, int%29)(Object anObject, int index) Adds an item at a specific index.
void	removeAllElements() Empties the list.
void	removeElement(Object anObject) Removes an item from the model.
void	removeElementAt(int index) Removes an item at a specific index.
void	setSelectedItem(Object anObject) Set the value of the selected item.

Methods inherited from class javax.swing.AbstractListModel
addListDataListener, [fireContentsChanged](../../javax/swing/AbstractListModel.html#fireContentsChanged%28java.lang.Object, int, int%29), [fireIntervalAdded](../../javax/swing/AbstractListModel.html#fireIntervalAdded%28java.lang.Object, int, int%29), [fireIntervalRemoved](../../javax/swing/AbstractListModel.html#fireIntervalRemoved%28java.lang.Object, int, int%29), getListDataListeners, getListeners, removeListDataListener

Methods inherited from class javax.swing.AbstractListModel

addListDataListener, [fireContentsChanged](../../javax/swing/AbstractListModel.html#fireContentsChanged%28java.lang.Object, int, int%29), [fireIntervalAdded](../../javax/swing/AbstractListModel.html#fireIntervalAdded%28java.lang.Object, int, int%29), [fireIntervalRemoved](../../javax/swing/AbstractListModel.html#fireIntervalRemoved%28java.lang.Object, int, int%29), getListDataListeners, getListeners, removeListDataListener

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, [wait](../../java/lang/Object.html#wait%28long, int%29)

Methods inherited from interface javax.swing.ListModel
addListDataListener, removeListDataListener

Constructor Detail

DefaultComboBoxModel

public DefaultComboBoxModel()

Constructs an empty DefaultComboBoxModel object.

DefaultComboBoxModel

public DefaultComboBoxModel(Object[] items)

Constructs a DefaultComboBoxModel object initialized with an array of objects.

Parameters:

items - an array of Object objects

DefaultComboBoxModel

public DefaultComboBoxModel(Vector<?> v)

Constructs a DefaultComboBoxModel object initialized with a vector.

Parameters:

v - a Vector object ...

Method Detail

setSelectedItem

public void setSelectedItem(Object anObject)

Set the value of the selected item. The selected item may be null.

Specified by:

[setSelectedItem](../../javax/swing/ComboBoxModel.html#setSelectedItem%28java.lang.Object%29) in interface [ComboBoxModel](../../javax/swing/ComboBoxModel.html "interface in javax.swing")

Parameters:

anObject - The combo box value or null for no selection.

getSelectedItem

public Object getSelectedItem()

Description copied from interface: [ComboBoxModel](../../javax/swing/ComboBoxModel.html#getSelectedItem%28%29)

Returns the selected item

Specified by:

[getSelectedItem](../../javax/swing/ComboBoxModel.html#getSelectedItem%28%29) in interface [ComboBoxModel](../../javax/swing/ComboBoxModel.html "interface in javax.swing")

Returns:

The selected item or null if there is no selection

getSize

public int getSize()

Description copied from interface: [ListModel](../../javax/swing/ListModel.html#getSize%28%29)

Returns the length of the list.

Specified by:

[getSize](../../javax/swing/ListModel.html#getSize%28%29) in interface [ListModel](../../javax/swing/ListModel.html "interface in javax.swing")

Returns:

the length of the list

getElementAt

public Object getElementAt(int index)

Description copied from interface: [ListModel](../../javax/swing/ListModel.html#getElementAt%28int%29)

Returns the value at the specified index.

Specified by:

[getElementAt](../../javax/swing/ListModel.html#getElementAt%28int%29) in interface [ListModel](../../javax/swing/ListModel.html "interface in javax.swing")

Parameters:

index - the requested index

Returns:

the value at index

getIndexOf

public int getIndexOf(Object anObject)

Returns the index-position of the specified object in the list.

Parameters:

anObject -

Returns:

an int representing the index position, where 0 is the first position

addElement

public void addElement(Object anObject)

Description copied from interface: [MutableComboBoxModel](../../javax/swing/MutableComboBoxModel.html#addElement%28java.lang.Object%29)

Adds an item at the end of the model. The implementation of this method should notify all registered ListDataListeners that the item has been added.

Specified by:

[addElement](../../javax/swing/MutableComboBoxModel.html#addElement%28java.lang.Object%29) in interface [MutableComboBoxModel](../../javax/swing/MutableComboBoxModel.html "interface in javax.swing")

Parameters:

anObject - the Object to be added

insertElementAt

public void insertElementAt(Object anObject, int index)

Description copied from interface: [MutableComboBoxModel](../../javax/swing/MutableComboBoxModel.html#insertElementAt%28java.lang.Object, int%29)

Adds an item at a specific index. The implementation of this method should notify all registered ListDataListeners that the item has been added.

Specified by:

[insertElementAt](../../javax/swing/MutableComboBoxModel.html#insertElementAt%28java.lang.Object, int%29) in interface [MutableComboBoxModel](../../javax/swing/MutableComboBoxModel.html "interface in javax.swing")

Parameters:

anObject - the Object to be added

index - location to add the object

removeElementAt

public void removeElementAt(int index)

Description copied from interface: [MutableComboBoxModel](../../javax/swing/MutableComboBoxModel.html#removeElementAt%28int%29)

Removes an item at a specific index. The implementation of this method should notify all registered ListDataListeners that the item has been removed.

Specified by:

[removeElementAt](../../javax/swing/MutableComboBoxModel.html#removeElementAt%28int%29) in interface [MutableComboBoxModel](../../javax/swing/MutableComboBoxModel.html "interface in javax.swing")

Parameters:

index - location of object to be removed

removeElement

public void removeElement(Object anObject)

Description copied from interface: [MutableComboBoxModel](../../javax/swing/MutableComboBoxModel.html#removeElement%28java.lang.Object%29)

Removes an item from the model. The implementation of this method should should notify all registered ListDataListeners that the item has been removed.

Specified by:

[removeElement](../../javax/swing/MutableComboBoxModel.html#removeElement%28java.lang.Object%29) in interface [MutableComboBoxModel](../../javax/swing/MutableComboBoxModel.html "interface in javax.swing")

Parameters:

anObject - the Object to be removed

removeAllElements

public void removeAllElements()

Empties the list.

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.