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.

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 class	GestureController.SimpleOnGestureListener Simple implementation of GestureController.OnGestureListener

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.
void	animateStateTo(State endState) Animates current state to provided end state.
Settings	getSettings() Returns settings that can be updated.
State	getState() Returns current state.
StateController	getStateController() Returns state controller that can be used externally.
protected void	notifyStateReset()
protected void	notifyStateUpdated()
protected boolean	onDoubleTapEvent(android.view.MotionEvent e)
protected boolean	onDown(android.view.MotionEvent e)
protected boolean	onFling(android.view.MotionEvent e1, android.view.MotionEvent e2, float vX, float vY)
protected void	onFlingAnimationFinished()
protected void	onFlingScroll(float fromX, float fromY, float toX, float toY)
protected void	onLongPress(android.view.MotionEvent e)
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 e)
protected boolean	onSingleTapUp(android.view.MotionEvent e)
protected void	onStateAnimationFinished()
boolean	onTouch(android.view.View view, android.view.MotionEvent event)
protected void	onUpOrCancel(android.view.MotionEvent e)
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	setLongPressEnabled(boolean enabled) Sets whether long press is enabled or not.
void	setOnGesturesListener(GestureController.OnGestureListener listener) Sets listener for basic touch events.
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(android.view.View view)

Method Detail

setOnGesturesListener

public void setOnGesturesListener(GestureController.OnGestureListener listener)

Sets listener for basic touch events.

See also GestureController.OnGestureListener

addOnStateChangeListener

public void addOnStateChangeListener(GestureController.OnStateChangeListener listener)

Adds listener for state changes.

See also GestureController.OnStateChangeListener

removeOnStateChangeListener

public void removeOnStateChangeListener(GestureController.OnStateChangeListener listener)

Removes listener for state changes.

See also addOnStateChangeListener(OnStateChangeListener)

setLongPressEnabled

public void setLongPressEnabled(boolean enabled)

Sets whether long press is enabled or not. Long press is disabled by default.

See also GestureController.OnGestureListener.onLongPress(android.view.MotionEvent)

getSettings

public Settings getSettings()

Returns settings that can be updated.

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

getState

public State getState()

Returns current state. In most cases you should not modify state directly, use one of the methods provided in StateController instead.

If current state was changed outside GestureController you should call updateState() to properly apply changes.

getStateController

public StateController getStateController()

Returns state controller that can be used externally.

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).

animateStateTo

public void animateStateTo(State endState)

Animates current state to provided end state. Note, that no state restrictions will be applied during animation, so you should ensure end state is within bounds.

stopStateAnimation

public void stopStateAnimation()

stopFlingAnimation

public void stopFlingAnimation()

stopAllAnimations

public void stopAllAnimations()

notifyStateUpdated

protected void notifyStateUpdated()

notifyStateReset

protected void notifyStateReset()

onTouch

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

Specified by:

onTouch in interface android.view.View.OnTouchListener

onDown

protected boolean onDown(android.view.MotionEvent e)

onUpOrCancel

protected void onUpOrCancel(android.view.MotionEvent e)

onSingleTapUp

protected boolean onSingleTapUp(android.view.MotionEvent e)

onLongPress

protected void onLongPress(android.view.MotionEvent e)

onScroll

protected boolean onScroll(android.view.MotionEvent e1,
                           android.view.MotionEvent e2,
                           float dX,
                           float dY)

onFling

protected boolean onFling(android.view.MotionEvent e1,
                          android.view.MotionEvent e2,
                          float vX,
                          float vY)

onFlingScroll

protected void onFlingScroll(float fromX,
                             float fromY,
                             float toX,
                             float toY)

onSingleTapConfirmed

protected boolean onSingleTapConfirmed(android.view.MotionEvent e)

onDoubleTapEvent

protected boolean onDoubleTapEvent(android.view.MotionEvent e)

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)

onFlingAnimationFinished

protected void onFlingAnimationFinished()

onStateAnimationFinished

protected void onStateAnimationFinished()