com.alexvasilkov.gestures

Class GestureController

java.lang.Object

com.alexvasilkov.gestures.GestureController

All Implemented Interfaces:

android.view.View.OnTouchListener

Direct Known Subclasses:

GestureControllerForPager

public class GestureController
extends java.lang.Object
implements android.view.View.OnTouchListener

Handles touch events to update view's position state (State) based on current setup (Settings).
Settings can be obtained and altered through getSettings().
Note, that some settings are required in order to correctly update state, see Settings.

This class implements View.OnTouchListener to delegate touches from view to controller.

State can also be manipulated directly with getState(), updateState() and resetState(). You can also access getStateController() for some additional stuff.

State can be animated with animateStateTo(State) method.
See also stopFlingAnimation(), stopStateAnimation() and stopAllAnimations() methods.

All state changes will be passed to OnStateChangeListener. See addOnStateChangeListener and removeOnStateChangeListener methods.

Additional touch events can be listened with OnGestureListener and SimpleOnGestureListener using setOnGesturesListener method.

State source changes (whether state is being changed by user or by animation) can be listened with GestureController.OnStateSourceChangeListener using setOnStateSourceChangeListener(OnStateSourceChangeListener) method.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GestureController.OnGestureListener Listener for different touch events.
static interface	GestureController.OnStateChangeListener State changes listener.
static interface	GestureController.OnStateSourceChangeListener State source changes listener.
static class	GestureController.SimpleOnGestureListener Simple implementation of GestureController.OnGestureListener.
static class	GestureController.StateSource Source of state changes.

Constructor Summary

Constructors

Constructor and Description
GestureController(android.view.View view)

Method Summary

Modifier and Type	Method and Description
void	addOnStateChangeListener(GestureController.OnStateChangeListener listener) Adds listener for state changes.
boolean	animateKeepInBounds() Animates to correct position withing the bounds.
boolean	animateStateTo(State endState) Animates current state to provided end state.
Settings	getSettings() Returns settings that can be updated.
State	getState() Current state.
StateController	getStateController()
boolean	isAnimating()
boolean	isAnimatingFling()
boolean	isAnimatingState()
protected void	notifyStateReset()
protected void	notifyStateUpdated()
protected boolean	onDoubleTapEvent(android.view.MotionEvent event)
protected boolean	onDown(android.view.MotionEvent event)
protected boolean	onFling(android.view.MotionEvent e1, android.view.MotionEvent e2, float vx, float vy)
protected void	onFlingAnimationFinished(boolean forced)
protected boolean	onFlingScroll(int dx, int dy)
boolean	onInterceptTouch(android.view.View view, android.view.MotionEvent event)
protected void	onLongPress(android.view.MotionEvent event)
protected boolean	onRotate(RotationGestureDetector detector)
protected boolean	onRotationBegin(RotationGestureDetector detector)
protected void	onRotationEnd(RotationGestureDetector detector)
protected boolean	onScale(android.view.ScaleGestureDetector detector)
protected boolean	onScaleBegin(android.view.ScaleGestureDetector detector)
protected void	onScaleEnd(android.view.ScaleGestureDetector detector)
protected boolean	onScroll(android.view.MotionEvent e1, android.view.MotionEvent e2, float dx, float dy)
protected boolean	onSingleTapConfirmed(android.view.MotionEvent event)
protected boolean	onSingleTapUp(android.view.MotionEvent event)
protected void	onStateAnimationFinished(boolean forced)
boolean	onTouch(android.view.View view, android.view.MotionEvent event)
protected boolean	onTouchInternal(android.view.View view, android.view.MotionEvent event)
protected void	onUpOrCancel(android.view.MotionEvent event)
void	removeOnStateChangeListener(GestureController.OnStateChangeListener listener) Removes listener for state changes.
void	resetState() Resets to initial state (default position, min zoom level) and notifies GestureController.OnStateChangeListener listeners.
void	setOnGesturesListener(GestureController.OnGestureListener listener) Sets listener for basic touch events.
void	setOnStateSourceChangeListener(GestureController.OnStateSourceChangeListener listener) Sets listener for state source changes.
void	setPivot(float pivotX, float pivotY) Sets pivot point for zooming when keeping image in bounds.
protected boolean	shouldDisallowInterceptTouch(android.view.MotionEvent event)
void	stopAllAnimations()
void	stopFlingAnimation()
void	stopStateAnimation()
void	updateState() Applies state restrictions and notifies GestureController.OnStateChangeListener listeners.

Methods inherited from class java.lang.Object

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

Constructor Detail

GestureController

public GestureController(@NonNull
                         android.view.View view)

Method Detail

setOnGesturesListener

public void setOnGesturesListener(@Nullable
                                  GestureController.OnGestureListener listener)

Sets listener for basic touch events.

Parameters:

listener - Gestures listener

See Also:

GestureController.OnGestureListener

setOnStateSourceChangeListener

public void setOnStateSourceChangeListener(@Nullable
                                           GestureController.OnStateSourceChangeListener listener)

Sets listener for state source changes.

Parameters:

listener - State's source changes listener

See Also:

GestureController.OnStateSourceChangeListener

addOnStateChangeListener

public void addOnStateChangeListener(@NonNull
                                     GestureController.OnStateChangeListener listener)

Adds listener for state changes.

Parameters:

listener - State changes listener

See Also:

GestureController.OnStateChangeListener

removeOnStateChangeListener

public void removeOnStateChangeListener(@NonNull
                                        GestureController.OnStateChangeListener listener)

Removes listener for state changes.

Parameters:

listener - State changes listener to be removed

See Also:

addOnStateChangeListener(OnStateChangeListener)

getSettings

@NonNull
public Settings getSettings()

Returns settings that can be updated.

Note: call updateState(), resetState() or animateKeepInBounds() after settings was changed to correctly apply state restrictions.

Returns:

Gesture view's settings

getState

@NonNull
public State getState()

Current state.

If this state is changed from outside you should call updateState() or animateKeepInBounds() to properly apply changes.

Returns:

Current state

getStateController

@NonNull
public StateController getStateController()

Returns:

State controller to get computed min/max zoom levels or calculate movement area

updateState

public void updateState()

Applies state restrictions and notifies GestureController.OnStateChangeListener listeners.

resetState

public void resetState()

Resets to initial state (default position, min zoom level) and notifies GestureController.OnStateChangeListener listeners.

Should be called when image size is changed.

See Settings.setImage(int, int).

setPivot

public void setPivot(float pivotX,
                     float pivotY)

Sets pivot point for zooming when keeping image in bounds.

Parameters:

pivotX - Pivot point's X coordinate

pivotY - Pivot point's Y coordinate

See Also:

animateKeepInBounds(), animateStateTo(State)

animateKeepInBounds

public boolean animateKeepInBounds()

Animates to correct position withing the bounds.

Returns:

true if animation started, false otherwise. Animation may not be started if image already withing the bounds.

animateStateTo

public boolean animateStateTo(@Nullable
                              State endState)

Animates current state to provided end state.

Parameters:

endState - End state

Returns:

true if animation started, false otherwise. Animation may not be started if end state is null or equals to current state (after bounds restrictions are applied).

isAnimatingState

public boolean isAnimatingState()

isAnimatingFling

public boolean isAnimatingFling()

isAnimating

public boolean isAnimating()

stopStateAnimation

public void stopStateAnimation()

stopFlingAnimation

public void stopFlingAnimation()

stopAllAnimations

public void stopAllAnimations()

onStateAnimationFinished

protected void onStateAnimationFinished(boolean forced)

onFlingAnimationFinished

protected void onFlingAnimationFinished(boolean forced)

notifyStateUpdated

protected void notifyStateUpdated()

notifyStateReset

protected void notifyStateReset()

onInterceptTouch

public boolean onInterceptTouch(@NonNull
                                android.view.View view,
                                @NonNull
                                android.view.MotionEvent event)

onTouch

public boolean onTouch(@NonNull
                       android.view.View view,
                       @NonNull
                       android.view.MotionEvent event)

Specified by:

onTouch in interface android.view.View.OnTouchListener

onTouchInternal

protected boolean onTouchInternal(@NonNull
                                  android.view.View view,
                                  @NonNull
                                  android.view.MotionEvent event)

shouldDisallowInterceptTouch

protected boolean shouldDisallowInterceptTouch(android.view.MotionEvent event)

onDown

protected boolean onDown(@NonNull
                         android.view.MotionEvent event)

onUpOrCancel

protected void onUpOrCancel(@NonNull
                            android.view.MotionEvent event)

onSingleTapUp

protected boolean onSingleTapUp(@NonNull
                                android.view.MotionEvent event)

onLongPress

protected void onLongPress(@NonNull
                           android.view.MotionEvent event)

onScroll

protected boolean onScroll(@NonNull
                           android.view.MotionEvent e1,
                           @NonNull
                           android.view.MotionEvent e2,
                           float dx,
                           float dy)

onFling

protected boolean onFling(@NonNull
                          android.view.MotionEvent e1,
                          @NonNull
                          android.view.MotionEvent e2,
                          float vx,
                          float vy)

onFlingScroll

protected boolean onFlingScroll(int dx,
                                int dy)

Parameters:

dx - Current X offset in the fling scroll

dy - Current Y offset in the fling scroll

Returns:

true if state was changed, false otherwise.

onSingleTapConfirmed

protected boolean onSingleTapConfirmed(android.view.MotionEvent event)

onDoubleTapEvent

protected boolean onDoubleTapEvent(android.view.MotionEvent event)

onScaleBegin

protected boolean onScaleBegin(android.view.ScaleGestureDetector detector)

onScale

protected boolean onScale(android.view.ScaleGestureDetector detector)

onScaleEnd

protected void onScaleEnd(android.view.ScaleGestureDetector detector)

onRotationBegin

protected boolean onRotationBegin(RotationGestureDetector detector)

onRotate

protected boolean onRotate(RotationGestureDetector detector)

onRotationEnd

protected void onRotationEnd(RotationGestureDetector detector)