UnmanagedRestorationScope class Null safety
Inserts a provided RestorationBucket into the widget tree and makes it available to descendants via RestorationScope.of.
A restoration scope inserts a RestorationBucket into the widget tree, which descendant widgets can access via RestorationScope.of. It is uncommon for descendants to directly store data in this bucket. Instead, descendant widgets should consider storing their own restoration data in a child bucket claimed with RestorationBucket.claimChild from the bucket provided by this scope.
If bucket is null, no restoration bucket is made available to descendant widgets (RestorationScope.of invoked from a descendant will return null). This effectively turns off state restoration for the subtree because no bucket for storing restoration data is made available.
See also:
- RestorationScope, which inserts a bucket obtained from a surrounding restoration scope into the widget tree and makes it accessible for descendants via RestorationScope.of.
- RootRestorationScope, which inserts the root bucket provided by the RestorationManager into the widget tree and makes it accessible for descendants via RestorationScope.of.
- RestorationMixin, which may be used in State objects to manage the restoration data of a StatefulWidget instead of manually interacting with RestorationScopes and RestorationBuckets.
- RestorationManager, which describes the basic concepts of state restoration in Flutter.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- ProxyWidget
- InheritedWidget
- UnmanagedRestorationScope
Constructors
- UnmanagedRestorationScope({Key? key, RestorationBucket? bucket, required Widget child})
-
Creates an UnmanagedRestorationScope.
const
Properties
- bucket → RestorationBucket?
-
The RestorationBucket that this widget will insert into the widget tree.
final
- child → Widget
-
The widget below this widget in the tree.
finalinherited
- hashCode → int
- The hash code for this object.
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
read-onlyinherited
Methods
-
createElement(
) → InheritedElement -
Inflates this configuration to a concrete instance.
inherited
-
debugDescribeChildren(
) → List< DiagnosticsNode> -
Returns a list of
DiagnosticsNodeobjects describing this node's children.protected">@protectedinherited -
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 -
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 UnmanagedRestorationScope oldWidget) → bool -
Whether the framework should notify widgets that inherit from this widget.
override
Operators
-
operator ==(
Object other) → bool -
The equality operator.
nonVirtual">@nonVirtualinherited