NestedScrollViewState class
The State for a NestedScrollView.
The ScrollControllers, innerController and outerController, of the NestedScrollView's children may be accessed through its state. This is useful for obtaining respective scroll positions in the NestedScrollView.
If you want to access the inner or outer scroll controller of a
NestedScrollView, you can get its NestedScrollViewState by supplying a
GlobalKey<NestedScrollViewState> to the NestedScrollView.key parameter).
NestedScrollViewState can be obtained using a GlobalKey.
Using the following setup, you can access the inner scroll controller
using
link
globalKey.currentState.innerController.
To create a local project with this code sample, run:
flutter create --sample=widgets.NestedScrollViewState.1 mysample
- Inheritance
-
- Object
- State<
NestedScrollView> - NestedScrollViewState
Constructors
Properties
- context → BuildContext
-
The location in the tree where this widget builds.
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- innerController → ScrollController
-
The ScrollController provided to the ScrollView in
NestedScrollView.body.
no setter
- mounted → bool
-
Whether this State object is currently in a tree.
no setterinherited
- outerController → ScrollController
-
The ScrollController provided to the ScrollView in
NestedScrollView.headerSliverBuilder.
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- widget → NestedScrollView
-
The current configuration.
no setterinherited
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
-
deactivate(
) → void -
Called when this object is removed from the tree.
inherited
-
debugFillProperties(
DiagnosticPropertiesBuilder properties) → void -
Add additional properties associated with the node.
inherited
-
didChangeDependencies(
) → void -
Called when a dependency of this State object changes.
override
-
didUpdateWidget(
covariant NestedScrollView 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 nonexistent method or property is accessed.
inherited
-
reassemble(
) → void -
Called whenever the application is reassembled during debugging, for
example during hot reload.
inherited
-
setState(
VoidCallback fn) → void -
Notify the framework that the internal state of this object has changed.
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
-
toStringShort(
) → String -
A brief description of this object, usually just the runtimeType and the
hashCode.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited