org.jminor.swing.common.model.table

Class SwingTableSelectionModel<R>

java.lang.Object

javax.swing.DefaultListSelectionModel

org.jminor.swing.common.model.table.SwingTableSelectionModel<R>

Type Parameters:

R - the type of rows

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, javax.swing.ListSelectionModel, SelectionModel<R>

public final class SwingTableSelectionModel<R>
extends javax.swing.DefaultListSelectionModel
implements SelectionModel<R>

A default table selection model implementation

See Also:

Serialized Form

Field Summary

Fields inherited from class javax.swing.DefaultListSelectionModel

leadAnchorNotificationEnabled, listenerList

Fields inherited from interface javax.swing.ListSelectionModel

MULTIPLE_INTERVAL_SELECTION, SINGLE_INTERVAL_SELECTION, SINGLE_SELECTION

Constructor Summary

Constructors

Constructor and Description
SwingTableSelectionModel(FilteredTableModel<R,?,?> tableModel) Instantiates a new SwingTableSelectionModel

Method Summary

Modifier and Type	Method and Description
void	addSelectedIndex(int index) Selects the item at index
void	addSelectedIndexes(java.util.Collection<java.lang.Integer> indexes) Adds these indexes to the selection
void	addSelectedIndexListener(EventDataListener<java.lang.Integer> listener)
void	addSelectedItem(R item) Adds the given item to the selection
void	addSelectedItemListener(EventDataListener<R> listener)
void	addSelectedItems(java.util.Collection<R> items) Adds the given items to the selection
void	addSelectedItemsListener(EventDataListener<java.util.List<R>> listener)
void	addSelectionChangedListener(EventListener listener)
void	addSelectionInterval(int fromIndex, int toIndex)
void	fireValueChanged(int firstIndex, int lastIndex, boolean isAdjusting)
StateObserver	getMultipleSelectionObserver()
int	getSelectedIndex()
java.util.List<java.lang.Integer>	getSelectedIndexes()
R	getSelectedItem()
java.util.List<R>	getSelectedItems()
int	getSelectionCount()
StateObserver	getSelectionEmptyObserver()
StateObserver	getSingleSelectionObserver()
void	insertIndexInterval(int fromIndex, int length, boolean before)
void	moveSelectionDown() Moves all selected indexes down one index, wraps around.
void	moveSelectionUp() Moves all selected indexes up one index, wraps around.
void	removeIndexInterval(int fromIndex, int toIndex)
void	removeSelectedIndex(int index) Removes the item at index from the selection
void	removeSelectedIndexes(java.util.Collection<java.lang.Integer> indexes) Removes the given indexes from the selection
void	removeSelectedIndexListener(EventDataListener listener)
void	removeSelectedItem(R item) Remove the given item from the selection
void	removeSelectedItemListener(EventDataListener listener)
void	removeSelectedItems(java.util.Collection<R> items) Remove the given items from the selection
void	removeSelectedItemsListener(EventDataListener listener)
void	removeSelectionChangedListener(EventListener listener)
void	removeSelectionInterval(int fromIndex, int toIndex)
void	selectAll() Selects all visible entities
void	setSelectedIndex(int index) Clears the selection and selects the item at index
void	setSelectedIndexes(java.util.Collection<java.lang.Integer> indexes) Selects the given indexes
void	setSelectedItem(R item) Sets the selected item
void	setSelectedItems(java.util.Collection<R> items) Selects the given items
void	setSelectionInterval(int fromIndex, int toIndex)

Methods inherited from class javax.swing.DefaultListSelectionModel

addListSelectionListener, clearSelection, clone, fireValueChanged, fireValueChanged, getAnchorSelectionIndex, getLeadSelectionIndex, getListeners, getListSelectionListeners, getMaxSelectionIndex, getMinSelectionIndex, getSelectionMode, getValueIsAdjusting, isLeadAnchorNotificationEnabled, isSelectedIndex, isSelectionEmpty, moveLeadSelectionIndex, removeListSelectionListener, setAnchorSelectionIndex, setLeadAnchorNotificationEnabled, setLeadSelectionIndex, setSelectionMode, setValueIsAdjusting, toString

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jminor.common.model.table.SelectionModel

clearSelection, isSelectionEmpty

Constructor Detail

SwingTableSelectionModel

public SwingTableSelectionModel(FilteredTableModel<R,?,?> tableModel)

Instantiates a new SwingTableSelectionModel

Parameters:

tableModel - the FilteredTableModel required for accessing table model items and size

Method Detail

addSelectedIndex

public void addSelectedIndex(int index)

Selects the item at index

Specified by:

addSelectedIndex in interface SelectionModel<R>

Parameters:

index - the index

removeSelectedIndex

public void removeSelectedIndex(int index)

Removes the item at index from the selection

Specified by:

removeSelectedIndex in interface SelectionModel<R>

Parameters:

index - the index

removeSelectedIndexes

public void removeSelectedIndexes(java.util.Collection<java.lang.Integer> indexes)

Removes the given indexes from the selection

Specified by:

removeSelectedIndexes in interface SelectionModel<R>

Parameters:

indexes - the indexes

setSelectedIndex

public void setSelectedIndex(int index)

Clears the selection and selects the item at index

Specified by:

setSelectedIndex in interface SelectionModel<R>

Parameters:

index - the index

getSelectionCount

public int getSelectionCount()

Specified by:

getSelectionCount in interface SelectionModel<R>

Returns:

the number of selected indexes in the underlying selection model.

addSelectedIndexes

public void addSelectedIndexes(java.util.Collection<java.lang.Integer> indexes)

Adds these indexes to the selection

Specified by:

addSelectedIndexes in interface SelectionModel<R>

Parameters:

indexes - the indexes to add to the selection

setSelectedIndexes

public void setSelectedIndexes(java.util.Collection<java.lang.Integer> indexes)

Selects the given indexes

Specified by:

setSelectedIndexes in interface SelectionModel<R>

Parameters:

indexes - the indexes to select

getSelectedIndexes

public java.util.List<java.lang.Integer> getSelectedIndexes()

Specified by:

getSelectedIndexes in interface SelectionModel<R>

Returns:

the selected indexes, an empty list if selection is empty

getSelectedIndex

public int getSelectedIndex()

Specified by:

getSelectedIndex in interface SelectionModel<R>

Returns:

the index of the selected record, -1 if none is selected and the lowest index if more than one record is selected

selectAll

public void selectAll()

Selects all visible entities

Specified by:

selectAll in interface SelectionModel<R>

See Also:

SelectionModel.addSelectionChangedListener(EventListener)

getSelectedItem

public R getSelectedItem()

Specified by:

getSelectedItem in interface SelectionModel<R>

Returns:

the item at the lowest selected index, null if none is selected

getSelectedItems

public java.util.List<R> getSelectedItems()

Specified by:

getSelectedItems in interface SelectionModel<R>

Returns:

a list containing the selected items

setSelectedItem

public void setSelectedItem(R item)

Sets the selected item

Specified by:

setSelectedItem in interface SelectionModel<R>

Parameters:

item - the item to select

setSelectedItems

public void setSelectedItems(java.util.Collection<R> items)

Selects the given items

Specified by:

setSelectedItems in interface SelectionModel<R>

Parameters:

items - the items to select

addSelectedItem

public void addSelectedItem(R item)

Adds the given item to the selection

Specified by:

addSelectedItem in interface SelectionModel<R>

Parameters:

item - the item to add to the selection

addSelectedItems

public void addSelectedItems(java.util.Collection<R> items)

Adds the given items to the selection

Specified by:

addSelectedItems in interface SelectionModel<R>

Parameters:

items - the items to add to the selection

removeSelectedItem

public void removeSelectedItem(R item)

Remove the given item from the selection

Specified by:

removeSelectedItem in interface SelectionModel<R>

Parameters:

item - the item to remove from the selection

removeSelectedItems

public void removeSelectedItems(java.util.Collection<R> items)

Remove the given items from the selection

Specified by:

removeSelectedItems in interface SelectionModel<R>

Parameters:

items - the items to remove from the selection

addSelectionInterval

public void addSelectionInterval(int fromIndex,
                                 int toIndex)

Specified by:

addSelectionInterval in interface javax.swing.ListSelectionModel

Overrides:

addSelectionInterval in class javax.swing.DefaultListSelectionModel

setSelectionInterval

public void setSelectionInterval(int fromIndex,
                                 int toIndex)

Specified by:

setSelectionInterval in interface javax.swing.ListSelectionModel

Overrides:

setSelectionInterval in class javax.swing.DefaultListSelectionModel

removeSelectionInterval

public void removeSelectionInterval(int fromIndex,
                                    int toIndex)

Specified by:

removeSelectionInterval in interface javax.swing.ListSelectionModel

Overrides:

removeSelectionInterval in class javax.swing.DefaultListSelectionModel

insertIndexInterval

public void insertIndexInterval(int fromIndex,
                                int length,
                                boolean before)

Specified by:

insertIndexInterval in interface javax.swing.ListSelectionModel

Overrides:

insertIndexInterval in class javax.swing.DefaultListSelectionModel

removeIndexInterval

public void removeIndexInterval(int fromIndex,
                                int toIndex)

Specified by:

removeIndexInterval in interface javax.swing.ListSelectionModel

Overrides:

removeIndexInterval in class javax.swing.DefaultListSelectionModel

moveSelectionUp

public void moveSelectionUp()

Moves all selected indexes up one index, wraps around. If the selection is empty the last item in this model is selected.

Specified by:

moveSelectionUp in interface SelectionModel<R>

See Also:

SelectionModel.addSelectionChangedListener(EventListener)

moveSelectionDown

public void moveSelectionDown()

Moves all selected indexes down one index, wraps around. If the selection is empty the first item in this model is selected.

Specified by:

moveSelectionDown in interface SelectionModel<R>

See Also:

SelectionModel.addSelectionChangedListener(EventListener)

fireValueChanged

public void fireValueChanged(int firstIndex,
                             int lastIndex,
                             boolean isAdjusting)

Overrides:

fireValueChanged in class javax.swing.DefaultListSelectionModel

addSelectedIndexListener

public void addSelectedIndexListener(EventDataListener<java.lang.Integer> listener)

Specified by:

addSelectedIndexListener in interface SelectionModel<R>

Parameters:

listener - a listener to be notified each time the selected index changes

removeSelectedIndexListener

public void removeSelectedIndexListener(EventDataListener listener)

Specified by:

removeSelectedIndexListener in interface SelectionModel<R>

Parameters:

listener - the listener to remove

addSelectionChangedListener

public void addSelectionChangedListener(EventListener listener)

Specified by:

addSelectionChangedListener in interface SelectionModel<R>

Parameters:

listener - a listener to be notified each time the selection changes

removeSelectionChangedListener

public void removeSelectionChangedListener(EventListener listener)

Specified by:

removeSelectionChangedListener in interface SelectionModel<R>

Parameters:

listener - the listener to remove

addSelectedItemListener

public void addSelectedItemListener(EventDataListener<R> listener)

Specified by:

addSelectedItemListener in interface SelectionModel<R>

Parameters:

listener - a listener to be notified each time the selected item changes

removeSelectedItemListener

public void removeSelectedItemListener(EventDataListener listener)

Specified by:

removeSelectedItemListener in interface SelectionModel<R>

Parameters:

listener - the listener to remove

addSelectedItemsListener

public void addSelectedItemsListener(EventDataListener<java.util.List<R>> listener)

Specified by:

addSelectedItemsListener in interface SelectionModel<R>

Parameters:

listener - a listener to be notified each time the selected items change

removeSelectedItemsListener

public void removeSelectedItemsListener(EventDataListener listener)

Specified by:

removeSelectedItemsListener in interface SelectionModel<R>

Parameters:

listener - the listener to remove

getMultipleSelectionObserver

public StateObserver getMultipleSelectionObserver()

Specified by:

getMultipleSelectionObserver in interface SelectionModel<R>

Returns:

a StateObserver indicating that multiple rows are selected

getSingleSelectionObserver

public StateObserver getSingleSelectionObserver()

Specified by:

getSingleSelectionObserver in interface SelectionModel<R>

Returns:

a StateObserver indicating that a single row is selected

getSelectionEmptyObserver

public StateObserver getSelectionEmptyObserver()

Specified by:

getSelectionEmptyObserver in interface SelectionModel<R>

Returns:

a StateObserver indicating that the selection is empty