RedirectPointer class

Redirects pointer events to widgets anywhere else in the tree.

This is useful for widgets that overflow their parent such as from a Transform and would otherwise not receive pointer events.

To use this widget, give the child you would like to receive pointer events a GlobalKey and pass it to the above or below parameter.

Note that the RedirectPointer widget needs to encompass the entire widget that should receive pointer events, we recommend wrapping the body of the Scaffold so that it can receive pointer events for the whole screen.

You may also want to wrap the targets in an IgnorePointer so they aren't hit tested more than once.

Hit testing is performed in the following order:

  1. The above widgets in reverse.
  2. The child.
  3. The below widgets in reverse.
Inheritance

Constructors

RedirectPointer({Key? key, Widget? child, List<GlobalKey<State<StatefulWidget>>> above = const [], List<GlobalKey<State<StatefulWidget>>> below = const []})
const

Properties

above → List<GlobalKey<State<StatefulWidget>>>
final
below → List<GlobalKey<State<StatefulWidget>>>
final
child → Widget?
The widget below this widget in the tree.
finalinherited
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

createElement() → SingleChildRenderObjectElement
RenderObjectWidgets always inflate to a RenderObjectElement subclass.
inherited
createRenderObject(BuildContext context) → RenderRedirectPointer
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.
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.
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 RenderRedirectPointer 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