FocusableActionDetector class

FocusableActionDetector class - widgets library

A widget that combines the functionality of Actions, Shortcuts, MouseRegion and a Focus widget to create a detector that defines actions and key bindings, and provides callbacks for handling focus and hover highlights.

This widget can be used to give a control the required detection modes for focus and hover handling. It is most often used when authoring a new control widget, and the new control should be enabled for keyboard traversal and activation.

This example shows how keyboard interaction can be added to a custom control that changes color when hovered and focused, and can toggle a light when activated, either by touch or by hitting the X key on the keyboard when the "And Me" button has the keyboard focus (be sure to use TAB to move the focus to the "And Me" button before trying it out).

This example defines its own key binding for the X key, but in this case, there is also a default key binding for ActivateAction in the default key bindings created by WidgetsApp (the parent for MaterialApp, and CupertinoApp), so the ENTER key will also activate the buttons.

link

To create a local project with this code sample, run:
flutter create --sample=widgets.FocusableActionDetector.1 mysample

This widget doesn't have any visual representation, it is just a detector that provides focus and hover capabilities.

It hosts its own FocusNode or uses focusNode, if given.

Inheritance

Object
DiagnosticableTree
Widget
StatefulWidget
FocusableActionDetector

Constructors

FocusableActionDetector({Key? key, bool enabled = true, FocusNode? focusNode, bool autofocus = false, bool descendantsAreFocusable = true, bool descendantsAreTraversable = true, Map<ShortcutActivator, Intent>? shortcuts, Map<Type, Action<Intent>>? actions, ValueChanged<bool>? onShowFocusHighlight, ValueChanged<bool>? onShowHoverHighlight, ValueChanged<bool>? onFocusChange, MouseCursor mouseCursor = MouseCursor.defer, bool includeFocusSemantics = true, required Widget child}): Create a const FocusableActionDetector.
const

Properties

actions → Map<Type, Action<Intent>>?: A map of Intent keys to Action<Intent> objects that defines which actions this widget knows about.
final
autofocus → bool: True if this widget will be selected as the initial focus when no other node in its scope is currently focused.
final
child → Widget: The child widget for this FocusableActionDetector widget.
final
descendantsAreFocusable → bool: If false, will make this widget's descendants unfocusable.
final
descendantsAreTraversable → bool: If false, will make this widget's descendants untraversable.
final
enabled → bool: Is this widget enabled or not.
final
focusNode → FocusNode?: An optional focus node to use as the focus node for this widget.
final
hashCode → int: The hash code for this object.
no setterinherited
includeFocusSemantics → bool: Whether to include semantics from Focus.
final
key → Key?: Controls how one widget replaces another widget in the tree.
finalinherited
mouseCursor → MouseCursor: The cursor for a mouse pointer when it enters or is hovering over the widget.
final
onFocusChange → ValueChanged<bool>?: A function that will be called when the focus changes.
final
onShowFocusHighlight → ValueChanged<bool>?: A function that will be called when the focus highlight should be shown or hidden.
final
onShowHoverHighlight → ValueChanged<bool>?: A function that will be called when the hover highlight should be shown or hidden.
final
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
shortcuts → Map<ShortcutActivator, Intent>?: The map of shortcuts that describes the mapping between a key sequence defined by a ShortcutActivator and the Intent that will be emitted when that key sequence is pressed.
final

Methods

createElement() → StatefulElement: Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<FocusableActionDetector>: 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

Operators

operator ==(Object other) → bool: The equality operator.
inherited