Class PagingControlBase

java.lang.Object
javafx.scene.Node
javafx.scene.Parent
javafx.scene.layout.Region
javafx.scene.control.Control
com.dlsc.gemsfx.paging.PagingControlBase
All Implemented Interfaces:
javafx.css.Styleable, javafx.event.EventTarget, javafx.scene.control.Skinnable
Direct Known Subclasses:
ItemPagingControlBase, PagingControls
public abstract class PagingControlBase extends javafx.scene.control.Control

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    PagingControlBase.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 
    PagingControlBase.MessageLabelStrategy
    A list of possible strategies for showing / hiding the message label.

  • 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, or right.
    final javafx.beans.property.ListProperty<Integer>
    availablePageSizes
    A list of available page sizes that will be shown by the page size selector.
    final javafx.beans.property.ObjectProperty<PagingControlBase.FirstLastPageDisplayMode>
    firstLastPageDisplayMode
    Controls how first and last page navigation is displayed by the paging control.
    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.StringProperty
    firstPageText
    The text that will be shown by the "first page" button.
    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.StringProperty
    lastPageText
    The text that will be shown by the "last page" button.
    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<PagingControlBase.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.StringProperty
    nextPageText
    The text that will be shown by the "next page" button.
    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.StringProperty
    pageSizeSelectorLabel
    The text / label shown in front of the page size selector control.
    final javafx.beans.property.StringProperty
    previousPageText
    The text that will be shown by the "previous page" button.
    final javafx.beans.property.BooleanProperty
    sameWidthPageButtons
    A flag used to signal whether the individual page buttons will all have the same width or if their width can be different based on the page number that they are showing (e.g. the button for page "1" would be substantially less wide than the button for page "999").
    final javafx.beans.property.BooleanProperty
    showPageSizeSelector
    Determines if the control will show a selector UI for choosing different page sizes.
    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

  • 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
    PagingControlBase()
     

  • 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, or right.
    final javafx.beans.property.ListProperty<Integer>
    availablePageSizesProperty()
    A list of available page sizes that will be shown by the page size selector.
    final javafx.beans.property.ObjectProperty<PagingControlBase.FirstLastPageDisplayMode>
    firstLastPageDisplayModeProperty()
    Controls how first and last page navigation is displayed by the paging control.
    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.beans.property.StringProperty
    firstPageTextProperty()
    The text that will be shown by the "first page" button.
    final javafx.geometry.HPos
    getAlignment()
    Gets the value of the alignment property.
    final javafx.collections.ObservableList<Integer>
    getAvailablePageSizes()
    Gets the value of the availablePageSizes property.
    static List<javafx.css.CssMetaData<? extends javafx.css.Styleable, ?>>
    getClassCssMetaData()
    Gets the CssMetaData associated with this class, which may include the CssMetaData of its superclasses.
    List<javafx.css.CssMetaData<? extends javafx.css.Styleable, ?>>
    getControlCssMetaData()
     
    final PagingControlBase.FirstLastPageDisplayMode
    getFirstLastPageDisplayMode()
    Gets the value of the firstLastPageDisplayMode property.
    final javafx.scene.Node
    getFirstPageDivider()
    Gets the value of the firstPageDivider property.
    final String
    getFirstPageText()
    Gets the value of the firstPageText property.
    final javafx.scene.Node
    getLastPageDivider()
    Gets the value of the lastPageDivider property.
    final String
    getLastPageText()
    Gets the value of the lastPageText property.
    final int
    getMaxPageIndicatorsCount()
    Gets the value of the maxPageIndicatorsCount property.
    final javafx.util.Callback<PagingControls, String>
    getMessageLabelProvider()
    Gets the value of the messageLabelProvider property.
    final PagingControlBase.MessageLabelStrategy
    getMessageLabelStrategy()
    Gets the value of the messageLabelStrategy property.
    final String
    getNextPageText()
    Gets the value of the nextPageText property.
    final int
    getPage()
    Gets the value of the page property.
    final int
    getPageCount()
    Gets the value of the pageCount property.
    final int
    getPageSize()
    Gets the value of the pageSize property.
    final String
    getPageSizeSelectorLabel()
    Gets the value of the pageSizeSelectorLabel property.
    final String
    getPreviousPageText()
    Gets the value of the previousPageText property.
    final int
    getTotalItemCount()
    Gets the value of the totalItemCount property.
    final boolean
    isSameWidthPageButtons()
    Gets the value of the sameWidthPageButtons property.
    final boolean
    isShowPageSizeSelector()
    Gets the value of the showPageSizeSelector property.
    final boolean
    isShowPreviousNextPageButton()
    Gets the value of the showPreviousNextPageButton property.
    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.StringProperty
    lastPageTextProperty()
    The text that will be shown by the "last page" button.
    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<PagingControlBase.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.StringProperty
    nextPageTextProperty()
    The text that will be shown by the "next page" button.
    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.
    final javafx.beans.property.StringProperty
    pageSizeSelectorLabelProperty()
    The text / label shown in front of the page size selector control.
    void
    previousPage()
    Decrements the page index.
    final javafx.beans.property.StringProperty
    previousPageTextProperty()
    The text that will be shown by the "previous page" button.
    final javafx.beans.property.BooleanProperty
    sameWidthPageButtonsProperty()
    A flag used to signal whether the individual page buttons will all have the same width or if their width can be different based on the page number that they are showing (e.g. the button for page "1" would be substantially less wide than the button for page "999").
    final void
    setAlignment(javafx.geometry.HPos alignment)
    Sets the value of the alignment property.
    final void
    setAvailablePageSizes(javafx.collections.ObservableList<Integer> availablePageSizes)
    Sets the value of the availablePageSizes property.
    final void
    setFirstLastPageDisplayMode(PagingControlBase.FirstLastPageDisplayMode firstLastPageDisplayMode)
    Sets the value of the firstLastPageDisplayMode property.
    final void
    setFirstPageDivider(javafx.scene.Node firstPageDivider)
    Sets the value of the firstPageDivider property.
    final void
    setFirstPageText(String firstPageText)
    Sets the value of the firstPageText property.
    final void
    setLastPageDivider(javafx.scene.Node lastPageDivider)
    Sets the value of the lastPageDivider property.
    final void
    setLastPageText(String lastPageText)
    Sets the value of the lastPageText property.
    final void
    setMaxPageIndicatorsCount(int maxPageIndicatorsCount)
    Sets the value of the maxPageIndicatorsCount property.
    final void
    setMessageLabelProvider(javafx.util.Callback<PagingControls, String> messageLabelProvider)
    Sets the value of the messageLabelProvider property.
    final void
    setMessageLabelStrategy(PagingControlBase.MessageLabelStrategy messageLabelStrategy)
    Sets the value of the messageLabelStrategy property.
    final void
    setNextPageText(String nextPageText)
    Sets the value of the nextPageText property.
    final void
    setPage(int page)
    Sets the value of the page property.
    final void
    setPageSize(int pageSize)
    Sets the value of the pageSize property.
    final void
    setPageSizeSelectorLabel(String pageSizeSelectorLabel)
    Sets the value of the pageSizeSelectorLabel property.
    final void
    setPreviousPageText(String previousPageText)
    Sets the value of the previousPageText property.
    final void
    setSameWidthPageButtons(boolean sameWidthPageButtons)
    Sets the value of the sameWidthPageButtons property.
    final void
    setShowPageSizeSelector(boolean showPageSizeSelector)
    Sets the value of the showPageSizeSelector property.
    final void
    setShowPreviousNextPageButton(boolean showPreviousNextPageButton)
    Sets the value of the showPreviousNextPageButton property.
    final void
    setTotalItemCount(int totalItemCount)
    Sets the value of the totalItemCount property.
    final javafx.beans.property.BooleanProperty
    showPageSizeSelectorProperty()
    Determines if the control will show a selector UI for choosing different page sizes.
    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, 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, 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

  • Constructor Details

    • PagingControlBase

      public PagingControlBase()

  • Method Details

    • getPageSizeSelectorLabel

      public final String getPageSizeSelectorLabel()
      Gets the value of the pageSizeSelectorLabel property.
      Property description:
      The text / label shown in front of the page size selector control.
      Returns:
      the value of the pageSizeSelectorLabel property
      See Also:

    • pageSizeSelectorLabelProperty

      public final javafx.beans.property.StringProperty pageSizeSelectorLabelProperty()
      The text / label shown in front of the page size selector control.
      Returns:
      the label property for the page size selector
      See Also:

    • setPageSizeSelectorLabel

      public final void setPageSizeSelectorLabel(String pageSizeSelectorLabel)
      Sets the value of the pageSizeSelectorLabel property.
      Property description:
      The text / label shown in front of the page size selector control.
      Parameters:
      pageSizeSelectorLabel - the value for the pageSizeSelectorLabel property
      See Also:

    • getAvailablePageSizes

      public final javafx.collections.ObservableList<Integer> getAvailablePageSizes()
      Gets the value of the availablePageSizes property.
      Property description:
      A list of available page sizes that will be shown by the page size selector.
      Returns:
      the value of the availablePageSizes property
      See Also:

    • availablePageSizesProperty

      public final javafx.beans.property.ListProperty<Integer> availablePageSizesProperty()
      A list of available page sizes that will be shown by the page size selector.
      Returns:
      a list of available page sizes
      See Also:

    • setAvailablePageSizes

      public final void setAvailablePageSizes(javafx.collections.ObservableList<Integer> availablePageSizes)
      Sets the value of the availablePageSizes property.
      Property description:
      A list of available page sizes that will be shown by the page size selector.
      Parameters:
      availablePageSizes - the value for the availablePageSizes property
      See Also:

    • isShowPageSizeSelector

      public final boolean isShowPageSizeSelector()
      Gets the value of the showPageSizeSelector property.
      Property description:
      Determines if the control will show a selector UI for choosing different page sizes.

      Can be set via CSS using the -fx-show-page-size-selector property. Valid values are: true, false. The default value is true.

      Returns:
      the value of the showPageSizeSelector property
      See Also:

    • showPageSizeSelectorProperty

      public final javafx.beans.property.BooleanProperty showPageSizeSelectorProperty()
      Determines if the control will show a selector UI for choosing different page sizes.

      Can be set via CSS using the -fx-show-page-size-selector property. Valid values are: true, false. The default value is true.

      Returns:
      a flag used to determine if the page size selector should be shown or not
      See Also:

    • setShowPageSizeSelector

      public final void setShowPageSizeSelector(boolean showPageSizeSelector)
      Sets the value of the showPageSizeSelector property.
      Property description:
      Determines if the control will show a selector UI for choosing different page sizes.

      Can be set via CSS using the -fx-show-page-size-selector property. Valid values are: true, false. The default value is true.

      Parameters:
      showPageSizeSelector - the value for the showPageSizeSelector property
      See Also:

    • isSameWidthPageButtons

      public final boolean isSameWidthPageButtons()
      Gets the value of the sameWidthPageButtons property.
      Property description:
      A flag used to signal whether the individual page buttons will all have the same width or if their width can be different based on the page number that they are showing (e.g. the button for page "1" would be substantially less wide than the button for page "999").

      Can be set via CSS using the -fx-same-width-page-buttons property. Valid values are: true, false. The default value is false.

      Returns:
      the value of the sameWidthPageButtons property
      See Also:

    • sameWidthPageButtonsProperty

      public final javafx.beans.property.BooleanProperty sameWidthPageButtonsProperty()
      A flag used to signal whether the individual page buttons will all have the same width or if their width can be different based on the page number that they are showing (e.g. the button for page "1" would be substantially less wide than the button for page "999").

      Can be set via CSS using the -fx-same-width-page-buttons property. Valid values are: true, false. The default value is false.

      Returns:
      a flag to control the width of the page buttons
      See Also:

    • setSameWidthPageButtons

      public final void setSameWidthPageButtons(boolean sameWidthPageButtons)
      Sets the value of the sameWidthPageButtons property.
      Property description:
      A flag used to signal whether the individual page buttons will all have the same width or if their width can be different based on the page number that they are showing (e.g. the button for page "1" would be substantially less wide than the button for page "999").

      Can be set via CSS using the -fx-same-width-page-buttons property. Valid values are: true, false. The default value is false.

      Parameters:
      sameWidthPageButtons - the value for the sameWidthPageButtons property
      See Also:

    • isShowPreviousNextPageButton

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

      Can be set via CSS using the -fx-show-previous-next-page-button property. Valid values are: true, false. The default value is true.

      Returns:
      the value of the showPreviousNextPageButton property
      See Also:

    • 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.

      Can be set via CSS using the -fx-show-previous-next-page-button property. Valid values are: true, false. The default value is true.

      Returns:
      a boolean property to control the visibility of the previous / next buttons
      See Also:

    • setShowPreviousNextPageButton

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

      Can be set via CSS using the -fx-show-previous-next-page-button property. Valid values are: true, false. The default value is true.

      Parameters:
      showPreviousNextPageButton - the value for the showPreviousNextPageButton property
      See Also:

    • getMessageLabelStrategy

      public final PagingControlBase.MessageLabelStrategy getMessageLabelStrategy()
      Gets the value of the messageLabelStrategy property.
      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.

      Can be set via CSS using the -fx-message-label-strategy property. Valid values are: HIDE, SHOW_WHEN_NEEDED, ALWAYS_SHOW. The default value is ALWAYS_SHOW.

      Returns:
      the value of the messageLabelStrategy property
      See Also:

    • messageLabelStrategyProperty

      public final javafx.beans.property.ObjectProperty<PagingControlBase.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.

      Can be set via CSS using the -fx-message-label-strategy property. Valid values are: HIDE, SHOW_WHEN_NEEDED, ALWAYS_SHOW. The default value is ALWAYS_SHOW.

      Returns:
      the strategy used to show or hide the message label
      See Also:

    • setMessageLabelStrategy

      public final void setMessageLabelStrategy(PagingControlBase.MessageLabelStrategy messageLabelStrategy)
      Sets the value of the messageLabelStrategy property.
      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.

      Can be set via CSS using the -fx-message-label-strategy property. Valid values are: HIDE, SHOW_WHEN_NEEDED, ALWAYS_SHOW. The default value is ALWAYS_SHOW.

      Parameters:
      messageLabelStrategy - the value for the messageLabelStrategy property
      See Also:

    • getFirstLastPageDisplayMode

      public final PagingControlBase.FirstLastPageDisplayMode getFirstLastPageDisplayMode()
      Gets the value of the firstLastPageDisplayMode property.
      Property description:
      Controls how first and last page navigation is displayed by the paging control.

      Can be set via CSS using the -fx-first-last-page-display-mode property. Valid values are: HIDE, SHOW_ARROW_BUTTONS, SHOW_PAGE_BUTTONS. The default value is SHOW_PAGE_BUTTONS.

      Returns:
      the value of the firstLastPageDisplayMode property
      See Also:

    • firstLastPageDisplayModeProperty

      public final javafx.beans.property.ObjectProperty<PagingControlBase.FirstLastPageDisplayMode> firstLastPageDisplayModeProperty()
      Controls how first and last page navigation is displayed by the paging control.

      Can be set via CSS using the -fx-first-last-page-display-mode property. Valid values are: HIDE, SHOW_ARROW_BUTTONS, SHOW_PAGE_BUTTONS. The default value is SHOW_PAGE_BUTTONS.

      Returns:
      the display mode for first and last page navigation controls
      See Also:

    • setFirstLastPageDisplayMode

      public final void setFirstLastPageDisplayMode(PagingControlBase.FirstLastPageDisplayMode firstLastPageDisplayMode)
      Sets the value of the firstLastPageDisplayMode property.
      Property description:
      Controls how first and last page navigation is displayed by the paging control.

      Can be set via CSS using the -fx-first-last-page-display-mode property. Valid values are: HIDE, SHOW_ARROW_BUTTONS, SHOW_PAGE_BUTTONS. The default value is SHOW_PAGE_BUTTONS.

      Parameters:
      firstLastPageDisplayMode - the value for the firstLastPageDisplayMode property
      See Also:

    • getFirstPageDivider

      public final javafx.scene.Node getFirstPageDivider()
      Gets the value of the firstPageDivider property.
      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 "...".
      Returns:
      the value of the firstPageDivider property
      See Also:

    • 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 "...".
      Returns:
      a node for separating the "first page" button, usually a label showing "..."
      See Also:

    • setFirstPageDivider

      public final void setFirstPageDivider(javafx.scene.Node firstPageDivider)
      Sets the value of the firstPageDivider property.
      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 "...".
      Parameters:
      firstPageDivider - the value for the firstPageDivider property
      See Also:

    • getLastPageDivider

      public final javafx.scene.Node getLastPageDivider()
      Gets the value of the lastPageDivider property.
      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 "...".
      Returns:
      the value of the lastPageDivider property
      See Also:

    • 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 "...".
      Returns:
      a node for separating the "last page" button, usually a label showing "..."
      See Also:

    • setLastPageDivider

      public final void setLastPageDivider(javafx.scene.Node lastPageDivider)
      Sets the value of the lastPageDivider property.
      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 "...".
      Parameters:
      lastPageDivider - the value for the lastPageDivider property
      See Also:

    • getMessageLabelProvider

      public final javafx.util.Callback<PagingControls, String> getMessageLabelProvider()
      Gets the value of the messageLabelProvider property.
      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".
      Returns:
      the value of the messageLabelProvider property
      See Also:

    • 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".
      Returns:
      the message label provider
      See Also:

    • setMessageLabelProvider

      public final void setMessageLabelProvider(javafx.util.Callback<PagingControls, String> messageLabelProvider)
      Sets the value of the messageLabelProvider property.
      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".
      Parameters:
      messageLabelProvider - the value for the messageLabelProvider property
      See Also:

    • 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 totalItemCount property.
      Property description:
      The total number of items (rows) displayed by the control that utilizes this pagination control for paging.
      Returns:
      the value of the totalItemCount property
      See Also:

    • 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.
      Returns:
      the total number of items in the view
      See Also:

    • setTotalItemCount

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

    • getPageCount

      public final int getPageCount()
      Gets the value of the pageCount property.
      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.
      Returns:
      the value of the pageCount property
      See Also:

    • 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.
      Returns:
      a read-only integer property storing the number of required pages
      See Also:

    • getMaxPageIndicatorsCount

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

      Can be set via CSS using the -fx-max-page-indicators-count property. Valid values are positive integers. The default value is 5.

      Returns:
      the value of the maxPageIndicatorsCount property
      See Also:

    • 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.

      Can be set via CSS using the -fx-max-page-indicators-count property. Valid values are positive integers. The default value is 5.

      Returns:
      the number of page buttons shown by the control
      See Also:

    • setMaxPageIndicatorsCount

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

      Can be set via CSS using the -fx-max-page-indicators-count property. Valid values are positive integers. The default value is 5.

      Parameters:
      maxPageIndicatorsCount - the value for the maxPageIndicatorsCount property
      See Also:

    • getPage

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

    • pageProperty

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

    • setPage

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

    • getPageSize

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

    • 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.
      Returns:
      the number of items per page
      See Also:

    • setPageSize

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

    • getAlignment

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

      Can be set via CSS using the -fx-page-alignment property. Valid values are: LEFT, CENTER, RIGHT. The default value is RIGHT.

      Returns:
      the value of the alignment property
      See Also:

    • 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, or right.

      Can be set via CSS using the -fx-page-alignment property. Valid values are: LEFT, CENTER, RIGHT. The default value is RIGHT.

      Returns:
      the alignment / the position of the paging buttons
      See Also:

    • setAlignment

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

      Can be set via CSS using the -fx-page-alignment property. Valid values are: LEFT, CENTER, RIGHT. The default value is RIGHT.

      Parameters:
      alignment - the value for the alignment property
      See Also:

    • getFirstPageText

      public final String getFirstPageText()
      Gets the value of the firstPageText property.
      Property description:
      The text that will be shown by the "first page" button.
      Returns:
      the value of the firstPageText property
      See Also:

    • firstPageTextProperty

      public final javafx.beans.property.StringProperty firstPageTextProperty()
      The text that will be shown by the "first page" button.
      Returns:
      the text of the "first page" button
      See Also:

    • setFirstPageText

      public final void setFirstPageText(String firstPageText)
      Sets the value of the firstPageText property.
      Property description:
      The text that will be shown by the "first page" button.
      Parameters:
      firstPageText - the value for the firstPageText property
      See Also:

    • getLastPageText

      public final String getLastPageText()
      Gets the value of the lastPageText property.
      Property description:
      The text that will be shown by the "last page" button.
      Returns:
      the value of the lastPageText property
      See Also:

    • lastPageTextProperty

      public final javafx.beans.property.StringProperty lastPageTextProperty()
      The text that will be shown by the "last page" button.
      Returns:
      the text of the "last page" button
      See Also:

    • setLastPageText

      public final void setLastPageText(String lastPageText)
      Sets the value of the lastPageText property.
      Property description:
      The text that will be shown by the "last page" button.
      Parameters:
      lastPageText - the value for the lastPageText property
      See Also:

    • getPreviousPageText

      public final String getPreviousPageText()
      Gets the value of the previousPageText property.
      Property description:
      The text that will be shown by the "previous page" button.
      Returns:
      the value of the previousPageText property
      See Also:

    • previousPageTextProperty

      public final javafx.beans.property.StringProperty previousPageTextProperty()
      The text that will be shown by the "previous page" button.
      Returns:
      the text of the "previous page" button
      See Also:

    • setPreviousPageText

      public final void setPreviousPageText(String previousPageText)
      Sets the value of the previousPageText property.
      Property description:
      The text that will be shown by the "previous page" button.
      Parameters:
      previousPageText - the value for the previousPageText property
      See Also:

    • getNextPageText

      public final String getNextPageText()
      Gets the value of the nextPageText property.
      Property description:
      The text that will be shown by the "next page" button.
      Returns:
      the value of the nextPageText property
      See Also:

    • nextPageTextProperty

      public final javafx.beans.property.StringProperty nextPageTextProperty()
      The text that will be shown by the "next page" button.
      Returns:
      the text of the "next page" button
      See Also:

    • setNextPageText

      public final void setNextPageText(String nextPageText)
      Sets the value of the nextPageText property.
      Property description:
      The text that will be shown by the "next page" button.
      Parameters:
      nextPageText - the value for the nextPageText property
      See Also:

    • getClassCssMetaData

      public static List<javafx.css.CssMetaData<? extends javafx.css.Styleable, ?>> getClassCssMetaData()
      Gets the CssMetaData associated with this class, which may include the CssMetaData of its superclasses.
      Returns:
      the CssMetaData

    • getControlCssMetaData

      public List<javafx.css.CssMetaData<? extends javafx.css.Styleable, ?>> getControlCssMetaData()
      Overrides:
      getControlCssMetaData in class javafx.scene.control.Control