FilteredList

java.lang.Object
- <any>
- - javafx.collections.transformation.TransformationList<E,E>
  - - javafx.collections.transformation.FilteredList<E>

```
public final class FilteredList<E>
extends TransformationList<E,E>
```
Wraps an ObservableList and filters its content using the provided Predicate. All changes in the ObservableList are propagated immediately to the FilteredList.

Since:

JavaFX 8.0

See Also:

TransformationList

Property Summary

All Methods Instance Methods Concrete Methods
Type Property and Description

<any> predicate
The predicate that will match the elements that will be in this FilteredList.

All Methods Instance Methods Concrete Methods
Type	Property and Description
`<any>`	`predicate` The predicate that will match the elements that will be in this FilteredList.

Field Summary

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

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`private void`	`addRemove(<any> 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()` Gets the value of the property predicate.
`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.
`int`	`getViewIndex(int index)` Maps the index of the direct source list's element to an index in this list.
`private void`	`permutate(<any> c)`
`<any>`	`predicateProperty()` The predicate that will match the elements that will be in this FilteredList.
`private void`	`refilter()`
`void`	`setPredicate(java.util.function.Predicate<? super E> predicate)` Sets the value of the property predicate.
`int`	`size()` Returns the number of elements in this list.
`protected void`	`sourceChanged(<any> c)` Called when a change from the source is triggered.
`private void`	`update(<any> c)`
`private void`	`updateIndexes(int from, int delta)`

Methods inherited from class javafx.collections.transformation.TransformationList
getSource, getSourceIndexFor, isInTransformationChain

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Property Detail
  - predicate
```
public final <any> predicateProperty
```
    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.
    
    See Also:
    
    getPredicate(), setPredicate(Predicate)
- 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 <any> 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(<any> 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(<any> 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 <any> predicateProperty()
```
    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.
    
    See Also:
    
    getPredicate(), setPredicate(Predicate)
  - getPredicate
```
public final java.util.function.Predicate<? super E> getPredicate()
```
    Gets the value of the property predicate.
  - setPredicate
```
public final void setPredicate(java.util.function.Predicate<? super E> predicate)
```
    Sets the value of the property predicate.
  - getPredicateImpl
```
private java.util.function.Predicate<? super E> getPredicateImpl()
```
  - sourceChanged
```
protected void sourceChanged(<any> 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.
    
    Returns:
    
    the number of elements in this list
  - get
```
public E get(int index)
```
    Returns the element at the specified position in this list.
    
    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()
  - getViewIndex
```
public int getViewIndex(int index)
```
    Description copied from class: TransformationList
    
    Maps the index of the direct source list's element to an index in this list.
    
    Specified by:
    
    getViewIndex in class TransformationList<E,E>
    
    Parameters:
    
    index - the index in the source list
    
    Returns:
    
    the index of the element in this list if it is contained in this list or negative value otherwise
    
    See Also:
    
    TransformationList.getSource(), TransformationList.getSourceIndex(int)
  - 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(<any> c)
```
  - addRemove
```
private void addRemove(<any> c)
```
  - update
```
private void update(<any> c)
```
  - refilter
```
private void refilter()
```

Class FilteredList<E>

Property Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class javafx.collections.transformation.TransformationList

Methods inherited from class java.lang.Object

Property Detail

predicate

Field Detail

filtered

size

helper

ALWAYS_TRUE

predicate

Constructor Detail

FilteredList

FilteredList

Method Detail

predicateProperty

getPredicate

setPredicate

getPredicateImpl

sourceChanged

size

get

getSourceIndex

getViewIndex

getSortHelper

findPosition

ensureSize

updateIndexes

permutate

addRemove

update

refilter