WidgetToRenderBoxAdapter class Null safety

An adapter for placing a specific RenderBox in the widget tree.

A given render object can be placed at most once in the widget tree. This widget enforces that restriction by keying itself using a GlobalObjectKey for the given render object.

This widget will call RenderObject.dispose on the renderBox when it is unmounted. After that point, the renderBox will be unusable. If any children have been added to the renderBox, they must be disposed in the onUnmount callback.

Inheritance

Constructors

WidgetToRenderBoxAdapter({required RenderBox renderBox, VoidCallback? onBuild, VoidCallback? onUnmount})
Creates an adapter for placing a specific RenderBox in the widget tree.

Properties

hashCode → int
The hash code for this object.
nonVirtual">@nonVirtualread-onlyinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
onBuild → VoidCallback?
Called when it is safe to update the render box and its descendants. If you update the RenderObject subtree under this widget outside of invocations of this callback, features like hit-testing will fail as the tree will be dirty.
final
onUnmount → VoidCallback?
Called when it is safe to dispose of children that were manually added to the renderBox.
final
renderBox → RenderBox
The render box to place in the widget tree.
final
runtimeType → Type
A representation of the runtime type of the object.
read-onlyinherited

Methods

createElement() → LeafRenderObjectElement
RenderObjectWidgets always inflate to a RenderObjectElement subclass.
inherited
createRenderObject(BuildContext context) → RenderBox
Creates an instance of the RenderObject class that this RenderObjectWidget represents, using the configuration described by this RenderObjectWidget.
override
debugDescribeChildren() → List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
protected">@protectedinherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
didUnmountRenderObject(covariant RenderObject renderObject) → void
A render object previously associated with this widget has been removed from the tree. The given RenderObject will be of the same type as returned by this object's createRenderObject.
override
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
updateRenderObject(BuildContext context, covariant RenderBox renderObject) → void
Copies the configuration described by this RenderObjectWidget to the given RenderObject, which will be of the same type as returned by this object's createRenderObject.
override

Operators

operator ==(Object other) → bool
The equality operator.
nonVirtual">@nonVirtualinherited