TapAndHorizontalDragGestureRecognizer class
Recognizes taps along with movement in the horizontal direction.
Before this recognizer has won the arena for the primary pointer being tracked, it will only accept a drag on the horizontal axis. If a drag is detected after this recognizer has won the arena then it will accept a drag on any axis.
See also:
- BaseTapAndDragGestureRecognizer, for the class that provides the main implementation details of this recognizer.
- TapAndPanGestureRecognizer, for a similar recognizer that accepts a drag on any axis regardless if the recognizer has won the arena for the primary pointer being tracked.
- HorizontalDragGestureRecognizer, for a similar recognizer that only recognizes horizontal movement.
- Inheritance
-
- Object
- GestureArenaMember
- GestureRecognizer
- OneSequenceGestureRecognizer
- BaseTapAndDragGestureRecognizer
- TapAndHorizontalDragGestureRecognizer
Constructors
-
TapAndHorizontalDragGestureRecognizer({Object? debugOwner, Set<
PointerDeviceKind> ? supportedDevices}) - Create a gesture recognizer for interactions in the horizontal axis.
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.
finalinherited
- consecutiveTapCount → int
-
no setterinherited
- currentDown → PointerDownEvent?
-
no setterinherited
- currentUp → PointerUpEvent?
-
no setterinherited
- debugDescription → String
-
Returns a very short pretty description of the gesture that the
recognizer looks for, like 'tap' or 'horizontal drag'.
no setteroverride
- debugOwner → Object?
-
The recognizer's owner.
finalinherited
- dragStartBehavior ↔ DragStartBehavior
-
Configure the behavior of offsets passed to onDragStart.
getter/setter pairinherited
- dragUpdateThrottleFrequency ↔ Duration?
-
The frequency at which the onDragUpdate callback is called.
getter/setter pairinherited
- eagerVictoryOnDrag ↔ bool
-
Whether this recognizer eagerly declares victory when it has detected
a drag.
getter/setter pairinherited
- gestureSettings ↔ DeviceGestureSettings?
-
Optional device specific configuration for device gestures that will
take precedence over framework defaults.
getter/setter pairinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- maxConsecutiveTap ↔ int?
-
An upper bound for the amount of taps that can belong to one tap series.
getter/setter pairinherited
- onCancel ↔ GestureCancelCallback?
-
The pointer that previously triggered onTapDown did not complete.
getter/setter pairinherited
- onDragEnd ↔ GestureTapDragEndCallback?
-
A pointer that was previously in contact with the screen with a primary
button and moving is no longer in contact with the screen and was moving
at a specific velocity when it stopped contacting the screen.
getter/setter pairinherited
- onDragStart ↔ GestureTapDragStartCallback?
-
A pointer has contacted the screen with a primary button and has begun to
move.
getter/setter pairinherited
- onDragUpdate ↔ GestureTapDragUpdateCallback?
-
A pointer that is in contact with the screen with a primary button and
moving has moved again.
getter/setter pairinherited
- onTapDown ↔ GestureTapDragDownCallback?
-
A pointer has contacted the screen at a particular location with a primary
button, which might be the start of a tap.
getter/setter pairinherited
- onTapTrackReset ↔ VoidCallback?
-
Callback used to indicate that a tap tracking has been reset which
happens on the next PointerDownEvent after the timer between two taps
elapses, the recognizer loses the arena, the gesture is cancelled or
the recognizer is disposed of.
getter/setter pairinherited
- onTapTrackStart ↔ VoidCallback?
-
Callback used to indicate that a tap tracking has started upon
a PointerDownEvent.
getter/setter pairinherited
- onTapUp ↔ GestureTapDragUpCallback?
-
A pointer has stopped contacting the screen at a particular location,
which is recognized as a tap of a primary button.
getter/setter pairinherited
- 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
supportedDevices
in 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 pairinherited - team ↔ GestureArenaTeam?
-
The team that this recognizer belongs to, if any.
getter/setter pairinherited
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.
inherited
-
addAllowedPointerPanZoom(
PointerPanZoomStartEvent event) → void -
Registers a new pointer pan/zoom that's been checked to be allowed by this
gesture recognizer.
inherited
-
addPointer(
PointerDownEvent event) → void -
Registers a new pointer that might be relevant to this gesture
detector.
inherited
-
addPointerPanZoom(
PointerPanZoomStartEvent event) → void -
Registers a new pointer pan/zoom that might be relevant to this gesture
detector.
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.
inherited
-
didStopTrackingLastPointer(
int pointer) → void -
Called when the number of pointers this recognizer is tracking changes from one to zero.
inherited
-
dispose(
) → void -
Releases any resources used by the object.
inherited
-
getKindForPointer(
int pointer) → PointerDeviceKind -
For a given pointer ID, returns the device kind associated with it.
inherited
-
handleEvent(
PointerEvent event) → void -
Called when a pointer event is routed to this recognizer.
inherited
-
handleNonAllowedPointer(
PointerDownEvent event) → void -
Handles a pointer being added that's not allowed by this recognizer.
inherited
-
handleNonAllowedPointerPanZoom(
PointerPanZoomStartEvent event) → void -
Handles a pointer pan/zoom being added that's not allowed by this recognizer.
inherited
-
invokeCallback<
T> (String name, RecognizerCallback< T> callback, {String debugReport()?}) → T? -
Invoke a callback provided by the application, catching and logging any
exceptions.
inherited
-
isPointerAllowed(
PointerEvent event) → bool -
Checks whether or not a pointer is allowed to be tracked by this recognizer.
inherited
-
isPointerPanZoomAllowed(
PointerPanZoomStartEvent event) → bool -
Checks whether or not a pointer pan/zoom is allowed to be tracked by this recognizer.
inherited
-
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
-
resolve(
GestureDisposition disposition) → void -
Resolves this recognizer's participation in each gesture arena with the
given disposition.
inherited
-
resolvePointer(
int pointer, GestureDisposition disposition) → void -
Resolves this recognizer's participation in the given gesture arena with
the given disposition.
inherited
-
startTrackingPointer(
int pointer, [Matrix4? transform]) → void -
Causes events related to the given pointer ID to be routed to this recognizer.
inherited
-
stopTrackingIfPointerNoLongerDown(
PointerEvent event) → void -
Stops tracking the pointer associated with the given event if the event is
a PointerUpEvent or a PointerCancelEvent event.
inherited
-
stopTrackingPointer(
int pointer) → void -
Stops events related to the given pointer ID from being routed to this recognizer.
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