SuperEditorHardwareKeyHandler class
Applies appropriate edits to a document and selection when the user presses hardware keys.
Hardware key events are dispatched through FocusNodes, therefore, this widget's FocusNode needs to be focused for key events to be applied. A FocusNode can be provided, or this widget will create its own FocusNode internally, which is wrapped around the given child.
keyboardActions determines the mapping from keyboard key presses to document editing behaviors. keyboardActions operates as a Chain of Responsibility.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- SuperEditorHardwareKeyHandler
Constructors
-
SuperEditorHardwareKeyHandler({Key? key, FocusNode? focusNode, required EditContext editContext, List<
DocumentKeyboardAction> keyboardActions = const [], bool autofocus = false, required Widget child}) -
const
Properties
- autofocus → bool
-
Whether or not the SuperEditorHardwareKeyHandler should autofocus
final
- child → Widget
-
The child widget, which is expected to include the document UI
somewhere in the sub-tree.
final
- editContext → EditContext
-
Service locator for document editing dependencies.
final
- focusNode → FocusNode?
-
The source of all key events.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
-
keyboardActions
→ List<
DocumentKeyboardAction> -
All the actions that the user can execute with keyboard keys.
final
- 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< SuperEditorHardwareKeyHandler> -
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}) → 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