Module MaterialFX

Package io.github.palexdev.materialfx.controls.base

Class AbstractMFXListView<T,C extends io.github.palexdev.virtualizedfx.cell.Cell<T>>

java.lang.Object

javafx.scene.Node

javafx.scene.Parent

javafx.scene.layout.Region

javafx.scene.control.Control

io.github.palexdev.materialfx.controls.base.AbstractMFXListView<T,C>

Type Parameters:

T - the type of data within the ListView

All Implemented Interfaces:

IListView<T,C>, Styleable, EventTarget, Skinnable

Direct Known Subclasses:

MFXCheckListView, MFXListView

public abstract class AbstractMFXListView<T,C extends io.github.palexdev.virtualizedfx.cell.Cell<T>>
extends Control
implements IListView<T,C>

Base class for all list views based on VirtualizedFX, defines common properties and behavior.

Property Summary

Properties

Type	Property	Description
ObjectProperty<StringConverter<T>>	converter	Specifies the StringConverter used to convert a generic item to a String.
StyleableObjectProperty<DepthLevel>	depthLevel	Specifies the shadow strength around the control.
ObjectProperty<Duration>	hideAfter	Specifies the time after which the scrollbars are hidden.
StyleableBooleanProperty	hideScrollBars	Specifies if the scrollbars should be hidden when the mouse is not on the list.
ObjectProperty<ObservableList<T>>	items	The items list property.
ObjectProperty<Paint>	thumbColor	Specifies the color of the scrollbars' thumb.
ObjectProperty<Paint>	thumbHoverColor	Specifies the color of the scrollbars' thumb when mouse hover.
ObjectProperty<Paint>	trackColor	Specifies the color of the scrollbars' track.

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, 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

Properties inherited from interface io.github.palexdev.materialfx.controls.base.IListView

cellFactory

Field Summary

Fields

Modifier and Type	Field	Description
protected final ObjectProperty<StringConverter<T>>	converter
protected final ObjectProperty<ObservableList<T>>	items
protected final IMultipleSelectionModel<T>	selectionModel

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
AbstractMFXListView()
AbstractMFXListView(ObservableList<T> items)

Method Summary

Modifier and Type	Method	Description
protected void	addBarsListeners()
ObjectProperty<StringConverter<T>>	converterProperty()	Specifies the StringConverter used to convert a generic item to a String.
StyleableObjectProperty<DepthLevel>	depthLevelProperty()	Specifies the shadow strength around the control.
static List<CssMetaData<? extends Styleable,?>>	getClassCssMetaData()
protected List<CssMetaData<? extends Styleable,?>>	getControlCssMetaData()
StringConverter<T>	getConverter()	Gets the value of the property converter.
DepthLevel	getDepthLevel()	Gets the value of the property depthLevel.
Duration	getHideAfter()	Gets the value of the property hideAfter.
ObservableList<T>	getItems()	Gets the value of the property items.
IMultipleSelectionModel<T>	getSelectionModel()
Paint	getThumbColor()	Gets the value of the property thumbColor.
Paint	getThumbHoverColor()	Gets the value of the property thumbHoverColor.
Paint	getTrackColor()	Gets the value of the property trackColor.
ObjectProperty<Duration>	hideAfterProperty()	Specifies the time after which the scrollbars are hidden.
StyleableBooleanProperty	hideScrollBarsProperty()	Specifies if the scrollbars should be hidden when the mouse is not on the list.
protected void	initialize()
boolean	isHideScrollBars()	Gets the value of the property hideScrollBars.
ObjectProperty<ObservableList<T>>	itemsProperty()	The items list property.
protected void	setColors()	Sets the CSS looked-up colors
void	setConverter(StringConverter<T> converter)	Sets the value of the property converter.
protected abstract void	setDefaultCellFactory()	Abstract method called automatically to set a default factory for the cells.
void	setDepthLevel(DepthLevel depthLevel)	Sets the value of the property depthLevel.
void	setHideAfter(Duration hideAfter)	Sets the value of the property hideAfter.
void	setHideScrollBars(boolean hideScrollBars)	Sets the value of the property hideScrollBars.
void	setItems(ObservableList<T> items)	Sets the value of the property items.
void	setThumbColor(Paint thumbColor)	Sets the value of the property thumbColor.
void	setThumbHoverColor(Paint thumbHoverColor)	Sets the value of the property thumbHoverColor.
void	setTrackColor(Paint trackColor)	Sets the value of the property trackColor.
ObjectProperty<Paint>	thumbColorProperty()	Specifies the color of the scrollbars' thumb.
ObjectProperty<Paint>	thumbHoverColorProperty()	Specifies the color of the scrollbars' thumb when mouse hover.
ObjectProperty<Paint>	trackColorProperty()	Specifies the color of the scrollbars' track.

Methods inherited from class javafx.scene.control.Control

computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, contextMenuProperty, createDefaultSkin, 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, getUserAgentStylesheet, 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, 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, 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 io.github.palexdev.materialfx.controls.base.IListView

cellFactoryProperty, getCellFactory, setCellFactory

Methods inherited from interface javafx.css.Styleable

getStyleableNode

Property Details

trackColor

public ObjectProperty<Paint> trackColorProperty

Specifies the color of the scrollbars' track.

See Also:

• getTrackColor()
• setTrackColor(Paint)

thumbColor

public ObjectProperty<Paint> thumbColorProperty

Specifies the color of the scrollbars' thumb.

See Also:

• getThumbColor()
• setThumbColor(Paint)

thumbHoverColor

public ObjectProperty<Paint> thumbHoverColorProperty

Specifies the color of the scrollbars' thumb when mouse hover.

See Also:

• getThumbHoverColor()
• setThumbHoverColor(Paint)

hideAfter

public ObjectProperty<Duration> hideAfterProperty

Specifies the time after which the scrollbars are hidden.

See Also:

• getHideAfter()
• setHideAfter(Duration)

items

public ObjectProperty<ObservableList<T>> itemsProperty

Specified by:

itemsProperty in interface IListView<T,C extends io.github.palexdev.virtualizedfx.cell.Cell<T>>

See Also:

• getItems()
• setItems(ObservableList)

converter

public ObjectProperty<StringConverter<T>> converterProperty

Specified by:

converterProperty in interface IListView<T,C extends io.github.palexdev.virtualizedfx.cell.Cell<T>>

See Also:

• getConverter()
• setConverter(StringConverter)

hideScrollBars

public StyleableBooleanProperty hideScrollBarsProperty

Specifies if the scrollbars should be hidden when the mouse is not on the list.

See Also:

• isHideScrollBars()
• setHideScrollBars(boolean)

depthLevel

public StyleableObjectProperty<DepthLevel> depthLevelProperty

Specifies the shadow strength around the control.

See Also:

• getDepthLevel()
• setDepthLevel(DepthLevel)

Field Details

items

protected final ObjectProperty<ObservableList<T>> items

converter

protected final ObjectProperty<StringConverter<T>> converter

selectionModel

protected final IMultipleSelectionModel<T> selectionModel

Constructor Details

AbstractMFXListView

public AbstractMFXListView()

AbstractMFXListView

public AbstractMFXListView(ObservableList<T> items)

Method Details

setDefaultCellFactory

protected abstract void setDefaultCellFactory()

Abstract method called automatically to set a default factory for the cells.

initialize

protected void initialize()

addBarsListeners

protected void addBarsListeners()

setColors

protected void setColors()

Sets the CSS looked-up colors

getTrackColor

public Paint getTrackColor()

Gets the value of the property trackColor.

Property description:

Specifies the color of the scrollbars' track.

trackColorProperty

public ObjectProperty<Paint> trackColorProperty()

Specifies the color of the scrollbars' track.

See Also:

• getTrackColor()
• setTrackColor(Paint)

setTrackColor

public void setTrackColor(Paint trackColor)

Sets the value of the property trackColor.

Property description:

Specifies the color of the scrollbars' track.

getThumbColor

public Paint getThumbColor()

Gets the value of the property thumbColor.

Property description:

Specifies the color of the scrollbars' thumb.

thumbColorProperty

public ObjectProperty<Paint> thumbColorProperty()

Specifies the color of the scrollbars' thumb.

See Also:

• getThumbColor()
• setThumbColor(Paint)

setThumbColor

public void setThumbColor(Paint thumbColor)

Sets the value of the property thumbColor.

Property description:

Specifies the color of the scrollbars' thumb.

getThumbHoverColor

public Paint getThumbHoverColor()

Gets the value of the property thumbHoverColor.

Property description:

Specifies the color of the scrollbars' thumb when mouse hover.

thumbHoverColorProperty

public ObjectProperty<Paint> thumbHoverColorProperty()

Specifies the color of the scrollbars' thumb when mouse hover.

See Also:

• getThumbHoverColor()
• setThumbHoverColor(Paint)

setThumbHoverColor

public void setThumbHoverColor(Paint thumbHoverColor)

Sets the value of the property thumbHoverColor.

Property description:

Specifies the color of the scrollbars' thumb when mouse hover.

getHideAfter

public Duration getHideAfter()

Gets the value of the property hideAfter.

Property description:

Specifies the time after which the scrollbars are hidden.

hideAfterProperty

public ObjectProperty<Duration> hideAfterProperty()

Specifies the time after which the scrollbars are hidden.

See Also:

• getHideAfter()
• setHideAfter(Duration)

setHideAfter

public void setHideAfter(Duration hideAfter)

Sets the value of the property hideAfter.

Property description:

Specifies the time after which the scrollbars are hidden.

getItems

public ObservableList<T> getItems()

Gets the value of the property items.

Specified by:

getItems in interface IListView<T,C extends io.github.palexdev.virtualizedfx.cell.Cell<T>>

Property description:

Returns:

the items observable list

itemsProperty

public ObjectProperty<ObservableList<T>> itemsProperty()

Description copied from interface: IListView

The items list property.

Specified by:

itemsProperty in interface IListView<T,C extends io.github.palexdev.virtualizedfx.cell.Cell<T>>

See Also:

• getItems()
• setItems(ObservableList)

setItems

public void setItems(ObservableList<T> items)

Sets the value of the property items.

Specified by:

setItems in interface IListView<T,C extends io.github.palexdev.virtualizedfx.cell.Cell<T>>

Property description:

getConverter

public StringConverter<T> getConverter()

Gets the value of the property converter.

Specified by:

getConverter in interface IListView<T,C extends io.github.palexdev.virtualizedfx.cell.Cell<T>>

Property description:

converterProperty

public ObjectProperty<StringConverter<T>> converterProperty()

Description copied from interface: IListView

Specifies the StringConverter used to convert a generic item to a String. It is used by the list cells.

Specified by:

converterProperty in interface IListView<T,C extends io.github.palexdev.virtualizedfx.cell.Cell<T>>

See Also:

• getConverter()
• setConverter(StringConverter)

setConverter

public void setConverter(StringConverter<T> converter)

Sets the value of the property converter.

Specified by:

setConverter in interface IListView<T,C extends io.github.palexdev.virtualizedfx.cell.Cell<T>>

Property description:

getSelectionModel

public IMultipleSelectionModel<T> getSelectionModel()

Specified by:

getSelectionModel in interface IListView<T,C extends io.github.palexdev.virtualizedfx.cell.Cell<T>>

Returns:

the listview selection model

isHideScrollBars

public boolean isHideScrollBars()

Gets the value of the property hideScrollBars.

Property description:

Specifies if the scrollbars should be hidden when the mouse is not on the list.

hideScrollBarsProperty

public StyleableBooleanProperty hideScrollBarsProperty()

Specifies if the scrollbars should be hidden when the mouse is not on the list.

See Also:

• isHideScrollBars()
• setHideScrollBars(boolean)

setHideScrollBars

public void setHideScrollBars(boolean hideScrollBars)

Sets the value of the property hideScrollBars.

Property description:

Specifies if the scrollbars should be hidden when the mouse is not on the list.

getDepthLevel

public DepthLevel getDepthLevel()

Gets the value of the property depthLevel.

Property description:

Specifies the shadow strength around the control.

depthLevelProperty

public StyleableObjectProperty<DepthLevel> depthLevelProperty()

Specifies the shadow strength around the control.

See Also:

• getDepthLevel()
• setDepthLevel(DepthLevel)

setDepthLevel

public void setDepthLevel(DepthLevel depthLevel)

Sets the value of the property depthLevel.

Property description:

Specifies the shadow strength around the control.

getClassCssMetaData

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

getControlCssMetaData

protected List<CssMetaData<? extends Styleable,?>> getControlCssMetaData()

Overrides:

getControlCssMetaData in class Control