ScrollableState class
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
- Object
- Diagnosticable
- State<
Scrollable> - ScrollableState
- Implemented types
- Mixed in types
Constructors
Properties
- axisDirection → AxisDirection
-
The direction in which the widget scrolls.
read-only, override
- notificationContext → BuildContext
-
The BuildContext that should be used when dispatching
ScrollNotifications. [...]
read-only, override
- position → ScrollPosition
-
The manager for this Scrollable widget's viewport position. [...]
read-only
- storageContext → BuildContext
-
The BuildContext that should be used when searching for a PageStorage. [...]
read-only, override
- vsync → TickerProvider
-
A TickerProvider to use when animating the scroll position.
read-only, override
- context → BuildContext
-
The location in the tree where this widget builds. [...]
read-only, inherited
- hashCode → int
-
The hash code for this object. [...]
read-only, inherited
- mounted → bool
-
Whether this State object is currently in a tree. [...]
read-only, inherited
- runtimeType → Type
-
A representation of the runtime type of the object.
read-only, inherited
- widget → Scrollable
-
The current configuration. [...]
read-only, inherited
Methods
-
build(
BuildContext context) → Widget -
Describes the part of the user interface represented by this widget. [...]
override
-
debugFillProperties(
DiagnosticPropertiesBuilder properties) → void -
Add additional properties associated with the node. [...]
override
-
didChangeDependencies(
) → void -
Called when a dependency of this State object changes. [...]
override
-
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
-
setCanDrag(
bool canDrag) → void -
Whether the user can drag the widget, for example to initiate a scroll.
@protected, override
-
setIgnorePointer(
bool value) → void -
Whether the contents of the widget should ignore PointerEvent inputs. [...]
@protected, override
-
setSemanticsActions(
Set< SemanticsAction> actions) → void -
Set the SemanticsActions that should be expose to the semantics tree.
@protected, 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, @protected, inherited
-
initState(
) → void -
Called when this object is inserted into the tree. [...]
@mustCallSuper, @protected, inherited
-
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, @protected, inherited
-
setState(
VoidCallback fn) → void -
Notify the framework that the internal state of this object has changed. [...]
@protected, inherited
-
toDiagnosticsNode(
{String name, DiagnosticsTreeStyle style }) → DiagnosticsNode -
Returns a debug representation of the object that is used by debugging
tools and by
toStringDeep
. [...]inherited -
toString(
{DiagnosticLevel minLevel: DiagnosticLevel.debug }) → String -
Returns 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 ==(
dynamic other) → bool -
The equality operator. [...]
inherited