GemsFX 3.10.1 · com.dlsc.gemsfx.paging.ItemPagingControlBase

Modifier and Type	Field and Description
private final LongProperty	commitLoadStatusDelay
private final BooleanProperty	fillLastPage
private final ObservableList<T>	itemsOnCurrentPage
private final LongProperty	loadDelayInMillis
private final ObjectProperty<Callback<PagingLoadRequest, PagingLoadResponse<T>>>	loader
private final ObjectProperty<LoadingService<T>>	loadingService
private final ObjectProperty<LoadingPane.Status>	loadingStatus
private final ObjectProperty<Consumer<T>>	onOpenItem
private final ObjectProperty<Side>	pagingControlsLocation
private ObjectProperty<Node>	placeholder
private boolean	processingService
private final ObjectProperty<MultipleSelectionModel<T>>	selectionModel
private final BooleanProperty	showPagingControls
private final BooleanProperty	usingScrollPane

Access	Constructor and Description
protected	ItemPagingControlBase() Constructs an instance of ItemPagingControlBase and initializes the paging and loading service behavior.

Method Summary

Modifier and Type	Method and Description
public final LongProperty	Returns: the commit delay for the nested loading pane commitLoadStatusDelayProperty() The delay in milliseconds before the list view will display the progress indicator for long-running load operations.
public final BooleanProperty	Returns: a flag used to control whether the last page will be filled with empty cells if needed fillLastPageProperty() The control might not have enough data to fill its last page with items / cells.
public final long	getCommitLoadStatusDelay()
public final ObservableList<T>	Returns: the currently shown items getItemsOnCurrentPage() Returns an observable list with the items shown by the current page.
public final long	getLoadDelayInMillis()
public final Callback<PagingLoadRequest, PagingLoadResponse<T>>	getLoader()
public final LoadingService<T>	getLoadingService()
public final LoadingPane.Status	getLoadingStatus()
public final Consumer<T>	getOnOpenItem()
public final Side	getPagingControlsLocation()
public final Node	getPlaceholder()
public final MultipleSelectionModel<T>	Returns: the currently installed selection model getSelectionModel() Returns the currently installed selection model.
public final boolean	isFillLastPage()
public final boolean	isShowPagingControls()
public final boolean	isUsingScrollPane()
public final LongProperty	Returns: the delay before data will actually be loaded loadDelayInMillisProperty() The delay in milliseconds before the loading service will actually try to retrieve the data from (for example) a backend.
public final ObjectProperty<Callback<PagingLoadRequest, PagingLoadResponse<T>>>	Returns: the loader property loaderProperty() Provides access to the loader property, which is a callback used to handle loading of paginated data.
public final ObjectProperty<LoadingService<T>>	Returns: the loading service loadingServiceProperty() Returns the service responsible for executing the actual loading of the data on a background thread.
public final ObjectProperty<LoadingPane.Status>	Returns: the loading status loadingStatusProperty() The loading status used for the wrapped `LoadingPane`.
public final ObjectProperty<Consumer<T>>	Returns: a callback for opening table items onOpenItemProperty() A callback for opening an item represented by a row in the table view.
public final ObjectProperty<Side>	Returns: the location where the paging controls will be shown pagingControlsLocationProperty() Controls on which side the paging controls should be located.
public final ObjectProperty<Node>	placeholderProperty() The `Node` to show to the user when the `PagingListView` has no content to show.
private void	processService(LoadingService<T> service)
public abstract void	refresh() Triggers an explicit refresh of the control.
public final void	reload() Triggers an explicit reload of the list view.
public final ObjectProperty<MultipleSelectionModel<T>>	Returns: the selectionModel property selectionModelProperty() The SelectionModel provides the API through which it is possible to select single or multiple items within a ListView, as well as inspect which items have been selected by the user.
public final void	setCommitLoadStatusDelay(long commitLoadStatusDelay)
public final void	setFillLastPage(boolean fillLastPage)
public final void	setLoadDelayInMillis(long loadDelayInMillis)
public final void	setLoader(Callback<PagingLoadRequest, PagingLoadResponse<T>> loader)
public final void	setLoadingService(LoadingService<T> loadingService)
public final void	setLoadingStatus(LoadingPane.Status loadingStatus)
public final void	setOnOpenItem(Consumer<T> onOpenItem)
public final void	setPagingControlsLocation(Side pagingControlsLocation)
public final void	setPlaceholder(Node value)
public final void	setSelectionModel(MultipleSelectionModel<T> the MultipleSelectionModel to be used in this ListView value) Sets the `MultipleSelectionModel` to be used in the ListView.
public final void	setShowPagingControls(boolean showPagingControls)
public final void	setUsingScrollPane(boolean usingScrollPane)
public final BooleanProperty	Returns: a property that is true if the paging controls should be visible showPagingControlsProperty() A flag used to control the visibility of the paging controls (page buttons, previous, next, etc...).
public final BooleanProperty	usingScrollPaneProperty()

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

commitLoadStatusDelay	back to summary
private final LongProperty commitLoadStatusDelay

fillLastPage	back to summary
private final BooleanProperty fillLastPage

itemsOnCurrentPage	back to summary
private final ObservableList<T> itemsOnCurrentPage

loadDelayInMillis	back to summary
private final LongProperty loadDelayInMillis

loader	back to summary
private final ObjectProperty<Callback<PagingLoadRequest, PagingLoadResponse<T>>> loader

loadingService	back to summary
private final ObjectProperty<LoadingService<T>> loadingService

loadingStatus	back to summary
private final ObjectProperty<LoadingPane.Status> loadingStatus

onOpenItem	back to summary
private final ObjectProperty<Consumer<T>> onOpenItem

pagingControlsLocation	back to summary
private final ObjectProperty<Side> pagingControlsLocation

placeholder	back to summary
private ObjectProperty<Node> placeholder

processingService	back to summary
private boolean processingService

selectionModel	back to summary
private final ObjectProperty<MultipleSelectionModel<T>> selectionModel

showPagingControls	back to summary
private final BooleanProperty showPagingControls

usingScrollPane	back to summary
private final BooleanProperty usingScrollPane

ItemPagingControlBase	back to summary
protected ItemPagingControlBase() Constructs an instance of ItemPagingControlBase and initializes the paging and loading service behavior. This constructor sets up listeners and bindings for various properties to control the behavior of the pagination mechanism and the underlying loading service. Specifically: Automatically unbinds and resets the state of the previous loading service when a new one is set. Binds the new loading service's properties such as page, page size, load delay, and loader to their corresponding properties in this control. Updates the loading status based on the state of the new loading service. Sets up listeners for reloading or refreshing the data whenever relevant properties, such as page or page size, are changed. Adds validation for certain operations, ensuring that invalid configurations such as negative load delays or unsupported paging control locations throw exceptions with descriptive error messages. Additionally, the constructor initializes the loading service with a default `LoadingService`, applies delay validation, and specifies constraints for the paging controls' location.

Method Detail

commitLoadStatusDelayProperty back to summary

commitLoadStatusDelayProperty	back to summary
public final LongProperty commitLoadStatusDelayProperty() The delay in milliseconds before the list view will display the progress indicator for long-running load operations. Returns:LongProperty the commit delay for the nested loading pane See Also `LoadingPane#commitDelayProperty()`

public final LongProperty commitLoadStatusDelayProperty()

The delay in milliseconds before the list view will display the progress indicator for long-running load operations.

Returns:LongProperty: the commit delay for the nested loading pane
See Also: LoadingPane#commitDelayProperty()

fillLastPageProperty	back to summary
public final BooleanProperty fillLastPageProperty() The control might not have enough data to fill its last page with items / cells. This flag can be used to control whether we want the control to become smaller because of missing items or if we want the view to fill the page with empty cells. Returns:BooleanProperty a flag used to control whether the last page will be filled with empty cells if needed

fillLastPageProperty

back to summary

public final BooleanProperty fillLastPageProperty()

The control might not have enough data to fill its last page with items / cells. This flag can be used to control whether we want the control to become smaller because of missing items or if we want the view to fill the page with empty cells.

Returns:BooleanProperty: a flag used to control whether the last page will be filled with empty cells if needed

getCommitLoadStatusDelay	back to summary
public final long getCommitLoadStatusDelay()

getItemsOnCurrentPage	back to summary
public final ObservableList<T> getItemsOnCurrentPage() Returns an observable list with the items shown by the current page. Returns:ObservableList<T> the currently shown items

getItemsOnCurrentPage

back to summary

public final ObservableList<T> getItemsOnCurrentPage()

Returns an observable list with the items shown by the current page.

Returns:ObservableList<T>: the currently shown items

getLoadDelayInMillis	back to summary
public final long getLoadDelayInMillis()

getLoader	back to summary
public final Callback<PagingLoadRequest, PagingLoadResponse<T>> getLoader()

getLoadingService	back to summary
public final LoadingService<T> getLoadingService()

getLoadingStatus	back to summary
public final LoadingPane.Status getLoadingStatus()

getOnOpenItem	back to summary
public final Consumer<T> getOnOpenItem()

getPagingControlsLocation	back to summary
public final Side getPagingControlsLocation()

getPlaceholder	back to summary
public final Node getPlaceholder()

getSelectionModel	back to summary
public final MultipleSelectionModel<T> getSelectionModel() Returns the currently installed selection model. Returns:MultipleSelectionModel<T> the currently installed selection model

getSelectionModel

back to summary

public final MultipleSelectionModel<T> getSelectionModel()

Returns the currently installed selection model.

Returns:MultipleSelectionModel<T>: the currently installed selection model

isFillLastPage	back to summary
public final boolean isFillLastPage()

isShowPagingControls	back to summary
public final boolean isShowPagingControls()

isUsingScrollPane	back to summary
public final boolean isUsingScrollPane()

loadDelayInMillisProperty	back to summary
public final LongProperty loadDelayInMillisProperty() The delay in milliseconds before the loading service will actually try to retrieve the data from (for example) a backend. This delay is around a few hundred milliseconds by default. Delaying the loading has the advantage that sudden property changes will not trigger multiple backend queries but will get batched together in a single reload operation. Returns:LongProperty the delay before data will actually be loaded

loadDelayInMillisProperty

back to summary

public final LongProperty loadDelayInMillisProperty()

The delay in milliseconds before the loading service will actually try to retrieve the data from (for example) a backend. This delay is around a few hundred milliseconds by default. Delaying the loading has the advantage that sudden property changes will not trigger multiple backend queries but will get batched together in a single reload operation.

Returns:LongProperty: the delay before data will actually be loaded

loaderProperty back to summary

loaderProperty	back to summary
public final ObjectProperty<Callback<PagingLoadRequest, PagingLoadResponse<T>>> loaderProperty() Provides access to the loader property, which is a callback used to handle loading of paginated data. The callback is responsible for processing `PagingLoadRequest` and returning the corresponding `PagingLoadResponse`. Returns:ObjectProperty<Callback<PagingLoadRequest, PagingLoadResponse<T>>> the loader property

public final ObjectProperty<Callback<PagingLoadRequest, PagingLoadResponse<T>>> loaderProperty()

Provides access to the loader property, which is a callback used to handle loading of paginated data. The callback is responsible for processing PagingLoadRequest and returning the corresponding PagingLoadResponse.

Returns:ObjectProperty<Callback<PagingLoadRequest, PagingLoadResponse<T>>>: the loader property

loadingServiceProperty	back to summary
public final ObjectProperty<LoadingService<T>> loadingServiceProperty() Returns the service responsible for executing the actual loading of the data on a background thread. Returns:ObjectProperty<LoadingService<T>> the loading service

loadingServiceProperty

back to summary

public final ObjectProperty<LoadingService<T>> loadingServiceProperty()

Returns the service responsible for executing the actual loading of the data on a background thread.

Returns:ObjectProperty<LoadingService<T>>: the loading service

loadingStatusProperty back to summary

loadingStatusProperty	back to summary
public final ObjectProperty<LoadingPane.Status> loadingStatusProperty() The loading status used for the wrapped `LoadingPane`. The loading pane will appear if the loader takes a long time to return the new page items. Returns:ObjectProperty<LoadingPane.Status> the loading status

public final ObjectProperty<LoadingPane.Status> loadingStatusProperty()

The loading status used for the wrapped LoadingPane. The loading pane will appear if the loader takes a long time to return the new page items.

Returns:ObjectProperty<LoadingPane.Status>: the loading status

onOpenItemProperty	back to summary
public final ObjectProperty<Consumer<T>> onOpenItemProperty() A callback for opening an item represented by a row in the table view. Returns:ObjectProperty<Consumer<T>> a callback for opening table items

onOpenItemProperty

back to summary

public final ObjectProperty<Consumer<T>> onOpenItemProperty()

A callback for opening an item represented by a row in the table view.

Returns:ObjectProperty<Consumer<T>>: a callback for opening table items

pagingControlsLocationProperty back to summary

pagingControlsLocationProperty	back to summary
public final ObjectProperty<Side> pagingControlsLocationProperty() Controls on which side the paging controls should be located. Currently only `Side#TOP` and `Side#BOTTOM` are supported. Returns:ObjectProperty<Side> the location where the paging controls will be shown

public final ObjectProperty<Side> pagingControlsLocationProperty()

Controls on which side the paging controls should be located. Currently only Side#TOP and Side#BOTTOM are supported.

Returns:ObjectProperty<Side>: the location where the paging controls will be shown

placeholderProperty	back to summary
public final ObjectProperty<Node> placeholderProperty() The `Node` to show to the user when the `PagingListView` has no content to show. This happens when the list model has no data or when a filter has been applied to the list model, resulting in there being nothing to show the user.

processService	back to summary
private void processService(LoadingService<T> service)

refresh	back to summary
public abstract void refresh() Triggers an explicit refresh of the control. Refreshing the view does not trigger data loading.

reload	back to summary
public final void reload() Triggers an explicit reload of the list view.

selectionModelProperty	back to summary
public final ObjectProperty<MultipleSelectionModel<T>> selectionModelProperty() The SelectionModel provides the API through which it is possible to select single or multiple items within a ListView, as well as inspect which items have been selected by the user. Note that it has a generic type that must match the type of the ListView itself. Returns:ObjectProperty<MultipleSelectionModel<T>> the selectionModel property

selectionModelProperty

back to summary

public final ObjectProperty<MultipleSelectionModel<T>> selectionModelProperty()

The SelectionModel provides the API through which it is possible to select single or multiple items within a ListView, as well as inspect which items have been selected by the user. Note that it has a generic type that must match the type of the ListView itself.

Returns:ObjectProperty<MultipleSelectionModel<T>>: the selectionModel property

setCommitLoadStatusDelay	back to summary
public final void setCommitLoadStatusDelay(long commitLoadStatusDelay)

setFillLastPage	back to summary
public final void setFillLastPage(boolean fillLastPage)

setLoadDelayInMillis	back to summary
public final void setLoadDelayInMillis(long loadDelayInMillis)

setLoader	back to summary
public final void setLoader(Callback<PagingLoadRequest, PagingLoadResponse<T>> loader)

setLoadingService	back to summary
public final void setLoadingService(LoadingService<T> loadingService)

setLoadingStatus	back to summary
public final void setLoadingStatus(LoadingPane.Status loadingStatus)

setOnOpenItem	back to summary
public final void setOnOpenItem(Consumer<T> onOpenItem)

setPagingControlsLocation	back to summary
public final void setPagingControlsLocation(Side pagingControlsLocation)

setPlaceholder	back to summary
public final void setPlaceholder(Node value)

setSelectionModel back to summary

public final void setSelectionModel(MultipleSelectionModel<T> value)

Sets the MultipleSelectionModel to be used in the ListView. Despite a ListView requiring a MultipleSelectionModel, it is possible to configure it to only allow single selection (see MultipleSelectionModel#setSelectionMode(javafx.scene.control.SelectionMode) for more information).

Parameters

value:MultipleSelectionModel<T>: the MultipleSelectionModel to be used in this ListView

setShowPagingControls	back to summary
public final void setShowPagingControls(boolean showPagingControls)

setUsingScrollPane	back to summary
public final void setUsingScrollPane(boolean usingScrollPane)

showPagingControlsProperty

back to summary

public final BooleanProperty showPagingControlsProperty()

A flag used to control the visibility of the paging controls (page buttons, previous, next, etc...).

Returns:BooleanProperty: a property that is true if the paging controls should be visible

usingScrollPaneProperty	back to summary
public final BooleanProperty usingScrollPaneProperty()

public abstract Class ItemPagingControlBase<T>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail