Module com.dlsc.gemsfx
Package com.dlsc.gemsfx

Class PagingControls

java.lang.Object
javafx.scene.Node
javafx.scene.Parent
javafx.scene.layout.Region
javafx.scene.control.Control
com.dlsc.gemsfx.PagingControls
All Implemented Interfaces:
javafx.css.Styleable, javafx.event.EventTarget, javafx.scene.control.Skinnable
public class PagingControls extends javafx.scene.control.Control
A control for navigating paged information, for example, a paged database table view.

  • Property Summary

    Properties
    Type
    Property
    Description
    final javafx.beans.property.ObjectProperty<javafx.geometry.HPos>
    alignment
    The alignment property controls where in the view the paging buttons will appear: left, center, middle.
    final javafx.beans.property.ObjectProperty<PagingControls.FirstLastPageDisplayMode>
    firstLastPageDisplayMode
     
    final javafx.beans.property.ObjectProperty<javafx.scene.Node>
    firstPageDivider
    Stores the node that will be placed between the regular page buttons and the page button that represents the "first" page.
    final javafx.beans.property.ObjectProperty<javafx.scene.Node>
    lastPageDivider
    Stores the node that will be placed between the regular page buttons and the page button that represents the "last" page.
    final javafx.beans.property.IntegerProperty
    maxPageIndicatorsCount
    The maximum number of page indicators / buttons that will be shown at any time by this control.
    final javafx.beans.property.ObjectProperty<javafx.util.Callback<PagingControls,String>>
    messageLabelProvider
    A message label provider is used to customize the messages shown by the message label of this control, for example, "Showing items 11 to 20 of a total of 1000 items".
    final javafx.beans.property.ObjectProperty<PagingControls.MessageLabelStrategy>
    messageLabelStrategy
    The message label strategy controls whether the message label will appear in certain situations, for example, when there are no items currently in the view that is being controlled by these pagination controls.
    final javafx.beans.property.ReadOnlyIntegerProperty
    pageCount
    A read-only property that stores the number of pages that are required for the given number of items and the given page size.
    final javafx.beans.property.IntegerProperty
    page
    The index of the currently showing page.
    final javafx.beans.property.IntegerProperty
    pageSize
    The number of items shown per page of the control that is being controlled by the pagination control.
    final javafx.beans.property.BooleanProperty
    showPreviousNextPageButton
    A flag used to determine whether the control will display arrow buttons to go to the next or the previous page.
    final javafx.beans.property.IntegerProperty
    totalItemCount
    The total number of items (rows) displayed by the control that utilizes this pagination control for paging.

    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

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    PagingControls.FirstLastPageDisplayMode
    An enum listing the different ways the control will display or not display controls to quickly go to the first or the last page.
    static enum 
    PagingControls.MessageLabelStrategy
    A list of possible strategies for showing / hiding the message label.

  • 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
    PagingControls()
    Constructs a new instance.

  • Method Summary

    Modifier and Type
    Method
    Description
    final javafx.beans.property.ObjectProperty<javafx.geometry.HPos>
    alignmentProperty()
    The alignment property controls where in the view the paging buttons will appear: left, center, middle.
    protected javafx.scene.control.Skin<?>
    createDefaultSkin()
     
    final javafx.beans.property.ObjectProperty<PagingControls.FirstLastPageDisplayMode>
    firstLastPageDisplayModeProperty()
     
    void
    firstPage()
    Sets the page index to zero.
    final javafx.beans.property.ObjectProperty<javafx.scene.Node>
    firstPageDividerProperty()
    Stores the node that will be placed between the regular page buttons and the page button that represents the "first" page.
    final javafx.geometry.HPos
    getAlignment()
    Gets the value of the property alignment.
    final PagingControls.FirstLastPageDisplayMode
    getFirstLastPageDisplayMode()
    Gets the value of the property firstLastPageDisplayMode.
    final javafx.scene.Node
    getFirstPageDivider()
    Gets the value of the property firstPageDivider.
    final javafx.scene.Node
    getLastPageDivider()
    Gets the value of the property lastPageDivider.
    final int
    getMaxPageIndicatorsCount()
    Gets the value of the property maxPageIndicatorsCount.
    final javafx.util.Callback<PagingControls,String>
    getMessageLabelProvider()
    Gets the value of the property messageLabelProvider.
    final PagingControls.MessageLabelStrategy
    getMessageLabelStrategy()
    Gets the value of the property messageLabelStrategy.
    final int
    getPage()
    Gets the value of the property page.
    final int
    getPageCount()
    Gets the value of the property pageCount.
    final int
    getPageSize()
    Gets the value of the property pageSize.
    final boolean
    getShowPreviousNextPageButton()
    Gets the value of the property showPreviousNextPageButton.
    final int
    getTotalItemCount()
    Gets the value of the property totalItemCount.
    String
    getUserAgentStylesheet()
     
    void
    lastPage()
    Sets the page index to the page count minus one.
    final javafx.beans.property.ObjectProperty<javafx.scene.Node>
    lastPageDividerProperty()
    Stores the node that will be placed between the regular page buttons and the page button that represents the "last" page.
    final javafx.beans.property.IntegerProperty
    maxPageIndicatorsCountProperty()
    The maximum number of page indicators / buttons that will be shown at any time by this control.
    final javafx.beans.property.ObjectProperty<javafx.util.Callback<PagingControls,String>>
    messageLabelProviderProperty()
    A message label provider is used to customize the messages shown by the message label of this control, for example, "Showing items 11 to 20 of a total of 1000 items".
    final javafx.beans.property.ObjectProperty<PagingControls.MessageLabelStrategy>
    messageLabelStrategyProperty()
    The message label strategy controls whether the message label will appear in certain situations, for example, when there are no items currently in the view that is being controlled by these pagination controls.
    void
    nextPage()
    Increments the page index.
    final javafx.beans.property.ReadOnlyIntegerProperty
    pageCountProperty()
    A read-only property that stores the number of pages that are required for the given number of items and the given page size.
    final javafx.beans.property.IntegerProperty
    pageProperty()
    The index of the currently showing page.
    final javafx.beans.property.IntegerProperty
    pageSizeProperty()
    The number of items shown per page of the control that is being controlled by the pagination control.
    void
    previousPage()
    Decrements the page index.
    final void
    setAlignment(javafx.geometry.HPos alignment)
    Sets the value of the property alignment.
    final void
    setFirstLastPageDisplayMode(PagingControls.FirstLastPageDisplayMode firstLastPageDisplayMode)
    Sets the value of the property firstLastPageDisplayMode.
    final void
    setFirstPageDivider(javafx.scene.Node firstPageDivider)
    Sets the value of the property firstPageDivider.
    final void
    setLastPageDivider(javafx.scene.Node lastPageDivider)
    Sets the value of the property lastPageDivider.
    final void
    setMaxPageIndicatorsCount(int maxPageIndicatorsCount)
    Sets the value of the property maxPageIndicatorsCount.
    final void
    setMessageLabelProvider(javafx.util.Callback<PagingControls,String> messageLabelProvider)
    Sets the value of the property messageLabelProvider.
    final void
    setMessageLabelStrategy(PagingControls.MessageLabelStrategy messageLabelStrategy)
    Sets the value of the property messageLabelStrategy.
    final void
    setPage(int page)
    Sets the value of the property page.
    final void
    setPageSize(int pageSize)
    Sets the value of the property pageSize.
    final void
    setShowPreviousNextPageButton(boolean showPreviousNextPageButton)
    Sets the value of the property showPreviousNextPageButton.
    final void
    setTotalItemCount(int totalItemCount)
    Sets the value of the property totalItemCount.
    final javafx.beans.property.BooleanProperty
    showPreviousNextPageButtonProperty()
    A flag used to determine whether the control will display arrow buttons to go to the next or the previous page.
    final javafx.beans.property.IntegerProperty
    totalItemCountProperty()
    The total number of items (rows) displayed by the control that utilizes this pagination control for paging.

    Methods inherited from class javafx.scene.control.Control

    computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, contextMenuProperty, executeAccessibleAction, getBaselineOffset, getClassCssMetaData, getContextMenu, getControlCssMetaData, 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, 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

    • showPreviousNextPageButton

      public final javafx.beans.property.BooleanProperty showPreviousNextPageButtonProperty
      A flag used to determine whether the control will display arrow buttons to go to the next or the previous page.
      See Also:

    • alignment

      public final javafx.beans.property.ObjectProperty<javafx.geometry.HPos> alignmentProperty
      The alignment property controls where in the view the paging buttons will appear: left, center, middle.
      See Also:

    • messageLabelStrategy

      public final javafx.beans.property.ObjectProperty<PagingControls.MessageLabelStrategy> messageLabelStrategyProperty
      The message label strategy controls whether the message label will appear in certain situations, for example, when there are no items currently in the view that is being controlled by these pagination controls.
      See Also:

    • firstLastPageDisplayMode

      public final javafx.beans.property.ObjectProperty<PagingControls.FirstLastPageDisplayMode> firstLastPageDisplayModeProperty
      See Also:

    • firstPageDivider

      public final javafx.beans.property.ObjectProperty<javafx.scene.Node> firstPageDividerProperty
      Stores the node that will be placed between the regular page buttons and the page button that represents the "first" page. This is usually a label showing "...".
      See Also:

    • lastPageDivider

      public final javafx.beans.property.ObjectProperty<javafx.scene.Node> lastPageDividerProperty
      Stores the node that will be placed between the regular page buttons and the page button that represents the "last" page. This is usually a label showing "...".
      See Also:

    • messageLabelProvider

      public final javafx.beans.property.ObjectProperty<javafx.util.Callback<PagingControls,String>> messageLabelProviderProperty
      A message label provider is used to customize the messages shown by the message label of this control, for example, "Showing items 11 to 20 of a total of 1000 items".
      See Also:

    • totalItemCount

      public final javafx.beans.property.IntegerProperty totalItemCountProperty
      The total number of items (rows) displayed by the control that utilizes this pagination control for paging.
      See Also:

    • pageCount

      public final javafx.beans.property.ReadOnlyIntegerProperty pageCountProperty
      A read-only property that stores the number of pages that are required for the given number of items and the given page size.
      See Also:

    • maxPageIndicatorsCount

      public final javafx.beans.property.IntegerProperty maxPageIndicatorsCountProperty
      The maximum number of page indicators / buttons that will be shown at any time by this control.
      See Also:

    • page

      public final javafx.beans.property.IntegerProperty pageProperty
      The index of the currently showing page.
      See Also:

    • pageSize

      public final javafx.beans.property.IntegerProperty pageSizeProperty
      The number of items shown per page of the control that is being controlled by the pagination control.
      See Also:

  • Constructor Details

    • PagingControls

      public PagingControls()
      Constructs a new instance.

  • 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

    • getShowPreviousNextPageButton

      public final boolean getShowPreviousNextPageButton()
      Gets the value of the property showPreviousNextPageButton.
      Property description:
      A flag used to determine whether the control will display arrow buttons to go to the next or the previous page.

    • showPreviousNextPageButtonProperty

      public final javafx.beans.property.BooleanProperty showPreviousNextPageButtonProperty()
      A flag used to determine whether the control will display arrow buttons to go to the next or the previous page.
      See Also:

    • setShowPreviousNextPageButton

      public final void setShowPreviousNextPageButton(boolean showPreviousNextPageButton)
      Sets the value of the property showPreviousNextPageButton.
      Property description:
      A flag used to determine whether the control will display arrow buttons to go to the next or the previous page.

    • getAlignment

      public final javafx.geometry.HPos getAlignment()
      Gets the value of the property alignment.
      Property description:
      The alignment property controls where in the view the paging buttons will appear: left, center, middle.

    • alignmentProperty

      public final javafx.beans.property.ObjectProperty<javafx.geometry.HPos> alignmentProperty()
      The alignment property controls where in the view the paging buttons will appear: left, center, middle.
      See Also:

    • setAlignment

      public final void setAlignment(javafx.geometry.HPos alignment)
      Sets the value of the property alignment.
      Property description:
      The alignment property controls where in the view the paging buttons will appear: left, center, middle.

    • getMessageLabelStrategy

      public final PagingControls.MessageLabelStrategy getMessageLabelStrategy()
      Gets the value of the property messageLabelStrategy.
      Property description:
      The message label strategy controls whether the message label will appear in certain situations, for example, when there are no items currently in the view that is being controlled by these pagination controls.

    • messageLabelStrategyProperty

      public final javafx.beans.property.ObjectProperty<PagingControls.MessageLabelStrategy> messageLabelStrategyProperty()
      The message label strategy controls whether the message label will appear in certain situations, for example, when there are no items currently in the view that is being controlled by these pagination controls.
      See Also:

    • setMessageLabelStrategy

      public final void setMessageLabelStrategy(PagingControls.MessageLabelStrategy messageLabelStrategy)
      Sets the value of the property messageLabelStrategy.
      Property description:
      The message label strategy controls whether the message label will appear in certain situations, for example, when there are no items currently in the view that is being controlled by these pagination controls.

    • getFirstLastPageDisplayMode

      public final PagingControls.FirstLastPageDisplayMode getFirstLastPageDisplayMode()
      Gets the value of the property firstLastPageDisplayMode.
      Property description:

    • firstLastPageDisplayModeProperty

      public final javafx.beans.property.ObjectProperty<PagingControls.FirstLastPageDisplayMode> firstLastPageDisplayModeProperty()
      See Also:

    • setFirstLastPageDisplayMode

      public final void setFirstLastPageDisplayMode(PagingControls.FirstLastPageDisplayMode firstLastPageDisplayMode)
      Sets the value of the property firstLastPageDisplayMode.
      Property description:

    • getFirstPageDivider

      public final javafx.scene.Node getFirstPageDivider()
      Gets the value of the property firstPageDivider.
      Property description:
      Stores the node that will be placed between the regular page buttons and the page button that represents the "first" page. This is usually a label showing "...".

    • firstPageDividerProperty

      public final javafx.beans.property.ObjectProperty<javafx.scene.Node> firstPageDividerProperty()
      Stores the node that will be placed between the regular page buttons and the page button that represents the "first" page. This is usually a label showing "...".
      See Also:

    • setFirstPageDivider

      public final void setFirstPageDivider(javafx.scene.Node firstPageDivider)
      Sets the value of the property firstPageDivider.
      Property description:
      Stores the node that will be placed between the regular page buttons and the page button that represents the "first" page. This is usually a label showing "...".

    • getLastPageDivider

      public final javafx.scene.Node getLastPageDivider()
      Gets the value of the property lastPageDivider.
      Property description:
      Stores the node that will be placed between the regular page buttons and the page button that represents the "last" page. This is usually a label showing "...".

    • lastPageDividerProperty

      public final javafx.beans.property.ObjectProperty<javafx.scene.Node> lastPageDividerProperty()
      Stores the node that will be placed between the regular page buttons and the page button that represents the "last" page. This is usually a label showing "...".
      See Also:

    • setLastPageDivider

      public final void setLastPageDivider(javafx.scene.Node lastPageDivider)
      Sets the value of the property lastPageDivider.
      Property description:
      Stores the node that will be placed between the regular page buttons and the page button that represents the "last" page. This is usually a label showing "...".

    • getMessageLabelProvider

      public final javafx.util.Callback<PagingControls,String> getMessageLabelProvider()
      Gets the value of the property messageLabelProvider.
      Property description:
      A message label provider is used to customize the messages shown by the message label of this control, for example, "Showing items 11 to 20 of a total of 1000 items".

    • messageLabelProviderProperty

      public final javafx.beans.property.ObjectProperty<javafx.util.Callback<PagingControls,String>> messageLabelProviderProperty()
      A message label provider is used to customize the messages shown by the message label of this control, for example, "Showing items 11 to 20 of a total of 1000 items".
      See Also:

    • setMessageLabelProvider

      public final void setMessageLabelProvider(javafx.util.Callback<PagingControls,String> messageLabelProvider)
      Sets the value of the property messageLabelProvider.
      Property description:
      A message label provider is used to customize the messages shown by the message label of this control, for example, "Showing items 11 to 20 of a total of 1000 items".

    • firstPage

      public void firstPage()
      Sets the page index to zero.

    • lastPage

      public void lastPage()
      Sets the page index to the page count minus one.
      See Also:

    • nextPage

      public void nextPage()
      Increments the page index.
      See Also:

    • previousPage

      public void previousPage()
      Decrements the page index.
      See Also:

    • getTotalItemCount

      public final int getTotalItemCount()
      Gets the value of the property totalItemCount.
      Property description:
      The total number of items (rows) displayed by the control that utilizes this pagination control for paging.

    • totalItemCountProperty

      public final javafx.beans.property.IntegerProperty totalItemCountProperty()
      The total number of items (rows) displayed by the control that utilizes this pagination control for paging.
      See Also:

    • setTotalItemCount

      public final void setTotalItemCount(int totalItemCount)
      Sets the value of the property totalItemCount.
      Property description:
      The total number of items (rows) displayed by the control that utilizes this pagination control for paging.

    • getPageCount

      public final int getPageCount()
      Gets the value of the property pageCount.
      Property description:
      A read-only property that stores the number of pages that are required for the given number of items and the given page size.

    • pageCountProperty

      public final javafx.beans.property.ReadOnlyIntegerProperty pageCountProperty()
      A read-only property that stores the number of pages that are required for the given number of items and the given page size.
      See Also:

    • getMaxPageIndicatorsCount

      public final int getMaxPageIndicatorsCount()
      Gets the value of the property maxPageIndicatorsCount.
      Property description:
      The maximum number of page indicators / buttons that will be shown at any time by this control.

    • maxPageIndicatorsCountProperty

      public final javafx.beans.property.IntegerProperty maxPageIndicatorsCountProperty()
      The maximum number of page indicators / buttons that will be shown at any time by this control.
      See Also:

    • setMaxPageIndicatorsCount

      public final void setMaxPageIndicatorsCount(int maxPageIndicatorsCount)
      Sets the value of the property maxPageIndicatorsCount.
      Property description:
      The maximum number of page indicators / buttons that will be shown at any time by this control.

    • getPage

      public final int getPage()
      Gets the value of the property page.
      Property description:
      The index of the currently showing page.

    • pageProperty

      public final javafx.beans.property.IntegerProperty pageProperty()
      The index of the currently showing page.
      See Also:

    • setPage

      public final void setPage(int page)
      Sets the value of the property page.
      Property description:
      The index of the currently showing page.

    • getPageSize

      public final int getPageSize()
      Gets the value of the property pageSize.
      Property description:
      The number of items shown per page of the control that is being controlled by the pagination control.

    • pageSizeProperty

      public final javafx.beans.property.IntegerProperty pageSizeProperty()
      The number of items shown per page of the control that is being controlled by the pagination control.
      See Also:

    • setPageSize

      public final void setPageSize(int pageSize)
      Sets the value of the property pageSize.
      Property description:
      The number of items shown per page of the control that is being controlled by the pagination control.