Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.jgoodies.binding.list
Class SelectionInList<E>

    java.lang.Object
      com.jgoodies.common.bean.AbstractBean
          com.jgoodies.binding.beans.Model
              com.jgoodies.binding.list.IndirectListModel<E>
                  com.jgoodies.binding.list.SelectionInList<E>

Type Parameters:
  `E` - the type of the list elements and the selection

All Implemented Interfaces:
  ValueModel, com.jgoodies.common.bean.ObservableBean, com.jgoodies.common.bean.ObservableBean2, Serializable, ListModel

    public final class SelectionInList<E>

extends IndirectListModel<E>
implements ValueModel

Represents a selection in a list of objects. Provides bound bean properties for the list, the selection, the selection index, and the selection empty state. The SelectionInList implements ValueModel with the selection as value. Selection changes fire an event only if the old and new value are not equal. If you need to compare the identity you can use and observe the selection index instead of the selection or value.

The SelectionInList uses three ValueModels to hold the list, the selection and selection index and provides bound bean properties for these models. You can access, observe and replace these ValueModels. This is useful to connect a SelectionInList with other ValueModels; for example you can use the SelectionInList's selection holder as bean channel for a PresentationModel. Since the SelectionInList is a ValueModel, it is often used as bean channel. See the Binding tutorial classes for examples on how to connect a SelectionInList with a PresentationModel.

This class also implements the `ListModel` interface that allows API users to observe fine grained changes in the structure and contents of the list. Hence instances of this class can be used directly as model of a JList. If you want to use a SelectionInList with a JComboBox or JTable, you can convert the SelectionInList to the associated component model interfaces using the adapter classes `ComboBoxAdapter` and `AbstractTableAdapter` respectively. These classes are part of the Binding library too.

The SelectionInList supports two list types as content of its list holder: `List` and `ListModel`. The two modes differ in how precise this class can fire events about changes to the content and structure of the list. If you use a List, this class can only report that the list changes completely; this is done by firing a PropertyChangeEvent for the list property. Also, a `ListDataEvent` is fired that reports a complete change. In contrast, if you use a ListModel it will report the same PropertyChangeEvent. But fine grained changes in the list model will be fired by this class to notify observes about changes in the content, added and removed elements.

If the list content doesn't change at all, or if it always changes completely, you can work well with both List content and ListModel content. But if the list structure or content changes, the ListModel reports more fine grained events to registered ListDataListeners, which in turn allows list views to chooser better user interface gestures: for example, a table with scroll pane may retain the current selection and scroll offset.

An example for using a ListModel in a SelectionInList is the asynchronous transport of list elements from a server to a client. Let's say you transport the list elements in portions of 10 elements to improve the application's responsiveness. The user can then select and work with the SelectionInList as soon as the ListModel gets populated. If at a later time more elements are added to the list model, the SelectionInList can retain the selection index (and selection) and will just report a ListDataEvent about the interval added. JList, JTable and JComboBox will then just add the new elements at the end of the list presentation.

If you want to combine List operations and the ListModel change reports, you may consider using an implementation that combines these two interfaces, for example `com.jgoodies.common.collect.ArrayListModel` or `com.jgoodies.common.collect.LinkedListModel`.

Important Note: If you change the ListModel instance, either by calling `#setListModel(ListModel)` or by setting a new value to the underlying list holder, you must ensure that the list holder throws a PropertyChangeEvent whenever the instance changes. This event is used to remove a ListDataListener from the old ListModel instance and is later used to add it to the new ListModel instance. It is easy to violate this constraint, just because Java's standard PropertyChangeSupport helper class that is used by many beans, checks a changed property value via `#equals`, not `==`. For example, if you change the SelectionInList's list model from an empty list `L1` to another empty list instance `L2`, the PropertyChangeSupport won't generate a PropertyChangeEvent, and so, the SelectionInList won't know about the change, which may lead to unexpected behavior.

This binding library provides some help for firing PropertyChangeEvents if the old ListModel and new ListModel are equal but not the same. Class `ExtendedPropertyChangeSupport` allows to permanently or individually check the identity (using `==`) instead of checking the equity (using `#equals`). Class `Model` uses this extended property change support. And class `ValueHolder` uses it too and can be configured to always test the identity.

Since version 1.0.2 this class provides public convenience methods for firing ListDataEvents, see the methods `#fireContentsChanged`, `#fireIntervalAdded`, and `#fireIntervalRemoved`. These are automatically invoked if the list holder holds a ListModel that fires these events. If on the other hand the underlying List or ListModel does not fire a required ListDataEvent, you can use these methods to notify presentations about a change. It is recommended to avoid sending duplicate ListDataEvents; hence check if the underlying ListModel fires the necessary events or not. Typically an underlying ListModel will fire the add and remove events; but often it'll lack an event if the (selected) contents has changed. A convenient way to indicate that change is `#fireSelectedContentsChanged`. See the tutorial's AlbumManagerModel for an example how to use this feature.

The SelectionInList is partially defined for Lists and ListModels that contain `null`. Setting the selection to `null` on a SelectionInList that contains `null` won't set the selection index to the index of the first `null` element. For details see the `setSelection(Object)` JavaDocs. This is because the current implementation interprets a `null` selection as unspecified, which maps better to a cleared selection than to a concrete selection index. Anyway, as long as you work with the selection index and selection index holder, such a SelectionInList will work fine. This is the case if you bind a SelectionInList to a JList or JTable. Binding such a SelectionInList to a JComboBox won't synchronize the selection index if `null` is selected.

Constraints: The list holder holds instances of `List` or `ListModel`, the selection holder values of type `E` and the selection index holder of type `Integer`. The selection index holder must hold non-null index values; however, when firing an index value change event, both the old and new value may be null. If the ListModel changes, the underlying ValueModel must fire a PropertyChangeEvent.

Version:
  $Revision: 1.43 $
Author:
  Karsten Lentzsch
See Also:
  `ValueModel`, `List`, `ListModel`, `ComboBoxAdapter`, `AbstractTableAdapter`, `ExtendedPropertyChangeSupport`, `Model`, `ValueHolder`, Serialized Form

Field Summary
`static String` | `PROPERTYNAME_SELECTION` The name of the bound read-write selection property.
`static String` | `PROPERTYNAME_SELECTION_EMPTY` The name of the bound read-only selectionEmpty property.
`static String` | `PROPERTYNAME_SELECTION_HOLDER` The name of the bound read-write selection holder property.
`static String` | `PROPERTYNAME_SELECTION_INDEX` The name of the bound read-write selectionIndex property.
`static String` | `PROPERTYNAME_SELECTION_INDEX_HOLDER` The name of the bound read-write selection index holder property.
`static String` | `PROPERTYNAME_VALUE` The name of the bound read-write value property.

Fields inherited from class com.jgoodies.binding.list.IndirectListModel
`PROPERTYNAME_LIST, PROPERTYNAME_LIST_HOLDER`

Fields inherited from class com.jgoodies.common.bean.AbstractBean
`changeSupport`

Constructor Summary
`SelectionInList()` Constructs a SelectionInList with an empty initial `ArrayListModel` using defaults for the selection holder and selection index holder.
`SelectionInList(E[] listItems)` Constructs a SelectionInList on the given item array using defaults for the selection holder and selection index holder.
`SelectionInList(E[] listItems, ValueModel selectionHolder)` Constructs a SelectionInList on the given item array and selection holder using a default selection index holder.
`SelectionInList(E[] listItems, ValueModel selectionHolder, ValueModel selectionIndexHolder)` Constructs a SelectionInList on the given item array and selection holder using a default selection index holder.
`SelectionInList(List<E> list)` Constructs a SelectionInList on the given list using defaults for the selection holder and selection index holder.
`SelectionInList(List<E> list, ValueModel selectionHolder)` Constructs a SelectionInList on the given list and selection holder using a default selection index holder.
`SelectionInList(List<E> list, ValueModel selectionHolder, ValueModel selectionIndexHolder)` Constructs a SelectionInList on the given list, selection holder, and selection index holder.
`SelectionInList(ListModel listModel)` Constructs a SelectionInList on the given list model using defaults for the selection holder and selection index holder.
`SelectionInList(ListModel listModel, ValueModel selectionHolder)` Constructs a SelectionInList on the given list model and selection holder using a default selection index holder.
`SelectionInList(ListModel listModel, ValueModel selectionHolder, ValueModel selectionIndexHolder)` Constructs a SelectionInList on the given list model, selection holder, and selection index holder.
`SelectionInList(ValueModel listHolder)` Constructs a SelectionInList on the given list holder using defaults for the selection holder and selection index holder.
`SelectionInList(ValueModel listHolder, ValueModel selectionHolder)` Constructs a SelectionInList on the given list holder, selection holder and selection index holder.
`SelectionInList(ValueModel listHolder, ValueModel selectionHolder, ValueModel selectionIndexHolder)` Constructs a SelectionInList on the given list holder, selection holder and selection index holder.

Method Summary
`void` | `addValueChangeListener(PropertyChangeListener l)` Registers the given PropertyChangeListener with this model.
`void` | `clearSelection()` Clears the selection of this SelectionInList - if any.
`protected ListDataListener` | `createListDataChangeHandler()` Creates and returns the ListDataListener used to observe changes in the underlying ListModel.
`void` | `fireSelectedContentsChanged()` Notifies all registered ListDataListeners that the contents of the selected list item - if any - has changed.
`E` | `getSelection()` Looks up and returns the current selection using the current selection index.
`ValueModel` | `getSelectionHolder()` Returns the selection holder.
`int` | `getSelectionIndex()` Returns the selection index.
`ValueModel` | `getSelectionIndexHolder()` Returns the selection index holder.
`E` | `getValue()` Returns the current selection, `null` if the selection index does not represent a selection in the list.
`boolean` | `hasSelection()` Checks and answers if an element is selected.
`boolean` | `isSelectionEmpty()` Checks and answers whether the selection is empty or not.
`void` | `release()` Removes the internal listeners from the list holder, selection holder, selection index holder.
`void` | `removeValueChangeListener(PropertyChangeListener l)` Removes the given PropertyChangeListener from the model.
`void` | `setSelection(E newSelection)` Sets the selection index to the index of the first list element that equals `newSelection`.
`void` | `setSelectionHolder(ValueModel newSelectionHolder)` Sets a new selection holder.
`void` | `setSelectionIndex(int newSelectionIndex)` Sets a new selection index.
`void` | `setSelectionIndexHolder(ValueModel newSelectionIndexHolder)` Sets a new selection index holder.
`void` | `setValue(Object newValue)` Sets the selection index to the index of the first list element that equals `newValue`.
`protected void` | `updateList(Object oldList, int oldSize, Object newList)` Removes the list data change handler from the old list in case it is a `ListModel` and adds it to new one in case it is a `ListModel`.

Methods inherited from class com.jgoodies.binding.list.IndirectListModel
`addListDataListener, fireContentsChanged, fireIntervalAdded, fireIntervalRemoved, fireListChanged, getElementAt, getList, getListDataListeners, getListHolder, getListModel, getSize, getSize, isEmpty, removeListDataListener, setList, setListHolder, setListModel`

Methods inherited from class com.jgoodies.binding.beans.Model
`createPropertyChangeSupport, firePropertyChange`

Methods inherited from class com.jgoodies.common.bean.AbstractBean
`addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, addVetoableChangeListener, fireIndexedPropertyChange, fireIndexedPropertyChange, fireIndexedPropertyChange, fireMultiplePropertiesChanged, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, getPropertyChangeListeners, getPropertyChangeListeners, getVetoableChangeListeners, getVetoableChangeListeners, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, removeVetoableChangeListener`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

### PROPERTYNAME_SELECTION

    public static final String PROPERTYNAME_SELECTION

  The name of the bound read-write selection property.

  See Also:
    Constant Field Values

### PROPERTYNAME_SELECTION_EMPTY

    public static final String PROPERTYNAME_SELECTION_EMPTY

  The name of the bound read-only selectionEmpty property.

  See Also:
    Constant Field Values

### PROPERTYNAME_SELECTION_HOLDER

    public static final String PROPERTYNAME_SELECTION_HOLDER

  The name of the bound read-write selection holder property.

  See Also:
    Constant Field Values

### PROPERTYNAME_SELECTION_INDEX

    public static final String PROPERTYNAME_SELECTION_INDEX

  The name of the bound read-write selectionIndex property.

  See Also:
    Constant Field Values

### PROPERTYNAME_SELECTION_INDEX_HOLDER

    public static final String PROPERTYNAME_SELECTION_INDEX_HOLDER

  The name of the bound read-write selection index holder property.

  See Also:
    Constant Field Values

### PROPERTYNAME_VALUE

    public static final String PROPERTYNAME_VALUE

  The name of the bound read-write value property.

  See Also:
    Constant Field Values

Constructor Detail

### SelectionInList

    public SelectionInList()

  Constructs a SelectionInList with an empty initial `ArrayListModel` using defaults for the selection holder and selection index holder.

### SelectionInList

    public SelectionInList(E[] listItems)

  Constructs a SelectionInList on the given item array using defaults for the selection holder and selection index holder. The specified array will be converted to a List.

  Changes to the list "write through" to the array, and changes to the array contents will be reflected in the list.

  Parameters:
    `listItems` - the array of initial items
  Throws:
    `NullPointerException` - if `listItems` is `null`

### SelectionInList

    public SelectionInList(E[] listItems,
                           ValueModel selectionHolder)

  Constructs a SelectionInList on the given item array and selection holder using a default selection index holder. The specified array will be converted to a List.

  Changes to the list "write through" to the array, and changes to the array contents will be reflected in the list.

  Parameters:
    `listItems` - the array of initial items
    `selectionHolder` - holds the selection
  Throws:
    `NullPointerException` - if `listItems` or `selectionHolder` is `null`

### SelectionInList

    public SelectionInList(E[] listItems,
                           ValueModel selectionHolder,
                           ValueModel selectionIndexHolder)

  Constructs a SelectionInList on the given item array and selection holder using a default selection index holder. The specified array will be converted to a List.

  Changes to the list "write through" to the array, and changes to the array contents will be reflected in the list.

  Parameters:
    `listItems` - the array of initial items
    `selectionHolder` - holds the selection
    `selectionIndexHolder` - holds the selection index
  Throws:
    `NullPointerException` - if `listItems`, `selectionHolder`, or `selectionIndexHolder` is `null`

### SelectionInList

    public SelectionInList(List<E> list)

  Constructs a SelectionInList on the given list using defaults for the selection holder and selection index holder.

  Note: Favor `ListModel` over `List` when working with the SelectionInList. Why? The SelectionInList can work with both types. What's the difference? ListModel provides all list access features required by the SelectionInList's. In addition it reports more fine grained change events, instances of `ListDataEvents`. In contrast developer often create Lists and operate on them and the ListModel may be inconvenient for these operations.

  A convenient solution for this situation is to use the `ArrayListModel` and `LinkedListModel` classes. These implement both List and ListModel, offer the standard List operations and report the fine grained ListDataEvents.

  Parameters:
    `list` - the initial list

### SelectionInList

    public SelectionInList(List<E> list,
                           ValueModel selectionHolder)

  Constructs a SelectionInList on the given list and selection holder using a default selection index holder.

  Note: Favor `ListModel` over `List` when working with the SelectionInList. Why? The SelectionInList can work with both types. What's the difference? ListModel provides all list access features required by the SelectionInList's. In addition it reports more fine grained change events, instances of `ListDataEvents`. In contrast developer often create Lists and operate on them and the ListModel may be inconvenient for these operations.

  A convenient solution for this situation is to use the `ArrayListModel` and `LinkedListModel` classes. These implement both List and ListModel, offer the standard List operations and report the fine grained ListDataEvents.

  Parameters:
    `list` - the initial list
    `selectionHolder` - holds the selection
  Throws:
    `NullPointerException` - if `selectionHolder` is `null`

### SelectionInList

    public SelectionInList(List<E> list,
                           ValueModel selectionHolder,
                           ValueModel selectionIndexHolder)

  Constructs a SelectionInList on the given list, selection holder, and selection index holder.

  Note: Favor `ListModel` over `List` when working with the SelectionInList. Why? The SelectionInList can work with both types. What's the difference? ListModel provides all list access features required by the SelectionInList's. In addition it reports more fine grained change events, instances of `ListDataEvents`. In contrast developer often create Lists and operate on them and the ListModel may be inconvenient for these operations.

  A convenient solution for this situation is to use the `ArrayListModel` and `LinkedListModel` classes. These implement both List and ListModel, offer the standard List operations and report the fine grained ListDataEvents.

  Parameters:
    `list` - the initial list
    `selectionHolder` - holds the selection
    `selectionIndexHolder` - holds the selection index
  Throws:
    `NullPointerException` - if `selectionHolder`, or `selectionIndexHolder` is `null`

### SelectionInList

    public SelectionInList(ListModel listModel)

  Constructs a SelectionInList on the given list model using defaults for the selection holder and selection index holder.

  Parameters:
    `listModel` - the initial list model

### SelectionInList

    public SelectionInList(ListModel listModel,
                           ValueModel selectionHolder)

  Constructs a SelectionInList on the given list model and selection holder using a default selection index holder.

  Parameters:
    `listModel` - the initial list model
    `selectionHolder` - holds the selection
  Throws:
    `NullPointerException` - if `selectionHolder` is `null`

### SelectionInList

    public SelectionInList(ListModel listModel,
                           ValueModel selectionHolder,
                           ValueModel selectionIndexHolder)

  Constructs a SelectionInList on the given list model, selection holder, and selection index holder.

  Parameters:
    `listModel` - the initial list model
    `selectionHolder` - holds the selection
    `selectionIndexHolder` - holds the selection index
  Throws:
    `NullPointerException` - if `selectionHolder`, or `selectionIndexHolder` is `null`

### SelectionInList

    public SelectionInList(ValueModel listHolder)

  Constructs a SelectionInList on the given list holder using defaults for the selection holder and selection index holder.

  Constraints: 1) The listHolder must hold instances of List or ListModel and 2) must report a value change whenever the value's identity changes. Note that many bean properties don't fire a PropertyChangeEvent if the old and new value are equal - and so would break this constraint. If you provide a ValueHolder, enable its identityCheck feature during construction. If you provide an adapted bean property from a bean that extends the JGoodies `Model` class, you can enable the identity check feature in the methods `#firePropertyChange` by setting the trailing boolean parameter to `true`.

  Parameters:
    `listHolder` - holds the list or list model
  Throws:
    `NullPointerException` - if `listHolder` is `null`

### SelectionInList

    public SelectionInList(ValueModel listHolder,
                           ValueModel selectionHolder)

  Constructs a SelectionInList on the given list holder, selection holder and selection index holder.

  Constraints: 1) The listHolder must hold instances of List or ListModel and 2) must report a value change whenever the value's identity changes. Note that many bean properties don't fire a PropertyChangeEvent if the old and new value are equal - and so would break this constraint. If you provide a ValueHolder, enable its identityCheck feature during construction. If you provide an adapted bean property from a bean that extends the JGoodies `Model` class, you can enable the identity check feature in the methods `#firePropertyChange` by setting the trailing boolean parameter to `true`.

  Parameters:
    `listHolder` - holds the list or list model
    `selectionHolder` - holds the selection
  Throws:
    `NullPointerException` - if `listHolder` or `selectionHolder` is `null`

### SelectionInList

    public SelectionInList(ValueModel listHolder,
                           ValueModel selectionHolder,
                           ValueModel selectionIndexHolder)

  Constructs a SelectionInList on the given list holder, selection holder and selection index holder.

  Constraints: 1) The listHolder must hold instances of List or ListModel and 2) must report a value change whenever the value's identity changes. Note that many bean properties don't fire a PropertyChangeEvent if the old and new value are equal - and so would break this constraint. If you provide a ValueHolder, enable its identityCheck feature during construction. If you provide an adapted bean property from a bean that extends the JGoodies `Model` class, you can enable the identity check feature in the methods `#firePropertyChange` by setting the trailing boolean parameter to `true`.

  Parameters:
    `listHolder` - holds the list or list model
    `selectionHolder` - holds the selection
    `selectionIndexHolder` - holds the selection index
  Throws:
    `NullPointerException` - if the `listModelHolder`, `selectionHolder`, or `selectionIndexHolder` is `null`
    `IllegalArgumentException` - if the listHolder is a ValueHolder that doesn't check the identity when changing its value
    `ClassCastException` - if the listModelHolder contents is neither a List nor a ListModel

Method Detail

### fireSelectedContentsChanged

    public void fireSelectedContentsChanged()

  Notifies all registered ListDataListeners that the contents of the selected list item - if any - has changed. Useful to update a presentation after editing the selection. See the tutorial's AlbumManagerModel for an example how to use this feature.

  If the list holder holds a ListModel, this SelectionInList listens to ListDataEvents fired by that ListModel, and forwards these events by invoking the associated `#fireXXX` method, which in turn notifies all registered ListDataListeners. Therefore if you fire ListDataEvents in an underlying ListModel, you don't need this method and should not use it to avoid sending duplicate ListDataEvents.

  Since:
    1.0.2
  See Also:
    `ListModel`, `ListDataListener`, `ListDataEvent`

### getSelection

    public E getSelection()

  Looks up and returns the current selection using the current selection index. Returns `null` if no object is selected or if the list has no elements.

  Returns:
    the current selection, `null` if none is selected

### setSelection

    public void setSelection(E newSelection)

  Sets the selection index to the index of the first list element that equals `newSelection`. If `newSelection` is `null`, it is interpreted as unspecified and the selection index is set to -1, and this SelectionInList has no selection. Does nothing if the list is empty or `null`.

  Parameters:
    `newSelection` - the object to be set as new selection, or `null` to set the selection index to -1

### hasSelection

    public boolean hasSelection()

  Checks and answers if an element is selected.

  Returns:
    true if an element is selected, false otherwise

### isSelectionEmpty

    public boolean isSelectionEmpty()

  Checks and answers whether the selection is empty or not. Unlike #hasSelection, the underlying property #selectionEmpty for this method is bound. I.e. you can observe this property using a PropertyChangeListener to update UI state.

  Returns:
    true if nothing is selected, false if there's a selection
  See Also:
    `clearSelection()`, `hasSelection()`

### clearSelection

    public void clearSelection()

  Clears the selection of this SelectionInList - if any.

### getSelectionIndex

    public int getSelectionIndex()

  Returns the selection index.

  Returns:
    the selection index
  Throws:
    `NullPointerException` - if the selection index holder has a null Object set

### setSelectionIndex

    public void setSelectionIndex(int newSelectionIndex)

  Sets a new selection index. Does nothing if it is the same as before.

  Parameters:
    `newSelectionIndex` - the selection index to be set
  Throws:
    `IndexOutOfBoundsException` - if the new selection index is outside the bounds of the list

### getSelectionHolder

    public ValueModel getSelectionHolder()

  Returns the selection holder.

  Returns:
    the selection holder

### setSelectionHolder

    public void setSelectionHolder(ValueModel newSelectionHolder)

  Sets a new selection holder. Does nothing if the new is the same as before. The selection remains unchanged and is still driven by the selection index holder. It's just that future index changes will update the new selection holder and that future selection holder changes affect the selection index.

  Parameters:
    `newSelectionHolder` - the selection holder to set
  Throws:
    `NullPointerException` - if the new selection holder is null

### getSelectionIndexHolder

    public ValueModel getSelectionIndexHolder()

  Returns the selection index holder.

  Returns:
    the selection index holder

### setSelectionIndexHolder

    public void setSelectionIndexHolder(ValueModel newSelectionIndexHolder)

  Sets a new selection index holder. Does nothing if the new is the same as before.

  Parameters:
    `newSelectionIndexHolder` - the selection index holder to set
  Throws:
    `NullPointerException` - if the new selection index holder is null
    `IllegalArgumentException` - if the value of the new selection index holder is null

### getValue

    public E getValue()

  Returns the current selection, `null` if the selection index does not represent a selection in the list.

  Specified by:
    `getValue` in interface `ValueModel`
  Returns:
    the selected element - if any

### setValue

    public void setValue(Object newValue)

  Sets the selection index to the index of the first list element that equals `newValue`. If `newValue` is `null`, it is interpreted as unspecified and the selection index is set to -1, and this SelectionInList has no selection. Does nothing if the list is empty or `null`.

  Specified by:
    `setValue` in interface `ValueModel`
  Parameters:
    `newValue` - the object to be set as new selection, or `null` to set the selection index to -1

### addValueChangeListener

    public void addValueChangeListener(PropertyChangeListener l)

  Registers the given PropertyChangeListener with this model. The listener will be notified if the value has changed.

  The PropertyChangeEvents delivered to the listener have the name set to "value". In other words, the listeners won't get notified when a PropertyChangeEvent is fired that has a null object as the name to indicate an arbitrary set of the event source's properties have changed.

  In the rare case, where you want to notify a PropertyChangeListener even with PropertyChangeEvents that have no property name set, you can register the listener with #addPropertyChangeListener, not #addValueChangeListener.

  Specified by:
    `addValueChangeListener` in interface `ValueModel`
  Parameters:
    `l` - the listener to add
  See Also:
    `ValueModel`

### removeValueChangeListener

    public void removeValueChangeListener(PropertyChangeListener l)

  Removes the given PropertyChangeListener from the model.

  Specified by:
    `removeValueChangeListener` in interface `ValueModel`
  Parameters:
    `l` - the listener to remove

### release

    public void release()

  Removes the internal listeners from the list holder, selection holder, selection index holder. If the current list is a ListModel, the internal ListDataListener is removed from the list model. This SelectionInList must not be used after calling `#release`.

  To avoid memory leaks it is recommended to invoke this method, if the list holder, selection holder, or selection index holder live much longer than this SelectionInList. Instead of releasing the SelectionInList, you typically make the list holder, selection holder, and selection index holder obsolete by releasing the PresentationModel or BeanAdapter that has created them before.

  As an alternative you may use ValueModels that in turn use event listener lists implemented using `WeakReference`.

  Basically this release method performs the reverse operation performed during the SelectionInList construction.

  Overrides:
    `release` in class `IndirectListModel<E>`
  Since:
    1.2
  See Also:
    `PresentationModel.release()`, `BeanAdapter.release()`, `WeakReference`

### createListDataChangeHandler

    protected ListDataListener createListDataChangeHandler()

  Creates and returns the ListDataListener used to observe changes in the underlying ListModel. It is re-registered in `#updateListModel`.

  Overrides:
    `createListDataChangeHandler` in class `IndirectListModel<E>`
  Returns:
    the ListDataListener that handles changes in the underlying ListModel

### updateList

    protected void updateList(Object oldList,
                              int oldSize,
                              Object newList)

  Removes the list data change handler from the old list in case it is a `ListModel` and adds it to new one in case it is a `ListModel`. It then fires a property change for the list and a contents change event for the list content. Finally it tries to restore the previous selection - if any.

  Since version 1.1 the selection will be restored after the list content change has been indicated. This is because some listeners may clear the selection in a side-effect. For example a JTable that is bound to this SelectionInList via an AbstractTableAdapter and a SingleSelectionAdapter will clear the selection if the new list has a size other than the old list.

  Overrides:
    `updateList` in class `IndirectListModel<E>`
  Parameters:
    `oldList` - the old list content
    `oldSize` - the size of the old List content
    `newList` - the new list content
  See Also:
    `JTable.tableChanged(javax.swing.event.TableModelEvent)`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

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