FutureTaskStateMixin<T extends StatefulWidget> mixin

Mixin to make it easy to provide asynchronous callbacks for buttons, etc. which show progress and prevent double tapping.

The easiest use is to assign the result of asyncTaskCallback to a onPressed or onTapped parameter of ListTile, Button, etc. it will return a callback, but once the callback is running returns null so the button is disabled for the time the callback is running.

You can then use the task attribute to show Progress or even show a label of the current state of the running task.

Superclass Constraints

Properties

context → BuildContext
The location in the tree where this widget builds.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
mounted → bool
Whether this State object is currently in a tree.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
showErrorDialog → ShowErrorDialog
no setter
task → FutureTask?
no setter
widget → T
The current configuration.
no setterinherited

Methods

activate() → void
Called when this object is reinserted into the tree after having been removed via deactivate.
inherited
asyncRunTask<U>(Future<U> taskRunner(TaskProgress progress), {String? label}) → Future<U>
asyncTaskCallback<U>(Future<U> progress(TaskProgress progress)) → VoidCallback?
build(BuildContext context) → Widget
Describes the part of the user interface represented by this widget.
inherited
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.
inherited
didUpdateWidget(covariant T oldWidget) → void
Called whenever the widget configuration changes.
inherited
dispose() → void
Called when this object is removed from the tree permanently.
inherited
initState() → void
Called when this object is inserted into the tree.
inherited
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

Static Properties

defaultShowErrorDialog ↔ ShowErrorDialog
getter/setter pair