Module MaterialFX

Package io.github.palexdev.materialfx.filter

Class EnumFilter<T,E extends Enum<E>>

java.lang.Object

io.github.palexdev.materialfx.filter.base.AbstractFilter<T,E>

io.github.palexdev.materialfx.filter.EnumFilter<T,E>

public class EnumFilter<T,E extends Enum<E>>
extends AbstractFilter<T,E>

Extension of AbstractFilter for Enum fields.

Offers the following default BiPredicateBeans:

- "is": checks for enums equality

- "is not": checks for enums inequality

This filter is special because to extract the enumerations of a given E enum, it's needed to also pass the type to the constructor. This is necessary for the EnumStringConverter.

Property Summary

Properties inherited from class io.github.palexdev.materialfx.filter.base.AbstractFilter

selectedPredicateIndex

Field Summary

Fields inherited from class io.github.palexdev.materialfx.filter.base.AbstractFilter

converter, predicates, selectedPredicateIndex

Constructor Summary

Constructors

Constructor	Description
EnumFilter(String name, Function<T,E> extractor, Class<E> enumType)
EnumFilter(String name, Function<T,E> extractor, Class<E> enumType, StringConverter<E> converter)

Method Summary

Modifier and Type	Method	Description
protected ObservableList<BiPredicateBean<E,E>>	defaultPredicates()	Every implementation of AbstractFilter must define some default BiPredicates.
protected final EnumFilter<T,E>	extend(BiPredicateBean<E,E>... predicateBeans)	Allows to add some extra BiPredicateBeans alongside the default ones.
Class<E>	getEnumType()

Methods inherited from class io.github.palexdev.materialfx.filter.base.AbstractFilter

getConverter, getExtractor, getPredicates, getSelectedPredicateIndex, getValue, name, predicateFor, predicateFor, selectedPredicateIndexProperty, setSelectedPredicateIndex, toFilterBean, toFilterBean, toFilterBean, toString

Methods inherited from class java.lang.Object

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

Constructor Details

EnumFilter

public EnumFilter(String name,
 Function<T,E> extractor,
 Class<E> enumType)

EnumFilter

public EnumFilter(String name,
 Function<T,E> extractor,
 Class<E> enumType,
 StringConverter<E> converter)

Method Details

getEnumType

public Class<E> getEnumType()

defaultPredicates

protected ObservableList<BiPredicateBean<E,E>> defaultPredicates()

Description copied from class: AbstractFilter

Every implementation of AbstractFilter must define some default BiPredicates.

Specified by:

defaultPredicates in class AbstractFilter<T,E extends Enum<E>>

extend

@SafeVarargs
protected final EnumFilter<T,E> extend(BiPredicateBean<E,E>... predicateBeans)

Description copied from class: AbstractFilter

Allows to add some extra BiPredicateBeans alongside the default ones.

Specified by:

extend in class AbstractFilter<T,E extends Enum<E>>