de.saxsys.mvvmfx.utils.itemlist

Class SelectableItemList<ListType>

java.lang.Object

de.saxsys.mvvmfx.utils.itemlist.ListTransformation<ListType,String>

de.saxsys.mvvmfx.utils.itemlist.ItemList<ListType>

de.saxsys.mvvmfx.utils.itemlist.SelectableItemList<ListType>

Type Parameters:

ListType - type of the list elements which should be transformed to a string list

All Implemented Interfaces:

SelectableStringList

public class SelectableItemList<ListType>
extends ItemList<ListType>
implements SelectableStringList

Element that you can use in a View Model to transform any list to a string representation which can be bound to UI Elements like ChoiceBox or ListView. You should only expose the stringListProperty() and/or the selectedIndexProperty() to the view, otherwise you create a visibility of the view to the model. If you want to expose it more convenient, use the SelectableStringList interface to hide all dependencies to the model. Create something like this in your View Model: public SelectableStringList stringListProperty(){ return selectableItemListInstance; } You have to provide a ModelToStringFunction to define how to map from your model representation to a string. In addition you have properties which represents the actual selection state of a list. You can set either the selectedIndexProperty() or the selectedItemProperty() and the other will change automatically.

Author:

sialcasa

Property Summary

Type	Property and Description
javafx.beans.property.ReadOnlyIntegerProperty	selectedIndex Represents an Integer which is the current selection index.
javafx.beans.property.ObjectProperty<ListType>	selectedItem Represents the current selected item.
javafx.beans.property.ReadOnlyListProperty<String>	stringList String list which can be used by the UI to present the data.

Properties inherited from class de.saxsys.mvvmfx.utils.itemlist.ListTransformation

modelListProperty, sourceListProperty, targetListProperty

Constructor Summary

Constructors

Constructor and Description
SelectableItemList(javafx.collections.ObservableList<ListType> itemList, ModelToStringFunction<ListType> modelToStringMapper) Creates a SelectableItemList by a given list of items and a ModelToStringFunction.

Method Summary

Modifier and Type	Method and Description
void	clearSelection() Removes the selection.
int	getSelectedIndex() Gets the value of the property selectedIndex.
ListType	getSelectedItem()
List<String>	getStringList()
void	select(int index)
void	select(ListType item)
javafx.beans.property.ReadOnlyIntegerProperty	selectedIndexProperty() Represents an Integer which is the current selection index.
javafx.beans.property.ObjectProperty<ListType>	selectedItemProperty() Represents the current selected item.
javafx.beans.property.ReadOnlyListProperty<String>	stringListProperty() String list which can be used by the UI to present the data.

Methods inherited from class de.saxsys.mvvmfx.utils.itemlist.ListTransformation

getModelList, getSourceList, getTargetList, modelListProperty, setModelList, setSourceList, sourceListProperty, targetListProperty

Methods inherited from class java.lang.Object

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

Property Detail

selectedIndex

public javafx.beans.property.ReadOnlyIntegerProperty selectedIndexProperty

Represents an Integer which is the current selection index. If you set another value to the property selectedItemProperty() will change automatically. If the value was an invalid index, the change will be rollbacked.

Specified by:

selectedIndexProperty in interface SelectableStringList

Returns:

the index property

See Also:

getSelectedIndex()

stringList

public javafx.beans.property.ReadOnlyListProperty<String> stringListProperty

Specified by:

stringListProperty in interface SelectableStringList

Overrides:

stringListProperty in class ItemList<ListType>

Returns:

string list

See Also:

getStringList()

selectedItem

public javafx.beans.property.ObjectProperty<ListType> selectedItemProperty

Represents the current selected item. If you set another value to the property selectedIndexProperty() will change automatically. If the value was an invalid item which is not in the itemlist, the change will be rollbacked.

See Also:

getSelectedItem()

Constructor Detail

SelectableItemList

public SelectableItemList(javafx.collections.ObservableList<ListType> itemList,
                          ModelToStringFunction<ListType> modelToStringMapper)

Creates a SelectableItemList by a given list of items and a ModelToStringFunction.

Parameters:

itemList - which should be transformed for the UI

modelToStringMapper - which is used for transformation

Method Detail

selectedIndexProperty

public javafx.beans.property.ReadOnlyIntegerProperty selectedIndexProperty()

Represents an Integer which is the current selection index. If you set another value to the property selectedItemProperty() will change automatically. If the value was an invalid index, the change will be rollbacked.

Specified by:

selectedIndexProperty in interface SelectableStringList

Returns:

the index property

See Also:

getSelectedIndex()

getSelectedIndex

public int getSelectedIndex()

Gets the value of the property selectedIndex.

Specified by:

getSelectedIndex in interface SelectableStringList

Returns:

the currently selected index.

See Also:

SelectableStringList.selectedIndexProperty()

stringListProperty

public javafx.beans.property.ReadOnlyListProperty<String> stringListProperty()

Description copied from interface: SelectableStringList

String list which can be used by the UI to present the data.

Specified by:

stringListProperty in interface SelectableStringList

Overrides:

stringListProperty in class ItemList<ListType>

Returns:

string list

See Also:

getStringList()

getStringList

public List<String> getStringList()

Returns:

String representation of ListTransformation.modelListProperty() as List.

selectedItemProperty

public javafx.beans.property.ObjectProperty<ListType> selectedItemProperty()

Represents the current selected item. If you set another value to the property selectedIndexProperty() will change automatically. If the value was an invalid item which is not in the itemlist, the change will be rollbacked.

See Also:

getSelectedItem()

select

public void select(ListType item)

Parameters:

item - the item will be selected.

See Also:

selectedItemProperty()

getSelectedItem

public ListType getSelectedItem()

Returns:

the currently selected item.

See Also:

selectedItemProperty()

clearSelection

public void clearSelection()

Description copied from interface: SelectableStringList

Removes the selection.

Specified by:

clearSelection in interface SelectableStringList

select

public void select(int index)

Specified by:

select in interface SelectableStringList

Parameters:

index - the id to be selected

See Also:

SelectableStringList.selectedIndexProperty()