PagedLayoutBuilder<PageKeyType, ItemType> class

Facilitates creating infinitely scrolled paged layouts.

Combines a PagingController with a PagedChildBuilderDelegate and calls the supplied loadingListingBuilder, errorListingBuilder or completedListingBuilder for filling in the gaps.

For ordinary cases, this widget shouldn't be used directly. Instead, take a look at PagedSliverList, PagedSliverGrid, PagedListView, PagedGridView, PagedMasonryGridView, or PagedPageView.

Inheritance

Constructors

PagedLayoutBuilder({required PagingController<PageKeyType, ItemType> pagingController, required PagedChildBuilderDelegate<ItemType> builderDelegate, required LoadingListingBuilder loadingListingBuilder, required ErrorListingBuilder errorListingBuilder, required CompletedListingBuilder completedListingBuilder, required PagedLayoutProtocol layoutProtocol, bool shrinkWrapFirstPageIndicators = false, Key? key})
const

Properties

builderDelegate → PagedChildBuilderDelegate<ItemType>
The delegate for building the UI pieces of scrolling paged listings.
final
completedListingBuilder → CompletedListingBuilder
The builder for a completed listing.
final
errorListingBuilder → ErrorListingBuilder
The builder for an in-progress listing with a failed request.
final
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
layoutProtocol → PagedLayoutProtocol
The layout protocol of the widget you're using this to build.
final
loadingListingBuilder → LoadingListingBuilder
The builder for an in-progress listing.
final
pagingController → PagingController<PageKeyType, ItemType>
The controller for paged listings.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
shrinkWrapFirstPageIndicators → bool
Whether the extent of the first page indicators should be determined by the contents being viewed.
final

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<PagedLayoutBuilder<PageKeyType, ItemType>>
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, int wrapWidth = 65}) → 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