NodeFlowKeyboardHandler<T> class
Primary keyboard handler for NodeFlow using Flutter's Actions and Shortcuts system.
This widget integrates NodeFlow's action system with Flutter's built-in Actions and Shortcuts framework, providing proper keyboard shortcut handling with all the benefits of Flutter's actions ecosystem (menu integration, shortcut manager support, etc.).
Features:
- Proper integration with Flutter's Actions and Shortcuts system
- Automatic focus management with optional autofocus
- Support for custom focus nodes
- Action enabling/disabling based on controller state
- Platform-aware shortcut handling (Cmd on macOS, Ctrl on Windows/Linux)
Example usage:
NodeFlowKeyboardHandler(
controller: nodeFlowController,
autofocus: true,
child: NodeFlowCanvas(...),
)
See also:
- Shortcuts, the Flutter widget used for shortcut mapping
- Actions, the Flutter widget used for action handling
- NodeFlowShortcutManager, which defines available shortcuts
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- NodeFlowKeyboardHandler
- Available extensions
Constructors
-
NodeFlowKeyboardHandler({Key? key, required NodeFlowController<
T> controller, required Widget child, bool autofocus = true, FocusNode? focusNode}) -
Creates a keyboard handler for NodeFlow.
const
Properties
- autofocus → bool
-
Whether to automatically request focus when the widget is built.
final
- child → Widget
-
The child widget that will have keyboard handling.
final
-
controller
→ NodeFlowController<
T> -
The NodeFlow controller containing the shortcuts and actions.
final
- focusNode → FocusNode?
-
Optional custom focus node.
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(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< NodeFlowKeyboardHandler< T> > -
Creates the mutable state for this widget at a given location in the tree.
override
-
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
-
withAnnotationLayer(
NodeFlowController< T> controller) → Widget -
Available on Widget, provided by the AnnotationLayerSupport extension
Wraps this widget with an annotation layer.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited