DraggableScrollableActuator class
A widget that can notify a descendent DraggableScrollableSheet that it should reset its position to the initial state.
The Scaffold uses this widget to notify a persistent bottom sheet that the user has tapped back if the sheet has started to cover more of the body than when at its initial position. This is important for users of assistive technology, where dragging may be difficult to communicate.
This is just a wrapper on top of DraggableScrollableController. It is primarily useful for controlling a sheet in a part of the widget tree that the current code does not control (e.g. library code trying to affect a sheet in library users' code). Generally, it's easier to control the sheet directly by creating a controller and passing the controller to the sheet in its constructor (see DraggableScrollableSheet.controller).
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- DraggableScrollableActuator
Constructors
- DraggableScrollableActuator({Key? key, required Widget child})
-
Creates a widget that can notify descendent DraggableScrollableSheets
to reset to their initial position.
const
Properties
- child → Widget
-
This child's DraggableScrollableSheet descendant will be reset when the
reset method is applied to a context that includes it.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< DraggableScrollableActuator> -
Creates the mutable state for this widget at a given location in the tree.
override
-
debugDescribeChildren(
) → List< DiagnosticsNode> -
Returns a list of DiagnosticsNode objects describing this node's
children.
inherited
-
debugFillProperties(
DiagnosticPropertiesBuilder properties) → void -
Add additional properties associated with the node.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
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
-
toStringDeep(
{String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String -
Returns a string representation of this node and its descendants.
inherited
-
toStringShallow(
{String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String -
Returns a one-line detailed description of the object.
inherited
-
toStringShort(
) → String -
A short, textual description of this widget.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
reset(
BuildContext context) → bool - Notifies any descendant DraggableScrollableSheet that it should reset to its initial position.