org.jminor.javafx.framework.model

Class FXEntityListSelectionModel

java.lang.Object

org.jminor.javafx.framework.model.FXEntityListSelectionModel

All Implemented Interfaces:

SelectionModel<Entity>

public final class FXEntityListSelectionModel
extends java.lang.Object
implements SelectionModel<Entity>

A JavaFX SelectionModel implementation

Constructor Summary

Constructors

Constructor and Description
FXEntityListSelectionModel(javafx.scene.control.SelectionModel<Entity> selectionModel)

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(Entity item) Adds the given item to the selection
void	addSelectedItemListener(EventDataListener<Entity> listener)
void	addSelectedItems(java.util.Collection<Entity> items) Adds the given items to the selection
void	addSelectedItemsListener(EventDataListener<java.util.List<Entity>> listener)
void	addSelectionChangedListener(EventListener listener)
void	clearSelection() Clears the selection
StateObserver	getMultipleSelectionObserver()
int	getSelectedIndex()
java.util.List<java.lang.Integer>	getSelectedIndexes()
Entity	getSelectedItem()
java.util.List<Entity>	getSelectedItems()
int	getSelectionCount()
StateObserver	getSelectionEmptyObserver()
javafx.scene.control.SelectionModel<Entity>	getSelectionModel()
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(Entity item) Remove the given item from the selection
void	removeSelectedItemListener(EventDataListener listener)
void	removeSelectedItems(java.util.Collection<Entity> 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(Entity item) Sets the selected item
void	setSelectedItems(java.util.Collection<Entity> items) Selects the given items

Methods inherited from class java.lang.Object

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

Constructor Detail

FXEntityListSelectionModel

public FXEntityListSelectionModel(javafx.scene.control.SelectionModel<Entity> selectionModel)

Parameters:

selectionModel - the SelectionModel instance to base this selection model on

Method Detail

getSelectionModel

public javafx.scene.control.SelectionModel<Entity> getSelectionModel()

Returns:

the underlying SelectionModel instance

getSelectionEmptyObserver

public StateObserver getSelectionEmptyObserver()

Specified by:

getSelectionEmptyObserver in interface SelectionModel<Entity>

Returns:

a StateObserver indicating that the selection is empty

getMultipleSelectionObserver

public StateObserver getMultipleSelectionObserver()

Specified by:

getMultipleSelectionObserver in interface SelectionModel<Entity>

Returns:

a StateObserver indicating that multiple rows are selected

getSingleSelectionObserver

public StateObserver getSingleSelectionObserver()

Specified by:

getSingleSelectionObserver in interface SelectionModel<Entity>

Returns:

a StateObserver indicating that a single row is selected

addSelectionChangedListener

public void addSelectionChangedListener(EventListener listener)

Specified by:

addSelectionChangedListener in interface SelectionModel<Entity>

Parameters:

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

removeSelectionChangedListener

public void removeSelectionChangedListener(EventListener listener)

Specified by:

removeSelectionChangedListener in interface SelectionModel<Entity>

Parameters:

listener - the listener to remove

addSelectedIndexListener

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

Specified by:

addSelectedIndexListener in interface SelectionModel<Entity>

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<Entity>

Parameters:

listener - the listener to remove

addSelectedItemListener

public void addSelectedItemListener(EventDataListener<Entity> listener)

Specified by:

addSelectedItemListener in interface SelectionModel<Entity>

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<Entity>

Parameters:

listener - the listener to remove

addSelectedItemsListener

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

Specified by:

addSelectedItemsListener in interface SelectionModel<Entity>

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<Entity>

Parameters:

listener - the listener to remove

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<Entity>

See Also:

SelectionModel.addSelectionChangedListener(EventListener)

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<Entity>

See Also:

SelectionModel.addSelectionChangedListener(EventListener)

getSelectedIndex

public int getSelectedIndex()

Specified by:

getSelectedIndex in interface SelectionModel<Entity>

Returns:

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

addSelectedIndex

public void addSelectedIndex(int index)

Selects the item at index

Specified by:

addSelectedIndex in interface SelectionModel<Entity>

Parameters:

index - the index

removeSelectedIndex

public void removeSelectedIndex(int index)

Removes the item at index from the selection

Specified by:

removeSelectedIndex in interface SelectionModel<Entity>

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<Entity>

Parameters:

indexes - the indexes

removeSelectedItem

public void removeSelectedItem(Entity item)

Remove the given item from the selection

Specified by:

removeSelectedItem in interface SelectionModel<Entity>

Parameters:

item - the item to remove from the selection

removeSelectedItems

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

Remove the given items from the selection

Specified by:

removeSelectedItems in interface SelectionModel<Entity>

Parameters:

items - the items to remove from the selection

setSelectedIndex

public void setSelectedIndex(int index)

Clears the selection and selects the item at index

Specified by:

setSelectedIndex in interface SelectionModel<Entity>

Parameters:

index - the index

setSelectedIndexes

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

Selects the given indexes

Specified by:

setSelectedIndexes in interface SelectionModel<Entity>

Parameters:

indexes - the indexes to select

getSelectedIndexes

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

Specified by:

getSelectedIndexes in interface SelectionModel<Entity>

Returns:

the selected indexes, an empty list if selection is empty

selectAll

public void selectAll()

Selects all visible entities

Specified by:

selectAll in interface SelectionModel<Entity>

See Also:

SelectionModel.addSelectionChangedListener(EventListener)

addSelectedIndexes

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

Adds these indexes to the selection

Specified by:

addSelectedIndexes in interface SelectionModel<Entity>

Parameters:

indexes - the indexes to add to the selection

getSelectionCount

public int getSelectionCount()

Specified by:

getSelectionCount in interface SelectionModel<Entity>

Returns:

the number of selected indexes in the underlying selection model.

setSelectedItems

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

Selects the given items

Specified by:

setSelectedItems in interface SelectionModel<Entity>

Parameters:

items - the items to select

getSelectedItems

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

Specified by:

getSelectedItems in interface SelectionModel<Entity>

Returns:

a list containing the selected items

getSelectedItem

public Entity getSelectedItem()

Specified by:

getSelectedItem in interface SelectionModel<Entity>

Returns:

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

setSelectedItem

public void setSelectedItem(Entity item)

Sets the selected item

Specified by:

setSelectedItem in interface SelectionModel<Entity>

Parameters:

item - the item to select

addSelectedItem

public void addSelectedItem(Entity item)

Adds the given item to the selection

Specified by:

addSelectedItem in interface SelectionModel<Entity>

Parameters:

item - the item to add to the selection

addSelectedItems

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

Adds the given items to the selection

Specified by:

addSelectedItems in interface SelectionModel<Entity>

Parameters:

items - the items to add to the selection

clearSelection

public void clearSelection()

Clears the selection

Specified by:

clearSelection in interface SelectionModel<Entity>

isSelectionEmpty

public boolean isSelectionEmpty()

Specified by:

isSelectionEmpty in interface SelectionModel<Entity>

Returns:

true if the selection is empty