ScrollableState class Null safety

State object for a Scrollable widget.

To manipulate a Scrollable widget's scroll position, use the object obtained from the position property.

To be informed of when a Scrollable widget is scrolling, use a NotificationListener to listen for ScrollNotification notifications.

This class is not intended to be subclassed. To specialize the behavior of a Scrollable, provide it with a ScrollPhysics.

Inheritance
Implemented types
Mixed in types

Constructors

ScrollableState()

Properties

axisDirection → AxisDirection
The direction in which the widget scrolls.
read-onlyoverride
bucket → RestorationBucket?
The RestorationBucket used for the restoration data of the RestorablePropertys registered to this mixin.
read-onlyinherited
context → BuildContext
The location in the tree where this widget builds.
read-onlyinherited
hashCode → int
The hash code for this object.
read-onlyinherited
mounted → bool
Whether this State object is currently in a tree.
read-onlyinherited
notificationContext → BuildContext?
The BuildContext that should be used when dispatching ScrollNotifications.
read-onlyoverride
position → ScrollPosition
The manager for this Scrollable widget's viewport position.
read-only
restorationId → String?
The restoration ID used for the RestorationBucket in which the mixin will store the restoration data of all registered properties.
read-onlyoverride
restorePending → bool
Whether restoreState will be called at the beginning of the next build phase.
read-onlyinherited
runtimeType → Type
A representation of the runtime type of the object.
read-onlyinherited
storageContext → BuildContext
The BuildContext that should be used when searching for a PageStorage.
read-onlyoverride
vsync → TickerProvider
A TickerProvider to use when animating the scroll position.
read-onlyoverride
widget → Scrollable
The current configuration.
read-onlyinherited

Methods

activate() → void
Called when this object is reinserted into the tree after having been removed via deactivate.
inherited
build(BuildContext context) → Widget
Describes the part of the user interface represented by this widget.
override
createTicker(TickerCallback onTick) → Ticker
Creates a ticker with the given callback.
inherited
deactivate() → void
Called when this object is removed from the tree.
mustCallSuper">@mustCallSuperprotected">@protectedinherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
override
didChangeDependencies() → void
Called when a dependency of this State object changes.
override
didToggleBucket(RestorationBucket? oldBucket) → void
Called when bucket switches between null and non-null values.
mustCallSuper">@mustCallSuperprotected">@protectedinherited
didUpdateRestorationId() → void
Must be called when the value returned by restorationId changes.
protected">@protectedinherited
didUpdateWidget(covariant Scrollable oldWidget) → void
Called whenever the widget configuration changes.
override
dispose() → void
Called when this object is removed from the tree permanently.
override
initState() → void
Called when this object is inserted into the tree.
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed.
inherited
reassemble() → void
Called whenever the application is reassembled during debugging, for example during hot reload.
mustCallSuper">@mustCallSuperprotected">@protectedinherited
registerForRestoration(RestorableProperty<Object?> property, String restorationId) → void
Registers a RestorableProperty for state restoration.
protected">@protectedinherited
restoreState(RestorationBucket? oldBucket, bool initialRestore) → void
Called to initialize or restore the RestorablePropertys used by the State object.
override
saveOffset(double offset) → void
Called by the ScrollPosition whenever scrolling ends to persist the provided scroll offset for state restoration purposes.
override
setCanDrag(bool value) → void
Whether the user can drag the widget, for example to initiate a scroll.
protected">@protectedoverride
setIgnorePointer(bool value) → void
Whether the contents of the widget should ignore PointerEvent inputs.
protected">@protectedoverride
setSemanticsActions(Set<SemanticsAction> actions) → void
Set the SemanticsActions that should be expose to the semantics tree.
protected">@protectedoverride
setState(VoidCallback fn) → void
Notify the framework that the internal state of this object has changed.
protected">@protectedinherited
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
toStringShort() → String
A brief description of this object, usually just the runtimeType and the hashCode.
inherited
unregisterFromRestoration(RestorableProperty<Object?> property) → void
Unregisters a RestorableProperty from state restoration.
protected">@protectedinherited

Operators

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