State for a PageableList widget.
Widgets that subclass PageableList can subclass this class to have sensible default behaviors for pageable lists.
- Inheritance
- Object
- State<T>
- ScrollableState<T>
- PageableState<T>
- PageableListState
Constructors
Properties
- config → T
-
The current configuration.
read-only, inherited - context → BuildContext
-
The location in the tree where this widget builds.
read-only, inherited - hashCode → int
-
Get a hash code for this object.
read-only, inherited - mounted → bool
-
Whether this
Stateobject is currently in a tree.read-only, inherited - pixelsPerScrollUnit → double
-
Convert from the item based scroll units to logical pixels.
read-only, inherited - platform → TargetPlatform
-
Returns the style of scrolling to use.
read-only, inherited - runtimeType → Type
-
A representation of the runtime type of the object.
read-only, inherited - scrollBehavior → ExtentScrollBehavior
-
read-only, inherited
- scrollOffset → double
-
The current scroll offset.
read-only, inherited - shouldSnapScrollOffset → bool
-
read-only, inherited
- virtualScrollOffset → double
-
The current scroll offset, irrespective of the constraints defined by any
ClampOverscrollswidget ancestors.read-only, inherited
Operators
-
operator ==(
other) → bool -
The equality operator.
inherited
Methods
-
buildContent(
BuildContext context) → Widget -
Calls the widget's
builderby default. -
build(
BuildContext context) → Widget -
Describes the part of the user interface represented by this widget.
inherited -
buildGestureDetectors(
) → Map<Type, GestureRecognizerFactory> -
Return the gesture detectors, in the form expected by RawGestureDetector.gestures and RawGestureDetectorState.replaceGestureRecognizers, that are applicable to this Scrollable in its current state.
inherited -
createScrollBehavior(
) → ExtentScrollBehavior -
Use the value returned by
ScrollConfiguration.createScrollBehavior. If this widget doesn't have a ScrollConfiguration ancestor, or its createScrollBehavior callback is null, then return a new instance ofOverscrollWhenScrollableBehavior.inherited -
createTicker(
TickerCallback onTick) → Ticker -
Creates a ticker with the given callback.
inherited -
deactivate(
) → void -
Called when this object is removed from the tree.
inherited -
debugFillDescription(
List<String> description) → void -
Add additional information to the given description for use by
toString.inherited -
dependenciesChanged(
) → void -
Called when a dependency of this
Stateobject changes.inherited -
didUpdateConfig(
Pageable oldConfig) → void -
Called whenever the configuration changes.
inherited -
didUpdateScrollBehavior(
double newScrollOffset) → void -
Update any in-progress scrolling physics to account for new scroll behavior.
inherited -
dispatchOnScroll(
) → void -
Calls the onScroll callback.
inherited -
dispatchOnScrollEnd(
) → void -
Calls the dispatchOnScrollEnd callback.
inherited -
dispatchOnScrollStart(
) → void -
Calls the onScrollStart callback.
inherited -
dispose(
) → void -
Called when this object is removed from the tree permanently.
inherited -
fling(
double scrollVelocity) → Future<Null> -
If
scrollVelocityis greater thanPixelScrollTolerance.velocitythen fling the scroll offset with the given velocity in logical pixels/second. Otherwise, if this scrollable is overscrolled or asnapOffsetCallbackwas given, animate the scroll offset to its final value withsettleScrollOffset.inherited -
handleExtentsChanged(
double contentExtent, double containerExtent) → void -
Updates the scroll behavior for the new content and container extent.
inherited -
initState(
) → void -
Called when this object is inserted into the tree.
inherited -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a non-existent method or property is accessed.
inherited -
pixelDeltaToScrollOffset(
Offset pixelDelta) → double -
Returns the scroll offset component of the given pixel delta, accounting for the scroll direction and scroll anchor.
inherited -
pixelOffsetToScrollOffset(
double pixelOffset) → double -
Convert a position or velocity measured in terms of pixels to a scrollOffset. Scrollable gesture handlers convert their incoming values with this method. Subclasses that define scrollOffset in units other than pixels must override this method.
inherited -
reassemble(
) → void -
Called whenever the application is reassembled during debugging.
inherited -
scrollBy(
double scrollDelta, { Duration duration, Curve curve: Curves.ease, DragUpdateDetails details }) → Future<Null> -
Scroll this widget by the given scroll delta.
inherited -
scrollOffsetToPixelDelta(
double scrollOffset) → Offset -
Returns a two-dimensional representation of the scroll offset, accounting for the scroll direction and scroll anchor.
inherited -
scrollOffsetToPixelOffset(
double scrollOffset) → double -
Convert a scrollOffset value to the number of pixels to which it corresponds.
inherited -
scrollTo(
double newScrollOffset, { Duration duration, Curve curve: Curves.ease, DragUpdateDetails details }) → Future<Null> -
Scroll this widget to the given scroll offset.
inherited -
setState(
VoidCallback fn) → void -
Notify the framework that the internal state of this object has changed.
inherited -
settleScrollOffset(
) → Future<Null> -
Animate the scroll offset to a value with a local minima of energy.
inherited -
snapScrollOffset(
double newScrollOffset) → double -
Returns the snapped offset closest to the given scroll offset.
inherited -
toString(
) → String -
Returns a string representation of this object.
inherited -
updateGestureDetector(
) → void -
Fixes up the gesture detector to listen to the appropriate gestures based on the current information about the layout.
inherited