Module MaterialFX

Package io.github.palexdev.materialfx.selection

Class SingleSelectionModel<T>

java.lang.Object

io.github.palexdev.materialfx.selection.base.AbstractSingleSelectionModel<T>

io.github.palexdev.materialfx.selection.SingleSelectionModel<T>

All Implemented Interfaces:

ISingleSelectionModel<T>

Direct Known Subclasses:

ComboBoxSelectionModel

public class SingleSelectionModel<T>
extends AbstractSingleSelectionModel<T>

Implementation of AbstractSingleSelectionModel to implement the API specified by ISingleSelectionModel.

The logic is handled by SingleSelectionManager, in fact all methods are just delegates.

Property Summary

Properties

Type	Property	Description
ReadOnlyIntegerProperty	selectedIndex	Delegate method for SingleSelectionManager.selectedIndexProperty(), but a read-only property is returned.
ReadOnlyObjectProperty<T>	selectedItem	Delegate method for SingleSelectionManager.selectedItemProperty(), but a read-only property is returned.

Field Summary

Fields inherited from class io.github.palexdev.materialfx.selection.base.AbstractSingleSelectionModel

items, selectionManager

Constructor Summary

Constructors

Constructor	Description
SingleSelectionModel(ObjectProperty<ObservableList<T>> items)
SingleSelectionModel(ObservableList<T> items)

Method Summary

Modifier and Type	Method	Description
void	bindIndex(SingleSelectionModel<T> selectionModel)	Binds this selection model's index to the given selection model's index, calls SingleSelectionManager.bindIndex(ObservableValue, Function).
void	bindIndex(ObservableValue<? extends Number> source, Function<Integer,T> indexConverter)	Delegate method for SingleSelectionManager.bindIndex(ObservableValue, Function).
void	bindIndexBidirectional(SingleSelectionModel<T> selectionModel)	Binds this selection model's index bidirectionally to the given selection model's index, calls SingleSelectionManager.bindIndexBidirectional(Property, Function, TriConsumer).
void	bindIndexBidirectional(Property<Number> other, Function<Integer,T> indexConverter, TriConsumer<Boolean,Integer,Property<Number>> updateOther)	Delegate method for SingleSelectionManager.bindIndexBidirectional(Property, Function, TriConsumer).
void	bindItem(SingleSelectionModel<T> selectionModel)	Binds this selection model's item to the given selection model's item, calls SingleSelectionManager.bindItem(ObservableValue, Function).
void	bindItem(ObservableValue<? extends T> source, Function<T,Integer> itemConverter)	Delegate method for SingleSelectionManager.bindItem(ObservableValue, Function).
void	bindItemBidirectional(SingleSelectionModel<T> selectionModel)	Binds this selection model's item bidirectionally to the given selection model's item, calls SingleSelectionManager.bindItemBidirectional(Property, Function, TriConsumer).
void	bindItemBidirectional(Property<T> other, Function<T,Integer> itemConverter, TriConsumer<Boolean,T,Property<T>> updateOther)	Delegate method for SingleSelectionManager.bindItemBidirectional(Property, Function, TriConsumer).
void	clearSelection()	Delegate method for SingleSelectionManager.clearSelection().
int	getSelectedIndex()	Delegate method for SingleSelectionManager.getSelectedIndex()}.
T	getSelectedItem()	Delegate method for SingleSelectionManager.getSelectedItem().
boolean	isBound()	Delegate method for SingleSelectionManager.isBound().
ReadOnlyIntegerProperty	selectedIndexProperty()	Delegate method for SingleSelectionManager.selectedIndexProperty(), but a read-only property is returned.
ReadOnlyObjectProperty<T>	selectedItemProperty()	Delegate method for SingleSelectionManager.selectedItemProperty(), but a read-only property is returned.
void	selectIndex(int index)	Delegate method for SingleSelectionManager.updateSelection(int).
void	selectItem(T item)	Delegate method for SingleSelectionManager.updateSelection(Object).
void	unbind()	Delegate method for SingleSelectionManager.unbind().
void	unbindBidirectional()	Delegate method for SingleSelectionManager.unbindBidirectional().
void	unbindIndexBidirectional(Property<Number> other)	Delegate method for SingleSelectionManager.unbindIndexBidirectional(Property).
void	unbindItemBidirectional(Property<T> other)	Delegate method for SingleSelectionManager.unbindItemBidirectional(Property).

Methods inherited from class io.github.palexdev.materialfx.selection.base.AbstractSingleSelectionModel

getItems, getUnmodifiableItems

Methods inherited from class java.lang.Object

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

Property Details

selectedIndex

public ReadOnlyIntegerProperty selectedIndexProperty

Delegate method for SingleSelectionManager.selectedIndexProperty(), but a read-only property is returned.

See Also:

• getSelectedIndex()

selectedItem

public ReadOnlyObjectProperty<T> selectedItemProperty

Delegate method for SingleSelectionManager.selectedItemProperty(), but a read-only property is returned.

See Also:

• getSelectedItem()

Constructor Details

SingleSelectionModel

public SingleSelectionModel(ObservableList<T> items)

SingleSelectionModel

public SingleSelectionModel(ObjectProperty<ObservableList<T>> items)

Method Details

clearSelection

public void clearSelection()

Delegate method for SingleSelectionManager.clearSelection().

selectIndex

public void selectIndex(int index)

Delegate method for SingleSelectionManager.updateSelection(int).

selectItem

public void selectItem(T item)

Delegate method for SingleSelectionManager.updateSelection(Object).

getSelectedIndex

public int getSelectedIndex()

Delegate method for SingleSelectionManager.getSelectedIndex()}.

Returns:

the current selected index

selectedIndexProperty

public ReadOnlyIntegerProperty selectedIndexProperty()

Delegate method for SingleSelectionManager.selectedIndexProperty(), but a read-only property is returned.

See Also:

• getSelectedIndex()

getSelectedItem

public T getSelectedItem()

Delegate method for SingleSelectionManager.getSelectedItem().

Returns:

the current selected item

selectedItemProperty

public ReadOnlyObjectProperty<T> selectedItemProperty()

Delegate method for SingleSelectionManager.selectedItemProperty(), but a read-only property is returned.

See Also:

• getSelectedItem()

bindIndex

public void bindIndex(SingleSelectionModel<T> selectionModel)

Binds this selection model's index to the given selection model's index, calls SingleSelectionManager.bindIndex(ObservableValue, Function).

Default implementation:

 
      selectionManager.bindIndex(selectionModel.selectionManager.selectedIndexProperty(), getItems()::get);
 
 

bindIndexBidirectional

public void bindIndexBidirectional(SingleSelectionModel<T> selectionModel)

Binds this selection model's index bidirectionally to the given selection model's index, calls SingleSelectionManager.bindIndexBidirectional(Property, Function, TriConsumer).

Default implementation:

 
         selectionManager.bindIndexBidirectional(
                 selectionModel.selectionManager.selectedIndexProperty(),
                 getItems()::get,
                 (clearing, i, other) -> {
                     selectionModel.selectionManager.setClearing(clearing);
                     selectionModel.selectionManager.updateSelection(i);
                 }
         );
 
 

bindItem

public void bindItem(SingleSelectionModel<T> selectionModel)

Binds this selection model's item to the given selection model's item, calls SingleSelectionManager.bindItem(ObservableValue, Function).

Default implementation:

 
         selectionManager.bindItem(selectionModel.selectionManager.selectedItemProperty(), getItems()::indexOf);
 
 

bindItemBidirectional

public void bindItemBidirectional(SingleSelectionModel<T> selectionModel)

Binds this selection model's item bidirectionally to the given selection model's item, calls SingleSelectionManager.bindItemBidirectional(Property, Function, TriConsumer).

Default implementation:

 
         selectionManager.bindItemBidirectional(
                 selectionModel.selectionManager.selectedItemProperty(),
                 getItems()::indexOf,
                 (clearing, item, other) -> {
                     selectionModel.selectionManager.setClearing(clearing);
                     selectionModel.selectionManager.updateSelection(item);
                 }
         );
 
 

bindIndex

public void bindIndex(ObservableValue<? extends Number> source,
 Function<Integer,T> indexConverter)

Delegate method for SingleSelectionManager.bindIndex(ObservableValue, Function).

bindIndexBidirectional

public void bindIndexBidirectional(Property<Number> other,
 Function<Integer,T> indexConverter,
 TriConsumer<Boolean,Integer,Property<Number>> updateOther)

Delegate method for SingleSelectionManager.bindIndexBidirectional(Property, Function, TriConsumer).

bindItem

public void bindItem(ObservableValue<? extends T> source,
 Function<T,Integer> itemConverter)

Delegate method for SingleSelectionManager.bindItem(ObservableValue, Function).

bindItemBidirectional

public void bindItemBidirectional(Property<T> other,
 Function<T,Integer> itemConverter,
 TriConsumer<Boolean,T,Property<T>> updateOther)

Delegate method for SingleSelectionManager.bindItemBidirectional(Property, Function, TriConsumer).

unbind

public void unbind()

Delegate method for SingleSelectionManager.unbind().

unbindIndexBidirectional

public void unbindIndexBidirectional(Property<Number> other)

Delegate method for SingleSelectionManager.unbindIndexBidirectional(Property).

unbindItemBidirectional

public void unbindItemBidirectional(Property<T> other)

Delegate method for SingleSelectionManager.unbindItemBidirectional(Property).

unbindBidirectional

public void unbindBidirectional()

Delegate method for SingleSelectionManager.unbindBidirectional().

isBound

public boolean isBound()

Delegate method for SingleSelectionManager.isBound().