AbsorbPointer class

A widget that absorbs pointers during hit testing.

When absorbing is true, this widget prevents its subtree from receiving pointer events by terminating hit testing at itself. It still consumes space during layout and paints its child as usual. It just prevents its children from being the target of located events, because it returns true from RenderBox.hitTest.

When ignoringSemantics is true, the subtree will be invisible to the semantics layer (and thus e.g. accessibility tools).

The following sample has an AbsorbPointer widget wrapping the button on top of the stack, which absorbs pointer events, preventing its child button and the button below it in the stack from receiving the pointer events.
link

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

Semantics

Using this class may also affect how the semantics subtree underneath is collected.

If absorbing is true, pointer-related SemanticsActions are removed from the semantics subtree. Otherwise, the subtree remains untouched.

The usages of ignoringSemantics are deprecated and not recommended. This property was introduced to workaround the semantics behavior of the IgnorePointer and its friends before v3.8.0-12.0.pre.

Before that version, entire semantics subtree is dropped if absorbing is true. Developers can only use ignoringSemantics to preserver the semantics subtrees.

After that version, with absorbing set to true, it only prevents semantics user actions in the semantics subtree but leaves the other SemanticsProperties intact. Therefore, the ignoringSemantics is no longer needed.

If ignoringSemantics is true, the semantics subtree is dropped. Therefore, the subtree will be invisible to assistive technologies.

If ignoringSemantics is false, the semantics subtree is collected as usual.

See also:

  • IgnorePointer, which also prevents its children from receiving pointer events but is itself invisible to hit testing.
Inheritance

Constructors

AbsorbPointer({Key? key, bool absorbing = true, @Deprecated('Use ExcludeSemantics or create a custom absorb pointer widget instead. ' 'This feature was deprecated after v3.8.0-12.0.pre.') bool? ignoringSemantics, Widget? child})
Creates a widget that absorbs pointers during hit testing.
const

Properties

absorbing → bool
Whether this widget absorbs pointers during hit testing.
final
child → Widget?
The widget below this widget in the tree.
finalinherited
hashCode → int
The hash code for this object.
no setterinherited
ignoringSemantics → bool?
Whether the semantics of this render object is ignored when compiling the semantics tree.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

createElement() → SingleChildRenderObjectElement
RenderObjectWidgets always inflate to a RenderObjectElement subclass.
inherited
createRenderObject(BuildContext context) → RenderAbsorbPointer
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.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
override
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.
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
updateRenderObject(BuildContext context, covariant RenderAbsorbPointer 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.
inherited