GestureRecognizer class abstract
The base class that all gesture recognizers inherit from.
Provides a basic API that can be used by classes that work with gesture recognizers but don't care about the specific details of the gestures recognizers themselves.
See also:
- GestureDetector, the widget that is used to detect built-in gestures.
- RawGestureDetector, the widget that is used to detect custom gestures.
- debugPrintRecognizerCallbacksTrace, a flag that can be set to help debug issues with gesture recognizers.
- Inheritance
-
- Object
- GestureArenaMember
- GestureRecognizer
- Mixed in types
- Implementers
Constructors
-
GestureRecognizer({Object? debugOwner, Set<
PointerDeviceKind> ? supportedDevices, AllowedButtonsFilter allowedButtonsFilter = _defaultButtonAcceptBehavior}) - Initializes the gesture recognizer.
Properties
- allowedButtonsFilter → AllowedButtonsFilter
-
Called when interaction starts. This limits the dragging behavior
for custom clicks (such as scroll click). Its parameter comes
from PointerEvent.buttons.
final
- debugDescription → String
-
Returns a very short pretty description of the gesture that the
recognizer looks for, like 'tap' or 'horizontal drag'.
no setter
- debugOwner → Object?
-
The recognizer's owner.
final
- gestureSettings ↔ DeviceGestureSettings?
-
Optional device specific configuration for device gestures that will
take precedence over framework defaults.
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
supportedDevices
↔ Set<
PointerDeviceKind> ? -
The kind of devices that are allowed to be recognized as provided by
supportedDevicesin the constructor, or the currently deprecatedkind. These cannot both be set. If both are null, events from all device kinds will be tracked and recognized.getter/setter pair
Methods
-
acceptGesture(
int pointer) → void -
Called when this member wins the arena for the given pointer id.
inherited
-
addAllowedPointer(
PointerDownEvent event) → void - Registers a new pointer that's been checked to be allowed by this gesture recognizer.
-
addAllowedPointerPanZoom(
PointerPanZoomStartEvent event) → void - Registers a new pointer pan/zoom that's been checked to be allowed by this gesture recognizer.
-
addPointer(
PointerDownEvent event) → void - Registers a new pointer that might be relevant to this gesture detector.
-
addPointerPanZoom(
PointerPanZoomStartEvent event) → void - Registers a new pointer pan/zoom that might be relevant to this gesture detector.
-
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
-
dispose(
) → void - Releases any resources used by the object.
-
getKindForPointer(
int pointer) → PointerDeviceKind - For a given pointer ID, returns the device kind associated with it.
-
handleNonAllowedPointer(
PointerDownEvent event) → void - Handles a pointer being added that's not allowed by this recognizer.
-
handleNonAllowedPointerPanZoom(
PointerPanZoomStartEvent event) → void - Handles a pointer pan/zoom being added that's not allowed by this recognizer.
-
invokeCallback<
T> (String name, RecognizerCallback< T> callback, {String debugReport()?}) → T? - Invoke a callback provided by the application, catching and logging any exceptions.
-
isPointerAllowed(
PointerDownEvent event) → bool - Checks whether or not a pointer is allowed to be tracked by this recognizer.
-
isPointerPanZoomAllowed(
PointerPanZoomStartEvent event) → bool - Checks whether or not a pointer pan/zoom is allowed to be tracked by this recognizer.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
rejectGesture(
int pointer) → void -
Called when this member loses the arena for the given pointer id.
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 brief description of this object, usually just the runtimeType and the
hashCode.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited