ZdsAbsorbPointer 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.

{@tool dartpad} 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.

** See code in examples/api/lib/widgets/basic/absorb_pointer.0.dart ** {@end-tool}

See also:

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

Constructors

ZdsAbsorbPointer({required Widget child, Key? key, bool absorbing = true, Duration duration = const Duration(milliseconds: 250)})
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 whose events should be prevented
final
duration Duration
Opacity duration
final
hashCode int
The hash code for this object.
no setterinherited
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

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.
override
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