AsyncControllerScope<C extends ScopeController> class final AsyncControllerScope

Inheritance

Constructors

AsyncControllerScope({Key? key, Object? tag, Object? scopeKey, Duration? scopeKeyTimeout, void onScopeKeyTimeout()?, Duration? initCancellationTimeout, void onInitCancellationTimeout()?, Duration? disposeScopeTimeout, void onDisposeScopeTimeout()?, Duration? waitForChildrenTimeout, void onWaitForChildrenTimeout()?, Duration? pauseAfterInitialization, required C createController(BuildContext context), Widget waitingBuilder(BuildContext context)?, required Widget progressBuilder(BuildContext context), required Widget builder(BuildContext context, C controller), required Widget errorBuilder(BuildContext context, Object error, StackTrace stackTrace)})
Creates a scope owning a controller.
const

Properties

builder → Widget Function(BuildContext context, C controller)
Built once the controller is ready, and receives it.
final
child → Widget
The widget below this widget in the tree.
finalinherited
disposeScopeTimeout → Duration?
How long to wait for the teardown of the controller; null takes the default.
finalinherited
errorBuilder → Widget Function(BuildContext context, Object error, StackTrace stackTrace)
Built when the initialization of the controller failed.
final
hashCode → int
The hash code for this object.
no setterinherited
initCancellationTimeout → Duration?
How long the teardown waits for the initialization of the controller to be cancelled; null takes the default.
finalinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
onDisposeScopeTimeout → void Function()?
Called when the wait for the teardown expires.
finalinherited
onInitCancellationTimeout → void Function()?
Called when the wait for the cancellation expires.
finalinherited
onScopeKeyTimeout → void Function()?
Called when the wait for scopeKey expires.
finalinherited
onWaitForChildrenTimeout → void Function()?
Called when the wait for the child scopes expires.
finalinherited
pauseAfterInitialization → Duration?
Holds the ready branch back for this long after the initialization.
finalinherited
progressBuilder → Widget Function(BuildContext context)
Built while the controller is initializing.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scopeKey → Object?
Serializes this scope with the others that share the key.
finalinherited
scopeKeyTimeout → Duration?
How long to wait for scopeKey; null takes the default.
finalinherited
tag → Object?
Names this particular scope in the log.
finalinherited
waitForChildrenTimeout → Duration?
How long to wait for the child scopes; null takes the default.
finalinherited
waitingBuilder → Widget Function(BuildContext context)?
Built while waiting for a scopeKey and for the controller.
final

Methods

buildOnError(BuildContext context, Object error, StackTrace stackTrace) → Widget
Built when the initialization of the controller failed.
override
buildOnProgress(BuildContext context) → Widget
Built while the controller is initializing.
override
buildOnReady(BuildContext context, C controller) → Widget
Built once the controller is ready, and receives it.
override
buildOnWaiting(BuildContext context) → Widget?
Built while waiting for a scopeKey and for the controller.
override
createController(BuildContext context) → C
Creates the controller this scope owns.
override
createElement() → InheritedElement
Inflates this configuration to a concrete instance.
inherited
createScopeElement() → _AsyncControllerScopeElement<AsyncControllerScope<C>, C>
Creates the element of this scope.
inherited
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, int wrapWidth = 65}) → 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({bool showHashCode = false}) → String
A short, textual description of this widget.
inherited
updateShouldNotify(covariant ScopeWidgetCore<AsyncControllerScope<C>, _AsyncControllerScopeElement<AsyncControllerScope<C>, C>> oldWidget) → bool
Whether the framework should notify widgets that inherit from this widget.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

maybeOf<C extends ScopeController>(BuildContext context, {required bool listen}) → AsyncControllerScopeContext<AsyncControllerScope<C>, C>?
The nearest AsyncControllerScope<C> above context, or null.
override
of<C extends ScopeController>(BuildContext context, {required bool listen}) → AsyncControllerScopeContext<AsyncControllerScope<C>, C>
The nearest AsyncControllerScope<C> above context.
override
select<C extends ScopeController, V extends Object?>(BuildContext context, V selector(AsyncControllerScopeContext<AsyncControllerScope<C>, C> context)) → V
Subscribes to one value of the scope and returns it.
override