Class PagingGridTableView<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.PagingGridTableView<T>
- Type Parameters:
T- the type of items displayed in the table view
- All Implemented Interfaces:
javafx.css.Styleable, javafx.event.EventTarget, javafx.scene.control.Skinnable
- Direct Known Subclasses:
SimplePagingGridTableView
The
PagingGridTableView class is a control that combines a grid table with paging capabilities.
This class facilitates the display of paginated data in a table format, supporting customizable columns,
adjustable page size, and options to fill the last page with empty rows.-
Nested Class Summary
Nested classes/interfaces inherited from class PagingControlBase
PagingControlBase.FirstLastPageDisplayMode, PagingControlBase.MessageLabelStrategy -
Property Summary
PropertiesTypePropertyDescriptionfinal javafx.beans.property.ListProperty<GridTableColumn<T, ?>> Provides access to the list property containing the columns of the grid table.Properties inherited from class ItemPagingControlBase
commitLoadStatusDelay, fillLastPage, loadDelayInMillis, loader, loadingService, loadingStatus, onOpenItem, pagingControlsLocation, placeholder, selectionModel, showPagingControls, usingScrollPaneProperties inherited from class PagingControlBase
alignment, availablePageSizes, firstLastPageDisplayMode, firstPageDivider, firstPageText, lastPageDivider, lastPageText, maxPageIndicatorsCount, messageLabelProvider, messageLabelStrategy, nextPageText, pageCount, page, pageSize, pageSizeSelectorLabel, previousPageText, sameWidthPageButtons, showPageSizeSelector, showPreviousNextPageButton, totalItemCountProperties inherited from class javafx.scene.control.Control
contextMenu, skin, tooltipProperties inherited from class javafx.scene.layout.Region
background, border, cacheShape, centerShape, height, insets, maxHeight, maxWidth, minHeight, minWidth, opaqueInsets, padding, prefHeight, prefWidth, scaleShape, shape, snapToPixel, widthProperties inherited from class javafx.scene.Parent
needsLayoutProperties 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_SIZEFields inherited from class javafx.scene.Node
BASELINE_OFFSET_SAME_AS_HEIGHT -
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor for thePagingGridTableViewclass. -
Method Summary
Modifier and TypeMethodDescriptionfinal javafx.beans.property.ListProperty<GridTableColumn<T, ?>> Provides access to the list property containing the columns of the grid table.protected javafx.scene.control.Skin<?> final javafx.collections.ObservableList<GridTableColumn<T, ?>> Gets the value of thecolumnsproperty.javafx.geometry.Orientationfinal GridTableView<T> Returns the wrapped table view.final voidrefresh()Triggers a rebuild of the view without reloading data.final voidsetColumns(javafx.collections.ObservableList<GridTableColumn<T, ?>> columns) Sets the value of thecolumnsproperty.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, usingScrollPanePropertyMethods 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, totalItemCountPropertyMethods 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, tooltipPropertyMethods 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, widthPropertyMethods inherited from class javafx.scene.Parent
getChildren, getChildrenUnmodifiable, getManagedChildren, getStylesheets, isNeedsLayout, layout, lookup, needsLayoutProperty, requestLayout, requestParentLayout, setNeedsLayout, updateBoundsMethods 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, 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, visiblePropertyMethods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface javafx.css.Styleable
getStyleableNode
-
Property Details
-
columns
Provides access to the list property containing the columns of the grid table.- See Also:
-
-
Constructor Details
-
PagingGridTableView
public PagingGridTableView()Default constructor for thePagingGridTableViewclass. This initializes the control and binds necessary properties to manage paging and display of items. The constructor sets up the following behavior: - Adds a specific style class named "paging-grid-table-view" to the control. - Binds the columns of the internalGridTableViewto thecolumnsPropertyof this control. - Sets the items of the internalGridTableViewto the items provided by the current page. - Configures the `minNumberOfRowsProperty` of the internalGridTableViewto ensure the proper number of rows are displayed, including empty rows if the last page should be filled. - Registers a listener on the `minNumberOfRowsProperty` to trigger a refresh when the property changes. Internally, this class uses the following additional methods and properties: -columnsProperty(): Provides access to the grid table's columns. -getItemsOnCurrentPage(): Supplies the items to display on the current page. -fillLastPageProperty(): Indicates whether the last page should be filled with empty rows if needed. -pageSizeProperty(): Defines the number of items per page. -refresh(): Rebuilds the view without reloading data.
-
-
Method Details
-
createDefaultSkin
protected javafx.scene.control.Skin<?> createDefaultSkin()- Overrides:
createDefaultSkinin classjavafx.scene.control.Control
-
getUserAgentStylesheet
- Overrides:
getUserAgentStylesheetin classjavafx.scene.layout.Region
-
getContentBias
public javafx.geometry.Orientation getContentBias()- Overrides:
getContentBiasin classjavafx.scene.Node
-
columnsProperty
Provides access to the list property containing the columns of the grid table.- Returns:
- the list property of
GridTableColumn<T, ?>objects representing the columns - See Also:
-
getColumns
Gets the value of thecolumnsproperty.- Property description:
- Provides access to the list property containing the columns of the grid table.
- Returns:
- the value of the
columnsproperty - See Also:
-
setColumns
Sets the value of thecolumnsproperty.- Property description:
- Provides access to the list property containing the columns of the grid table.
- Parameters:
columns- the value for thecolumnsproperty- See Also:
-
getGridTableView
Returns the wrapped table view.- Returns:
- the table view
-
refresh
public final void refresh()Triggers a rebuild of the view without reloading data.- Specified by:
refreshin classItemPagingControlBase<T>
-