JavaTM Platform
Standard Ed. 6

javax.swing
Class AbstractListModel

java.lang.Object
  extended by javax.swing.AbstractListModel
All Implemented Interfaces:
Serializable, ListModel
Direct Known Subclasses:
BasicDirectoryModel, DefaultComboBoxModel, DefaultListModel, MetalFileChooserUI.DirectoryComboBoxModel, MetalFileChooserUI.FilterComboBoxModel

public abstract class AbstractListModel
extends Object
implements ListModel, Serializable

The abstract definition for the data model that provides a List with its contents.

Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. As of 1.4, support for long term storage of all JavaBeansTM has been added to the java.beans package. Please see XMLEncoder.


Field Summary
protected  EventListenerList listenerList
           
 
Constructor Summary
AbstractListModel()
           
 
Method Summary
 void addListDataListener(ListDataListener l)
          Adds a listener to the list that's notified each time a change to the data model occurs.
protected  void fireContentsChanged(Object source, int index0, int index1)
          AbstractListModel subclasses must call this method after one or more elements of the list change.
protected  void fireIntervalAdded(Object source, int index0, int index1)
          AbstractListModel subclasses must call this method after one or more elements are added to the model.
protected  void fireIntervalRemoved(Object source, int index0, int index1)
          AbstractListModel subclasses must call this method after one or more elements are removed from the model.
 ListDataListener[] getListDataListeners()
          Returns an array of all the list data listeners registered on this AbstractListModel.
<T extends EventListener>
T[]
getListeners(Class<T> listenerType)
          Returns an array of all the objects currently registered as FooListeners upon this model.
 void removeListDataListener(ListDataListener l)
          Removes a listener from the list that's notified each time a change to the data model occurs.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface javax.swing.ListModel
getElementAt, getSize
 

Field Detail

listenerList

protected EventListenerList listenerList
Constructor Detail

AbstractListModel

public AbstractListModel()
Method Detail

addListDataListener

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

Specified by:
addListDataListener in interface ListModel
Parameters:
l - the ListDataListener to be added

removeListDataListener

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

Specified by:
removeListDataListener in interface ListModel
Parameters:
l - the ListDataListener to be removed

getListDataListeners

public ListDataListener[] getListDataListeners()
Returns an array of all the list data listeners registered on this AbstractListModel.

Returns:
all of this model's ListDataListeners, or an empty array if no list data listeners are currently registered
Since:
1.4
See Also:
addListDataListener(javax.swing.event.ListDataListener), removeListDataListener(javax.swing.event.ListDataListener)

fireContentsChanged

protected void fireContentsChanged(Object source,
                                   int index0,
                                   int index1)
AbstractListModel subclasses must call this method after one or more elements of the list change. The changed elements are specified by the closed interval index0, index1 -- the endpoints are included. Note that index0 need not be less than or equal to index1.

Parameters:
source - the ListModel that changed, typically "this"
index0 - one end of the new interval
index1 - the other end of the new interval
See Also:
EventListenerList, DefaultListModel

fireIntervalAdded

protected void fireIntervalAdded(Object source,
                                 int index0,
                                 int index1)
AbstractListModel subclasses must call this method after one or more elements are added to the model. The new elements are specified by a closed interval index0, index1 -- the enpoints are included. Note that index0 need not be less than or equal to index1.

Parameters:
source - the ListModel that changed, typically "this"
index0 - one end of the new interval
index1 - the other end of the new interval
See Also:
EventListenerList, DefaultListModel

fireIntervalRemoved

protected void fireIntervalRemoved(Object source,
                                   int index0,
                                   int index1)
AbstractListModel subclasses must call this method after one or more elements are removed from the model. index0 and index1 are the end points of the interval that's been removed. Note that index0 need not be less than or equal to index1.

Parameters:
source - the ListModel that changed, typically "this"
index0 - one end of the removed interval, including index0
index1 - the other end of the removed interval, including index1
See Also:
EventListenerList, DefaultListModel

getListeners

public <T extends EventListener> T[] getListeners(Class<T> listenerType)
Returns an array of all the objects currently registered as FooListeners upon this model. FooListeners are registered using the addFooListener method.

You can specify the listenerType argument with a class literal, such as FooListener.class. For example, you can query a list model m for its list data listeners with the following code:

ListDataListener[] ldls = (ListDataListener[])(m.getListeners(ListDataListener.class));
If no such listeners exist, this method returns an empty array.

Parameters:
listenerType - the type of listeners requested; this parameter should specify an interface that descends from java.util.EventListener
Returns:
an array of all objects registered as FooListeners on this model, or an empty array if no such listeners have been added
Throws:
ClassCastException - if listenerType doesn't specify a class or interface that implements java.util.EventListener
Since:
1.3
See Also:
getListDataListeners()

JavaTM Platform
Standard Ed. 6

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

Copyright 2005 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.