NodeFlowScope<T> class
An InheritedWidget that provides NodeFlowController to descendants.
This scope allows nodes and other widgets within the node flow to access the controller without explicit passing. This is particularly useful for:
- Nodes that need to call controller methods (e.g., resize callbacks)
- Custom widgets that need viewport information
- Plugins or extensions that need controller access
Usage
Access the controller in any descendant widget:
Widget build(BuildContext context) {
final controller = NodeFlowScope.of<MyData>(context);
// Use controller...
}
For optional access (when the widget might be outside the scope):
Widget build(BuildContext context) {
final controller = NodeFlowScope.maybeOf<MyData>(context);
if (controller != null) {
// Use controller...
}
}
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- ProxyWidget
- InheritedWidget
- NodeFlowScope
Constructors
-
NodeFlowScope({Key? key, required NodeFlowController<
T> controller, required Widget child}) -
const
Properties
- child → Widget
-
The widget below this widget in the tree.
finalinherited
-
controller
→ NodeFlowController<
T> -
The NodeFlowController provided by this scope.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- 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
-
createElement(
) → InheritedElement -
Inflates this configuration to a concrete instance.
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(
) → String -
A short, textual description of this widget.
inherited
-
updateShouldNotify(
covariant NodeFlowScope< T> oldWidget) → bool -
Whether the framework should notify widgets that inherit from this widget.
override
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
maybeOf<
T> (BuildContext context) → NodeFlowController< T> ? - Returns the NodeFlowController from the nearest NodeFlowScope ancestor, or null if not found.
-
of<
T> (BuildContext context) → NodeFlowController< T> - Returns the NodeFlowController from the nearest NodeFlowScope ancestor.