NodeFlowActionsMixin<T extends StatefulWidget> mixin
A mixin that provides convenient methods for executing NodeFlow actions from within stateful widgets.
This mixin is useful for widgets that need to programmatically trigger NodeFlow actions, check if actions can be executed, or display keyboard shortcuts in UI elements like menus or tooltips.
Example usage:
class MyWidget extends StatefulWidget {
const MyWidget({super.key});
@override
State<MyWidget> createState() => _MyWidgetState();
}
class _MyWidgetState extends State<MyWidget> with NodeFlowActionsMixin {
NodeFlowController? _controller;
@override
NodeFlowController? get nodeFlowController => _controller;
void _handleDelete() {
if (canExecuteAction('delete_selection')) {
executeAction('delete_selection');
}
}
@override
Widget build(BuildContext context) {
final shortcut = getActionShortcut('delete_selection');
return TextButton(
onPressed: _handleDelete,
child: Text('Delete ($shortcut)'),
);
}
}
See also:
- NodeFlowController, which contains the actions system
- NodeFlowAction, the action type being executed
- Superclass constraints
- State<
T>
- State<
Properties
- context → BuildContext
-
The location in the tree where this widget builds.
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- mounted → bool
-
Whether this State object is currently in a tree.
no setterinherited
- nodeFlowController → NodeFlowController?
-
The NodeFlow controller to use for action execution.
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- widget → T
-
The current configuration.
no setterinherited
Methods
-
activate(
) → void -
Called when this object is reinserted into the tree after having been
removed via deactivate.
inherited
-
build(
BuildContext context) → Widget -
Describes the part of the user interface represented by this widget.
inherited
-
canExecuteAction(
String actionId) → bool - Checks if a NodeFlow action can currently be executed.
-
deactivate(
) → void -
Called when this object is removed from the tree.
inherited
-
debugFillProperties(
DiagnosticPropertiesBuilder properties) → void -
Add additional properties associated with the node.
inherited
-
didChangeDependencies(
) → void -
Called when a dependency of this State object changes.
inherited
-
didUpdateWidget(
covariant T oldWidget) → void -
Called whenever the widget configuration changes.
inherited
-
dispose(
) → void -
Called when this object is removed from the tree permanently.
inherited
-
executeAction(
String actionId) → bool - Executes a NodeFlow action by its ID.
-
getActionShortcut(
String actionId) → String? - Gets the keyboard shortcut string for an action.
-
initState(
) → void -
Called when this object is inserted into the tree.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
reassemble(
) → void -
Called whenever the application is reassembled during debugging, for
example during hot reload.
inherited
-
setState(
VoidCallback fn) → void -
Notify the framework that the internal state of this object has changed.
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
-
toStringShort(
) → String -
A brief description of this object, usually just the runtimeType and the
hashCode.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited