AbstractListModel (Java Platform SE 6)

This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.

Overview

Package

Class

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.swing
class AbstractListModel

java.lang.Object
  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 JavaBeans^TM has been added to the java.beans package. Please see {@link java.beans.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`.
`EventListener[]`	`getListeners(Class listenerType)` Returns an array of all the objects currently registered as `FooListener`s 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`

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.

Parameters:: l - the ListDataListener to be added

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

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

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

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

getListeners

public EventListener[] getListeners(Class 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

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