Module org.controlsfx.controls

Package org.controlsfx.control.tableview2.filter.popupfilter

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:

Styleable, EventTarget, Skinnable

Direct Known Subclasses:

PopupNumberFilter, PopupStringFilter

public abstract class PopupFilter<S,T>
extends 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

Properties

Type	Property	Description
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

Nested Class Summary

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

PopupControl.CSSBridge

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

PopupWindow.AnchorLocation

Field Summary

Fields

Modifier and Type	Field	Description
protected 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 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.
String	getText()	Gets the value of the property text.
void	setText(String value)	Sets the value of the property text.
void	showPopup()	Shows the pop up just below the column header.
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 java.lang.Object

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

Property Detail

text

public final StringProperty textProperty

The textual content of this PopupFilter.

See Also:

getText(), setText(String)

Field Detail

text

protected final StringProperty text

The textual content of this PopupFilter.

Constructor Detail

PopupFilter

public PopupFilter(FilteredTableColumn<S,T> tableColumn)

Creates a new instance of PopupFilter.

Parameters:

tableColumn - TableColumn associated with this PopupFilter.

Method Detail

textProperty

public final StringProperty textProperty()

The textual content of this PopupFilter.

See Also:

getText(), setText(String)

getText

public final String getText()

Gets the value of the property text.

Property description:

The textual content of this PopupFilter.

setText

public final void setText(String value)

Sets the value of the property text.

Property description:

The textual content of this PopupFilter.

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 Skin<?> createDefaultSkin()

Overrides:

createDefaultSkin in class PopupControl