PaginationDataView<T> class

An implementation of UpdatableDataView for pagination data, including AppendIndicator, RefreshIndicator, PlaceholderText, Scrollbar and some scroll view, such as ListView, SliverList with CustomScrollView, MasonryGridView, SliverMasonryGrid with CustomScrollView.

Inheritance
Implementers

Constructors

PaginationDataView({Key? key, required List<T> data, required UpdatableDataViewStyle style, required Future<PagedList<T>> getData({required dynamic indicator}), UpdatableDataViewSetting<T> setting = const UpdatableDataViewSetting(), PaginationSetting paginationSetting = const PaginationSetting(), ScrollController? scrollController, required Widget itemBuilder(BuildContext, int, T), UpdatableDataViewExtraWidgets? extra, Widget? separator, bool? useOverlapInjector = false, SliverGridDelegate? gridDelegate, int? crossAxisCount = 2, double? mainAxisSpacing = 0.0, double? crossAxisSpacing = 0.0, Widget customViewBuilder(BuildContext context, PaginationDataView<T> view)?})
Creates a PaginationDataView with given style and all properties.
const
PaginationDataView.customView({Key? key, required List<T> data, required Future<PagedList<T>> getData({required dynamic indicator}), UpdatableDataViewSetting<T> setting = const UpdatableDataViewSetting(), PaginationSetting paginationSetting = const PaginationSetting(), ScrollController? scrollController, required Widget itemBuilder(BuildContext, int, T), UpdatableDataViewExtraWidgets? extra, Widget? separator, bool? useOverlapInjector = false, SliverGridDelegate? gridDelegate, int? crossAxisCount = 2, double? mainAxisSpacing = 0.0, double? crossAxisSpacing = 0.0, required Widget customViewBuilder(BuildContext context, PaginationDataView<T> view)?})
Creates a PaginationDataView with given UpdatableDataViewStyle.customView.
const
PaginationDataView.gridView({Key? key, required List<T> data, required Future<PagedList<T>> getData({required dynamic indicator}), UpdatableDataViewSetting<T> setting = const UpdatableDataViewSetting(), PaginationSetting paginationSetting = const PaginationSetting(), ScrollController? scrollController, required Widget itemBuilder(BuildContext, int, T), UpdatableDataViewExtraWidgets? extra, SliverGridDelegate? gridDelegate})
Creates a PaginationDataView with given UpdatableDataViewStyle.gridView.
const
PaginationDataView.listView({Key? key, required List<T> data, required Future<PagedList<T>> getData({required dynamic indicator}), UpdatableDataViewSetting<T> setting = const UpdatableDataViewSetting(), PaginationSetting paginationSetting = const PaginationSetting(), ScrollController? scrollController, required Widget itemBuilder(BuildContext, int, T), UpdatableDataViewExtraWidgets? extra, Widget? separator})
Creates a PaginationDataView with given UpdatableDataViewStyle.listView.
const
PaginationDataView.masonryGridView({Key? key, required List<T> data, required Future<PagedList<T>> getData({required dynamic indicator}), UpdatableDataViewSetting<T> setting = const UpdatableDataViewSetting(), PaginationSetting paginationSetting = const PaginationSetting(), ScrollController? scrollController, required Widget itemBuilder(BuildContext, int, T), UpdatableDataViewExtraWidgets? extra, int? crossAxisCount = 2, double? mainAxisSpacing = 0.0, double? crossAxisSpacing = 0.0})
Creates a PaginationDataView with given UpdatableDataViewStyle.masonryGridView.
const
PaginationDataView.sliverGridView({Key? key, required List<T> data, required Future<PagedList<T>> getData({required dynamic indicator}), UpdatableDataViewSetting<T> setting = const UpdatableDataViewSetting(), PaginationSetting paginationSetting = const PaginationSetting(), ScrollController? scrollController, required Widget itemBuilder(BuildContext, int, T), UpdatableDataViewExtraWidgets? extra, bool? useOverlapInjector = false, SliverGridDelegate? gridDelegate})
Creates a PaginationDataView with given UpdatableDataViewStyle.sliverGridView.
const
PaginationDataView.sliverListView({Key? key, required List<T> data, required Future<PagedList<T>> getData({required dynamic indicator}), UpdatableDataViewSetting<T> setting = const UpdatableDataViewSetting(), PaginationSetting paginationSetting = const PaginationSetting(), ScrollController? scrollController, required Widget itemBuilder(BuildContext, int, T), UpdatableDataViewExtraWidgets? extra, Widget? separator, bool? useOverlapInjector = false})
Creates a PaginationDataView with given UpdatableDataViewStyle.sliverListView.
const
PaginationDataView.sliverMasonryGridView({Key? key, required List<T> data, required Future<PagedList<T>> getData({required dynamic indicator}), UpdatableDataViewSetting<T> setting = const UpdatableDataViewSetting(), PaginationSetting paginationSetting = const PaginationSetting(), ScrollController? scrollController, required Widget itemBuilder(BuildContext, int, T), UpdatableDataViewExtraWidgets? extra, bool? useOverlapInjector = false, int? crossAxisCount = 2, double? mainAxisSpacing = 0.0, double? crossAxisSpacing = 0.0})
Creates a PaginationDataView with given UpdatableDataViewStyle.sliverMasonryGridView.
const

Properties

crossAxisCount → int?
The crossAxisCount for MasonryGridView and SliverMasonryGrid, defaults to 2.
final
crossAxisSpacing → double?
The crossAxisSpacing for MasonryGridView and SliverMasonryGrid, defaults to 0.0.
final
customViewBuilder → (Widget Function(BuildContext context, PaginationDataView<T> view)?)
The customViewBuilder for UpdatableDataViewStyle.customView.
final
data → List<T>
The list of data.
final
extra → UpdatableDataViewExtraWidgets?
The extra widgets around ScrollView.
final
getData → Future<PagedList<T>> Function({required dynamic indicator})
The function to get list data with pagination.
final
gridDelegate → SliverGridDelegate?
The gridDelegate for GridView and SliverGrid, defaults to SliverGridDelegateWithFixedCrossAxisCount(crossAxisCount: 2).
final
hashCode → int
The hash code for this object.
no setterinherited
itemBuilder → Widget Function(BuildContext, int, T)
The itemBuilder for ScrollView.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
mainAxisSpacing → double?
The mainAxisSpacing for MasonryGridView and SliverMasonryGrid, defaults to 0.0.
final
paginationSetting → PaginationSetting
The pagination setting.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scrollController → ScrollController?
The controller for ScrollView.
final
separator → Widget?
The separator for ListView and SliverList.
final
setting → UpdatableDataViewSetting<T>
The display and behavior setting.
final
style → UpdatableDataViewStyle
The data display style.
final
useOverlapInjector → bool?
The switcher to use SliverOverlapInjector in the top of sliver widgets, defaults to false.
final

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → PaginationDataViewState<T>
Creates the mutable state for this widget at a given location in the tree.
override
debugDescribeChildren() → List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String
A string representation of this object.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a one-line detailed description of the object.
inherited
toStringShort() → String
A short, textual description of this widget.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited