javafx.collections.transformation

Class FilteredList<E>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

javafx.collections.ObservableListBase<E>

javafx.collections.transformation.TransformationList<E,E>

javafx.collections.transformation.FilteredList<E>

All Implemented Interfaces:

java.lang.Iterable<E>, java.util.Collection<E>, java.util.List<E>, Observable, ObservableList<E>

public final class FilteredList<E>
extends TransformationList<E,E>

Wraps an ObservableList and filters it's content using the provided Predicate. All changes in the ObservableList are propagated immediately to the FilteredList.

Since:

JavaFX 8.0

See Also:

TransformationList

Field Summary

Fields

Modifier and Type	Field and Description
private static java.util.function.Predicate	ALWAYS_TRUE
private int[]	filtered
private SortHelper	helper
private ObjectProperty<java.util.function.Predicate<? super E>>	predicate The predicate that will match the elements that will be in this FilteredList.
private int	size

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
FilteredList(ObservableList<E> source) Constructs a new FilteredList wrapper around the source list.
FilteredList(ObservableList<E> source, java.util.function.Predicate<? super E> predicate) Constructs a new FilteredList wrapper around the source list.

Method Summary

Modifier and Type	Method and Description
private void	addRemove(ListChangeListener.Change<? extends E> c)
private void	ensureSize(int size)
private int	findPosition(int p)
E	get(int index) Returns the element at the specified position in this list.
java.util.function.Predicate<? super E>	getPredicate()
private java.util.function.Predicate<? super E>	getPredicateImpl()
private SortHelper	getSortHelper()
int	getSourceIndex(int index) Maps the index of this list's element to an index in the direct source list.
private void	permutate(ListChangeListener.Change<? extends E> c)
ObjectProperty<java.util.function.Predicate<? super E>>	predicateProperty()
private void	refilter()
void	setPredicate(java.util.function.Predicate<? super E> predicate)
int	size() Returns the number of elements in this list.
protected void	sourceChanged(ListChangeListener.Change<? extends E> c) Called when a change from the source is triggered.
private void	update(ListChangeListener.Change<? extends E> c)
private void	updateIndexes(int from, int delta)

Methods inherited from class javafx.collections.transformation.TransformationList

getSource, getSourceIndexFor, isInTransformationChain

Methods inherited from class javafx.collections.ObservableListBase

addAll, addListener, addListener, beginChange, endChange, fireChange, hasListeners, nextAdd, nextPermutation, nextRemove, nextRemove, nextReplace, nextSet, nextUpdate, remove, removeAll, removeListener, removeListener, retainAll, setAll, setAll

Methods inherited from class java.util.AbstractList

add, add, addAll, clear, equals, hashCode, indexOf, iterator, lastIndexOf, listIterator, listIterator, remove, removeRange, set, 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 javafx.collections.ObservableList

addAll, addListener, filtered, remove, removeAll, removeListener, retainAll, setAll, setAll, sorted, sorted

Methods inherited from interface java.util.List

add, add, addAll, addAll, clear, contains, containsAll, equals, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, replaceAll, retainAll, set, sort, spliterator, subList, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface javafx.beans.Observable

addListener, removeListener

Field Detail

filtered

private int[] filtered

size

private int size

helper

private SortHelper helper

ALWAYS_TRUE

private static final java.util.function.Predicate ALWAYS_TRUE

predicate

private ObjectProperty<java.util.function.Predicate<? super E>> predicate

The predicate that will match the elements that will be in this FilteredList. Elements not matching the predicate will be filtered-out. Null predicate means "always true" predicate, all elements will be matched.

Constructor Detail

FilteredList

public FilteredList(ObservableList<E> source,
                    java.util.function.Predicate<? super E> predicate)

Constructs a new FilteredList wrapper around the source list. The provided predicate will match the elements in the source list that will be visible. If the predicate is null, all elements will be matched and the list is equal to the source list.

Parameters:

source - the source list

predicate - the predicate to match the elements or null to match all elements.

FilteredList

public FilteredList(ObservableList<E> source)

Constructs a new FilteredList wrapper around the source list. This list has an "always true" predicate, containing all the elements of the source list.

This constructor might be useful if you want to bind predicateProperty() of this list.

Parameters:

source - the source list

Method Detail

predicateProperty

public final ObjectProperty<java.util.function.Predicate<? super E>> predicateProperty()

getPredicate

public final java.util.function.Predicate<? super E> getPredicate()

setPredicate

public final void setPredicate(java.util.function.Predicate<? super E> predicate)

getPredicateImpl

private java.util.function.Predicate<? super E> getPredicateImpl()

sourceChanged

protected void sourceChanged(ListChangeListener.Change<? extends E> c)

Description copied from class: TransformationList

Called when a change from the source is triggered.

Specified by:

sourceChanged in class TransformationList<E,E>

Parameters:

c - the change

size

public int size()

Returns the number of elements in this list.

Specified by:

size in interface java.util.Collection<E>

Specified by:

size in interface java.util.List<E>

Specified by:

size in class java.util.AbstractCollection<E>

Returns:

the number of elements in this list

get

public E get(int index)

Returns the element at the specified position in this list.

Specified by:

get in interface java.util.List<E>

Specified by:

get in class java.util.AbstractList<E>

Parameters:

index - index of the element to return

Returns:

the element at the specified position in this list

Throws:

java.lang.IndexOutOfBoundsException

getSourceIndex

public int getSourceIndex(int index)

Description copied from class: TransformationList

Maps the index of this list's element to an index in the direct source list.

Specified by:

getSourceIndex in class TransformationList<E,E>

Parameters:

index - the index in this list

Returns:

the index of the element's origin in the source list

See Also:

TransformationList.getSource()

getSortHelper

private SortHelper getSortHelper()

findPosition

private int findPosition(int p)

ensureSize

private void ensureSize(int size)

updateIndexes

private void updateIndexes(int from,
                           int delta)

permutate

private void permutate(ListChangeListener.Change<? extends E> c)

addRemove

private void addRemove(ListChangeListener.Change<? extends E> c)

update

private void update(ListChangeListener.Change<? extends E> c)

refilter

private void refilter()