ReadOnlyDocumentKeyboardInteractor class
Governs document input that comes from a physical keyboard.
Keyboard input won't work on a mobile device with a software keyboard because the software keyboard sends input through the operating system's Input Method Engine. For mobile use-cases, see IME input support. Receives all hardware keyboard input, when focused, and changes the read-only document display, as needed.
keyboardActions determines the mapping from keyboard key presses to document editing behaviors. keyboardActions operates as a Chain of Responsibility.
The difference between a read-only keyboard interactor, and an editing keyboard
interactor, is the type of service locator that's passed to each handler. For
example, the read-only keyboard interactor can't pass a DocumentEditor to
the keyboard handlers, because read-only documents don't support edits.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatelessWidget
- ReadOnlyDocumentKeyboardInteractor
Constructors
-
ReadOnlyDocumentKeyboardInteractor({Key? key, required FocusNode focusNode, required SuperReaderContext readerContext, required List<
ReadOnlyDocumentKeyboardAction> keyboardActions, required Widget child, bool autofocus = false}) -
const
Properties
- autofocus → bool
-
Whether or not the ReadOnlyDocumentKeyboardInteractor should autofocus
final
- child → Widget
-
The child widget, which is expected to include the document UI
somewhere in the sub-tree.
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<
ReadOnlyDocumentKeyboardAction> -
All the actions that the user can execute with keyboard keys.
final
- readerContext → SuperReaderContext
-
Service locator for document display dependencies.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
build(
BuildContext context) → Widget -
Describes the part of the user interface represented by this widget.
override
-
createElement(
) → StatelessElement -
Creates a StatelessElement to manage this widget's location in the tree.
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}) → 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