Class PopupFilter<S,T>

java.lang.Object
javafx.stage.Window
javafx.stage.PopupWindow
javafx.scene.control.PopupControl
org.controlsfx.control.tableview2.filter.popupfilter.PopupFilter<S,T>
Type Parameters:
S - Type of the objects contained within the FilteredTableView items list.
T - Type of the content to be filtered, which is similar to the type of cells contained in the FilteredTableColumn.
All Implemented Interfaces:
javafx.css.Styleable, javafx.event.EventTarget, javafx.scene.control.Skinnable
Direct Known Subclasses:
PopupNumberFilter, PopupStringFilter
public abstract class PopupFilter<S,T> extends javafx.scene.control.PopupControl
A popup control containing a TextField to filter data in a FilteredTableView. The control accepts a FilteredTableColumn on which the filter is to be applied. showPopup() should be called to show the popup.

  • Nested Class Summary

    Nested classes/interfaces inherited from class javafx.scene.control.PopupControl

    javafx.scene.control.PopupControl.CSSBridge

    Nested classes/interfaces inherited from class javafx.stage.PopupWindow

    javafx.stage.PopupWindow.AnchorLocation

  • Property Summary

    Properties
    Type
    Property
    Description
    final javafx.beans.property.StringProperty
    text
    The textual content of this PopupFilter.

    Properties inherited from class javafx.scene.control.PopupControl

    id, maxHeight, maxWidth, minHeight, minWidth, prefHeight, prefWidth, skin, style

    Properties inherited from class javafx.stage.PopupWindow

    anchorLocation, anchorX, anchorY, autoFix, autoHide, consumeAutoHidingEvents, hideOnEscape, onAutoHide, ownerNode, ownerWindow

    Properties inherited from class javafx.stage.Window

    eventDispatcher, focused, forceIntegerRenderScale, height, onCloseRequest, onHidden, onHiding, onShowing, onShown, opacity, outputScaleX, outputScaleY, renderScaleX, renderScaleY, scene, showing, width, x, y

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected final javafx.beans.property.StringProperty
    text
    The textual content of this PopupFilter.

    Fields inherited from class javafx.scene.control.PopupControl

    bridge, USE_COMPUTED_SIZE, USE_PREF_SIZE

  • Constructor Summary

    Constructors
    Constructor
    Description
    PopupFilter(FilteredTableColumn<S,T> tableColumn)
    Creates a new instance of PopupFilter.

  • Method Summary

    Modifier and Type
    Method
    Description
    protected javafx.scene.control.Skin<?>
    createDefaultSkin()
    abstract List<String>
    getOperations()
    Returns a list of operations which can be performed on this PopupFilter.
    abstract Parser<T>
    getParser()
    Returns a TextParser which is used to parse the text in the TextField and filter the data.
    FilteredTableColumn<S,T>
    getTableColumn()
    Returns the TableColumn associated with this PopupFilter.
    final String
    getText()
    Gets the value of the text property.
    final void
    setText(String value)
    Sets the value of the text property.
    void
    showPopup()
    Shows the pop up just below the column header.
    final javafx.beans.property.StringProperty
    textProperty()
    The textual content of this PopupFilter.

    Methods inherited from class javafx.scene.control.PopupControl

    getClassCssMetaData, getCssMetaData, getId, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getPrefHeight, getPrefWidth, getPseudoClassStates, getSkin, getStyle, getStyleableNode, getStyleableParent, getStyleClass, getTypeSelector, idProperty, maxHeight, maxHeightProperty, maxWidth, maxWidthProperty, minHeight, minHeightProperty, minWidth, minWidthProperty, prefHeight, prefHeightProperty, prefWidth, prefWidthProperty, pseudoClassStateChanged, setId, setMaxHeight, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinWidth, setPrefHeight, setPrefSize, setPrefWidth, setSkin, setStyle, skinProperty, styleProperty

    Methods inherited from class javafx.stage.PopupWindow

    anchorLocationProperty, anchorXProperty, anchorYProperty, autoFixProperty, autoHideProperty, consumeAutoHidingEventsProperty, getAnchorLocation, getAnchorX, getAnchorY, getConsumeAutoHidingEvents, getOnAutoHide, getOwnerNode, getOwnerWindow, hide, hideOnEscapeProperty, isAutoFix, isAutoHide, isHideOnEscape, onAutoHideProperty, ownerNodeProperty, ownerWindowProperty, setAnchorLocation, setAnchorX, setAnchorY, setAutoFix, setAutoHide, setConsumeAutoHidingEvents, setHideOnEscape, setOnAutoHide, setScene, show, show, show

    Methods inherited from class javafx.stage.Window

    addEventFilter, addEventHandler, buildEventDispatchChain, centerOnScreen, eventDispatcherProperty, fireEvent, focusedProperty, forceIntegerRenderScaleProperty, getEventDispatcher, getHeight, getOnCloseRequest, getOnHidden, getOnHiding, getOnShowing, getOnShown, getOpacity, getOutputScaleX, getOutputScaleY, getProperties, getRenderScaleX, getRenderScaleY, getScene, getUserData, getWidth, getWindows, getX, getY, hasProperties, heightProperty, isFocused, isForceIntegerRenderScale, isShowing, onCloseRequestProperty, onHiddenProperty, onHidingProperty, onShowingProperty, onShownProperty, opacityProperty, outputScaleXProperty, outputScaleYProperty, removeEventFilter, removeEventHandler, renderScaleXProperty, renderScaleYProperty, requestFocus, sceneProperty, setEventDispatcher, setEventHandler, setForceIntegerRenderScale, setHeight, setOnCloseRequest, setOnHidden, setOnHiding, setOnShowing, setOnShown, setOpacity, setRenderScaleX, setRenderScaleY, setUserData, setWidth, setX, setY, show, showingProperty, sizeToScene, widthProperty, xProperty, yProperty

    Methods inherited from class Object

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

  • Property Details

  • Field Details

    • text

      protected final javafx.beans.property.StringProperty text
      The textual content of this PopupFilter.

  • Constructor Details

    • PopupFilter

      public PopupFilter(FilteredTableColumn<S,T> tableColumn)
      Creates a new instance of PopupFilter.
      Parameters:
      tableColumn - TableColumn associated with this PopupFilter.

  • Method Details

    • textProperty

      public final javafx.beans.property.StringProperty textProperty()
      The textual content of this PopupFilter.
      Returns:
      the text property
      See Also:

    • getText

      public final String getText()
      Gets the value of the text property.
      Property description:
      The textual content of this PopupFilter.
      Returns:
      the value of the text property
      See Also:

    • setText

      public final void setText(String value)
      Sets the value of the text property.
      Property description:
      The textual content of this PopupFilter.
      Parameters:
      value - the value for the text property
      See Also:

    • showPopup

      public void showPopup()
      Shows the pop up just below the column header.

    • getOperations

      public abstract List<String> getOperations()
      Returns a list of operations which can be performed on this PopupFilter.
      Returns:
      A list of operations.

    • getParser

      public abstract Parser<T> getParser()
      Returns a TextParser which is used to parse the text in the TextField and filter the data.
      Returns:
      A Parser.

    • getTableColumn

      public FilteredTableColumn<S,T> getTableColumn()
      Returns the TableColumn associated with this PopupFilter.
      Returns:
      TableColumn associated with this PopupFilter.

    • createDefaultSkin

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