Module MaterialFX

Package io.github.palexdev.materialfx.collections

Class TransformableListWrapper<T>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<T>

io.github.palexdev.materialfx.collections.TransformableListWrapper<T>

All Implemented Interfaces:

Iterable<T>, Collection<T>, List<T>, Observable, ObservableList<T>

public class TransformableListWrapper<T>
extends AbstractList<T>
implements ObservableList<T>

For some idiot reason JavaFX's TransformationLists do not allow modifying the source list.

This class fixes that. It wraps an ObservableList which is the source list and the new TransformableList which is built from that source.

This way you can benefit of the futures of the new TransformableList (sorting and filtering) while also being able to directly modify the source list.

Property Summary

Properties

Type	Property	Description
ComparatorProperty<T>	comparator	Delegate for TransformableList.comparatorProperty().
PredicateProperty<T>	predicate	Delegate for TransformableList.predicateProperty().

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor	Description
TransformableListWrapper(ObservableList<T> source)

Method Summary

Modifier and Type	Method	Description
void	add(int index, T element)
boolean	add(T t)
boolean	addAll(int index, Collection<? extends T> c)
boolean	addAll(T... elements)
void	addListener(InvalidationListener listener)
void	addListener(ListChangeListener<? super T> listener)
void	clear()
ComparatorProperty<T>	comparatorProperty()	Delegate for TransformableList.comparatorProperty().
T	get(int index)
Comparator<T>	getComparator()	Gets the value of the property comparator.
Predicate<? super T>	getPredicate()	Gets the value of the property predicate.
ObservableList<? extends T>	getSource()
TransformableList<T>	getTransformableList()
int	indexOf(Object o)
boolean	isReversed()	Delegate for TransformableList.isReversed().
int	lastIndexOf(Object o)
PredicateProperty<T>	predicateProperty()	Delegate for TransformableList.predicateProperty().
T	remove(int index)
void	remove(int from, int to)
boolean	removeAll(T... elements)
void	removeListener(InvalidationListener listener)
void	removeListener(ListChangeListener<? super T> listener)
boolean	retainAll(T... elements)
T	set(int index, T element)
boolean	setAll(Collection<? extends T> col)
boolean	setAll(T... elements)
void	setComparator(Comparator<T> comparator)	Sets the value of the property comparator.
void	setComparator(Comparator<T> sorter, boolean reversed)	Delegate for TransformableList.setComparator(Comparator, boolean).
void	setPredicate(Predicate<T> predicate)	Sets the value of the property predicate.
void	setReversed(boolean reversed)	Delegate for TransformableList.setReversed(boolean).
int	size()
int	sourceToView(int index)	Delegate for TransformableList.sourceToView(int).
int	viewToSource(int index)	Delegate for TransformableList.viewToSource(int).

Methods inherited from class java.util.AbstractList

equals, hashCode, iterator, listIterator, listIterator, removeRange, subList

Methods inherited from class java.util.AbstractCollection

addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.List

addAll, contains, containsAll, equals, hashCode, isEmpty, iterator, listIterator, listIterator, remove, removeAll, replaceAll, retainAll, sort, spliterator, subList, toArray, toArray

Methods inherited from interface javafx.collections.ObservableList

filtered, sorted, sorted

Property Details

predicate

public PredicateProperty<T> predicateProperty

Delegate for TransformableList.predicateProperty().

See Also:

• getPredicate()
• setPredicate(Predicate)

comparator

public ComparatorProperty<T> comparatorProperty

Delegate for TransformableList.comparatorProperty().

See Also:

• getComparator()
• setComparator(Comparator)

Constructor Details

TransformableListWrapper

public TransformableListWrapper(ObservableList<T> source)

Method Details

addListener

public void addListener(ListChangeListener<? super T> listener)

Added to the TransformableList.

Specified by:

addListener in interface ObservableList<T>

removeListener

public void removeListener(ListChangeListener<? super T> listener)

Removed from the TransformableList.

Specified by:

removeListener in interface ObservableList<T>

add

public boolean add(T t)

Added to the source list.

Specified by:

add in interface Collection<T>

Specified by:

add in interface List<T>

Overrides:

add in class AbstractList<T>

set

public T set(int index,
 T element)

Set on the source list.

Specified by:

set in interface List<T>

Overrides:

set in class AbstractList<T>

add

public void add(int index,
 T element)

Added to the source list.

Specified by:

add in interface List<T>

Overrides:

add in class AbstractList<T>

remove

public T remove(int index)

Removed from the source list.

Specified by:

remove in interface List<T>

Overrides:

remove in class AbstractList<T>

indexOf

public int indexOf(Object o)

Retrieved from the TransformableList.

Specified by:

indexOf in interface List<T>

Overrides:

indexOf in class AbstractList<T>

lastIndexOf

public int lastIndexOf(Object o)

Retrieved from the TransformableList.

Specified by:

lastIndexOf in interface List<T>

Overrides:

lastIndexOf in class AbstractList<T>

clear

public void clear()

The source list is cleared.

Specified by:

clear in interface Collection<T>

Specified by:

clear in interface List<T>

Overrides:

clear in class AbstractList<T>

addAll

public boolean addAll(int index,
 Collection<? extends T> c)

Added to the source list.

Specified by:

addAll in interface List<T>

Overrides:

addAll in class AbstractList<T>

addAll

public boolean addAll(T... elements)

Added to the source list.

Specified by:

addAll in interface ObservableList<T>

setAll

public boolean setAll(T... elements)

Set on the source list.

Specified by:

setAll in interface ObservableList<T>

setAll

public boolean setAll(Collection<? extends T> col)

Set on the source list.

Specified by:

setAll in interface ObservableList<T>

removeAll

public boolean removeAll(T... elements)

Removed from the source list.

Specified by:

removeAll in interface ObservableList<T>

retainAll

public boolean retainAll(T... elements)

Retained on the source list.

Specified by:

retainAll in interface ObservableList<T>

remove

public void remove(int from,
 int to)

Removed from the source list.

Specified by:

remove in interface ObservableList<T>

addListener

public void addListener(InvalidationListener listener)

Added to the TransformableList.

Specified by:

addListener in interface Observable

removeListener

public void removeListener(InvalidationListener listener)

Removed from the TransformableList.

Specified by:

removeListener in interface Observable

get

public T get(int index)

Retrieved from the TransformableList.

Specified by:

get in interface List<T>

Specified by:

get in class AbstractList<T>

size

public int size()

Size of the TransformableList.

Specified by:

size in interface Collection<T>

Specified by:

size in interface List<T>

Specified by:

size in class AbstractCollection<T>

getSource

public ObservableList<? extends T> getSource()

Returns:

the source observable list

viewToSource

public int viewToSource(int index)

Delegate for TransformableList.viewToSource(int).

sourceToView

public int sourceToView(int index)

Delegate for TransformableList.sourceToView(int).

getPredicate

public Predicate<? super T> getPredicate()

Gets the value of the property predicate.

Property description:

Delegate for TransformableList.predicateProperty().

predicateProperty

public PredicateProperty<T> predicateProperty()

Delegate for TransformableList.predicateProperty().

See Also:

• getPredicate()
• setPredicate(Predicate)

setPredicate

public void setPredicate(Predicate<T> predicate)

Sets the value of the property predicate.

Property description:

Delegate for TransformableList.predicateProperty().

getComparator

public Comparator<T> getComparator()

Gets the value of the property comparator.

Property description:

Delegate for TransformableList.comparatorProperty().

comparatorProperty

public ComparatorProperty<T> comparatorProperty()

Delegate for TransformableList.comparatorProperty().

See Also:

• getComparator()
• setComparator(Comparator)

setComparator

public void setComparator(Comparator<T> comparator)

Sets the value of the property comparator.

Property description:

Delegate for TransformableList.comparatorProperty().

setComparator

public void setComparator(Comparator<T> sorter,
 boolean reversed)

Delegate for TransformableList.setComparator(Comparator, boolean).

isReversed

public boolean isReversed()

Delegate for TransformableList.isReversed().

setReversed

public void setReversed(boolean reversed)

Delegate for TransformableList.setReversed(boolean).

getTransformableList

public TransformableList<T> getTransformableList()

Returns:

the wrapped TransformableList