PreloadPageView class
A scrollable list that works page by page.
Each child of a page view is forced to be the same size as the viewport.
You can use a PreloadPageController to control which page is visible in the view. In addition to being able to control the pixel offset of the content inside the PreloadPageView, a PreloadPageController also lets you control the offset in terms of pages, which are increments of the viewport size.
The PreloadPageController can also be used to control the PreloadPageController.initialPage, which determines which page is shown when the PreloadPageView is first constructed, and the PreloadPageController.viewportFraction, which determines the size of the pages as a fraction of the viewport size.
See also:
- PreloadPageController, which controls which page is visible in the view.
- SingleChildScrollView, when you need to make a single child scrollable.
- ListView, for a scrollable list of boxes.
- GridView, for a scrollable grid of boxes.
- ScrollNotification and NotificationListener, which can be used to watch the scroll position without using a ScrollController.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- PreloadPageView
Constructors
-
PreloadPageView({Key? key, Axis scrollDirection = Axis.horizontal, bool reverse = false, PreloadPageController? controller, ScrollPhysics? physics, bool pageSnapping = true, ValueChanged<
int> ? onPageChanged, List<Widget> children = const <Widget>[], int preloadPagesCount = 1}) - Creates a scrollable list that works page by page from an explicit List of widgets.
-
PreloadPageView.builder({Key? key, Axis scrollDirection = Axis.horizontal, bool reverse = false, PreloadPageController? controller, ScrollPhysics? physics, bool pageSnapping = true, ValueChanged<
int> ? onPageChanged, required IndexedWidgetBuilder itemBuilder, int? itemCount, int preloadPagesCount = 1}) - Creates a scrollable list that works page by page using widgets that are created on demand.
-
PreloadPageView.custom({Key? key, Axis scrollDirection = Axis.horizontal, bool reverse = false, PreloadPageController? controller, ScrollPhysics? physics, bool pageSnapping = true, ValueChanged<
int> ? onPageChanged, required SliverChildDelegate childrenDelegate, int preloadPagesCount = 1}) - Creates a scrollable list that works page by page with a custom child model.
Properties
- childrenDelegate → SliverChildDelegate
-
A delegate that provides the children for the PreloadPageView.
final
- controller → PreloadPageController
-
An object that can be used to control the position to which this page
view is scrolled.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
-
onPageChanged
→ ValueChanged<
int> ? -
Called whenever the page in the center of the viewport changes.
final
- pageSnapping → bool
-
Set to false to disable page snapping, useful for custom scroll behavior.
final
- physics → ScrollPhysics?
-
How the page view should respond to user input.
final
- preloadPagesCount → int
-
An integer value that determines number pages that will be preloaded.
final
- reverse → bool
-
Whether the page view scrolls in the reading direction.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- scrollDirection → Axis
-
The axis along which the page view scrolls.
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → _PreloadPageViewState -
Creates the mutable state for this widget at a given location in the tree.
override
-
debugDescribeChildren(
) → List< DiagnosticsNode> -
Returns a list of
DiagnosticsNodeobjects 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