TextInputFocusNode class
Constructors
- TextInputFocusNode({String? debugLabel, FocusOnKeyEventCallback? onKeyEvent, FocusOnKeyCallback? onKey, bool skipTraversal = false, bool canRequestFocus = true, bool ignoreSystemKeyboardShow = true})
Properties
-
ancestors
→ Iterable<
FocusNode> -
An Iterable over the ancestors of this node.
no setterinherited
- canRequestFocus ↔ bool
-
If true, this focus node may request the primary focus.
getter/setter pairinherited
-
children
→ Iterable<
FocusNode> -
An iterator over the children of this node.
no setterinherited
- context → BuildContext?
-
The context that was supplied to attach.
no setterinherited
- debugLabel ↔ String?
-
A debug label that is used for diagnostic output.
getter/setter pairinherited
-
descendants
→ Iterable<
FocusNode> -
An Iterable over the hierarchy of children below this one, in
depth-first order.
no setterinherited
- descendantsAreFocusable ↔ bool
-
If false, will disable focus for all of this node's descendants.
getter/setter pairinherited
- descendantsAreTraversable ↔ bool
-
If false, tells the focus traversal policy to skip over for all of this
node's descendants for purposes of the traversal algorithm.
getter/setter pairinherited
- enclosingScope → FocusScopeNode?
-
Returns the nearest enclosing scope node above this node, or null if the
node has not yet be added to the focus tree.
no setterinherited
- hasFocus → bool
-
Whether this node has input focus.
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- hasListeners → bool
-
Whether any listeners are currently registered.
no setterinherited
- hasPrimaryFocus → bool
-
Returns true if this node currently has the application-wide input focus.
no setterinherited
- highlightMode → FocusHighlightMode
-
Returns the FocusHighlightMode that is currently in effect for this node.
no setterinherited
- ignoreSystemKeyboardShow → bool
-
final
- nearestScope → FocusScopeNode?
-
Returns the nearest enclosing scope node above this node, including
this node, if it's a scope.
no setterinherited
- offset → Offset
-
Returns the global offset to the upper left corner of the attached
widget's RenderObject, in logical units.
no setterinherited
- onKey ↔ FocusOnKeyCallback?
-
Called if this focus node receives a key event while focused (i.e. when
hasFocus returns true).
getter/setter pairinherited
- onKeyEvent ↔ FocusOnKeyEventCallback?
-
Called if this focus node receives a key event while focused (i.e. when
hasFocus returns true).
getter/setter pairinherited
- parent → FocusNode?
-
Returns the parent node for this object.
no setterinherited
- rect → Rect
-
Returns the global rectangle of the attached widget's RenderObject, in
logical units.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- size → Size
-
Returns the size of the attached widget's RenderObject, in logical
units.
no setterinherited
- skipTraversal ↔ bool
-
If true, tells the focus traversal policy to skip over this node for
purposes of the traversal algorithm.
getter/setter pairinherited
-
traversalChildren
→ Iterable<
FocusNode> -
An iterator over the children that are allowed to be traversed by the
FocusTraversalPolicy.
no setterinherited
-
traversalDescendants
→ Iterable<
FocusNode> -
Returns all descendants which do not have the skipTraversal and do have
the canRequestFocus flag set.
no setterinherited
Methods
-
addListener(
VoidCallback listener) → void -
Register a closure to be called when the object changes.
inherited
-
attach(
BuildContext? context, {FocusOnKeyEventCallback? onKeyEvent, FocusOnKeyCallback? onKey}) → FocusAttachment -
Called by the host StatefulWidget to attach a FocusNode to the
widget tree.
inherited
-
consumeKeyboardToken(
) → bool -
Removes the keyboard token from this focus node if it has one.
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
-
dispose(
) → void -
Discards any resources used by the object. After this is called, the
object is not in a usable state and should be discarded (calls to
addListener will throw after the object is disposed).
inherited
-
focusInDirection(
TraversalDirection direction) → bool -
Request to move the focus to the nearest focus node in the given
direction, by calling the FocusTraversalPolicy.inDirection method.
inherited
-
nextFocus(
) → bool -
Request to move the focus to the next focus node, by calling the
FocusTraversalPolicy.next method.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
notifyListeners(
) → void -
Call all the registered listeners.
inherited
-
previousFocus(
) → bool -
Request to move the focus to the previous focus node, by calling the
FocusTraversalPolicy.previous method.
inherited
-
removeListener(
VoidCallback listener) → void -
Remove a previously registered closure from the list of closures that are
notified when the object changes.
inherited
-
requestFocus(
[FocusNode? node]) → void -
Requests the primary focus for this node, or for a supplied
node
, which will also give focus to its ancestors.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 brief description of this object, usually just the runtimeType and the
hashCode.
inherited
-
unfocus(
{UnfocusDisposition disposition = UnfocusDisposition.scope}) → void -
Removes the focus on this node by moving the primary focus to another node.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited