org.jminor.common.model.table

Interface SelectionModel<R>

Type Parameters:

R - the type of rows in the table model

All Known Implementing Classes:

FXEntityListSelectionModel, SwingTableSelectionModel

public interface SelectionModel<R>

A table selection model

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	clearSelection() Clears the selection
StateObserver	getMultipleSelectionObserver()
int	getSelectedIndex()
java.util.List<java.lang.Integer>	getSelectedIndexes()
R	getSelectedItem()
java.util.List<R>	getSelectedItems()
int	getSelectionCount()
StateObserver	getSelectionEmptyObserver()
StateObserver	getSingleSelectionObserver()
boolean	isSelectionEmpty()
void	moveSelectionDown() Moves all selected indexes down one index, wraps around.
void	moveSelectionUp() Moves all selected indexes up one index, wraps around.
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	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

Method Detail

getSelectionEmptyObserver

StateObserver getSelectionEmptyObserver()

Returns:

a StateObserver indicating that the selection is empty

getMultipleSelectionObserver

StateObserver getMultipleSelectionObserver()

Returns:

a StateObserver indicating that multiple rows are selected

getSingleSelectionObserver

StateObserver getSingleSelectionObserver()

Returns:

a StateObserver indicating that a single row is selected

addSelectionChangedListener

void addSelectionChangedListener(EventListener listener)

Parameters:

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

removeSelectionChangedListener

void removeSelectionChangedListener(EventListener listener)

Parameters:

listener - the listener to remove

addSelectedIndexListener

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

Parameters:

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

removeSelectedIndexListener

void removeSelectedIndexListener(EventDataListener listener)

Parameters:

listener - the listener to remove

addSelectedItemListener

void addSelectedItemListener(EventDataListener<R> listener)

Parameters:

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

removeSelectedItemListener

void removeSelectedItemListener(EventDataListener listener)

Parameters:

listener - the listener to remove

addSelectedItemsListener

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

Parameters:

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

removeSelectedItemsListener

void removeSelectedItemsListener(EventDataListener listener)

Parameters:

listener - the listener to remove

moveSelectionDown

void moveSelectionDown()

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

See Also:

addSelectionChangedListener(EventListener)

moveSelectionUp

void moveSelectionUp()

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

See Also:

addSelectionChangedListener(EventListener)

getSelectedIndex

int getSelectedIndex()

Returns:

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

addSelectedIndex

void addSelectedIndex(int index)

Selects the item at index

Parameters:

index - the index

removeSelectedIndex

void removeSelectedIndex(int index)

Removes the item at index from the selection

Parameters:

index - the index

removeSelectedIndexes

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

Removes the given indexes from the selection

Parameters:

indexes - the indexes

setSelectedIndex

void setSelectedIndex(int index)

Clears the selection and selects the item at index

Parameters:

index - the index

setSelectedIndexes

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

Selects the given indexes

Parameters:

indexes - the indexes to select

getSelectedIndexes

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

Returns:

the selected indexes, an empty list if selection is empty

selectAll

void selectAll()

Selects all visible entities

See Also:

addSelectionChangedListener(EventListener)

addSelectedIndexes

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

Adds these indexes to the selection

Parameters:

indexes - the indexes to add to the selection

getSelectionCount

int getSelectionCount()

Returns:

the number of selected indexes in the underlying selection model.

setSelectedItems

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

Selects the given items

Parameters:

items - the items to select

getSelectedItems

java.util.List<R> getSelectedItems()

Returns:

a list containing the selected items

getSelectedItem

R getSelectedItem()

Returns:

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

setSelectedItem

void setSelectedItem(R item)

Sets the selected item

Parameters:

item - the item to select

addSelectedItem

void addSelectedItem(R item)

Adds the given item to the selection

Parameters:

item - the item to add to the selection

addSelectedItems

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

Adds the given items to the selection

Parameters:

items - the items to add to the selection

removeSelectedItem

void removeSelectedItem(R item)

Remove the given item from the selection

Parameters:

item - the item to remove from the selection

removeSelectedItems

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

Remove the given items from the selection

Parameters:

items - the items to remove from the selection

clearSelection

void clearSelection()

Clears the selection

isSelectionEmpty

boolean isSelectionEmpty()

Returns:

true if the selection is empty