A base class for widgets that display one page at a time.
Pageable widgets are similar to Scrollable except that they display a single child at a time. When being scrolled, they can display adjacent pages, but when the user stops scrolling, they settle their scroll offset to a value that shows a single page.
Pageable uses different units for its scroll offset than Scrollable. One unit of scroll offset corresponds to one child widget, which means a scroll offset of 2.75 indicates that the viewport is three quarters of the way between the child with index 2 and the child with index 3.
Widgets that subclass Pageable typically use state objects that subclass PageableState.
See also:
- PageableList, which pages through an iterable list of children.
- PageableLazyList, which pages through a lazily constructed list of children.
- Inheritance
- Object
- Widget
- StatefulWidget
- Scrollable
- Pageable
Constructors
- Pageable({Key key, double initialScrollOffset, Axis scrollDirection: Axis.vertical, ViewportAnchor scrollAnchor: ViewportAnchor.start, ScrollListener onScrollStart, ScrollListener onScroll, ScrollListener onScrollEnd, SnapOffsetCallback snapOffsetCallback, bool itemsWrap: false, PageableListFlingBehavior itemsSnapAlignment: PageableListFlingBehavior.stopAtNextPage, ValueChanged<int> onPageChanged, Duration duration: const Duration(milliseconds: 200), Curve curve: Curves.ease })
-
Initializes fields for subclasses.
Properties
- curve → Curve
-
The animation curve to use when animating to a given page.
read-only - duration → Duration
-
The duration used when animating to a given page.
read-only - itemCount → int
-
The number of items, one per page, to display.
read-only - itemsSnapAlignment → PageableListFlingBehavior
-
Controls whether a fling always reveals the adjacent item or whether flings can traverse many items.
read-only - itemsWrap → bool
-
Whether the first item should be revealed after scrolling past the last item.
read-only - onPageChanged → ValueChanged<int>
-
Called when the currently visible page changes.
read-only - builder → ScrollBuilder
-
Using to build the content of this widget.
read-only, inherited - hashCode → int
-
Get a hash code for this object.
read-only, inherited - initialScrollOffset → double
-
The scroll offset this widget should use when first created.
read-only, inherited - key → Key
-
Controls how one widget replaces another widget in the tree.
read-only, inherited - onScroll → ScrollListener
-
Called whenever this widget's scroll offset changes.
read-only, inherited - onScrollEnd → ScrollListener
-
Called whenever this widget stops scrolling.
read-only, inherited - onScrollStart → ScrollListener
-
Called whenever this widget starts to scroll.
read-only, inherited - runtimeType → Type
-
A representation of the runtime type of the object.
read-only, inherited - scrollAnchor → ViewportAnchor
-
Whether to place first child at the start of the container or the last child at the end of the container, when the scrollable has not been scrolled and has no initial scroll offset.
read-only, inherited - scrollDirection → Axis
-
The axis along which this widget should scroll.
read-only, inherited - snapOffsetCallback → SnapOffsetCallback
-
Called to determine the offset to which scrolling should snap, when handling a fling.
read-only, inherited
Operators
-
operator ==(
other) → bool -
The equality operator.
inherited
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited -
createState(
) → ScrollableState -
Creates the mutable state for this widget at a given location in the tree.
inherited -
debugFillDescription(
List<String> description) → void -
Add additional information to the given description for use by toString.
inherited -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a non-existent method or property is accessed.
inherited -
toString(
) → String -
Returns a string representation of this object.
inherited -
toStringShort(
) → String -
A short, textual description of this widget.
inherited