com.jgoodies.binding.list

Class ArrayListModel<E>

Implemented Interfaces:
List, ListModel, ObservableList<E>

public final class ArrayListModel<E>
extends ArrayList
implements ObservableList<E>

Adds javax.swing.ListModel capabilities to its superclass ArrayList, i. e. allows to observe changes in the content and structure. Useful for lists that are bound to list views, for example JList, JComboBox and JTable.
Version:
$Revision: 1.5 $
Author:
Karsten Lentzsch

Constructor Summary

ArrayListModel()
Constructs an empty list with an initial capacity of ten.
ArrayListModel(E> c)
Constructs a list containing the elements of the specified collection, in the order they are returned by the collection's iterator.
ArrayListModel(int initialCapacity)
Constructs an empty list with the specified initial capacity.

Method Summary

@Override
E remove(int index)
Removes the element at the specified position in this list.
@Override
E set(int index, E element)
Replaces the element at the specified position in this list with the specified element.
void
addListDataListener(ListDataListener l)
Adds a listener to the list that's notified each time a change to the data model occurs.
@Override
boolean add(E e)
Appends the specified element to the end of this list.
@Override
boolean addAll(E> c)
Appends all of the elements in the specified Collection to the end of this list, in the order that they are returned by the specified Collection's Iterator.
@Override
boolean addAll(int index, E> c)
Inserts all of the elements in the specified Collection into this list, starting at the specified position.
@Override
boolean remove(Object o)
Removes a single instance of the specified element from this list, if it is present (optional operation).
void
fireContentsChanged(int index)
Notifies all registered ListDataListeners that the element at the specified index has changed.
Object
getElementAt(int index)
Returns the value at the specified index.
ListDataListener[]
getListDataListeners()
Returns an array of all the list data listeners registered on this ArrayListModel.
int
getSize()
Returns the length of the list or 0 if there's no list.
void
removeListDataListener(ListDataListener l)
Removes a listener from the list that's notified each time a change to the data model occurs.
@Override
void add(int index, E element)
Inserts the specified element at the specified position in this list.
@Override
void clear()
Removes all of the elements from this list.
protected @Override
void removeRange(int fromIndex, int toIndex)
Removes from this List all of the elements whose index is between fromIndex, inclusive and toIndex, exclusive.

Constructor Details

ArrayListModel

public ArrayListModel()
Constructs an empty list with an initial capacity of ten.

ArrayListModel

public ArrayListModel(E> c)
Constructs a list containing the elements of the specified collection, in the order they are returned by the collection's iterator. The ArrayListModel instance has an initial capacity of 110% the size of the specified collection.
Parameters:
c - the collection whose elements are to be placed into this list.

ArrayListModel

public ArrayListModel(int initialCapacity)
Constructs an empty list with the specified initial capacity.
Parameters:
initialCapacity - the initial capacity of the list.

Method Details

E remove

public @Override E remove(int index)
Removes the element at the specified position in this list. Shifts any subsequent elements to the left (subtracts one from their indices).
Parameters:
index - the index of the element to removed.
Returns:
the element that was removed from the list.

E set

public @Override E set(int index,
                       E element)
Replaces the element at the specified position in this list with the specified element.
Parameters:
index - index of element to replace.
element - element to be stored at the specified position.
Returns:
the element previously at the specified position.

addListDataListener

public void addListDataListener(ListDataListener l)
Adds a listener to the list that's notified each time a change to the data model occurs.
Parameters:
l - the ListDataListener to be added

boolean add

public @Override boolean add(E e)
Appends the specified element to the end of this list.
Parameters:
e - element to be appended to this list.
Returns:
true (as per the general contract of Collection.add).

boolean addAll

public @Override boolean addAll(E> c)
Appends all of the elements in the specified Collection to the end of this list, in the order that they are returned by the specified Collection's Iterator. The behavior of this operation is undefined if the specified Collection is modified while the operation is in progress. (This implies that the behavior of this call is undefined if the specified Collection is this list, and this list is nonempty.)
Parameters:
c - the elements to be inserted into this list.
Returns:
true if this list changed as a result of the call.

boolean addAll

public @Override boolean addAll(int index,
                                E> c)
Inserts all of the elements in the specified Collection into this list, starting at the specified position. Shifts the element currently at that position (if any) and any subsequent elements to the right (increases their indices). The new elements will appear in the list in the order that they are returned by the specified Collection's iterator.
Parameters:
index - index at which to insert first element from the specified collection.
c - elements to be inserted into this list.
Returns:
true if this list changed as a result of the call.

boolean remove

public @Override boolean remove(Object o)
Removes a single instance of the specified element from this list, if it is present (optional operation). More formally, removes an element e such that (o==null ? e==null : o.equals(e)), if the list contains one or more such elements. Returns true if the list contained the specified element (or equivalently, if the list changed as a result of the call).

This implementation looks for the index of the specified element. If it finds the element, it removes the element at this index by calling #remove(int) that fires a ListDataEvent.

Parameters:
o - element to be removed from this list, if present.
Returns:
true if the list contained the specified element.

fireContentsChanged

public void fireContentsChanged(int index)
Notifies all registered ListDataListeners that the element at the specified index has changed. Useful if there's a content change without any structural change.

This method must be called after the element of the list changes.

Parameters:
index - the index of the element that has changed
See Also:
EventListenerList

getElementAt

public Object getElementAt(int index)
Returns the value at the specified index.
Parameters:
index - the requested index
Returns:
the value at index

getListDataListeners

public ListDataListener[] getListDataListeners()
Returns an array of all the list data listeners registered on this ArrayListModel.
Returns:
all of this model's ListDataListeners, or an empty array if no list data listeners are currently registered

getSize

public int getSize()
Returns the length of the list or 0 if there's no list.
Returns:
the length of the list or 0 if there's no list

removeListDataListener

public void removeListDataListener(ListDataListener l)
Removes a listener from the list that's notified each time a change to the data model occurs.
Parameters:
l - the ListDataListener to be removed

void add

public @Override void add(int index,
                          E element)
Inserts the specified element at the specified position in this list. Shifts the element currently at that position (if any) and any subsequent elements to the right (adds one to their indices).
Parameters:
index - index at which the specified element is to be inserted.
element - element to be inserted.

void clear

public @Override void clear()
Removes all of the elements from this list. The list will be empty after this call returns.

void removeRange

protected @Override void removeRange(int fromIndex,
                                     int toIndex)
Removes from this List all of the elements whose index is between fromIndex, inclusive and toIndex, exclusive. Shifts any succeeding elements to the left (reduces their index). This call shortens the list by (toIndex - fromIndex) elements. (If toIndex==fromIndex, this operation has no effect.)
Parameters:
fromIndex - index of first element to be removed.
toIndex - index after last element to be removed.

Copyright © 2002-2007 JGoodies Karsten Lentzsch. All Rights Reserved.