com.mapbox.android.gestures

Class AndroidGesturesManager

java.lang.Object

com.mapbox.android.gestures.AndroidGesturesManager

public class AndroidGesturesManager
extends java.lang.Object

Entry point for all of the detectors. Set listener for gestures you'd like to be notified about and pass all of the MotionEvents through onTouchEvent(MotionEvent) to start processing gestures.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AndroidGesturesManager.GestureType

Field Summary

Fields

Modifier and Type	Field and Description
static int	GESTURE_TYPE_DOUBLE_TAP
static int	GESTURE_TYPE_DOUBLE_TAP_EVENT
static int	GESTURE_TYPE_DOWN
static int	GESTURE_TYPE_FLING
static int	GESTURE_TYPE_LONG_PRESS
static int	GESTURE_TYPE_MOVE
static int	GESTURE_TYPE_MULTI_FINGER_TAP
static int	GESTURE_TYPE_QUICK_SCALE
static int	GESTURE_TYPE_ROTATE
static int	GESTURE_TYPE_SCALE
static int	GESTURE_TYPE_SCROLL
static int	GESTURE_TYPE_SHOVE
static int	GESTURE_TYPE_SHOW_PRESS
static int	GESTURE_TYPE_SIDEWAYS_SHOVE
static int	GESTURE_TYPE_SINGLE_TAP_CONFIRMED
static int	GESTURE_TYPE_SINGLE_TAP_UP

Constructor Summary

Constructors

Constructor and Description
AndroidGesturesManager(android.content.Context context) Creates a new instance of the AndroidGesturesManager.
AndroidGesturesManager(android.content.Context context, boolean applyDefaultThresholds) Creates a new instance of the AndroidGesturesManager.
AndroidGesturesManager(android.content.Context context, java.util.List<java.util.Set<java.lang.Integer>> exclusiveGestures, boolean applyDefaultThresholds) Creates a new instance of the AndroidGesturesManager.
AndroidGesturesManager(android.content.Context context, java.util.Set<java.lang.Integer>... exclusiveGestures) Creates a new instance of the AndroidGesturesManager.

Method Summary

Modifier and Type	Method and Description
java.util.List<BaseGesture>	getDetectors() Get a list of all active gesture detectors.
MoveGestureDetector	getMoveGestureDetector() Get move gesture detector.
MultiFingerTapGestureDetector	getMultiFingerTapGestureDetector() Get multi finger tap gesture detector.
java.util.List<java.util.Set<java.lang.Integer>>	getMutuallyExclusiveGestures() Returns a list of sets containing mutually exclusive gestures.
RotateGestureDetector	getRotateGestureDetector() Get rotate gesture detector.
ShoveGestureDetector	getShoveGestureDetector() Get shove gesture detector.
SidewaysShoveGestureDetector	getSidewaysShoveGestureDetector() Get sideways shove gesture detector.
StandardGestureDetector	getStandardGestureDetector() Get gesture detector that wraps androidx.core.view.GestureDetectorCompat.
StandardScaleGestureDetector	getStandardScaleGestureDetector() Get scale gesture detector.
boolean	onTouchEvent(android.view.MotionEvent motionEvent) Passes motion events to all gesture detectors.
void	removeMoveGestureListener() Removes a listener for move gestures.
void	removeMultiFingerTapGestureListener() Removes a listener for multi finger tap gestures.
void	removeRotateGestureListener() Removes a listener for rotate gestures.
void	removeShoveGestureListener() Removes a listener for shove gestures.
void	removeSidewaysShoveGestureListener() Removes a listener for sideways shove gestures.
void	removeStandardGestureListener() Removes a listener for all the events normally returned by the androidx.core.view.GestureDetectorCompat.
void	removeStandardScaleGestureListener() Removes a listener for scale gestures.
void	setMoveGestureListener(MoveGestureDetector.OnMoveGestureListener listener) Sets a listener for move gestures.
void	setMultiFingerTapGestureListener(MultiFingerTapGestureDetector.OnMultiFingerTapGestureListener listener) Sets a listener for multi finger tap gestures.
void	setMutuallyExclusiveGestures(java.util.List<java.util.Set<java.lang.Integer>> exclusiveGestures) Sets a list of sets containing mutually exclusive gestures.
void	setMutuallyExclusiveGestures(java.util.Set<java.lang.Integer>... exclusiveGestures) Sets a number of sets containing mutually exclusive gestures.
void	setRotateGestureListener(RotateGestureDetector.OnRotateGestureListener listener) Sets a listener for rotate gestures.
void	setShoveGestureListener(ShoveGestureDetector.OnShoveGestureListener listener) Sets a listener for shove gestures.
void	setSidewaysShoveGestureListener(SidewaysShoveGestureDetector.OnSidewaysShoveGestureListener listener) Sets a listener for sideways shove gestures.
void	setStandardGestureListener(StandardGestureDetector.StandardOnGestureListener listener) Sets a listener for all the events normally returned by the androidx.core.view.GestureDetectorCompat.
void	setStandardScaleGestureListener(StandardScaleGestureDetector.StandardOnScaleGestureListener listener) Sets a listener for scale gestures.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

GESTURE_TYPE_SCROLL

public static final int GESTURE_TYPE_SCROLL

See Also:

Constant Field Values

GESTURE_TYPE_SCALE

public static final int GESTURE_TYPE_SCALE

See Also:

Constant Field Values

GESTURE_TYPE_ROTATE

public static final int GESTURE_TYPE_ROTATE

See Also:

Constant Field Values

GESTURE_TYPE_SHOVE

public static final int GESTURE_TYPE_SHOVE

See Also:

Constant Field Values

GESTURE_TYPE_MULTI_FINGER_TAP

public static final int GESTURE_TYPE_MULTI_FINGER_TAP

See Also:

Constant Field Values

GESTURE_TYPE_SINGLE_TAP_UP

public static final int GESTURE_TYPE_SINGLE_TAP_UP

See Also:

Constant Field Values

GESTURE_TYPE_LONG_PRESS

public static final int GESTURE_TYPE_LONG_PRESS

See Also:

Constant Field Values

GESTURE_TYPE_FLING

public static final int GESTURE_TYPE_FLING

See Also:

Constant Field Values

GESTURE_TYPE_SHOW_PRESS

public static final int GESTURE_TYPE_SHOW_PRESS

See Also:

Constant Field Values

GESTURE_TYPE_DOWN

public static final int GESTURE_TYPE_DOWN

See Also:

Constant Field Values

GESTURE_TYPE_DOUBLE_TAP

public static final int GESTURE_TYPE_DOUBLE_TAP

See Also:

Constant Field Values

GESTURE_TYPE_DOUBLE_TAP_EVENT

public static final int GESTURE_TYPE_DOUBLE_TAP_EVENT

See Also:

Constant Field Values

GESTURE_TYPE_SINGLE_TAP_CONFIRMED

public static final int GESTURE_TYPE_SINGLE_TAP_CONFIRMED

See Also:

Constant Field Values

GESTURE_TYPE_MOVE

public static final int GESTURE_TYPE_MOVE

See Also:

Constant Field Values

GESTURE_TYPE_SIDEWAYS_SHOVE

public static final int GESTURE_TYPE_SIDEWAYS_SHOVE

See Also:

Constant Field Values

GESTURE_TYPE_QUICK_SCALE

public static final int GESTURE_TYPE_QUICK_SCALE

See Also:

Constant Field Values

Constructor Detail

AndroidGesturesManager

public AndroidGesturesManager(android.content.Context context)

Creates a new instance of the AndroidGesturesManager.

Parameters:

context - activity's context

AndroidGesturesManager

public AndroidGesturesManager(android.content.Context context,
                              boolean applyDefaultThresholds)

Creates a new instance of the AndroidGesturesManager.

Parameters:

context - activity's context

applyDefaultThresholds - if true, default gestures thresholds and adjustments will be applied

AndroidGesturesManager

@SafeVarargs
public AndroidGesturesManager(android.content.Context context,
                                           java.util.Set<java.lang.Integer>... exclusiveGestures)

Creates a new instance of the AndroidGesturesManager.

Parameters:

context - Activity's context

exclusiveGestures - a number of sets of AndroidGesturesManager.GestureTypes that should not be invoked at the same. This means that when a set contains a ProgressiveGesture and this gestures is in progress no other gestures from the set will be invoked.

At the moment GESTURE_TYPE_SCROLL is not interpreted as a progressive gesture because it is not implemented this way by the androidx.core.view.GestureDetectorCompat.

AndroidGesturesManager

public AndroidGesturesManager(android.content.Context context,
                              java.util.List<java.util.Set<java.lang.Integer>> exclusiveGestures,
                              boolean applyDefaultThresholds)

Creates a new instance of the AndroidGesturesManager.

Parameters:

context - Activity's context

exclusiveGestures - a list of sets of AndroidGesturesManager.GestureTypes that should not be invoked at the same. This means that when a set contains a ProgressiveGesture and this gestures is in progress no other gestures from the set will be invoked.

At the moment GESTURE_TYPE_SCROLL is not interpreted as a progressive gesture because it is not implemented this way by the androidx.core.view.GestureDetectorCompat.

applyDefaultThresholds - if true, default gestures thresholds and adjustments will be applied

Method Detail

onTouchEvent

public boolean onTouchEvent(android.view.MotionEvent motionEvent)

Passes motion events to all gesture detectors.

Parameters:

motionEvent - event provided by the Android OS.

Returns:

true if the touch event is handled by any gesture, false otherwise.

setStandardGestureListener

public void setStandardGestureListener(StandardGestureDetector.StandardOnGestureListener listener)

Sets a listener for all the events normally returned by the androidx.core.view.GestureDetectorCompat.

Parameters:

listener - your gestures listener

See Also:

Using Touch Gestures, GestureDetectorCompat

removeStandardGestureListener

public void removeStandardGestureListener()

Removes a listener for all the events normally returned by the androidx.core.view.GestureDetectorCompat.

setStandardScaleGestureListener

public void setStandardScaleGestureListener(StandardScaleGestureDetector.StandardOnScaleGestureListener listener)

Sets a listener for scale gestures.

Parameters:

listener - your gestures listener

removeStandardScaleGestureListener

public void removeStandardScaleGestureListener()

Removes a listener for scale gestures.

setRotateGestureListener

public void setRotateGestureListener(RotateGestureDetector.OnRotateGestureListener listener)

Sets a listener for rotate gestures.

Parameters:

listener - your gestures listener

removeRotateGestureListener

public void removeRotateGestureListener()

Removes a listener for rotate gestures.

setShoveGestureListener

public void setShoveGestureListener(ShoveGestureDetector.OnShoveGestureListener listener)

Sets a listener for shove gestures.

Parameters:

listener - your gestures listener

removeShoveGestureListener

public void removeShoveGestureListener()

Removes a listener for shove gestures.

setMultiFingerTapGestureListener

public void setMultiFingerTapGestureListener(MultiFingerTapGestureDetector.OnMultiFingerTapGestureListener listener)

Sets a listener for multi finger tap gestures.

Parameters:

listener - your gestures listener

removeMultiFingerTapGestureListener

public void removeMultiFingerTapGestureListener()

Removes a listener for multi finger tap gestures.

setMoveGestureListener

public void setMoveGestureListener(MoveGestureDetector.OnMoveGestureListener listener)

Sets a listener for move gestures.

MoveGestureDetector serves similar purpose to #onScroll(MotionEvent, MotionEvent, float, float), however, it's a ProgressiveGesture that introduces MoveGestureDetector.OnMoveGestureListener.onMoveBegin(MoveGestureDetector), MoveGestureDetector.OnMoveGestureListener.onMoveEnd(MoveGestureDetector, float, float), threshold with MoveGestureDetector.setMoveThreshold(float) and multi finger support thanks to MoveDistancesObject.

Parameters:

listener - your gestures listener

removeMoveGestureListener

public void removeMoveGestureListener()

Removes a listener for move gestures.

setSidewaysShoveGestureListener

public void setSidewaysShoveGestureListener(SidewaysShoveGestureDetector.OnSidewaysShoveGestureListener listener)

Sets a listener for sideways shove gestures.

Parameters:

listener - your gestures listener

removeSidewaysShoveGestureListener

public void removeSidewaysShoveGestureListener()

Removes a listener for sideways shove gestures.

getDetectors

public java.util.List<BaseGesture> getDetectors()

Get a list of all active gesture detectors.

Returns:

list of all gesture detectors

getStandardGestureDetector

public StandardGestureDetector getStandardGestureDetector()

Get gesture detector that wraps androidx.core.view.GestureDetectorCompat.

Returns:

gesture detector

getStandardScaleGestureDetector

public StandardScaleGestureDetector getStandardScaleGestureDetector()

Get scale gesture detector.

Returns:

gesture detector

getRotateGestureDetector

public RotateGestureDetector getRotateGestureDetector()

Get rotate gesture detector.

Returns:

gesture detector

getShoveGestureDetector

public ShoveGestureDetector getShoveGestureDetector()

Get shove gesture detector.

Returns:

gesture detector

getMultiFingerTapGestureDetector

public MultiFingerTapGestureDetector getMultiFingerTapGestureDetector()

Get multi finger tap gesture detector.

Returns:

gesture detector

getMoveGestureDetector

public MoveGestureDetector getMoveGestureDetector()

Get move gesture detector.

Returns:

gesture detector

getSidewaysShoveGestureDetector

public SidewaysShoveGestureDetector getSidewaysShoveGestureDetector()

Get sideways shove gesture detector.

Returns:

gesture detector

setMutuallyExclusiveGestures

@SafeVarargs
public final void setMutuallyExclusiveGestures(java.util.Set<java.lang.Integer>... exclusiveGestures)

Sets a number of sets containing mutually exclusive gestures.

Parameters:

exclusiveGestures - a number of sets of AndroidGesturesManager.GestureTypes that should not be invoked at the same. This means that when a set contains a ProgressiveGesture and this gestures is in progress no other gestures from the set will be invoked.

At the moment GESTURE_TYPE_SCROLL is not interpreted as a progressive gesture because it is not interpreted this way by the androidx.core.view.GestureDetectorCompat.

setMutuallyExclusiveGestures

public void setMutuallyExclusiveGestures(java.util.List<java.util.Set<java.lang.Integer>> exclusiveGestures)

Sets a list of sets containing mutually exclusive gestures.

Parameters:

exclusiveGestures - a list of sets of AndroidGesturesManager.GestureTypes that should not be invoked at the same. This means that when a set contains a ProgressiveGesture and this gestures is in progress no other gestures from the set will be invoked.

At the moment GESTURE_TYPE_SCROLL is not interpreted as a progressive gesture because it is not interpreted this way by the androidx.core.view.GestureDetectorCompat.

getMutuallyExclusiveGestures

public java.util.List<java.util.Set<java.lang.Integer>> getMutuallyExclusiveGestures()

Returns a list of sets containing mutually exclusive gestures.

Returns:

mutually exclusive gestures

See Also:

setMutuallyExclusiveGestures(List)