OpenJDK 1.22 · javax.swing.DefaultListModel · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private Vector<E>	delegate

Access	Constructor and Description
public	DefaultListModel() Constructs a `DefaultListModel`.

Method Summary

Modifier and Type	Method and Description
public void	add(int index at which the specified element is to be inserted index, E element to be inserted element) Inserts the specified element at the specified position in this list.
public void	addAll(Collection<? extends E> the collection which contains the elements to add c) Adds all of the elements present in the collection to the list.
public void	addAll(int index at which to insert the first element from the specified collection index, Collection<? extends E> the collection which contains the elements to add c) Adds all of the elements present in the collection, starting from the specified index.
public void	addElement(E the component to be added element) Adds the specified component to the end of this list.
public int	Returns: the current capacity capacity() Returns the current capacity of this list.
public void	clear() Removes all of the elements from this list.
public boolean	Returns: `true` if the specified object is the same as a component in this list contains(Object an object elem) Tests whether the specified object is a component in this list.
public void	copyInto(Object[] the array into which the components get copied anArray) Copies the components of this list into the specified array.
public E	Returns: the component at the specified index elementAt(int an index into this list index) Returns the component at the specified index.
public Enumeration<E>	Returns: an enumeration of the components of this list elements() Returns an enumeration of the components of this list.
public void	ensureCapacity(int the desired minimum capacity minCapacity) Increases the capacity of this list, if necessary, to ensure that it can hold at least the number of components specified by the minimum capacity argument.
public E	Returns: the first component of this list firstElement() Returns the first component of this list.
public E	Returns: the element at the specified position in this list get(int index of element to return index) Returns the element at the specified position in this list.
public E	Returns: the component at the specified index getElementAt(int an index into this list index) Implements javax.swing.ListModel.getElementAt. Returns the component at the specified index.
public int	Returns: the number of components in this list getSize() Implements javax.swing.ListModel.getSize. Returns the number of components in this list.
public int	Returns: the index of the first occurrence of the argument in this list; returns `-1` if the object is not found indexOf(Object an object elem) Searches for the first occurrence of `elem`.
public int	Returns: the index where the first occurrence of `elem` is found after `index`; returns `-1` if the `elem` is not found in the list indexOf(Object the desired component elem, int the index from which to begin searching index) Searches for the first occurrence of `elem`, beginning the search at `index`.
public void	insertElementAt(E the component to insert element, int where to insert the new component index) Inserts the specified element as a component in this list at the specified `index`.
public boolean	Returns: `true` if and only if this list has no components, that is, its size is zero; `false` otherwise isEmpty() Tests whether this list has any components.
public E	Returns: the last component of the list lastElement() Returns the last component of the list.
public int	Returns: the index of the last occurrence of `elem` in the list; returns `elem` if the object is not found lastIndexOf(Object the desired component elem) Returns the index of the last occurrence of `elem`.
public int	Returns: the index of the last occurrence of the `elem` in this list at position less than `index`; returns `-1` if the object is not found lastIndexOf(Object the desired component elem, int the index to start searching from index) Searches backwards for `elem`, starting from the specified index, and returns an index to it.
public E	Returns: the element previously at the specified position remove(int the index of the element to removed index) Removes the element at the specified position in this list.
public void	removeAllElements() Removes all components from this list and sets its size to zero.
public boolean	Returns: `true` if the argument was a component of this list; `false` otherwise removeElement(Object the component to be removed obj) Removes the first (lowest-indexed) occurrence of the argument from this list.
public void	removeElementAt(int the index of the object to remove index) Deletes the component at the specified index.
public void	removeRange(int the index of the lower end of the range fromIndex, int the index of the upper end of the range toIndex) Deletes the components at the specified range of indexes.
public E	Returns: the element previously at the specified position set(int index of element to replace index, E element to be stored at the specified position element) Replaces the element at the specified position in this list with the specified element.
public void	setElementAt(E what the component is to be set to element, int the specified index index) Sets the component at the specified `index` of this list to be the specified element.
public void	setSize(int the new size of this list newSize) Sets the size of this list.
public int	Returns: the number of components in this list size() Returns the number of components in this list.
public Object[]	Returns: an array containing the elements of the list toArray() Returns an array containing all of the elements in this list in the correct order.
public String	Returns: a String representation of this object toString() Overrides java.lang.Object.toString. Returns a string that displays and identifies this object's properties.
public void	trimToSize() Trims the capacity of this list to be the list's current size.

Inherited from javax.swing.AbstractListModel:: addListDataListener fireContentsChanged fireIntervalAdded fireIntervalRemoved getListDataListeners getListeners removeListDataListener

delegate	back to summary
private Vector<E> delegate

DefaultListModel	back to summary
public DefaultListModel() Constructs a `DefaultListModel`.

Method Detail

add back to summary

add	back to summary
public void add(int index, E element) Inserts the specified element at the specified position in this list. Parameters index:int index at which the specified element is to be inserted element:E element to be inserted Exceptions ArrayIndexOutOfBoundsException: if the index is out of range (`index < 0 \|\| index > size()`)

public void add(int index, E element)

Inserts the specified element at the specified position in this list.

Parameters

index:int: index at which the specified element is to be inserted
element:E: element to be inserted

Exceptions

ArrayIndexOutOfBoundsException:: if the index is out of range (index < 0 || index > size())

addAll back to summary

addAll	back to summary
public void addAll(Collection<? extends E> c) Adds all of the elements present in the collection to the list. Parameters c:Collection<? extends E> the collection which contains the elements to add Exceptions NullPointerException: if `c` is null

public void addAll(Collection<? extends E> c)

Adds all of the elements present in the collection to the list.

Parameters

c:Collection<? extends E>: the collection which contains the elements to add

Exceptions

NullPointerException:: if c is null

addAll back to summary

addAll	back to summary
public void addAll(int index, Collection<? extends E> c) Adds all of the elements present in the collection, starting from the specified index. Parameters index:int index at which to insert the first element from the specified collection c:Collection<? extends E> the collection which contains the elements to add Exceptions ArrayIndexOutOfBoundsException: if `index` does not fall within the range of number of elements currently held NullPointerException: if `c` is null

public void addAll(int index, Collection<? extends E> c)

Adds all of the elements present in the collection, starting from the specified index.

Parameters

index:int: index at which to insert the first element from the specified collection
c:Collection<? extends E>: the collection which contains the elements to add

Exceptions

ArrayIndexOutOfBoundsException:: if index does not fall within the range of number of elements currently held
NullPointerException:: if c is null

addElement back to summary

addElement	back to summary
public void addElement(E element) Adds the specified component to the end of this list. Parameters element:E the component to be added See Also `Vector#addElement(Object)`

public void addElement(E element)

Adds the specified component to the end of this list.

Parameters

element:E: the component to be added

See Also

Vector#addElement(Object)

capacity back to summary

capacity	back to summary
public int capacity() Returns the current capacity of this list. Returns:int the current capacity See Also `Vector#capacity()`

public int capacity()

Returns the current capacity of this list.

Returns:int: the current capacity
See Also: Vector#capacity()

clear	back to summary
public void clear() Removes all of the elements from this list. The list will be empty after this call returns (unless it throws an exception).

contains back to summary

contains	back to summary
public boolean contains(Object elem) Tests whether the specified object is a component in this list. Parameters elem:Object an object Returns:boolean `true` if the specified object is the same as a component in this list See Also `Vector#contains(Object)`

public boolean contains(Object elem)

Tests whether the specified object is a component in this list.

Parameters

elem:Object: an object

Returns:boolean

true if the specified object is the same as a component in this list

See Also

Vector#contains(Object)

copyInto back to summary

copyInto	back to summary
public void copyInto(Object[] anArray) Copies the components of this list into the specified array. The array must be big enough to hold all the objects in this list, else an `IndexOutOfBoundsException` is thrown. Parameters anArray:Object[] the array into which the components get copied See Also `Vector#copyInto(Object[])`

public void copyInto(Object[] anArray)

Copies the components of this list into the specified array. The array must be big enough to hold all the objects in this list, else an IndexOutOfBoundsException is thrown.

Parameters

anArray:Object[]: the array into which the components get copied

See Also

Vector#copyInto(Object[])

elementAt back to summary

elementAt	back to summary
public E elementAt(int index) Returns the component at the specified index. Note Although this method is not deprecated, the preferred method to use is `get(int)`, which implements the `List` interface defined in the 1.2 Collections framework. Parameters index:int an index into this list Returns:E the component at the specified index Exceptions ArrayIndexOutOfBoundsException: if the index is negative or not less than the size of the list See Also `get(int)`, `Vector#elementAt(int)`

public E elementAt(int index)

Returns the component at the specified index.

Note

Although this method is not deprecated, the preferred method to use is get(int), which implements the List interface defined in the 1.2 Collections framework.

Parameters

index:int: an index into this list

Returns:E

the component at the specified index

Exceptions

ArrayIndexOutOfBoundsException:: if the index is negative or not less than the size of the list

See Also

get(int), Vector#elementAt(int)

elements back to summary

elements	back to summary
public Enumeration<E> elements() Returns an enumeration of the components of this list. Returns:Enumeration<E> an enumeration of the components of this list See Also `Vector#elements()`

public Enumeration<E> elements()

Returns an enumeration of the components of this list.

Returns:Enumeration<E>: an enumeration of the components of this list
See Also: Vector#elements()

ensureCapacity back to summary

ensureCapacity	back to summary
public void ensureCapacity(int minCapacity) Increases the capacity of this list, if necessary, to ensure that it can hold at least the number of components specified by the minimum capacity argument. Parameters minCapacity:int the desired minimum capacity See Also `Vector#ensureCapacity(int)`

public void ensureCapacity(int minCapacity)

Increases the capacity of this list, if necessary, to ensure that it can hold at least the number of components specified by the minimum capacity argument.

Parameters

minCapacity:int: the desired minimum capacity

See Also

Vector#ensureCapacity(int)

firstElement back to summary

firstElement	back to summary
public E firstElement() Returns the first component of this list. Returns:E the first component of this list Exceptions NoSuchElementException: if this vector has no components See Also `Vector#firstElement()`

public E firstElement()

Returns the first component of this list.

Returns:E

the first component of this list

Exceptions

NoSuchElementException:: if this vector has no components

See Also

Vector#firstElement()

get back to summary

get	back to summary
public E get(int index) Returns the element at the specified position in this list. Parameters index:int index of element to return Returns:E the element at the specified position in this list Exceptions ArrayIndexOutOfBoundsException: if the index is out of range (`index < 0 \|\| index >= size()`)

public E get(int index)

Returns the element at the specified position in this list.

Parameters

index:int: index of element to return

Returns:E

the element at the specified position in this list

Exceptions

ArrayIndexOutOfBoundsException:: if the index is out of range (index < 0 || index >= size())

getElementAt back to summary

getElementAt	back to summary
public E getElementAt(int index) Implements javax.swing.ListModel.getElementAt. Returns the component at the specified index. Note Although this method is not deprecated, the preferred method to use is `get(int)`, which implements the `List` interface defined in the 1.2 Collections framework. Parameters index:int an index into this list Returns:E the component at the specified index Exceptions ArrayIndexOutOfBoundsException: if the `index` is negative or greater than the current size of this list See Also `get(int)`

public E getElementAt(int index)

Implements javax.swing.ListModel.getElementAt.

Returns the component at the specified index.

Note

Although this method is not deprecated, the preferred method to use is get(int), which implements the List interface defined in the 1.2 Collections framework.

Parameters

index:int: an index into this list

Returns:E

the component at the specified index

Exceptions

ArrayIndexOutOfBoundsException:: if the index is negative or greater than the current size of this list

See Also

get(int)

getSize back to summary

getSize	back to summary
public int getSize() Implements javax.swing.ListModel.getSize. Returns the number of components in this list. This method is identical to `size`, which implements the `List` interface defined in the 1.2 Collections framework. This method exists in conjunction with `setSize` so that `size` is identifiable as a JavaBean property. Returns:int the number of components in this list See Also `size()`

public int getSize()

Implements javax.swing.ListModel.getSize.

Returns the number of components in this list.

This method is identical to size, which implements the List interface defined in the 1.2 Collections framework. This method exists in conjunction with setSize so that size is identifiable as a JavaBean property.

Returns:int: the number of components in this list
See Also: size()

indexOf back to summary

indexOf	back to summary
public int indexOf(Object elem) Searches for the first occurrence of `elem`. Parameters elem:Object an object Returns:int the index of the first occurrence of the argument in this list; returns `-1` if the object is not found See Also `Vector#indexOf(Object)`

public int indexOf(Object elem)

Searches for the first occurrence of elem.

Parameters

elem:Object: an object

Returns:int

the index of the first occurrence of the argument in this list; returns -1 if the object is not found

See Also

Vector#indexOf(Object)

indexOf back to summary

indexOf	back to summary
public int indexOf(Object elem, int index) Searches for the first occurrence of `elem`, beginning the search at `index`. Parameters elem:Object the desired component index:int the index from which to begin searching Returns:int the index where the first occurrence of `elem` is found after `index`; returns `-1` if the `elem` is not found in the list See Also `Vector#indexOf(Object, int)`

public int indexOf(Object elem, int index)

Searches for the first occurrence of elem, beginning the search at index.

Parameters

elem:Object: the desired component
index:int: the index from which to begin searching

Returns:int

the index where the first occurrence of elem is found after index; returns -1 if the elem is not found in the list

See Also

Vector#indexOf(Object, int)

insertElementAt back to summary

insertElementAt	back to summary
public void insertElementAt(E element, int index) Inserts the specified element as a component in this list at the specified `index`. Note Although this method is not deprecated, the preferred method to use is `add(int,Object)`, which implements the `List` interface defined in the 1.2 Collections framework. Parameters element:E the component to insert index:int where to insert the new component Exceptions ArrayIndexOutOfBoundsException: if the index was invalid See Also `add(int, Object)`, `Vector#insertElementAt(Object, int)`

public void insertElementAt(E element, int index)

Inserts the specified element as a component in this list at the specified index.

Note

Although this method is not deprecated, the preferred method to use is add(int,Object), which implements the List interface defined in the 1.2 Collections framework.

Parameters

element:E: the component to insert
index:int: where to insert the new component

Exceptions

ArrayIndexOutOfBoundsException:: if the index was invalid

isEmpty back to summary

isEmpty	back to summary
public boolean isEmpty() Tests whether this list has any components. Returns:boolean `true` if and only if this list has no components, that is, its size is zero; `false` otherwise See Also `Vector#isEmpty()`

public boolean isEmpty()

Tests whether this list has any components.

Returns:boolean: true if and only if this list has no components, that is, its size is zero; false otherwise
See Also: Vector#isEmpty()

lastElement back to summary

lastElement	back to summary
public E lastElement() Returns the last component of the list. Returns:E the last component of the list Exceptions NoSuchElementException: if this vector has no components See Also `Vector#lastElement()`

public E lastElement()

Returns the last component of the list.

Returns:E

the last component of the list

Exceptions

NoSuchElementException:: if this vector has no components

See Also

Vector#lastElement()

lastIndexOf back to summary

lastIndexOf	back to summary
public int lastIndexOf(Object elem) Returns the index of the last occurrence of `elem`. Parameters elem:Object the desired component Returns:int the index of the last occurrence of `elem` in the list; returns `elem` if the object is not found See Also `Vector#lastIndexOf(Object)`

public int lastIndexOf(Object elem)

Returns the index of the last occurrence of elem.

Parameters

elem:Object: the desired component

Returns:int

the index of the last occurrence of elem in the list; returns elem if the object is not found

See Also

Vector#lastIndexOf(Object)

lastIndexOf back to summary

lastIndexOf	back to summary
public int lastIndexOf(Object elem, int index) Searches backwards for `elem`, starting from the specified index, and returns an index to it. Parameters elem:Object the desired component index:int the index to start searching from Returns:int the index of the last occurrence of the `elem` in this list at position less than `index`; returns `-1` if the object is not found See Also `Vector#lastIndexOf(Object, int)`

public int lastIndexOf(Object elem, int index)

Searches backwards for elem, starting from the specified index, and returns an index to it.

Parameters

elem:Object: the desired component
index:int: the index to start searching from

Returns:int

the index of the last occurrence of the elem in this list at position less than index; returns -1 if the object is not found

See Also

Vector#lastIndexOf(Object, int)

remove back to summary

remove	back to summary
public E remove(int index) Removes the element at the specified position in this list. Returns the element that was removed from the list Parameters index:int the index of the element to removed Returns:E the element previously at the specified position Exceptions ArrayIndexOutOfBoundsException: if the index is out of range (`index < 0 \|\| index >= size()`)

public E remove(int index)

Removes the element at the specified position in this list. Returns the element that was removed from the list

Parameters

index:int: the index of the element to removed

Returns:E

the element previously at the specified position

Exceptions

ArrayIndexOutOfBoundsException:: if the index is out of range (index < 0 || index >= size())

removeAllElements back to summary

removeAllElements	back to summary
public void removeAllElements() Removes all components from this list and sets its size to zero. Note Although this method is not deprecated, the preferred method to use is `clear`, which implements the `List` interface defined in the 1.2 Collections framework. See Also `clear()`, `Vector#removeAllElements()`

public void removeAllElements()

Removes all components from this list and sets its size to zero.

Note

Although this method is not deprecated, the preferred method to use is clear, which implements the List interface defined in the 1.2 Collections framework.

See Also: clear(), Vector#removeAllElements()

removeElement back to summary

removeElement	back to summary
public boolean removeElement(Object obj) Removes the first (lowest-indexed) occurrence of the argument from this list. Parameters obj:Object the component to be removed Returns:boolean `true` if the argument was a component of this list; `false` otherwise See Also `Vector#removeElement(Object)`

public boolean removeElement(Object obj)

Removes the first (lowest-indexed) occurrence of the argument from this list.

Parameters

obj:Object: the component to be removed

Returns:boolean

true if the argument was a component of this list; false otherwise

See Also

Vector#removeElement(Object)

removeElementAt back to summary

removeElementAt	back to summary
public void removeElementAt(int index) Deletes the component at the specified index. Note Although this method is not deprecated, the preferred method to use is `remove(int)`, which implements the `List` interface defined in the 1.2 Collections framework. Parameters index:int the index of the object to remove Exceptions ArrayIndexOutOfBoundsException: if the index is invalid See Also `remove(int)`, `Vector#removeElementAt(int)`

public void removeElementAt(int index)

Deletes the component at the specified index.

Note

Although this method is not deprecated, the preferred method to use is remove(int), which implements the List interface defined in the 1.2 Collections framework.

Parameters

index:int: the index of the object to remove

Exceptions

ArrayIndexOutOfBoundsException:: if the index is invalid

removeRange back to summary

removeRange	back to summary
public void removeRange(int fromIndex, int toIndex) Deletes the components at the specified range of indexes. The removal is inclusive, so specifying a range of (1,5) removes the component at index 1 and the component at index 5, as well as all components in between. Parameters fromIndex:int the index of the lower end of the range toIndex:int the index of the upper end of the range Exceptions ArrayIndexOutOfBoundsException: if the index was invalid IllegalArgumentException: if `fromIndex > toIndex` See Also `remove(int)`

public void removeRange(int fromIndex, int toIndex)

Deletes the components at the specified range of indexes. The removal is inclusive, so specifying a range of (1,5) removes the component at index 1 and the component at index 5, as well as all components in between.

Parameters

fromIndex:int: the index of the lower end of the range
toIndex:int: the index of the upper end of the range

Exceptions

ArrayIndexOutOfBoundsException:: if the index was invalid
IllegalArgumentException:: if fromIndex > toIndex

See Also

remove(int)

set back to summary

set	back to summary
public E set(int index, E element) Replaces the element at the specified position in this list with the specified element. Parameters index:int index of element to replace element:E element to be stored at the specified position Returns:E the element previously at the specified position Exceptions ArrayIndexOutOfBoundsException: if the index is out of range (`index < 0 \|\| index >= size()`)

public E set(int index, E element)

Replaces the element at the specified position in this list with the specified element.

Parameters

index:int: index of element to replace
element:E: element to be stored at the specified position

Returns:E

the element previously at the specified position

Exceptions

ArrayIndexOutOfBoundsException:: if the index is out of range (index < 0 || index >= size())

setElementAt back to summary

setElementAt	back to summary
public void setElementAt(E element, int index) Sets the component at the specified `index` of this list to be the specified element. The previous component at that position is discarded. Note Although this method is not deprecated, the preferred method to use is `set(int,Object)`, which implements the `List` interface defined in the 1.2 Collections framework. Parameters element:E what the component is to be set to index:int the specified index Exceptions ArrayIndexOutOfBoundsException: if the index is invalid See Also `set(int, Object)`, `Vector#setElementAt(Object, int)`

public void setElementAt(E element, int index)

Sets the component at the specified index of this list to be the specified element. The previous component at that position is discarded.

Note

Although this method is not deprecated, the preferred method to use is set(int,Object), which implements the List interface defined in the 1.2 Collections framework.

Parameters

element:E: what the component is to be set to
index:int: the specified index

Exceptions

ArrayIndexOutOfBoundsException:: if the index is invalid

setSize back to summary

setSize	back to summary
public void setSize(int newSize) Sets the size of this list. Parameters newSize:int the new size of this list See Also `Vector#setSize(int)`

public void setSize(int newSize)

Sets the size of this list.

Parameters

newSize:int: the new size of this list

See Also

Vector#setSize(int)

size back to summary

size	back to summary
public int size() Returns the number of components in this list. Returns:int the number of components in this list See Also `Vector#size()`

public int size()

Returns the number of components in this list.

Returns:int: the number of components in this list
See Also: Vector#size()

toArray back to summary

toArray	back to summary
public Object[] toArray() Returns an array containing all of the elements in this list in the correct order. Returns:Object[] an array containing the elements of the list See Also `Vector#toArray()`

public Object[] toArray()

Returns an array containing all of the elements in this list in the correct order.

Returns:Object[]: an array containing the elements of the list
See Also: Vector#toArray()

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Returns a string that displays and identifies this object's properties. Returns:String a String representation of this object

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Returns a string that displays and identifies this object's properties.

Returns:String: a String representation of this object

trimToSize back to summary

trimToSize	back to summary
public void trimToSize() Trims the capacity of this list to be the list's current size. See Also `Vector#trimToSize()`

public void trimToSize()

Trims the capacity of this list to be the list's current size.

See Also: Vector#trimToSize()

public Class DefaultListModel<E>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail