AutomaticKeepAliveClientMixin<T extends StatefulWidget> mixin

A mixin with convenience methods for clients of AutomaticKeepAlive. Used with State subclasses.

Subclasses must implement wantKeepAlive, and their build methods must call super.build (the return value will always return null, and should be ignored).

Then, whenever wantKeepAlive's value changes (or might change), the subclass should call updateKeepAlive.

The type argument T is the type of the StatefulWidget subclass of the State into which this class is being mixed.

See also:

Superclass Constraints
Implemented by
Annotations
  • @optionalTypeArgs

Constructors

AutomaticKeepAliveClientMixin()

Properties

wantKeepAlive → bool
Whether the current instance should be kept alive. [...]
@protected, read-only
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 → T
The current configuration. [...]
read-only, inherited

Methods

build(BuildContext context) → Widget
Describes the part of the user interface represented by this widget. [...]
@mustCallSuper, override
deactivate() → void
Called when this object is removed from the tree. [...]
override
initState() → void
Called when this object is inserted into the tree. [...]
override
updateKeepAlive() → void
Ensures that any AutomaticKeepAlive ancestors are in a good state, by firing a KeepAliveNotification or triggering the KeepAliveHandle as appropriate.
@protected
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node. [...]
inherited
didChangeDependencies() → void
Called when a dependency of this State object changes. [...]
@mustCallSuper, @protected, inherited
didUpdateWidget(covariant T oldWidget) → void
Called whenever the widget configuration changes. [...]
@mustCallSuper, @protected, inherited
dispose() → void
Called when this object is removed from the tree permanently. [...]
@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