FocusTrap class Null safety
The FocusTrap widget removes focus when a mouse primary pointer makes contact with another region of the screen.
When a primary pointer makes contact with the screen, this widget determines if that pointer contacted an existing focused widget. If not, this asks the FocusScopeNode to reset the focus state. This allows TextFields and other focusable widgets to give up their focus state, without creating a gesture detector that competes with others on screen.
In cases where focus is conceptually larger than the focused render object, a FocusTrapArea can be used to expand the focus area to include all render objects below that. This is used by the TextField widgets to prevent a loss of focus when interacting with decorations on the text area.
See also:
- FocusTrapArea, the widget that allows expanding the conceptual focus area.
- Inheritance
Constructors
- FocusTrap({required FocusScopeNode focusScopeNode, required Widget child, Key? key})
-
Create a new FocusTrap widget scoped to the provided focusScopeNode.
const
Properties
- child → Widget?
-
The widget below this widget in the tree. [...]
final, inherited
- focusScopeNode → FocusScopeNode
-
The focusScopeNode that this focus trap widget operates on.
final
- hashCode → int
-
The hash code for this object. [...]
@nonVirtual, read-only, inherited
- key → Key?
-
Controls how one widget replaces another widget in the tree. [...]
final, inherited
- runtimeType → Type
-
A representation of the runtime type of the object.
read-only, inherited
Methods
-
createElement(
) → SingleChildRenderObjectElement -
RenderObjectWidgets always inflate to a RenderObjectElement subclass.
inherited
-
createRenderObject(
BuildContext context) → RenderObject -
Creates an instance of the RenderObject class that this
RenderObjectWidget represents, using the configuration described by this
RenderObjectWidget. [...]
override
-
debugDescribeChildren(
) → List< DiagnosticsNode> -
Returns a list of
DiagnosticsNode
objects describing this node's children. [...]@protected, inherited -
debugFillProperties(
DiagnosticPropertiesBuilder properties) → void -
Add additional properties associated with the node. [...]
inherited
-
didUnmountRenderObject(
covariant RenderObject renderObject) → void -
A render object previously associated with this widget has been removed
from the tree. The given RenderObject will be of the same type as
returned by this object's createRenderObject.
@protected, inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a non-existent 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
-
updateRenderObject(
BuildContext context, covariant RenderObject renderObject) → void -
Copies the configuration described by this RenderObjectWidget to the
given RenderObject, which will be of the same type as returned by this
object's createRenderObject. [...]
override
Operators
-
operator ==(
Object other) → bool -
The equality operator. [...]
@nonVirtual, inherited