Module com.dlsc.gemsfx
Package com.dlsc.gemsfx

Class FilterView.Filter<T>

java.lang.Object
com.dlsc.gemsfx.FilterView.Filter<T>
Type Parameters:
T - the type of the model objects managed by the filter view
All Implemented Interfaces:
Predicate<T>
Enclosing class:
FilterView<T>
public abstract static class FilterView.Filter<T> extends Object implements Predicate<T>
A filter is a predicate that will be used for filtering the elements of an observable list. A filter may only be added to one FilterView.FilterGroup.
See Also:

  • Property Summary

    Properties
    Type
    Property
    Description
    final javafx.beans.property.StringProperty
    id
    An identifier, useful for persisting session state of the filter view.
    final javafx.beans.property.StringProperty
    name
    The name of the filter as shown inside the UI.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Filter(String name)
    Constructs a new filter with the given name.
    Filter(String name, String id)
    Constructs a new filter with the given name.

  • Method Summary

    Modifier and Type
    Method
    Description
    FilterView.FilterGroup<T>
    getGroup()
    Returns the group to which the filter belongs.
    final String
    getId()
    Gets the value of the id property.
    final String
    getName()
    Gets the value of the name property.
    final javafx.beans.property.StringProperty
    idProperty()
    An identifier, useful for persisting session state of the filter view.
    final javafx.beans.property.StringProperty
    nameProperty()
    The name of the filter as shown inside the UI.
    final void
    setId(String id)
    Sets the value of the id property.
    final void
    setName(String name)
    Sets the value of the name property.

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface java.util.function.Predicate

    and, negate, or, test

  • Property Details

    • name

      public final javafx.beans.property.StringProperty nameProperty
      The name of the filter as shown inside the UI.
      See Also:

    • id

      public final javafx.beans.property.StringProperty idProperty
      An identifier, useful for persisting session state of the filter view.
      See Also:

  • Constructor Details

    • Filter

      public Filter(String name, String id)
      Constructs a new filter with the given name.
      Parameters:
      name - the name of the filter (e.g. "Male")
      id - the id of the filter

    • Filter

      public Filter(String name)
      Constructs a new filter with the given name.
      Parameters:
      name - the name of the filter (e.g. "Male")

  • Method Details

    • getGroup

      public FilterView.FilterGroup<T> getGroup()
      Returns the group to which the filter belongs.
      Returns:
      the filter's "parent" group
      See Also:

    • nameProperty

      public final javafx.beans.property.StringProperty nameProperty()
      The name of the filter as shown inside the UI.
      Returns:
      the filter's name
      See Also:

    • getName

      public final String getName()
      Gets the value of the name property.
      Property description:
      The name of the filter as shown inside the UI.
      Returns:
      the value of the name property
      See Also:

    • setName

      public final void setName(String name)
      Sets the value of the name property.
      Property description:
      The name of the filter as shown inside the UI.
      Parameters:
      name - the value for the name property
      See Also:

    • getId

      public final String getId()
      Gets the value of the id property.
      Property description:
      An identifier, useful for persisting session state of the filter view.
      Returns:
      the value of the id property
      See Also:

    • idProperty

      public final javafx.beans.property.StringProperty idProperty()
      An identifier, useful for persisting session state of the filter view.
      Returns:
      the ID of the filter group
      See Also:

    • setId

      public final void setId(String id)
      Sets the value of the id property.
      Property description:
      An identifier, useful for persisting session state of the filter view.
      Parameters:
      id - the value for the id property
      See Also: