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

Class FilterView<T>

java.lang.Object
javafx.scene.Node
javafx.scene.Parent
javafx.scene.layout.Region
javafx.scene.control.Control
com.dlsc.gemsfx.FilterView<T>
Type Parameters:
T - the type of the model objects filtered by the view
All Implemented Interfaces:
javafx.css.Styleable, javafx.event.EventTarget, javafx.scene.control.Skinnable
public class FilterView<T> extends javafx.scene.control.Control
A view for presenting a set of predefined filter groups, each one with a list of filters. The user can select one or more filters from each group. Elements found in the resulting filtered list have to match ALL filters. The selected filters will be shown as "chips" (see @link ChipView).

Items can be added via the getItems() list. Table or list views have to use the getFilteredItems() list. This filtered list can also be wrapped via a SortedList and then added to a table or list view.

An input field for filtering based on text input will appear as soon as a text filter provider has been defined. See setTextFilterProvider(Callback).

Applications with additional filtering needs can utilize the additionalFilterPredicateProperty().

  • Property Summary

    Properties
    Type
    Property
    Description
    final javafx.beans.property.ObjectProperty<Predicate<T>>
    additionalFilterPredicate
     
    final javafx.beans.property.ObjectProperty<javafx.scene.Node>
    extras
    An extra node that can be added to the header of the filter view.
    final javafx.beans.property.ReadOnlyListProperty<T>
    filteredItems
     
    final javafx.beans.property.ListProperty<FilterView.FilterGroup<T>>
    filterGroups
     
    final javafx.beans.property.ReadOnlyObjectProperty<Predicate<T>>
    filterPredicate
     
    javafx.beans.property.ListProperty<FilterView.Filter<T>>
    filters
     
    final javafx.beans.property.StringProperty
    filterText
    Stores the filter text entered by the user inside the filter text field.
    final javafx.beans.property.ListProperty<T>
    items
    The list of items that will be managed by the view.
    javafx.beans.property.IntegerProperty
    scrollThreshold
    The threshold number of filters at which a ScrollPane is introduced to handle large number of elements.
    final javafx.beans.property.BooleanProperty
    showHeader
    A flag to control whether the title, subtitle, and the search field will be shown or not.
    javafx.beans.property.ObjectProperty<javafx.scene.control.Label>
    subtitleLabel
    The label instance that will be used for displaying the subtitle of the view.
    final javafx.beans.property.StringProperty
    subtitle
    The subtitle text for the filter view.
    final javafx.beans.property.ObjectProperty<javafx.util.Callback<String,Predicate<T>>>
    textFilterProvider
    Returns a filter predicate for a given text.
    final javafx.beans.property.ObjectProperty<javafx.scene.control.Label>
    titleLabel
    The label instance that will be used for displaying the title of the view.
    final javafx.beans.property.ObjectProperty<javafx.scene.control.Label>
    titlePostfixLabel
    The label instance that will be used for displaying the title postfix text of the view.
    final javafx.beans.property.StringProperty
    titlePostfix
    A text that can be added to the title text.
    final javafx.beans.property.StringProperty
    title
    The title for the filter view

    Properties inherited from class javafx.scene.control.Control

    contextMenu, skin, tooltip

    Properties inherited from class javafx.scene.layout.Region

    background, border, cacheShape, centerShape, height, insets, maxHeight, maxWidth, minHeight, minWidth, opaqueInsets, padding, prefHeight, prefWidth, scaleShape, shape, snapToPixel, width

    Properties inherited from class javafx.scene.Parent

    needsLayout

    Properties inherited from class javafx.scene.Node

    accessibleHelp, accessibleRoleDescription, accessibleRole, accessibleText, blendMode, boundsInLocal, boundsInParent, cacheHint, cache, clip, cursor, depthTest, disabled, disable, effectiveNodeOrientation, effect, eventDispatcher, focused, focusTraversable, focusVisible, focusWithin, hover, id, inputMethodRequests, layoutBounds, layoutX, layoutY, localToParentTransform, localToSceneTransform, managed, mouseTransparent, nodeOrientation, onContextMenuRequested, onDragDetected, onDragDone, onDragDropped, onDragEntered, onDragExited, onDragOver, onInputMethodTextChanged, onKeyPressed, onKeyReleased, onKeyTyped, onMouseClicked, onMouseDragEntered, onMouseDragExited, onMouseDragged, onMouseDragOver, onMouseDragReleased, onMouseEntered, onMouseExited, onMouseMoved, onMousePressed, onMouseReleased, onRotate, onRotationFinished, onRotationStarted, onScrollFinished, onScroll, onScrollStarted, onSwipeDown, onSwipeLeft, onSwipeRight, onSwipeUp, onTouchMoved, onTouchPressed, onTouchReleased, onTouchStationary, onZoomFinished, onZoom, onZoomStarted, opacity, parent, pickOnBounds, pressed, rotate, rotationAxis, scaleX, scaleY, scaleZ, scene, style, translateX, translateY, translateZ, viewOrder, visible

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    FilterView.Filter<T>
    A filter is a predicate that will be used for filtering the elements of an observable list.
    static class 
    FilterView.FilterGroup<T>
    A filter group consists of a group of filters and has a name.

  • Field Summary

    Fields inherited from class javafx.scene.layout.Region

    USE_COMPUTED_SIZE, USE_PREF_SIZE

    Fields inherited from class javafx.scene.Node

    BASELINE_OFFSET_SAME_AS_HEIGHT

  • Constructor Summary

    Constructors
    Constructor
    Description
    FilterView()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    final javafx.beans.property.ObjectProperty<Predicate<T>>
    additionalFilterPredicateProperty()
     
    protected javafx.scene.control.Skin<?>
    createDefaultSkin()
     
    final javafx.beans.property.ObjectProperty<javafx.scene.Node>
    extrasProperty()
    An extra node that can be added to the header of the filter view.
    final javafx.beans.property.ReadOnlyListProperty<T>
    filteredItemsProperty()
     
    final javafx.beans.property.ListProperty<FilterView.FilterGroup<T>>
    filterGroupsProperty()
     
    final javafx.beans.property.ReadOnlyObjectProperty<Predicate<T>>
    filterPredicateProperty()
     
    javafx.beans.property.ListProperty<FilterView.Filter<T>>
    filtersProperty()
     
    final javafx.beans.property.StringProperty
    filterTextProperty()
    Stores the filter text entered by the user inside the filter text field.
    final Predicate<T>
    getAdditionalFilterPredicate()
    Gets the value of the property additionalFilterPredicate.
    final javafx.scene.Node
    getExtras()
    Gets the value of the property extras.
    final javafx.collections.ObservableList<T>
    getFilteredItems()
    Gets the value of the property filteredItems.
    final javafx.collections.ObservableList<FilterView.FilterGroup<T>>
    getFilterGroups()
    Gets the value of the property filterGroups.
    final Predicate<T>
    getFilterPredicate()
    Gets the value of the property filterPredicate.
    javafx.collections.ObservableList<FilterView.Filter<T>>
    getFilters()
    Gets the value of the property filters.
    final String
    getFilterText()
    Gets the value of the property filterText.
    final javafx.collections.ObservableList<T>
    getItems()
    Gets the value of the property items.
    int
    getScrollThreshold()
    Gets the value of the property scrollThreshold.
    final SearchTextField
    getSearchTextField()
    Returns the search text field used for entering filter terms.
    final String
    getSubtitle()
    Gets the value of the property subtitle.
    javafx.scene.control.Label
    getSubtitleLabel()
    Gets the value of the property subtitleLabel.
    final javafx.util.Callback<String,Predicate<T>>
    getTextFilterProvider()
    Gets the value of the property textFilterProvider.
    final String
    getTitle()
    Gets the value of the property title.
    final javafx.scene.control.Label
    getTitleLabel()
    Gets the value of the property titleLabel.
    final String
    getTitlePostfix()
    Gets the value of the property titlePostfix.
    final javafx.scene.control.Label
    getTitlePostfixLabel()
    Gets the value of the property titlePostfixLabel.
    String
    getUserAgentStylesheet()
     
    final boolean
    isShowHeader()
    Gets the value of the property showHeader.
    final javafx.beans.property.ListProperty<T>
    itemsProperty()
    The list of items that will be managed by the view.
    javafx.beans.property.IntegerProperty
    scrollThresholdProperty()
    The threshold number of filters at which a ScrollPane is introduced to handle large number of elements.
    final void
    setAdditionalFilterPredicate(Predicate<T> additionalFilterPredicate)
    Sets the value of the property additionalFilterPredicate.
    final void
    setExtras(javafx.scene.Node extras)
    Sets the value of the property extras.
    final void
    setFilterGroups(javafx.collections.ObservableList<FilterView.FilterGroup<T>> filterGroups)
    Sets the value of the property filterGroups.
    void
    setFilters(javafx.collections.ObservableList<FilterView.Filter<T>> filters)
    Sets the value of the property filters.
    final void
    setFilterText(String filterText)
    Sets the value of the property filterText.
    final void
    setItems(javafx.collections.ObservableList<T> items)
    Sets the value of the property items.
    void
    setScrollThreshold(int scrollThreshold)
    Sets the value of the property scrollThreshold.
    final void
    setShowHeader(boolean showHeader)
    Sets the value of the property showHeader.
    final void
    setSubtitle(String subtitle)
    Sets the value of the property subtitle.
    void
    setSubtitleLabel(javafx.scene.control.Label subtitleLabel)
    Sets the value of the property subtitleLabel.
    final void
    setTextFilterProvider(javafx.util.Callback<String,Predicate<T>> textFilterProvider)
    Sets the value of the property textFilterProvider.
    final void
    setTitle(String title)
    Sets the value of the property title.
    final void
    setTitleLabel(javafx.scene.control.Label titleLabel)
    Sets the value of the property titleLabel.
    final void
    setTitlePostfix(String titlePostfix)
    Sets the value of the property titlePostfix.
    final void
    setTitlePostfixLabel(javafx.scene.control.Label titlePostfixLabel)
    Sets the value of the property titlePostfixLabel.
    final javafx.beans.property.BooleanProperty
    showHeaderProperty()
    A flag to control whether the title, subtitle, and the search field will be shown or not.
    javafx.beans.property.ObjectProperty<javafx.scene.control.Label>
    subtitleLabelProperty()
    The label instance that will be used for displaying the subtitle of the view.
    final javafx.beans.property.StringProperty
    subtitleProperty()
    The subtitle text for the filter view.
    final javafx.beans.property.ObjectProperty<javafx.util.Callback<String,Predicate<T>>>
    textFilterProviderProperty()
    Returns a filter predicate for a given text.
    final javafx.beans.property.ObjectProperty<javafx.scene.control.Label>
    titleLabelProperty()
    The label instance that will be used for displaying the title of the view.
    final javafx.beans.property.ObjectProperty<javafx.scene.control.Label>
    titlePostfixLabelProperty()
    The label instance that will be used for displaying the title postfix text of the view.
    final javafx.beans.property.StringProperty
    titlePostfixProperty()
    A text that can be added to the title text.
    final javafx.beans.property.StringProperty
    titleProperty()
    The title for the filter view

    Methods inherited from class javafx.scene.control.Control

    computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, contextMenuProperty, executeAccessibleAction, getBaselineOffset, getClassCssMetaData, getContextMenu, getControlCssMetaData, getCssMetaData, getInitialFocusTraversable, getSkin, getTooltip, isResizable, layoutChildren, queryAccessibleAttribute, setContextMenu, setSkin, setTooltip, skinProperty, tooltipProperty

    Methods inherited from class javafx.scene.layout.Region

    backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, getBackground, getBorder, getHeight, getInsets, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOpaqueInsets, getPadding, getPrefHeight, getPrefWidth, getShape, getWidth, heightProperty, insetsProperty, isCacheShape, isCenterShape, isScaleShape, isSnapToPixel, layoutInArea, layoutInArea, layoutInArea, layoutInArea, maxHeight, maxHeightProperty, maxWidth, maxWidthProperty, minHeight, minHeightProperty, minWidth, minWidthProperty, opaqueInsetsProperty, paddingProperty, positionInArea, positionInArea, prefHeight, prefHeightProperty, prefWidth, prefWidthProperty, resize, scaleShapeProperty, setBackground, setBorder, setCacheShape, setCenterShape, setHeight, setMaxHeight, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinWidth, setOpaqueInsets, setPadding, setPrefHeight, setPrefSize, setPrefWidth, setScaleShape, setShape, setSnapToPixel, setWidth, shapeProperty, snappedBottomInset, snappedLeftInset, snappedRightInset, snappedTopInset, snapPosition, snapPositionX, snapPositionY, snapSize, snapSizeX, snapSizeY, snapSpace, snapSpaceX, snapSpaceY, snapToPixelProperty, widthProperty

    Methods inherited from class javafx.scene.Parent

    getChildren, getChildrenUnmodifiable, getManagedChildren, getStylesheets, isNeedsLayout, layout, lookup, needsLayoutProperty, requestLayout, requestParentLayout, setNeedsLayout, updateBounds

    Methods inherited from class javafx.scene.Node

    accessibleHelpProperty, accessibleRoleDescriptionProperty, accessibleRoleProperty, accessibleTextProperty, addEventFilter, addEventHandler, applyCss, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, computeAreaInScreen, contains, contains, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, fireEvent, focusedProperty, focusTraversableProperty, focusVisibleProperty, focusWithinProperty, getAccessibleHelp, getAccessibleRole, getAccessibleRoleDescription, getAccessibleText, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getContentBias, getCursor, getDepthTest, getEffect, getEffectiveNodeOrientation, getEventDispatcher, getId, getInitialCursor, getInputMethodRequests, getLayoutBounds, getLayoutX, getLayoutY, getLocalToParentTransform, getLocalToSceneTransform, getNodeOrientation, getOnContextMenuRequested, getOnDragDetected, getOnDragDone, getOnDragDropped, getOnDragEntered, getOnDragExited, getOnDragOver, getOnInputMethodTextChanged, getOnKeyPressed, getOnKeyReleased, getOnKeyTyped, getOnMouseClicked, getOnMouseDragEntered, getOnMouseDragExited, getOnMouseDragged, getOnMouseDragOver, getOnMouseDragReleased, getOnMouseEntered, getOnMouseExited, getOnMouseMoved, getOnMousePressed, getOnMouseReleased, getOnRotate, getOnRotationFinished, getOnRotationStarted, getOnScroll, getOnScrollFinished, getOnScrollStarted, getOnSwipeDown, getOnSwipeLeft, getOnSwipeRight, getOnSwipeUp, getOnTouchMoved, getOnTouchPressed, getOnTouchReleased, getOnTouchStationary, getOnZoom, getOnZoomFinished, getOnZoomStarted, getOpacity, getParent, getProperties, getPseudoClassStates, getRotate, getRotationAxis, getScaleX, getScaleY, getScaleZ, getScene, getStyle, getStyleableParent, getStyleClass, getTransforms, getTranslateX, getTranslateY, getTranslateZ, getTypeSelector, getUserData, getViewOrder, hasProperties, hoverProperty, idProperty, inputMethodRequestsProperty, intersects, intersects, isCache, isDisable, isDisabled, isFocused, isFocusTraversable, isFocusVisible, isFocusWithin, isHover, isManaged, isMouseTransparent, isPickOnBounds, isPressed, isVisible, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParent, localToParent, localToParent, localToParent, localToParent, localToParentTransformProperty, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToSceneTransformProperty, localToScreen, localToScreen, localToScreen, localToScreen, localToScreen, lookupAll, managedProperty, mouseTransparentProperty, nodeOrientationProperty, notifyAccessibleAttributeChanged, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragEnteredProperty, onMouseDragExitedProperty, onMouseDraggedProperty, onMouseDragOverProperty, onMouseDragReleasedProperty, onMouseEnteredProperty, onMouseExitedProperty, onMouseMovedProperty, onMousePressedProperty, onMouseReleasedProperty, onRotateProperty, onRotationFinishedProperty, onRotationStartedProperty, onScrollFinishedProperty, onScrollProperty, onScrollStartedProperty, onSwipeDownProperty, onSwipeLeftProperty, onSwipeRightProperty, onSwipeUpProperty, onTouchMovedProperty, onTouchPressedProperty, onTouchReleasedProperty, onTouchStationaryProperty, onZoomFinishedProperty, onZoomProperty, onZoomStartedProperty, opacityProperty, parentProperty, parentToLocal, parentToLocal, parentToLocal, parentToLocal, parentToLocal, pickOnBoundsProperty, pressedProperty, pseudoClassStateChanged, relocate, removeEventFilter, removeEventHandler, requestFocus, resizeRelocate, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, screenToLocal, screenToLocal, screenToLocal, setAccessibleHelp, setAccessibleRole, setAccessibleRoleDescription, setAccessibleText, setBlendMode, setCache, setCacheHint, setClip, setCursor, setDepthTest, setDisable, setDisabled, setEffect, setEventDispatcher, setEventHandler, setFocused, setFocusTraversable, setHover, setId, setInputMethodRequests, setLayoutX, setLayoutY, setManaged, setMouseTransparent, setNodeOrientation, setOnContextMenuRequested, setOnDragDetected, setOnDragDone, setOnDragDropped, setOnDragEntered, setOnDragExited, setOnDragOver, setOnInputMethodTextChanged, setOnKeyPressed, setOnKeyReleased, setOnKeyTyped, setOnMouseClicked, setOnMouseDragEntered, setOnMouseDragExited, setOnMouseDragged, setOnMouseDragOver, setOnMouseDragReleased, setOnMouseEntered, setOnMouseExited, setOnMouseMoved, setOnMousePressed, setOnMouseReleased, setOnRotate, setOnRotationFinished, setOnRotationStarted, setOnScroll, setOnScrollFinished, setOnScrollStarted, setOnSwipeDown, setOnSwipeLeft, setOnSwipeRight, setOnSwipeUp, setOnTouchMoved, setOnTouchPressed, setOnTouchReleased, setOnTouchStationary, setOnZoom, setOnZoomFinished, setOnZoomStarted, setOpacity, setPickOnBounds, setPressed, setRotate, setRotationAxis, setScaleX, setScaleY, setScaleZ, setStyle, setTranslateX, setTranslateY, setTranslateZ, setUserData, setViewOrder, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, toString, translateXProperty, translateYProperty, translateZProperty, usesMirroring, viewOrderProperty, visibleProperty

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface javafx.css.Styleable

    getStyleableNode

  • Property Details

    • scrollThreshold

      public javafx.beans.property.IntegerProperty scrollThresholdProperty
      The threshold number of filters at which a ScrollPane is introduced to handle large number of elements. If the number of filters is equal to or exceeds this value, the filters will be displayed within a ScrollPane.
      See Also:

    • titleLabel

      public final javafx.beans.property.ObjectProperty<javafx.scene.control.Label> titleLabelProperty
      The label instance that will be used for displaying the title of the view.
      See Also:

    • titlePostfixLabel

      public final javafx.beans.property.ObjectProperty<javafx.scene.control.Label> titlePostfixLabelProperty
      The label instance that will be used for displaying the title postfix text of the view.
      See Also:

    • subtitleLabel

      public javafx.beans.property.ObjectProperty<javafx.scene.control.Label> subtitleLabelProperty
      The label instance that will be used for displaying the subtitle of the view.
      See Also:

    • showHeader

      public final javafx.beans.property.BooleanProperty showHeaderProperty
      A flag to control whether the title, subtitle, and the search field will be shown or not.
      See Also:

    • extras

      public final javafx.beans.property.ObjectProperty<javafx.scene.Node> extrasProperty
      An extra node that can be added to the header of the filter view. The node will appear to the right of the (optional) text filter field.
      See Also:

    • title

      public final javafx.beans.property.StringProperty titleProperty
      The title for the filter view
      See Also:

    • titlePostfix

      public final javafx.beans.property.StringProperty titlePostfixProperty
      A text that can be added to the title text.
      See Also:

    • subtitle

      public final javafx.beans.property.StringProperty subtitleProperty
      The subtitle text for the filter view.
      See Also:

    • items

      public final javafx.beans.property.ListProperty<T> itemsProperty
      The list of items that will be managed by the view.
      See Also:

    • filteredItems

      public final javafx.beans.property.ReadOnlyListProperty<T> filteredItemsProperty
      See Also:

    • filterText

      public final javafx.beans.property.StringProperty filterTextProperty
      Stores the filter text entered by the user inside the filter text field.
      See Also:

    • textFilterProvider

      public final javafx.beans.property.ObjectProperty<javafx.util.Callback<String,Predicate<T>>> textFilterProviderProperty
      Returns a filter predicate for a given text. This predicate will be added to the list of internally managed predicates. The input field for text will only appear if this predicate has been specified.
      See Also:

    • filterGroups

      public final javafx.beans.property.ListProperty<FilterView.FilterGroup<T>> filterGroupsProperty
      See Also:

    • filters

      public javafx.beans.property.ListProperty<FilterView.Filter<T>> filtersProperty
      See Also:

    • additionalFilterPredicate

      public final javafx.beans.property.ObjectProperty<Predicate<T>> additionalFilterPredicateProperty
      See Also:

    • filterPredicate

      public final javafx.beans.property.ReadOnlyObjectProperty<Predicate<T>> filterPredicateProperty
      See Also:

  • Constructor Details

    • FilterView

      public FilterView()

  • Method Details

    • getUserAgentStylesheet

      public String getUserAgentStylesheet()
      Overrides:
      getUserAgentStylesheet in class javafx.scene.layout.Region

    • createDefaultSkin

      protected javafx.scene.control.Skin<?> createDefaultSkin()
      Overrides:
      createDefaultSkin in class javafx.scene.control.Control

    • getSearchTextField

      public final SearchTextField getSearchTextField()
      Returns the search text field used for entering filter terms.
      Returns:
      the search text field

    • getScrollThreshold

      public int getScrollThreshold()
      Gets the value of the property scrollThreshold.
      Property description:
      The threshold number of filters at which a ScrollPane is introduced to handle large number of elements. If the number of filters is equal to or exceeds this value, the filters will be displayed within a ScrollPane.

    • scrollThresholdProperty

      public javafx.beans.property.IntegerProperty scrollThresholdProperty()
      The threshold number of filters at which a ScrollPane is introduced to handle large number of elements. If the number of filters is equal to or exceeds this value, the filters will be displayed within a ScrollPane.
      See Also:

    • setScrollThreshold

      public void setScrollThreshold(int scrollThreshold)
      Sets the value of the property scrollThreshold.
      Property description:
      The threshold number of filters at which a ScrollPane is introduced to handle large number of elements. If the number of filters is equal to or exceeds this value, the filters will be displayed within a ScrollPane.

    • getTitleLabel

      public final javafx.scene.control.Label getTitleLabel()
      Gets the value of the property titleLabel.
      Property description:
      The label instance that will be used for displaying the title of the view.

    • titleLabelProperty

      public final javafx.beans.property.ObjectProperty<javafx.scene.control.Label> titleLabelProperty()
      The label instance that will be used for displaying the title of the view.
      See Also:

    • setTitleLabel

      public final void setTitleLabel(javafx.scene.control.Label titleLabel)
      Sets the value of the property titleLabel.
      Property description:
      The label instance that will be used for displaying the title of the view.

    • getTitlePostfixLabel

      public final javafx.scene.control.Label getTitlePostfixLabel()
      Gets the value of the property titlePostfixLabel.
      Property description:
      The label instance that will be used for displaying the title postfix text of the view.

    • titlePostfixLabelProperty

      public final javafx.beans.property.ObjectProperty<javafx.scene.control.Label> titlePostfixLabelProperty()
      The label instance that will be used for displaying the title postfix text of the view.
      See Also:

    • setTitlePostfixLabel

      public final void setTitlePostfixLabel(javafx.scene.control.Label titlePostfixLabel)
      Sets the value of the property titlePostfixLabel.
      Property description:
      The label instance that will be used for displaying the title postfix text of the view.

    • getSubtitleLabel

      public javafx.scene.control.Label getSubtitleLabel()
      Gets the value of the property subtitleLabel.
      Property description:
      The label instance that will be used for displaying the subtitle of the view.

    • subtitleLabelProperty

      public javafx.beans.property.ObjectProperty<javafx.scene.control.Label> subtitleLabelProperty()
      The label instance that will be used for displaying the subtitle of the view.
      See Also:

    • setSubtitleLabel

      public void setSubtitleLabel(javafx.scene.control.Label subtitleLabel)
      Sets the value of the property subtitleLabel.
      Property description:
      The label instance that will be used for displaying the subtitle of the view.

    • isShowHeader

      public final boolean isShowHeader()
      Gets the value of the property showHeader.
      Property description:
      A flag to control whether the title, subtitle, and the search field will be shown or not.

    • showHeaderProperty

      public final javafx.beans.property.BooleanProperty showHeaderProperty()
      A flag to control whether the title, subtitle, and the search field will be shown or not.
      See Also:

    • setShowHeader

      public final void setShowHeader(boolean showHeader)
      Sets the value of the property showHeader.
      Property description:
      A flag to control whether the title, subtitle, and the search field will be shown or not.

    • getExtras

      public final javafx.scene.Node getExtras()
      Gets the value of the property extras.
      Property description:
      An extra node that can be added to the header of the filter view. The node will appear to the right of the (optional) text filter field.

    • extrasProperty

      public final javafx.beans.property.ObjectProperty<javafx.scene.Node> extrasProperty()
      An extra node that can be added to the header of the filter view. The node will appear to the right of the (optional) text filter field.
      See Also:

    • setExtras

      public final void setExtras(javafx.scene.Node extras)
      Sets the value of the property extras.
      Property description:
      An extra node that can be added to the header of the filter view. The node will appear to the right of the (optional) text filter field.

    • getTitle

      public final String getTitle()
      Gets the value of the property title.
      Property description:
      The title for the filter view

    • titleProperty

      public final javafx.beans.property.StringProperty titleProperty()
      The title for the filter view
      See Also:

    • setTitle

      public final void setTitle(String title)
      Sets the value of the property title.
      Property description:
      The title for the filter view

    • getTitlePostfix

      public final String getTitlePostfix()
      Gets the value of the property titlePostfix.
      Property description:
      A text that can be added to the title text.

    • titlePostfixProperty

      public final javafx.beans.property.StringProperty titlePostfixProperty()
      A text that can be added to the title text.
      See Also:

    • setTitlePostfix

      public final void setTitlePostfix(String titlePostfix)
      Sets the value of the property titlePostfix.
      Property description:
      A text that can be added to the title text.

    • getSubtitle

      public final String getSubtitle()
      Gets the value of the property subtitle.
      Property description:
      The subtitle text for the filter view.

    • subtitleProperty

      public final javafx.beans.property.StringProperty subtitleProperty()
      The subtitle text for the filter view.
      See Also:

    • setSubtitle

      public final void setSubtitle(String subtitle)
      Sets the value of the property subtitle.
      Property description:
      The subtitle text for the filter view.

    • getItems

      public final javafx.collections.ObservableList<T> getItems()
      Gets the value of the property items.
      Property description:
      The list of items that will be managed by the view.

    • itemsProperty

      public final javafx.beans.property.ListProperty<T> itemsProperty()
      The list of items that will be managed by the view.
      See Also:

    • setItems

      public final void setItems(javafx.collections.ObservableList<T> items)
      Sets the value of the property items.
      Property description:
      The list of items that will be managed by the view.

    • filteredItemsProperty

      public final javafx.beans.property.ReadOnlyListProperty<T> filteredItemsProperty()
      See Also:

    • getFilteredItems

      public final javafx.collections.ObservableList<T> getFilteredItems()
      Gets the value of the property filteredItems.
      Property description:

    • getFilterText

      public final String getFilterText()
      Gets the value of the property filterText.
      Property description:
      Stores the filter text entered by the user inside the filter text field.

    • filterTextProperty

      public final javafx.beans.property.StringProperty filterTextProperty()
      Stores the filter text entered by the user inside the filter text field.
      See Also:

    • setFilterText

      public final void setFilterText(String filterText)
      Sets the value of the property filterText.
      Property description:
      Stores the filter text entered by the user inside the filter text field.

    • getTextFilterProvider

      public final javafx.util.Callback<String,Predicate<T>> getTextFilterProvider()
      Gets the value of the property textFilterProvider.
      Property description:
      Returns a filter predicate for a given text. This predicate will be added to the list of internally managed predicates. The input field for text will only appear if this predicate has been specified.

    • textFilterProviderProperty

      public final javafx.beans.property.ObjectProperty<javafx.util.Callback<String,Predicate<T>>> textFilterProviderProperty()
      Returns a filter predicate for a given text. This predicate will be added to the list of internally managed predicates. The input field for text will only appear if this predicate has been specified.
      See Also:

    • setTextFilterProvider

      public final void setTextFilterProvider(javafx.util.Callback<String,Predicate<T>> textFilterProvider)
      Sets the value of the property textFilterProvider.
      Property description:
      Returns a filter predicate for a given text. This predicate will be added to the list of internally managed predicates. The input field for text will only appear if this predicate has been specified.

    • getFilterGroups

      public final javafx.collections.ObservableList<FilterView.FilterGroup<T>> getFilterGroups()
      Gets the value of the property filterGroups.
      Property description:

    • filterGroupsProperty

      public final javafx.beans.property.ListProperty<FilterView.FilterGroup<T>> filterGroupsProperty()
      See Also:

    • setFilterGroups

      public final void setFilterGroups(javafx.collections.ObservableList<FilterView.FilterGroup<T>> filterGroups)
      Sets the value of the property filterGroups.
      Property description:

    • getFilters

      public javafx.collections.ObservableList<FilterView.Filter<T>> getFilters()
      Gets the value of the property filters.
      Property description:

    • filtersProperty

      public javafx.beans.property.ListProperty<FilterView.Filter<T>> filtersProperty()
      See Also:

    • setFilters

      public void setFilters(javafx.collections.ObservableList<FilterView.Filter<T>> filters)
      Sets the value of the property filters.
      Property description:

    • getAdditionalFilterPredicate

      public final Predicate<T> getAdditionalFilterPredicate()
      Gets the value of the property additionalFilterPredicate.
      Property description:

    • additionalFilterPredicateProperty

      public final javafx.beans.property.ObjectProperty<Predicate<T>> additionalFilterPredicateProperty()
      See Also:

    • setAdditionalFilterPredicate

      public final void setAdditionalFilterPredicate(Predicate<T> additionalFilterPredicate)
      Sets the value of the property additionalFilterPredicate.
      Property description:

    • getFilterPredicate

      public final Predicate<T> getFilterPredicate()
      Gets the value of the property filterPredicate.
      Property description:

    • filterPredicateProperty

      public final javafx.beans.property.ReadOnlyObjectProperty<Predicate<T>> filterPredicateProperty()
      See Also: