TouchRippleGestureDetector<T extends dynamic> class

This widget detects user gestures, notifies the relevant controller that manages touch ripple effects, and delegates the handling to it.

Inheritance

Constructors

TouchRippleGestureDetector({Key? key, VoidCallback? onTap, TouchRippleAsyncCallback<T>? onTapAsync, TouchRippleAsyncNotifyCallback<T>? onTapAsyncStart, TouchRippleAsyncResultCallback<T>? onTapAsyncEnd, VoidCallback? onDoubleTap, TouchRippleContinuableCallback? onDoubleTapConsecutive, VoidCallback? onDoubleTapStart, VoidCallback? onDoubleTapEnd, TouchRippleContinuableCallback? onLongTap, VoidCallback? onLongTapStart, VoidCallback? onLongTapEnd, VoidCallback? onFocusStart, VoidCallback? onFocusEnd, VoidCallback? onHoverStart, VoidCallback? onHoverEnd, bool? onlyMainButton, HitTestBehavior behavior = HitTestBehavior.translucent, MouseCursor cursor = MouseCursor.defer, required TouchRippleController controller, required Widget child})
const

Properties

behavior → HitTestBehavior
The defines the behavior of hit testing for the child widget.
final
child → Widget
The widget is the target for detecting gestures related to touch ripple effects.
final
controller → TouchRippleController
The controller that manages ripple effects triggered by user gestures.
final
cursor → MouseCursor
The hover mouse cursor type, and default value is MouseCursor.defer.
final
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
onDoubleTap → VoidCallback?
The callback function is called when the user double taps or double clicks.
final
onDoubleTapConsecutive → TouchRippleContinuableCallback?
The callback function is called to determine whether consecutive double taps should continue. It returns a bool indicating whether the long tap event should continue after the initial occurrence.
final
onDoubleTapEnd → VoidCallback?
The callback function is a lifecycle callback for the double-tap event. It is called when a double tap ends, providing the advantage of knowing when a series of consecutive double taps has finished.
final
onDoubleTapStart → VoidCallback?
The callback function is a lifecycle callback for the double-tap event. It is called when a double tap starts, which is useful for handling actions that occur during successive double taps.
final
onFocusEnd → VoidCallback?
The callback function is a lifecycle callback for focus touch ripple events. It is called when a focus touch event ends, providing the advantage of knowing when a series of focus touch ripple events has concluded.
final
onFocusStart → VoidCallback?
The callback function is a lifecycle callback for focus touch ripple events. It is called when a focus touch event starts, allowing for the initiation of actions based on the beginning of the focus event sequence.
final
onHoverEnd → VoidCallback?
The callback function called when the cursor begins to leave the widget. (by MouseRegion) This function allows for actions to be executed based on the end of the hover interaction. This function is not called in touch-based environments yet.
final
onHoverStart → VoidCallback?
The callback function called when the cursor begins hovering over the widget. (by MouseRegion) This function allows for the initiation of actions based on the hover interaction. This function is not called in touch-based environments yet.
final
onLongTap → TouchRippleContinuableCallback?
The callback function is called when the user long presses or long clicks.
final
onLongTapEnd → VoidCallback?
The callback function is a lifecycle callback for the long-tap event. It is called when a long tap ends, providing the advantage of knowing when a series of consecutive long taps has concluded.
final
onLongTapStart → VoidCallback?
The callback function is a lifecycle callback for the long-tap event. It is called when a long tap starts, which is useful for initiating actions that require a sustained press.
final
onlyMainButton → bool?
The boolean that is whether only the main button is recognized as a gesture when the user that is using mouse device clicks on the widget.
final
onTap → VoidCallback?
The callback function is called when the user taps or clicks.
final
onTapAsync → TouchRippleAsyncCallback<T>?
The callback function is called when the user taps or clicks. but this function ensures that the touch ripple effect remains visible until the asynchronous operation is completed and prevents additional events during that time.
final
onTapAsyncEnd → TouchRippleAsyncResultCallback<T>?
The callback function is called when the result of the asynchronous operation is ready. It allows handling the result once the operation is complete.
final
onTapAsyncStart → TouchRippleAsyncNotifyCallback<T>?
The callback function is called when an asynchronous operation is initiated by a tap. It provides the associated Future instance for the ongoing operation.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<TouchRippleGestureDetector>
Creates the mutable state for this widget at a given location in the tree.
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
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, 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 short, textual description of this widget.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited