FdcDataSetPagingApi class final
Public paging facade for FdcDataSet.
Keeps page navigation and page state out of the dataset root API while preserving FdcDataSet as the single object owned by application code.
Properties
- enabled → bool
-
True when adapter-driven paging is enabled for the dataset.
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
- hasNextPage → bool
-
True when another page can be requested for the active query.
no setter
- hasPriorPage → bool
-
True when paging is enabled and the active page is not the first page.
no setter
- infiniteLoadThreshold → double
-
Scroll threshold used by infinite paging hosts.
no setter
- isInfinite → bool
-
True when the dataset appends subsequent pages instead of replacing rows.
no setter
- isLoadingNextPage → bool
-
True while an infinite-paging next-page request is in flight.
no setter
- isPaged → bool
-
True when standard page replacement or infinite page loading is enabled.
no setter
- mode → FdcDataPagingMode
-
Active paging mode.
no setter
- pageCount → int?
-
Total page count for the active query, or null when the adapter did not
report a total count.
no setter
- pageIndex → int
-
Zero-based active page index. With infinite paging this is the last
successfully loaded page index.
no setter
- pageOffset → int
-
Zero-based adapter offset for the active page.
no setter
- pageRecordCount → int
-
Number of records represented by the loaded page set. With infinite paging
enabled this is the number of rows currently retained by the dataset.
no setter
- pageSize → int
-
Number of rows requested per page.
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- totalRecordCount → int?
-
Total record count reported by the adapter for the active query, if known.
no setter
Methods
-
firstPage(
) → Future< void> - Loads the first page of the active adapter query.
-
lastPage(
) → Future< void> - Loads the last page when the adapter reported a total count.
-
loadNextPage(
) → Future< void> - Loads the next page in infinite paging mode.
-
nextPage(
) → Future< void> - Loads the page immediately after the active page.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
openPage(
int pageIndex, {int? pageSize, FdcDataLoadRequest request = const FdcDataLoadRequest()}) → Future< void> - Opens an arbitrary page by zero-based index.
-
priorPage(
) → Future< void> - Loads the page immediately before the active page.
-
refreshPage(
{FdcPageRefreshMode mode = FdcPageRefreshMode.keepPage}) → Future< void> -
Reloads paging data using
mode. -
setPageSize(
int pageSize) → Future< void> - Changes the page size and reloads from the first page.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited