HeroControllerScope class

An inherited widget to host a hero controller.

The hosted hero controller will be picked up by the navigator in the child subtree. Once a navigator picks up this controller, the navigator will bar any navigator below its subtree from receiving this controller.

The hero controller inside the HeroControllerScope can only subscribe to one navigator at a time. An assertion will be thrown if the hero controller subscribes to more than one navigators. This can happen when there are multiple navigators under the same HeroControllerScope in parallel.

Inheritance

Constructors

HeroControllerScope({Key key, HeroController controller, Widget child})
Creates a widget to host the input controller.
const
HeroControllerScope.none({Key key, Widget child})
Creates a widget to prevent the subtree from receiving the hero controller above.
const

Properties

child Widget
The widget below this widget in the tree. [...]
final, inherited
controller HeroController
The hero controller that is hosted inside this widget.
final
hashCode int
The hash code for this object. [...]
@nonVirtual, read-only, inherited
key Key
Controls how one widget replaces another widget in the tree. [...]
final, inherited
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited

Methods

createElement() InheritedElement
Inflates this configuration to a concrete instance. [...]
inherited
debugDescribeChildren() List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children. [...]
@protected, inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node. [...]
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent 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
Returns 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
updateShouldNotify(covariant HeroControllerScope oldWidget) bool
Whether the framework should notify widgets that inherit from this widget. [...]
override

Operators

operator ==(Object other) bool
The equality operator. [...]
@nonVirtual, inherited

Static Methods

of(BuildContext context) HeroController
Retrieves the HeroController from the closest HeroControllerScope ancestor.