BoxyId<T extends Object> class

Widget that can provide data to the parent CustomBoxy.

Similar to how LayoutId works, the parameters of this widget can influence layout and paint behavior of its direct ancestor in the render tree.

The data passed to this widget will be available to BoxyDelegate via BoxyChild.parentData.

See also:

  • CustomBoxy, which can use the data this widget provides.
  • ParentDataWidget, which has a more technical description of how this works.
Inheritance

Constructors

BoxyId({Object? id, Key? key, bool? hasData, T? data, required Widget child, bool alwaysRelayout = true, bool alwaysRepaint = true})
Constructs a BoxyData with an optional id, data, and child.
const

Properties

child → Widget
The widget below this widget in the tree.
finalinherited
data → T
The data to provide to the parent.
no setter
debugTypicalAncestorWidgetClass → Type
Describes the RenderObjectWidget that is typically used to set up the ParentData that applyParentData will write to.
no setteroverride
debugTypicalAncestorWidgetDescription → String
Describes the RenderObjectWidget that is typically used to set up the ParentData that applyParentData will write to.
no setterinherited
hasData → bool
Whether data was provided to this widget
final
hashCode → int
The hash code for this object.
no setterinherited
id → Object?
The object that identifies the child.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

applyParentData(RenderObject renderObject) → void
Write the data from this widget into the given render object's parent data.
override
createElement() → ParentDataElement<BaseBoxyParentData<RenderObject>>
Inflates this configuration to a concrete instance.
inherited
debugCanApplyOutOfTurn() → bool
Whether the ParentDataElement.applyWidgetOutOfTurn method is allowed with this widget.
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
debugIsValidRenderObject(RenderObject renderObject) → bool
Checks if this widget can apply its parent data to the provided renderObject.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
shouldRelayout(T oldData) → bool
Whether the difference in data should result in a relayout, defaults to the alwaysRelayout argument provided to our constructor.
shouldRepaint(T oldData) → bool
Whether the difference in data should result in a repaint, defaults to the alwaysRepaint argument provided to our constructor.
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() → String
A short, textual description of this widget.
inherited

Operators

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