DefaultEventSelectionModel (Glazed Lists)

java.lang.Object
- ca.odell.glazedlists.swing.DefaultEventSelectionModel<E>

All Implemented Interfaces:

AdvancedListSelectionModel<E>, javax.swing.ListSelectionModel
```
public final class DefaultEventSelectionModel<E>
extends java.lang.Object
implements AdvancedListSelectionModel<E>
```
An DefaultEventSelectionModel is a class that performs two simulaneous services. It is a ListSelectionModel to provide selection tracking for a JTable. It is also a EventList that contains the table's selection.
As elements are selected or deselected, the EventList aspect of this DefaultEventSelectionModel changes. Changes to that List will change the source EventList. To modify only the selection, use the ListSelectionModel's methods.
Alongside MULTIPLE_INTERVAL_SELECTION, this ListSelectionModel supports an additional selection mode. MULTIPLE_INTERVAL_SELECTION_DEFENSIVE is a new selection mode. It is identical to MULTIPLE_INTERVAL_SELECTION in every way but one. When a row is inserted immediately before a selected row in the MULTIPLE_INTERVAL_SELECTION mode, it becomes selected. But in the MULTIPLE_INTERVAL_SELECTION_DEFENSIVE mode, it does not become selected. To set this mode, use setSelectionMode(ListSelection.MULTIPLE_INTERVAL_SELECTION_DEFENSIVE).
DefaultEventSelectionModel is not thread-safe. Unless otherwise noted, all methods are only safe to be called from the event dispatch thread. To do this programmatically, use SwingUtilities.invokeAndWait(Runnable) and wrap the source list (or some part of the source list's pipeline) using GlazedListsSwing#swingThreadProxyList(EventList).

Author:

Jesse Wilson

See Also:

Bug 39, Bug 61, Bug 76, Bug 108, Bug 110, Bug 112, Bug 222 *

Field Summary
- Fields inherited from interface javax.swing.ListSelectionModel
  MULTIPLE_INTERVAL_SELECTION, SINGLE_INTERVAL_SELECTION, SINGLE_SELECTION

Constructor Summary

Constructors
Modifier	Constructor and Description
	`DefaultEventSelectionModel(EventList<E> source)` Creates a new selection model that also presents a list of the selection.
`protected`	`DefaultEventSelectionModel(EventList<E> source, boolean disposeSource)` Creates a new selection model that also presents a list of the selection.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addListSelectionListener(javax.swing.event.ListSelectionListener listener)` Add a listener to the list that's notified each time a change to the selection occurs.
`void`	`addSelectionInterval(int index0, int index1)` Change the selection to be the set union of the current selection and the indices between index0 and index1 inclusive
`void`	`addValidSelectionMatcher(Matcher<E> validSelectionMatcher)` Add a matcher which decides when source elements are valid for selection.
`void`	`clearSelection()` Change the selection to the empty set.
`void`	`dispose()` Releases the resources consumed by this `AdvancedListSelectionModel` so that it may eventually be garbage collected.
`int`	`getAnchorSelectionIndex()` Return the first index argument from the most recent call to setSelectionInterval(), addSelectionInterval() or removeSelectionInterval().
`EventList<E>`	`getDeselected()` Gets an `EventList` that contains only deselected values and modifies the source list on mutation.
`boolean`	`getEnabled()` Returns whether the EventSelectionModel is editable or not.
`int`	`getLeadSelectionIndex()` Return the second index argument from the most recent call to setSelectionInterval(), addSelectionInterval() or removeSelectionInterval().
`int`	`getMaxSelectionIndex()` Gets the index of the last selected element.
`int`	`getMinSelectionIndex()` Gets the index of the first selected element.
`EventList<E>`	`getSelected()` Gets an `EventList` that contains only selected values and modifies the source list on mutation.
`int`	`getSelectionMode()` Returns the current selection mode.
`EventList<E>`	`getTogglingDeselected()` Gets an `EventList` that contains only deselected values and modifies the selection state on mutation.
`EventList<E>`	`getTogglingSelected()` Gets an `EventList` that contains only selected values and modifies the selection state on mutation.
`boolean`	`getValueIsAdjusting()` Returns true if the value is undergoing a series of changes.
`void`	`insertIndexInterval(int index, int length, boolean before)` Insert length indices beginning before/after index.
`void`	`invertSelection()` Inverts the current selection.
`boolean`	`isSelectedIndex(int index)` Returns true if the specified index is selected.
`boolean`	`isSelectionEmpty()` Returns true if no indices are selected.
`void`	`removeIndexInterval(int index0, int index1)` Remove the indices in the interval index0,index1 (inclusive) from the selection model.
`void`	`removeListSelectionListener(javax.swing.event.ListSelectionListener listener)` Remove a listener from the list that's notified each time a change to the selection occurs.
`void`	`removeSelectionInterval(int index0, int index1)` Change the selection to be the set difference of the current selection and the indices between index0 and index1 inclusive.
`void`	`removeValidSelectionMatcher(Matcher<E> validSelectionMatcher)` Remove a matcher which decides when source elements are valid for selection.
`void`	`setAnchorSelectionIndex(int anchorSelectionIndex)` Set the anchor selection index.
`void`	`setEnabled(boolean enabled)` Set the EventSelectionModel as editable or not.
`void`	`setLeadSelectionIndex(int leadSelectionIndex)` Set the lead selection index.
`void`	`setSelectionInterval(int index0, int index1)` Change the selection to be between index0 and index1 inclusive.
`void`	`setSelectionMode(int selectionMode)` Set the selection mode.
`void`	`setValueIsAdjusting(boolean valueIsAdjusting)` This property is true if upcoming changes to the value of the model should be considered a single event.

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

- Constructor Detail
  - DefaultEventSelectionModel
```
public DefaultEventSelectionModel(EventList<E> source)
```
    Creates a new selection model that also presents a list of the selection. The DefaultEventSelectionModel listens to this EventList in order to adjust selection when the EventList is modified. For example, when an element is added to the EventList, this may offset the selection of the following elements.
    
    Parameters:
    
    source - the EventList whose selection will be managed. This should be the same EventList passed to the constructor of your DefaultEventTableModel or DefaultEventListModel.
  - DefaultEventSelectionModel
```
protected DefaultEventSelectionModel(EventList<E> source,
                                     boolean disposeSource)
```
    Creates a new selection model that also presents a list of the selection. The DefaultEventSelectionModel listens to this EventList in order to adjust selection when the EventList is modified. For example, when an element is added to the EventList, this may offset the selection of the following elements.
    
    Parameters:
    
    source - the EventList whose selection will be managed. This should be the same EventList passed to the constructor of your DefaultEventTableModel or DefaultEventListModel.
    
    diposeSource - true if the source list should be disposed when disposing this model, false otherwise
- Method Detail
  - getSelected
```
public EventList<E> getSelected()
```
    Gets an EventList that contains only selected values and modifies the source list on mutation. Adding and removing items from this list performs the same operation on the source list.
    
    Specified by:
    
    getSelected in interface AdvancedListSelectionModel<E>
  - getTogglingSelected
```
public EventList<E> getTogglingSelected()
```
    Gets an EventList that contains only selected values and modifies the selection state on mutation. Adding an item to this list selects it and removing an item deselects it. If an item not in the source list is added an IllegalArgumentException is thrown.
    
    Specified by:
    
    getTogglingSelected in interface AdvancedListSelectionModel<E>
  - getDeselected
```
public EventList<E> getDeselected()
```
    Gets an EventList that contains only deselected values and modifies the source list on mutation. Adding and removing items from this list performs the same operation on the source list.
    
    Specified by:
    
    getDeselected in interface AdvancedListSelectionModel<E>
  - getTogglingDeselected
```
public EventList<E> getTogglingDeselected()
```
    Gets an EventList that contains only deselected values and modifies the selection state on mutation. Adding an item to this list deselects it and removing an item selects it. If an item not in the source list is added an IllegalArgumentException is thrown
    
    Specified by:
    
    getTogglingDeselected in interface AdvancedListSelectionModel<E>
  - setEnabled
```
public void setEnabled(boolean enabled)
```
    Set the EventSelectionModel as editable or not. This means that the user cannot manipulate the selection by clicking. The selection can still be changed as the source list changes.
    Note that this will also disable the selection from being modified programatically. Therefore you must use setEnabled(true) to modify the selection in code.
    
    Specified by:
    
    setEnabled in interface AdvancedListSelectionModel<E>
  - getEnabled
```
public boolean getEnabled()
```
    Returns whether the EventSelectionModel is editable or not.
    
    Specified by:
    
    getEnabled in interface AdvancedListSelectionModel<E>
  - invertSelection
```
public void invertSelection()
```
    Inverts the current selection.
    
    Specified by:
    
    invertSelection in interface AdvancedListSelectionModel<E>
  - setSelectionInterval
```
public void setSelectionInterval(int index0,
                                 int index1)
```
    Change the selection to be between index0 and index1 inclusive.
    First this calculates the smallest range where changes occur. This includes the union of the selection range before and the selection range specified. It then walks through the change and sets each index as selected or not based on whether the index is in the new range. Finally it fires events to both the listening lists and selection listeners about what changes happened.
    If the selection does not change, this will not fire any events.
    
    Specified by:
    
    setSelectionInterval in interface javax.swing.ListSelectionModel
  - addSelectionInterval
```
public void addSelectionInterval(int index0,
                                 int index1)
```
    Change the selection to be the set union of the current selection and the indices between index0 and index1 inclusive
    
    Specified by:
    
    addSelectionInterval in interface javax.swing.ListSelectionModel
  - removeSelectionInterval
```
public void removeSelectionInterval(int index0,
                                    int index1)
```
    Change the selection to be the set difference of the current selection and the indices between index0 and index1 inclusive.
    
    Specified by:
    
    removeSelectionInterval in interface javax.swing.ListSelectionModel
  - isSelectedIndex
```
public boolean isSelectedIndex(int index)
```
    Returns true if the specified index is selected. If the specified index has not been seen before, this will return false. This is in the case where the table painting and selection have fallen out of sync. Usually in this case there is an update event waiting in the event queue that notifies this model of the change in table size.
    
    Specified by:
    
    isSelectedIndex in interface javax.swing.ListSelectionModel
  - getAnchorSelectionIndex
```
public int getAnchorSelectionIndex()
```
    Return the first index argument from the most recent call to setSelectionInterval(), addSelectionInterval() or removeSelectionInterval().
    
    Specified by:
    
    getAnchorSelectionIndex in interface javax.swing.ListSelectionModel
  - setAnchorSelectionIndex
```
public void setAnchorSelectionIndex(int anchorSelectionIndex)
```
    Set the anchor selection index.
    
    Specified by:
    
    setAnchorSelectionIndex in interface javax.swing.ListSelectionModel
  - getLeadSelectionIndex
```
public int getLeadSelectionIndex()
```
    Return the second index argument from the most recent call to setSelectionInterval(), addSelectionInterval() or removeSelectionInterval().
    
    Specified by:
    
    getLeadSelectionIndex in interface javax.swing.ListSelectionModel
  - setLeadSelectionIndex
```
public void setLeadSelectionIndex(int leadSelectionIndex)
```
    Set the lead selection index.
    
    Specified by:
    
    setLeadSelectionIndex in interface javax.swing.ListSelectionModel
  - getMinSelectionIndex
```
public int getMinSelectionIndex()
```
    Gets the index of the first selected element.
    
    Specified by:
    
    getMinSelectionIndex in interface javax.swing.ListSelectionModel
  - getMaxSelectionIndex
```
public int getMaxSelectionIndex()
```
    Gets the index of the last selected element.
    
    Specified by:
    
    getMaxSelectionIndex in interface javax.swing.ListSelectionModel
  - clearSelection
```
public void clearSelection()
```
    Change the selection to the empty set.
    
    Specified by:
    
    clearSelection in interface javax.swing.ListSelectionModel
  - isSelectionEmpty
```
public boolean isSelectionEmpty()
```
    Returns true if no indices are selected.
    
    Specified by:
    
    isSelectionEmpty in interface javax.swing.ListSelectionModel
  - insertIndexInterval
```
public void insertIndexInterval(int index,
                                int length,
                                boolean before)
```
    Insert length indices beginning before/after index.
    
    Specified by:
    
    insertIndexInterval in interface javax.swing.ListSelectionModel
  - removeIndexInterval
```
public void removeIndexInterval(int index0,
                                int index1)
```
    Remove the indices in the interval index0,index1 (inclusive) from the selection model.
    
    Specified by:
    
    removeIndexInterval in interface javax.swing.ListSelectionModel
  - setValueIsAdjusting
```
public void setValueIsAdjusting(boolean valueIsAdjusting)
```
    This property is true if upcoming changes to the value of the model should be considered a single event.
    
    Specified by:
    
    setValueIsAdjusting in interface javax.swing.ListSelectionModel
  - getValueIsAdjusting
```
public boolean getValueIsAdjusting()
```
    Returns true if the value is undergoing a series of changes.
    
    Specified by:
    
    getValueIsAdjusting in interface javax.swing.ListSelectionModel
  - setSelectionMode
```
public void setSelectionMode(int selectionMode)
```
    Set the selection mode.
    
    Specified by:
    
    setSelectionMode in interface javax.swing.ListSelectionModel
  - getSelectionMode
```
public int getSelectionMode()
```
    Returns the current selection mode.
    
    Specified by:
    
    getSelectionMode in interface javax.swing.ListSelectionModel
  - addValidSelectionMatcher
```
public void addValidSelectionMatcher(Matcher<E> validSelectionMatcher)
```
    Add a matcher which decides when source elements are valid for selection.
    
    Specified by:
    
    addValidSelectionMatcher in interface AdvancedListSelectionModel<E>
    
    Parameters:
    
    validSelectionMatcher - returns true if a source element can be selected; false otherwise
  - removeValidSelectionMatcher
```
public void removeValidSelectionMatcher(Matcher<E> validSelectionMatcher)
```
    Remove a matcher which decides when source elements are valid for selection.
    
    Specified by:
    
    removeValidSelectionMatcher in interface AdvancedListSelectionModel<E>
    
    Parameters:
    
    validSelectionMatcher - returns true if a source element can be selected; false otherwise
  - addListSelectionListener
```
public void addListSelectionListener(javax.swing.event.ListSelectionListener listener)
```
    Add a listener to the list that's notified each time a change to the selection occurs. Note that the change events fired by this class may include rows that have been removed from the table. For this reason it is advised not to for() through the changed range without also verifying that each row is still in the table.
    
    Specified by:
    
    addListSelectionListener in interface javax.swing.ListSelectionModel
  - removeListSelectionListener
```
public void removeListSelectionListener(javax.swing.event.ListSelectionListener listener)
```
    Remove a listener from the list that's notified each time a change to the selection occurs.
    
    Specified by:
    
    removeListSelectionListener in interface javax.swing.ListSelectionModel
  - dispose
```
public void dispose()
```
    Releases the resources consumed by this AdvancedListSelectionModel so that it may eventually be garbage collected.
    An AdvancedListSelectionModel will be garbage collected without a call to AdvancedListSelectionModel.dispose(), but not before its source EventList is garbage collected. By calling AdvancedListSelectionModel.dispose(), you allow the AdvancedListSelectionModel to be garbage collected before its source EventList. This is necessary for situations where an AdvancedListSelectionModel is short-lived but its source EventList is long-lived.
    Warning: It is an error to call any method on a AdvancedListSelectionModel after it has been disposed.
    
    Specified by:
    
    dispose in interface AdvancedListSelectionModel<E>

Class DefaultEventSelectionModel<E>

Field Summary

Fields inherited from interface javax.swing.ListSelectionModel

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DefaultEventSelectionModel

DefaultEventSelectionModel

Method Detail

getSelected

getTogglingSelected

getDeselected

getTogglingDeselected

setEnabled

getEnabled

invertSelection

setSelectionInterval

addSelectionInterval

removeSelectionInterval

isSelectedIndex

getAnchorSelectionIndex

setAnchorSelectionIndex

getLeadSelectionIndex

setLeadSelectionIndex

getMinSelectionIndex

getMaxSelectionIndex

clearSelection

isSelectionEmpty

insertIndexInterval

removeIndexInterval

setValueIsAdjusting

getValueIsAdjusting

setSelectionMode

getSelectionMode

addValidSelectionMatcher

removeValidSelectionMatcher

addListSelectionListener

removeListSelectionListener

dispose