Class PagingListView<T>

java.lang.Object
javafx.scene.Node
javafx.scene.Parent
javafx.scene.layout.Region
javafx.scene.control.Control
com.dlsc.gemsfx.paging.PagingControlBase
com.dlsc.gemsfx.paging.ItemPagingControlBase<T>
com.dlsc.gemsfx.paging.PagingListView<T>
Type Parameters:
T - the type of items to be displayed in the list view
All Implemented Interfaces:
javafx.css.Styleable, javafx.event.EventTarget, javafx.scene.control.Skinnable
Direct Known Subclasses:
SimplePagingListView
public class PagingListView<T> extends ItemPagingControlBase<T>
PagingListView is a custom control that extends the functionality of a standard ListView to include paging capabilities. It is designed to handle large datasets efficiently by splitting the data into manageable pages and allowing navigation between them.

  • Nested Class Summary

    Nested classes/interfaces inherited from class PagingControlBase

    PagingControlBase.FirstLastPageDisplayMode, PagingControlBase.MessageLabelStrategy

  • Property Summary

    Properties
    Type
    Property
    Description
    final javafx.beans.property.ObjectProperty<javafx.util.Callback<javafx.scene.control.ListView<T>, javafx.scene.control.ListCell<T>>>
    cellFactory
    Setting a custom cell factory has the effect of deferring all cell creation, allowing for total customization of the cell.
    final javafx.beans.property.ObjectProperty<javafx.scene.control.ProgressIndicator>
    progressIndicator
    The progress indicator that will be used to display percentage progress or the indeterminate state of the loading progress.

    Properties inherited from class ItemPagingControlBase

    commitLoadStatusDelay, fillLastPage, loadDelayInMillis, loader, loadingService, loadingStatus, onOpenItem, pagingControlsLocation, placeholder, selectionModel, showPagingControls, usingScrollPane

    Properties inherited from class PagingControlBase

    alignment, availablePageSizes, firstLastPageDisplayMode, firstPageDivider, firstPageText, lastPageDivider, lastPageText, maxPageIndicatorsCount, messageLabelProvider, messageLabelStrategy, nextPageText, pageCount, page, pageSize, pageSizeSelectorLabel, previousPageText, sameWidthPageButtons, showPageSizeSelector, showPreviousNextPageButton, totalItemCount

    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, focusVisible, focusWithin, 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 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
    PagingListView()
    Constructs a new PagingListView instance.

  • Method Summary

    Modifier and Type
    Method
    Description
    final javafx.beans.property.ObjectProperty<javafx.util.Callback<javafx.scene.control.ListView<T>, javafx.scene.control.ListCell<T>>>
    cellFactoryProperty()
    Setting a custom cell factory has the effect of deferring all cell creation, allowing for total customization of the cell.
    protected javafx.scene.control.Skin<?>
    createDefaultSkin()
     
    final javafx.util.Callback<javafx.scene.control.ListView<T>, javafx.scene.control.ListCell<T>>
    getCellFactory()
    Returns the current cell factory.
    final javafx.scene.control.ListView<T>
    getListView()
    Returns the wrapped list view.
    final javafx.scene.control.ProgressIndicator
    getProgressIndicator()
    Gets the value of the progressIndicator property.
    String
    getUserAgentStylesheet()
     
    final javafx.beans.property.ObjectProperty<javafx.scene.control.ProgressIndicator>
    progressIndicatorProperty()
    The progress indicator that will be used to display percentage progress or the indeterminate state of the loading progress.
    final void
    refresh()
    Triggers a rebuild of the view without reloading data.
    final void
    setCellFactory(javafx.util.Callback<javafx.scene.control.ListView<T>, javafx.scene.control.ListCell<T>> value)
    Sets a new cell factory to use in the ListView.
    final void
    setProgressIndicator(javafx.scene.control.ProgressIndicator progressIndicator)
    Sets the value of the progressIndicator property.

    Methods inherited from class ItemPagingControlBase

    commitLoadStatusDelayProperty, fillLastPageProperty, getClassCssMetaData, getCommitLoadStatusDelay, getControlCssMetaData, getItemsOnCurrentPage, getLoadDelayInMillis, getLoader, getLoadingService, getLoadingStatus, getOnOpenItem, getPagingControlsLocation, getPlaceholder, getSelectionModel, isFillLastPage, isShowPagingControls, isUsingScrollPane, loadDelayInMillisProperty, loaderProperty, loadingServiceProperty, loadingStatusProperty, onOpenItemProperty, pagingControlsLocationProperty, placeholderProperty, reload, selectionModelProperty, setCommitLoadStatusDelay, setFillLastPage, setLoadDelayInMillis, setLoader, setLoadingService, setLoadingStatus, setOnOpenItem, setPagingControlsLocation, setPlaceholder, setSelectionModel, setShowPagingControls, setUsingScrollPane, showPagingControlsProperty, usingScrollPaneProperty

    Methods inherited from class PagingControlBase

    alignmentProperty, availablePageSizesProperty, firstLastPageDisplayModeProperty, firstPage, firstPageDividerProperty, firstPageTextProperty, getAlignment, getAvailablePageSizes, getFirstLastPageDisplayMode, getFirstPageDivider, getFirstPageText, getLastPageDivider, getLastPageText, getMaxPageIndicatorsCount, getMessageLabelProvider, getMessageLabelStrategy, getNextPageText, getPage, getPageCount, getPageSize, getPageSizeSelectorLabel, getPreviousPageText, getTotalItemCount, isSameWidthPageButtons, isShowPageSizeSelector, isShowPreviousNextPageButton, lastPage, lastPageDividerProperty, lastPageTextProperty, maxPageIndicatorsCountProperty, messageLabelProviderProperty, messageLabelStrategyProperty, nextPage, nextPageTextProperty, pageCountProperty, pageProperty, pageSizeProperty, pageSizeSelectorLabelProperty, previousPage, previousPageTextProperty, sameWidthPageButtonsProperty, setAlignment, setAvailablePageSizes, setFirstLastPageDisplayMode, setFirstPageDivider, setFirstPageText, setLastPageDivider, setLastPageText, setMaxPageIndicatorsCount, setMessageLabelProvider, setMessageLabelStrategy, setNextPageText, setPage, setPageSize, setPageSizeSelectorLabel, setPreviousPageText, setSameWidthPageButtons, setShowPageSizeSelector, setShowPreviousNextPageButton, setTotalItemCount, showPageSizeSelectorProperty, showPreviousNextPageButtonProperty, totalItemCountProperty

    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, focusVisibleProperty, focusWithinProperty, 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, isFocusVisible, isFocusWithin, 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, requestFocusTraversal, 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 Object

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

    Methods inherited from interface javafx.css.Styleable

    getStyleableNode

  • Property Details

    • progressIndicator

      public final javafx.beans.property.ObjectProperty<javafx.scene.control.ProgressIndicator> progressIndicatorProperty
      The progress indicator that will be used to display percentage progress or the indeterminate state of the loading progress.
      See Also:

    • cellFactory

      public final javafx.beans.property.ObjectProperty<javafx.util.Callback<javafx.scene.control.ListView<T>, javafx.scene.control.ListCell<T>>> cellFactoryProperty

      Setting a custom cell factory has the effect of deferring all cell creation, allowing for total customization of the cell. Internally, the ListView is responsible for reusing ListCells - all that is necessary is for the custom cell factory to return from this function a ListCell which might be usable for representing any item in the ListView.

      Refer to the Cell class documentation for more detail.

      See Also:

  • Constructor Details

    • PagingListView

      public PagingListView()
      Constructs a new PagingListView instance. The PagingListView is a custom control that provides paging functionality for a list view, allowing for efficient display and navigation of large datasets across multiple pages. This constructor initializes the PagingListView by performing the following steps: - Adds a custom style class ("paging-list-view") to the control. - Configures the internal ListView, including setting a custom style class ("inner-list-view"), enabling "multiple selection" mode, and establishing bindings for the cell factory and items displayed on the current page. - Binds the selection model of the PagingListView to the internal ListView for consistent selection behavior. - Sets a default cell factory to customize the rendering of items in the list. - Listens to changes in the cell factory property and triggers a refresh when modifications occur.

  • Method Details

    • createDefaultSkin

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

    • getUserAgentStylesheet

      public String getUserAgentStylesheet()
      Overrides:
      getUserAgentStylesheet in class javafx.scene.layout.Region

    • getProgressIndicator

      public final javafx.scene.control.ProgressIndicator getProgressIndicator()
      Gets the value of the progressIndicator property.
      Property description:
      The progress indicator that will be used to display percentage progress or the indeterminate state of the loading progress.
      Returns:
      the value of the progressIndicator property
      See Also:

    • progressIndicatorProperty

      public final javafx.beans.property.ObjectProperty<javafx.scene.control.ProgressIndicator> progressIndicatorProperty()
      The progress indicator that will be used to display percentage progress or the indeterminate state of the loading progress.
      Returns:
      the progress indicator
      See Also:

    • setProgressIndicator

      public final void setProgressIndicator(javafx.scene.control.ProgressIndicator progressIndicator)
      Sets the value of the progressIndicator property.
      Property description:
      The progress indicator that will be used to display percentage progress or the indeterminate state of the loading progress.
      Parameters:
      progressIndicator - the value for the progressIndicator property
      See Also:

    • getListView

      public final javafx.scene.control.ListView<T> getListView()
      Returns the wrapped list view.
      Returns:
      the list view

    • setCellFactory

      public final void setCellFactory(javafx.util.Callback<javafx.scene.control.ListView<T>, javafx.scene.control.ListCell<T>> value)
      Sets a new cell factory to use in the ListView. This forces all old ListCell's to be thrown away, and new ListCell's created with the new cell factory.
      Parameters:
      value - cell factory to use in this ListView

    • getCellFactory

      public final javafx.util.Callback<javafx.scene.control.ListView<T>, javafx.scene.control.ListCell<T>> getCellFactory()
      Returns the current cell factory.
      Returns:
      the current cell factory

    • cellFactoryProperty

      public final javafx.beans.property.ObjectProperty<javafx.util.Callback<javafx.scene.control.ListView<T>, javafx.scene.control.ListCell<T>>> cellFactoryProperty()

      Setting a custom cell factory has the effect of deferring all cell creation, allowing for total customization of the cell. Internally, the ListView is responsible for reusing ListCells - all that is necessary is for the custom cell factory to return from this function a ListCell which might be usable for representing any item in the ListView.

      Refer to the Cell class documentation for more detail.

      Returns:
      the cell factory property
      See Also:

    • refresh

      public final void refresh()
      Triggers a rebuild of the view without reloading data.
      Specified by:
      refresh in class ItemPagingControlBase<T>