GestureDectectorCreatable<T extends dynamic> class abstract

An abstract stateful widget declared to handle click-related events and display them visually to the user.

See also:

  • Generic T defines a type of onTapAsync of return type.
Inheritance
Implementers

Constructors

GestureDectectorCreatable({Key? key, required Widget child, required TouchRippleEventCallBack? onTap, required TouchRippleEventAsyncCallBack<T>? onTapAsync, required TouchRippleEventCallBack? onTapAsyncStart, required TouchRippleEventResponseCallback<T>? onTapAsyncEnd, required TouchRippleEventCallBack? onDoubleTap, required TouchRippleStateCallBack? onDoubleTapStart, required TouchRippleStateCallBack? onDoubleTapEnd, required TouchRippleContinuableCheckedCallBack? onLongTap, required TouchRippleStateCallBack? onLongTapStart, required TouchRippleStateCallBack? onLongTapEnd, required TouchRippleBehavior? behavior, required TouchRippleBehavior? tapBehavior, required TouchRippleBehavior? doubleTapBehavior, required TouchRippleBehavior? longTapBehavior, required TouchRippleStateCallBack? onHoverStart, required TouchRippleStateCallBack? onHoverEnd, required TouchRippleStateCallBack? onFocusStart, required TouchRippleStateCallBack? onFocusEnd, required Color? hoverColor, required Duration hoverFadeInDuration, required Curve hoverFadeInCurve, required Duration? hoverFadeOutDuration, required Curve? hoverFadeOutCurve, required bool isDoubleTapContinuable, required bool isLongTapContinuable, required TouchRippleRejectBehavior rejectBehavior, required TouchRippleCancelledBehavior cancelledBehavior, required TouchRippleLongTapFocusStartEvent longTapFocusStartEvent, required Color? rippleColor, required TouchRippleRenderOrderType renderOrder, required double rippleScale, required Duration? tapableDuration, required HitTestBehavior hitTestBehavior, required Duration? doubleTappableDuration, required Duration? doubleTapHoldDuration, required Duration? longTappableDuration, required Duration longTapStartDeleyDuration, required Duration? tapPreviewMinDuration, required TouchRippleController? controller, required BorderRadius borderRadius, required TouchRippleContinuableCheckedCallBack? onDoubleTapContinuableChecked, required SystemMouseCursor hoverCursor, required double hoverColorRelativeOpacity, required double focusColorRelativeOpacity, required bool useHoverEffect, required bool useFocusEffect, required Color? focusColor, required Duration focusFadeInDuration, required Curve focusFadeInCurve, required Duration? focusFadeOutDuration, required Curve? focusFadeOutCurve, required bool useDoubleTapFocusEffect, required bool useLongTapFocusEffect, required bool isOnHoveredDisableFocusEffect, required double rippleBlurRadius})
const

Properties

behavior → TouchRippleBehavior?
Defines the default behavior of touch ripple all event.
final
borderRadius → BorderRadius
Same as BorderRadius of ClipRRect.
final
cancelledBehavior → TouchRippleCancelledBehavior
Defines the behavior that causes the gesture to be cancelled.
final
child → Widget
The child widget contained by the TouchRipple widget.
final
controller → TouchRippleController?
This is the controller you define when you need to manage touch ripple effects externally.
final
defaultBehavior → TouchRippleBehavior
Return the default values for all the defined properties of a touch ripple.
no setter
defaultDoubleTapBehavior → TouchRippleBehavior
Returns the final defined touch ripple behavior of double tap event.
no setter
defaultHorizontalDragBehavior → TouchRippleBehavior
Returns the final defined touch ripple behavior of horizontal drag event.
no setter
defaultLongTapBehavior → TouchRippleBehavior
Returns the final defined touch ripple behavior of long tap event.
no setter
defaultRippleColor → Color
Defines default touch ripple background color of all events.
no setter
defaultTapBehavior → TouchRippleBehavior
Returns the final defined touch ripple behavior of tap event.
no setter
defaultVerticalDragBehavior → TouchRippleBehavior
Returns the final defined touch ripple behavior of horizontal drag event.
no setter
doubleTapBehavior → TouchRippleBehavior?
Defines the behavior applied when a double tap event occurs.
final
doubleTapHoldDuration → Duration?
Defines the minimum duration to end the double tap state.
final
doubleTappableDuration → Duration?
The duration between two taps that is considered a double tap, This refers to the time interval used to recognize double taps.
final
focusColor → Color?
Defines the background colour of the focus effect that occurs on focus.
final
focusColorRelativeOpacity → double
Defines what percentage of ripple color opacity the default focus color will be defined as when no focus color is artificially defined.
final
focusFadeInCurve → Curve
Defines fade-in curve of focus curved animatin.
final
focusFadeInDuration → Duration
Defines fade-in duration of focus animatin.
final
focusFadeOutCurve → Curve?
Defines fade-out curve of focus curved animatin.
final
focusFadeOutDuration → Duration?
Defines fade-out duration of focus animatin.
final
hashCode → int
The hash code for this object.
no setterinherited
hitTestBehavior → HitTestBehavior
Same as HitTestBehavior of RawGestureDetector.
final
hoverColor → Color?
Defines the background color of the hover effect shown when the mouse hovers.
final
hoverColorRelativeOpacity → double
Defines what percentage of ripple color opacity the default hover color will be defined as when no hover color is artificially defined.
final
hoverCursor → SystemMouseCursor
Defines the mouse cursor that is visible when hovering with the mouse.
final
hoverFadeInCurve → Curve
Defines fade-in curve of hover curved animatin.
final
hoverFadeInDuration → Duration
Defines fade-in duration of hover animatin.
final
hoverFadeOutCurve → Curve?
Defines fade-out curve of hover curved animatin.
final
hoverFadeOutDuration → Duration?
Defines fade-out duration of hover animatin.
final
isDoubleTapContinuable → bool
Defines whether double tapping is allowed in succession.
final
isLongTapContinuable → bool
Defines whether long tapping is allowed in succession.
final
isOnHoveredDisableFocusEffect → bool
Defines whether to disable the focus effect when in a hover state.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
longTapBehavior → TouchRippleBehavior?
Defines the behavior applied when a long tap event occurs.
final
longTapFocusStartEvent → TouchRippleLongTapFocusStartEvent
final
longTappableDuration → Duration?
Defines the minimum duration define as a long tap.
final
longTapStartDeleyDuration → Duration
Defines the amount of duration that must elapse before a long press gesture is considered initiated.
final
onDoubleTap → TouchRippleEventCallBack?
Defines a function that is called when the user double taps on that widget.
final
onDoubleTapContinuableChecked → TouchRippleContinuableCheckedCallBack?
final
onDoubleTapEnd → TouchRippleStateCallBack?
Defines a function that is called when a double tap event is fired and the double tap state has ended.
final
onDoubleTapStart → TouchRippleStateCallBack?
Defines a function that is called when a double tap event occurs and enters the double tap state.
final
onFocusEnd → TouchRippleStateCallBack?
Defines a callback function that is called when the focus state ends.
final
onFocusStart → TouchRippleStateCallBack?
Defines a callback function that is called when the transitions to the focus state.
final
onHoverEnd → TouchRippleStateCallBack?
Defines a function that is called when the hover state ends.
final
onHoverStart → TouchRippleStateCallBack?
Defines a function that is called when a hover event occurs and enters the hover state.
final
onLongTap → TouchRippleContinuableCheckedCallBack?
Defines a function that is called when the user long tap on that widget.
final
onLongTapEnd → TouchRippleStateCallBack?
Defines a function that is called when a long tap event is fired and the long tap state has ended.
final
onLongTapStart → TouchRippleStateCallBack?
Defines a function that is called when a long tap event occurs and enters the long tap state.
final
onTap → TouchRippleEventCallBack?
Defines a function that is called when the user taps on that widget.
final
onTapAsync → TouchRippleEventAsyncCallBack<T>?
Defines a async function that is called when the user taps on that widget, Unlike onTap, ripples do not disappear and wait before receiving a response.
final
onTapAsyncEnd → TouchRippleEventResponseCallback<T>?
Defines a function that is called when async processing for onTapAsync ended.
final
onTapAsyncStart → TouchRippleEventCallBack?
Defines a function that is called when the start of async processing for onTapAsync.
final
rejectBehavior → TouchRippleRejectBehavior
Defines the touch ripple reject with pointer position behavior.
final
renderOrder → TouchRippleRenderOrderType
Defines the order in which the touch ripple effect is drawn.
final
rippleBlurRadius → double
Defines the radius value of the blur effect of a ripple.
final
rippleColor → Color?
Defines touch ripple background color of all events.
final
rippleScale → double
Defines scale of touch ripple effect size.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
tapableDuration → Duration?
tapableDuration defines the duration after which the tap event is canceled after the pointerDown event occurs,
final
tapBehavior → TouchRippleBehavior?
Defines the behavior applied when a tap event occurs.
final
tapPreviewMinDuration → Duration?
The minimum duration to wait before showing the preview tap effect, if no other events need to be considered.
final
useDoubleTapFocusEffect → bool
Defines whether to use the focus effect on double tap state.
final
useFocusEffect → bool
Defines whether a focus effect should be used throughout.
final
useHoverEffect → bool
Defines whether a hover effect should be used throughout.
final
useLongTapFocusEffect → bool
Defines whether to use the focus effect on long tap state.
final

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createGestureDetector({required Widget child, TouchRippleRecognizerCallback? onTap, TouchRippleRejectableCallback? onRejectableTap, TouchRippleRecognizerCountableCallback? onDoubleTap, TouchRippleStateCallBack? onDoubleTapStart, TouchRippleStateCallBack? onDoubleTapEnd, TouchRippleRejectableCallback? onRejectableLongTap, TouchRippleStateCallBack? onLongTapStart, TouchRippleStateCallBack? onLongTapEnd, TouchRippleRecognizerCallback? onCancel, TouchRippleAcceptedCallback? onAccepted, TouchRippleRejectedCallback? onRejected}) → TouchRippleGestureDetectorWidget
Create a new instance of the T widget that extends from TouchRippleGestureDetactorWidget.
createState() → State<StatefulWidget>
Creates the mutable state for this widget at a given location in the tree.
inherited
createTouchRippleController() → TouchRippleController
Create a new instance of the TouchRippleController,
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}) → 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

Static Methods

of(BuildContext context) → TouchRippleWidgetState?
Finds the TouchRippleWidgetState from the closest instance of this class that encloses the given context.