Module MaterialFX

Package io.github.palexdev.materialfx.controls

Class MFXListView<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,MFXListCell<T>>

io.github.palexdev.materialfx.controls.MFXListView<T>

All Implemented Interfaces:

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

public class MFXListView<T>
extends AbstractMFXListView<T,MFXListCell<T>>

Implementation of a check listview based on VirtualizedFX.

Extends AbstractMFXListView.

Default cell: MFXListCell.

Default skin: MFXListViewSkin.

Holds the reference to the VirtualFlow used by the list, this allows to expose some methods from it as delegate method thus allowing to:

- Manually scroll by a certain amount of pixels

- Manually scroll to a given index (also first and last)

- Manually scroll to the given pixel value

- Set the scrollbar's speed

- Get the vertical or horizontal position of the list

- Configure extra features of the VirtualFlow, features()

- Get the currently shown cells, or a specific cell by index

It's also responsible for updating the selection model in case the items list property changes, or changes occur in the items list.

Property Summary

Properties

Type	Property	Description
ObjectProperty<Function<T,MFXListCell<T>>>	cellFactory

Properties inherited from class io.github.palexdev.materialfx.controls.base.AbstractMFXListView

converter, depthLevel, hideAfter, hideScrollBars, items, thumbColor, thumbHoverColor, trackColor

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

Field Summary

Fields inherited from class io.github.palexdev.materialfx.controls.base.AbstractMFXListView

converter, items, 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
MFXListView()
MFXListView(ObservableList<T> items)

Method Summary

Modifier and Type	Method	Description
ObjectProperty<Function<T,MFXListCell<T>>>	cellFactoryProperty()
protected Skin<?>	createDefaultSkin()
io.github.palexdev.virtualizedfx.flow.simple.SimpleVirtualFlow<T,MFXListCell<T>>.io.github.palexdev.virtualizedfx.flow.simple.SimpleVirtualFlow.Features	features()	Delegate method for SimpleVirtualFlow.features().
MFXListCell<T>	getCell(int index)	Delegate method for SimpleVirtualFlow.getCell(int).
Function<T,MFXListCell<T>>	getCellFactory()	Gets the value of the property cellFactory.
Map<Integer,MFXListCell<T>>	getCells()	Delegate method for SimpleVirtualFlow.getCells().
double	getHorizontalPosition()	Delegate method for SimpleVirtualFlow.getHorizontalPosition().
String	getUserAgentStylesheet()
double	getVerticalPosition()	Delegate method for SimpleVirtualFlow.getVerticalPosition().
protected void	initialize()
protected void	itemsChanged(ListChangeListener.Change<? extends T> change)
void	scrollBy(double pixels)	Delegate method for SimpleVirtualFlow.scrollBy(double).
void	scrollTo(int index)	Delegate method for SimpleVirtualFlow.scrollTo(int).
void	scrollToFirst()	Delegate method for SimpleVirtualFlow.scrollToFirst().
void	scrollToLast()	Delegate method for SimpleVirtualFlow.scrollToLast().
void	scrollToPixel(double pixel)	Delegate method for SimpleVirtualFlow.scrollToPixel(double).
void	setCellFactory(Function<T,MFXListCell<T>> cellFactory)	Sets the value of the property cellFactory.
protected void	setDefaultCellFactory()	Abstract method called automatically to set a default factory for the cells.
void	setHSpeed(double unit, double block)	Delegate method for SimpleVirtualFlow.setHSpeed(double, double).
void	setVSpeed(double unit, double block)	Delegate method for SimpleVirtualFlow.setVSpeed(double, double).

Methods inherited from class io.github.palexdev.materialfx.controls.base.AbstractMFXListView

addBarsListeners, converterProperty, depthLevelProperty, getClassCssMetaData, getControlCssMetaData, getConverter, getDepthLevel, getHideAfter, getItems, getSelectionModel, getThumbColor, getThumbHoverColor, getTrackColor, hideAfterProperty, hideScrollBarsProperty, isHideScrollBars, itemsProperty, setColors, setConverter, setDepthLevel, setHideAfter, setHideScrollBars, setItems, setThumbColor, setThumbHoverColor, setTrackColor, thumbColorProperty, thumbHoverColorProperty, trackColorProperty

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, 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 javafx.css.Styleable

getStyleableNode

Property Details

cellFactory

public ObjectProperty<Function<T,MFXListCell<T>>> cellFactoryProperty

See Also:

• getCellFactory()
• setCellFactory(Function)

Constructor Details

MFXListView

public MFXListView()

MFXListView

public MFXListView(ObservableList<T> items)

Method Details

initialize

protected void initialize()

Overrides:

initialize in class AbstractMFXListView<T,MFXListCell<T>>

itemsChanged

protected void itemsChanged(ListChangeListener.Change<? extends T> change)

getCell

public MFXListCell<T> getCell(int index)

Delegate method for SimpleVirtualFlow.getCell(int).

getCells

public Map<Integer,MFXListCell<T>> getCells()

Delegate method for SimpleVirtualFlow.getCells().

scrollBy

public void scrollBy(double pixels)

Delegate method for SimpleVirtualFlow.scrollBy(double).

scrollTo

public void scrollTo(int index)

Delegate method for SimpleVirtualFlow.scrollTo(int).

scrollToFirst

public void scrollToFirst()

Delegate method for SimpleVirtualFlow.scrollToFirst().

scrollToLast

public void scrollToLast()

Delegate method for SimpleVirtualFlow.scrollToLast().

scrollToPixel

public void scrollToPixel(double pixel)

Delegate method for SimpleVirtualFlow.scrollToPixel(double).

setHSpeed

public void setHSpeed(double unit,
 double block)

Delegate method for SimpleVirtualFlow.setHSpeed(double, double).

setVSpeed

public void setVSpeed(double unit,
 double block)

Delegate method for SimpleVirtualFlow.setVSpeed(double, double).

getVerticalPosition

public double getVerticalPosition()

Delegate method for SimpleVirtualFlow.getVerticalPosition().

getHorizontalPosition

public double getHorizontalPosition()

Delegate method for SimpleVirtualFlow.getHorizontalPosition().

features

public io.github.palexdev.virtualizedfx.flow.simple.SimpleVirtualFlow<T,MFXListCell<T>>.io.github.palexdev.virtualizedfx.flow.simple.SimpleVirtualFlow.Features features()

Delegate method for SimpleVirtualFlow.features().

setDefaultCellFactory

protected void setDefaultCellFactory()

Description copied from class: AbstractMFXListView

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

Specified by:

setDefaultCellFactory in class AbstractMFXListView<T,MFXListCell<T>>

getCellFactory

public Function<T,MFXListCell<T>> getCellFactory()

Gets the value of the property cellFactory.

Property description:

Returns:

the function used to build the list cells

cellFactoryProperty

public ObjectProperty<Function<T,MFXListCell<T>>> cellFactoryProperty()

See Also:

• getCellFactory()
• setCellFactory(Function)

setCellFactory

public void setCellFactory(Function<T,MFXListCell<T>> cellFactory)

Sets the value of the property cellFactory.

Property description:

createDefaultSkin

protected Skin<?> createDefaultSkin()

Overrides:

createDefaultSkin in class Control

getUserAgentStylesheet

public String getUserAgentStylesheet()

Overrides:

getUserAgentStylesheet in class Region