Module org.controlsfx.controls
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 theFilteredTableView
items list.T
- Type of the content to be filtered, which is similar to the type of cells contained in theFilteredTableColumn
.
- 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.-
Property Summary
PropertiesTypePropertyDescriptionfinal javafx.beans.property.StringProperty
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
-
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
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected final javafx.beans.property.StringProperty
The textual content of this PopupFilter.Fields inherited from class javafx.scene.control.PopupControl
bridge, USE_COMPUTED_SIZE, USE_PREF_SIZE
-
Constructor Summary
ConstructorsConstructorDescriptionPopupFilter
(FilteredTableColumn<S, T> tableColumn) Creates a new instance of PopupFilter. -
Method Summary
Modifier and TypeMethodDescriptionprotected javafx.scene.control.Skin
<?> Returns a list of operations which can be performed on this PopupFilter.Returns a TextParser which is used to parse the text in the TextField and filter the data.Returns the TableColumn associated with this PopupFilter.final String
getText()
Gets the value of thetext
property.final void
Sets the value of thetext
property.void
Shows the pop up just below the column header.final javafx.beans.property.StringProperty
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
-
Property Details
-
text
public final javafx.beans.property.StringProperty textPropertyThe textual content of this PopupFilter.- See Also:
-
-
Field Details
-
text
protected final javafx.beans.property.StringProperty textThe textual content of this PopupFilter.
-
-
Constructor Details
-
PopupFilter
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
Gets the value of thetext
property.- Property description:
- The textual content of this PopupFilter.
- Returns:
- the value of the
text
property - See Also:
-
setText
Sets the value of thetext
property.- Property description:
- The textual content of this PopupFilter.
- Parameters:
value
- the value for thetext
property- See Also:
-
showPopup
public void showPopup()Shows the pop up just below the column header. -
getOperations
Returns a list of operations which can be performed on this PopupFilter.- Returns:
- A list of operations.
-
getParser
Returns a TextParser which is used to parse the text in the TextField and filter the data.- Returns:
- A
Parser
.
-
getTableColumn
Returns the TableColumn associated with this PopupFilter.- Returns:
- TableColumn associated with this PopupFilter.
-
createDefaultSkin
protected javafx.scene.control.Skin<?> createDefaultSkin()- Overrides:
createDefaultSkin
in classjavafx.scene.control.PopupControl
-