AutoDisposeMixin<T extends StatefulWidget> mixin

Mixin to simplifying managing the lifetime of listeners used by a StatefulWidget.

This mixin works by delegating to a DisposerMixin. It implements all of DisposerMixin's interface.

See also:

Superclass constraints
Implemented types

Properties

context → BuildContext
The location in the tree where this widget builds.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
listenables → List<Listenable>
no setteroverride
listeners → List<VoidCallback>
Not using VoidCallback because of https://github.com/dart-lang/mockito/issues/579
no setteroverride
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
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
addAutoDisposeListener(Listenable? listenable, [VoidCallback? listener, String? id]) → void
Add a listener to a Listenable object that is automatically removed on the object disposal or when cancel is called.
override
autoDisposeFocusNode(FocusNode? node) → void
Track a focus node that will be automatically disposed on dispose.
override
autoDisposeStreamSubscription(StreamSubscription subscription) → void
Track a stream subscription to be automatically cancelled on dispose.
override
build(BuildContext context) → Widget
Describes the part of the user interface represented by this widget.
inherited
callOnceWhenReady<T>({required VoidCallback callback, required ValueListenable<T> trigger, required bool readyWhen(T triggerValue)}) → void
Runs callback when trigger's value satisfies the readyWhen function.
override
cancelFocusNodes() → void
Cancel all focus nodes added.
override
cancelListener(VoidCallback? listener) → void
Cancels a single listener, if present.
override
cancelListeners({List<String> excludeIds = const <String>[]}) → void
Cancel all listeners added.
override
cancelStreamSubscriptions() → void
Cancel all stream subscriptions added.
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.
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.
override
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