Class FilterView.FilterGroup<T>

java.lang.Object
com.dlsc.gemsfx.FilterView.FilterGroup<T>
Type Parameters:
T - the type of the model objects managed by the filter view
Enclosing class:
FilterView<T>
public static class FilterView.FilterGroup<T> extends Object
A filter group consists of a group of filters and has a name. The name is displayed in the UI as part of the dropdown list that expostes the available filters.

  • Property Summary

    Properties
    Type
    Property
    Description
    final javafx.beans.property.ListProperty<FilterView.Filter<T>>
    filters
    The filters that belong to this group.
    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 in the filter group's dropdown list.

  • Constructor Summary

    Constructors
    Constructor
    Description
    FilterGroup(String name)
    Constructs a new group with an identifier derived from its name.
    FilterGroup(String name, String id)
    Constructs a new group.

  • Method Summary

    Modifier and Type
    Method
    Description
    final javafx.beans.property.ListProperty<FilterView.Filter<T>>
    filtersProperty()
    The filters that belong to this group.
    final javafx.collections.ObservableList<FilterView.Filter<T>>
    getFilters()
    Gets the value of the filters property.
    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 in the filter group's dropdown list.
    final void
    setFilters(javafx.collections.ObservableList<FilterView.Filter<T>> filters)
    Sets the value of the filters property.
    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 Object

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

  • Property Details

  • Constructor Details

    • FilterGroup

      public FilterGroup(String name, String id)
      Constructs a new group.
      Parameters:
      name - the name that will be shown in the UI, e.g. "Gender"
      id - the id of the group

    • FilterGroup

      public FilterGroup(String name)
      Constructs a new group with an identifier derived from its name.
      Parameters:
      name - the name that will be shown in the UI

  • Method Details

    • getFilters

      public final javafx.collections.ObservableList<FilterView.Filter<T>> getFilters()
      Gets the value of the filters property.
      Property description:
      The filters that belong to this group.
      Returns:
      the value of the filters property
      See Also:

    • filtersProperty

      public final javafx.beans.property.ListProperty<FilterView.Filter<T>> filtersProperty()
      The filters that belong to this group.
      Returns:
      the filters property
      See Also:

    • setFilters

      public final void setFilters(javafx.collections.ObservableList<FilterView.Filter<T>> filters)
      Sets the value of the filters property.
      Property description:
      The filters that belong to this group.
      Parameters:
      filters - the value for the filters property
      See Also:

    • nameProperty

      public final javafx.beans.property.StringProperty nameProperty()
      The name of the filter as shown in the filter group's dropdown list.
      Returns:
      the filter name
      See Also:

    • getName

      public final String getName()
      Gets the value of the name property.
      Property description:
      The name of the filter as shown in the filter group's dropdown list.
      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 in the filter group's dropdown list.
      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: