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().

  • 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.

  • 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.Node>
    subtitleGraphic
    The graphic node displayed alongside the subtitle label.
    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.Node>
    titleGraphic
    The graphic node displayed alongside the title label.
    final javafx.beans.property.ObjectProperty<javafx.scene.Node>
    titlePostfixGraphic
    The graphic node displayed alongside the title postfix label.
    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

  • 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 additionalFilterPredicate property.
    static List<javafx.css.CssMetaData<? extends javafx.css.Styleable, ?>>
    getClassCssMetaData()
     
    List<javafx.css.CssMetaData<? extends javafx.css.Styleable, ?>>
    getControlCssMetaData()
     
    final javafx.scene.Node
    getExtras()
    Gets the value of the extras property.
    final javafx.collections.ObservableList<T>
    getFilteredItems()
    Gets the value of the filteredItems property.
    final javafx.collections.ObservableList<FilterView.FilterGroup<T>>
    getFilterGroups()
    Gets the value of the filterGroups property.
    final Predicate<T>
    getFilterPredicate()
    Gets the value of the filterPredicate property.
    javafx.collections.ObservableList<FilterView.Filter<T>>
    getFilters()
    Gets the value of the filters property.
    final String
    getFilterText()
    Gets the value of the filterText property.
    final javafx.collections.ObservableList<T>
    getItems()
    Gets the value of the items property.
    int
    getScrollThreshold()
    Gets the value of the scrollThreshold property.
    final SearchTextField
    getSearchTextField()
    Returns the search text field used for entering filter terms.
    final String
    getSubtitle()
    Gets the value of the subtitle property.
    javafx.scene.Node
    getSubtitleGraphic()
    Gets the value of the subtitleGraphic property.
    final javafx.util.Callback<String, Predicate<T>>
    getTextFilterProvider()
    Gets the value of the textFilterProvider property.
    final String
    getTitle()
    Gets the value of the title property.
    final javafx.scene.Node
    getTitleGraphic()
    Gets the value of the titleGraphic property.
    final String
    getTitlePostfix()
    Gets the value of the titlePostfix property.
    final javafx.scene.Node
    getTitlePostfixGraphic()
    Gets the value of the titlePostfixGraphic property.
    String
    getUserAgentStylesheet()
     
    final boolean
    isShowHeader()
    Gets the value of the showHeader property.
    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 additionalFilterPredicate property.
    final void
    setExtras(javafx.scene.Node extras)
    Sets the value of the extras property.
    final void
    setFilterGroups(javafx.collections.ObservableList<FilterView.FilterGroup<T>> filterGroups)
    Sets the value of the filterGroups property.
    void
    setFilters(javafx.collections.ObservableList<FilterView.Filter<T>> filters)
    Sets the value of the filters property.
    final void
    setFilterText(String filterText)
    Sets the value of the filterText property.
    final void
    setItems(javafx.collections.ObservableList<T> items)
    Sets the value of the items property.
    void
    setScrollThreshold(int scrollThreshold)
    Sets the value of the scrollThreshold property.
    final void
    setShowHeader(boolean showHeader)
    Sets the value of the showHeader property.
    final void
    setSubtitle(String subtitle)
    Sets the value of the subtitle property.
    void
    setSubtitleGraphic(javafx.scene.Node subtitleGraphic)
    Sets the value of the subtitleGraphic property.
    final void
    setTextFilterProvider(javafx.util.Callback<String, Predicate<T>> textFilterProvider)
    Sets the value of the textFilterProvider property.
    final void
    setTitle(String title)
    Sets the value of the title property.
    final void
    setTitleGraphic(javafx.scene.Node titleGraphic)
    Sets the value of the titleGraphic property.
    final void
    setTitlePostfix(String titlePostfix)
    Sets the value of the titlePostfix property.
    final void
    setTitlePostfixGraphic(javafx.scene.Node titlePostfixGraphic)
    Sets the value of the titlePostfixGraphic property.
    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.Node>
    subtitleGraphicProperty()
    The graphic node displayed alongside the subtitle label.
    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.Node>
    titleGraphicProperty()
    The graphic node displayed alongside the title label.
    final javafx.beans.property.ObjectProperty<javafx.scene.Node>
    titlePostfixGraphicProperty()
    The graphic node displayed alongside the title postfix label.
    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, getContextMenu, 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, requestFocusTraversal, 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 Object

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

    Methods inherited from interface javafx.css.Styleable

    getStyleableNode

  • Property Details

  • 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 scrollThreshold property.
      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.
      Returns:
      the value of the scrollThreshold property
      See Also:

    • 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.
      Returns:
      the scrollThreshold property
      See Also:

    • setScrollThreshold

      public void setScrollThreshold(int scrollThreshold)
      Sets the value of the scrollThreshold property.
      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.
      Parameters:
      scrollThreshold - the value for the scrollThreshold property
      See Also:

    • getTitleGraphic

      public final javafx.scene.Node getTitleGraphic()
      Gets the value of the titleGraphic property.
      Property description:
      The graphic node displayed alongside the title label.
      Returns:
      the value of the titleGraphic property
      See Also:

    • titleGraphicProperty

      public final javafx.beans.property.ObjectProperty<javafx.scene.Node> titleGraphicProperty()
      The graphic node displayed alongside the title label.
      Returns:
      the titleGraphic property
      See Also:

    • setTitleGraphic

      public final void setTitleGraphic(javafx.scene.Node titleGraphic)
      Sets the value of the titleGraphic property.
      Property description:
      The graphic node displayed alongside the title label.
      Parameters:
      titleGraphic - the value for the titleGraphic property
      See Also:

    • getTitlePostfixGraphic

      public final javafx.scene.Node getTitlePostfixGraphic()
      Gets the value of the titlePostfixGraphic property.
      Property description:
      The graphic node displayed alongside the title postfix label.
      Returns:
      the value of the titlePostfixGraphic property
      See Also:

    • titlePostfixGraphicProperty

      public final javafx.beans.property.ObjectProperty<javafx.scene.Node> titlePostfixGraphicProperty()
      The graphic node displayed alongside the title postfix label.
      Returns:
      the titlePostfixGraphic property
      See Also:

    • setTitlePostfixGraphic

      public final void setTitlePostfixGraphic(javafx.scene.Node titlePostfixGraphic)
      Sets the value of the titlePostfixGraphic property.
      Property description:
      The graphic node displayed alongside the title postfix label.
      Parameters:
      titlePostfixGraphic - the value for the titlePostfixGraphic property
      See Also:

    • getSubtitleGraphic

      public javafx.scene.Node getSubtitleGraphic()
      Gets the value of the subtitleGraphic property.
      Property description:
      The graphic node displayed alongside the subtitle label.
      Returns:
      the value of the subtitleGraphic property
      See Also:

    • subtitleGraphicProperty

      public javafx.beans.property.ObjectProperty<javafx.scene.Node> subtitleGraphicProperty()
      The graphic node displayed alongside the subtitle label.
      Returns:
      the subtitleGraphic property
      See Also:

    • setSubtitleGraphic

      public void setSubtitleGraphic(javafx.scene.Node subtitleGraphic)
      Sets the value of the subtitleGraphic property.
      Property description:
      The graphic node displayed alongside the subtitle label.
      Parameters:
      subtitleGraphic - the value for the subtitleGraphic property
      See Also:

    • isShowHeader

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

      Can be set via CSS using the -fx-show-header property. Valid values are: true, false. The default value is true.

      Returns:
      the value of the showHeader property
      See Also:

    • 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.

      Can be set via CSS using the -fx-show-header property. Valid values are: true, false. The default value is true.

      Returns:
      true if the header will be shown (default is "true")
      See Also:

    • setShowHeader

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

      Can be set via CSS using the -fx-show-header property. Valid values are: true, false. The default value is true.

      Parameters:
      showHeader - the value for the showHeader property
      See Also:

    • getExtras

      public final javafx.scene.Node getExtras()
      Gets the value of the extras property.
      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.
      Returns:
      the value of the extras property
      See Also:

    • 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.
      Returns:
      the extra node
      See Also:

    • setExtras

      public final void setExtras(javafx.scene.Node extras)
      Sets the value of the extras property.
      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.
      Parameters:
      extras - the value for the extras property
      See Also:

    • getTitle

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

    • titleProperty

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

    • setTitle

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

    • getTitlePostfix

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

    • titlePostfixProperty

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

    • setTitlePostfix

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

    • getSubtitle

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

    • subtitleProperty

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

    • setSubtitle

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

    • getItems

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

    • itemsProperty

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

    • setItems

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

    • filteredItemsProperty

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

    • getFilteredItems

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

    • getFilterText

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

    • filterTextProperty

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

    • setFilterText

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

    • getTextFilterProvider

      public final javafx.util.Callback<String, Predicate<T>> getTextFilterProvider()
      Gets the value of the textFilterProvider property.
      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.
      Returns:
      the value of the textFilterProvider property
      See Also:

    • 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.
      Returns:
      the text filter predicate provider
      See Also:

    • setTextFilterProvider

      public final void setTextFilterProvider(javafx.util.Callback<String, Predicate<T>> textFilterProvider)
      Sets the value of the textFilterProvider property.
      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.
      Parameters:
      textFilterProvider - the value for the textFilterProvider property
      See Also:

    • getFilterGroups

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

    • filterGroupsProperty

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

    • setFilterGroups

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

    • getFilters

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

    • filtersProperty

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

    • setFilters

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

    • getAdditionalFilterPredicate

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

    • additionalFilterPredicateProperty

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

    • setAdditionalFilterPredicate

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

    • getFilterPredicate

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

    • filterPredicateProperty

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

    • getClassCssMetaData

      public static List<javafx.css.CssMetaData<? extends javafx.css.Styleable, ?>> getClassCssMetaData()

    • getControlCssMetaData

      public List<javafx.css.CssMetaData<? extends javafx.css.Styleable, ?>> getControlCssMetaData()
      Overrides:
      getControlCssMetaData in class javafx.scene.control.Control