public class OnSwipe


Create automatic swipe handling object

Summary

Nested types

public enum OnSwipe.Boundary
public enum OnSwipe.Drag
public enum OnSwipe.Mode
public enum OnSwipe.Side
public enum OnSwipe.TouchUp

Constants

static final int
static final int

Public constructors

OnSwipe(String anchor, OnSwipe.Side side, OnSwipe.Drag dragDirection)

Public methods

OnSwipe.Mode
OnSwipe.Drag
float
float
String
float
float
OnSwipe.TouchUp
String
OnSwipe.Boundary

The behaviour at the boundaries 0 and 1

float
float

Get the mass of the spring. the m in "a = (-k*x-c*v)/m" equation for the acceleration of a spring

float

get the stiffness of the spring

float

The threshold for spring motion to stop.

String
OnSwipe.Side
void

sets the behaviour at the boundaries 0 and 1 COMPLETE_MODE_CONTINUOUS_VELOCITY = 0; COMPLETE_MODE_SPRING = 1;

OnSwipe

The direction of the drag.

OnSwipe
setDragScale(int dragScale)

Normally 1 this can be tweaked to make the acceleration faster

OnSwipe
setDragThreshold(int dragThreshold)

This sets the threshold before the animation is kicked off.

OnSwipe

Only allow touch actions to be initiated within this region

OnSwipe
setMaxAcceleration(int maxAcceleration)

The maximum acceleration and deceleration of the animation (Change in Change in progress per second) Faster makes the object seem lighter and quicker

OnSwipe
setMaxVelocity(int maxVelocity)

The maximum velocity (Change in progress per second) animation can achieve

OnSwipe

Configures what happens when the user releases on mouse up.

OnSwipe
setRotateCenter(String rotationCenterId)

The view to center the rotation about

OnSwipe

The behaviour at the boundaries 0 and 1.

OnSwipe
setSpringDamping(float springDamping)

Set the damping of the spring if using spring. c in "a = (-k*x-c*v)/m" equation for the acceleration of a spring

OnSwipe
setSpringMass(float springMass)

Set the Mass of the spring if using spring. m in "a = (-k*x-c*v)/m" equation for the acceleration of a spring

OnSwipe
setSpringStiffness(float springStiffness)

set the stiffness of the spring if using spring.

OnSwipe
setSpringStopThreshold(float springStopThreshold)

set the threshold for spring motion to stop.

OnSwipe

The id of the view who's movement is matched to your drag If not specified it will map to a linear movement across the width of the motionLayout

OnSwipe

This side of the view that matches the drag movement.

String

Constants

FLAG_DISABLE_POST_SCROLL

Added in 1.1.0-alpha13
public static final int FLAG_DISABLE_POST_SCROLL = 1

FLAG_DISABLE_SCROLL

Added in 1.1.0-alpha13
public static final int FLAG_DISABLE_SCROLL = 2

Public constructors

OnSwipe

Added in 1.1.0-alpha13
public OnSwipe()

OnSwipe

Added in 1.1.0-alpha13
public OnSwipe(String anchor, OnSwipe.Side side, OnSwipe.Drag dragDirection)

Public methods

getAutoCompleteMode

Added in 1.1.0-alpha13
public OnSwipe.Mode getAutoCompleteMode()

getDragDirection

Added in 1.1.0-alpha13
public OnSwipe.Drag getDragDirection()

getDragScale

Added in 1.1.0-alpha13
public float getDragScale()

getDragThreshold

Added in 1.1.0-alpha13
public float getDragThreshold()

getLimitBoundsTo

Added in 1.1.0-alpha13
public String getLimitBoundsTo()

getMaxAcceleration

Added in 1.1.0-alpha13
public float getMaxAcceleration()

getMaxVelocity

Added in 1.1.0-alpha13
public float getMaxVelocity()

getOnTouchUp

Added in 1.1.0-alpha13
public OnSwipe.TouchUp getOnTouchUp()

getRotationCenterId

Added in 1.1.0-alpha13
public String getRotationCenterId()

getSpringBoundary

Added in 1.1.0-alpha13
public OnSwipe.Boundary getSpringBoundary()

The behaviour at the boundaries 0 and 1

getSpringDamping

Added in 1.1.0-alpha13
public float getSpringDamping()

getSpringMass

Added in 1.1.0-alpha13
public float getSpringMass()

Get the mass of the spring. the m in "a = (-k*x-c*v)/m" equation for the acceleration of a spring

getSpringStiffness

Added in 1.1.0-alpha13
public float getSpringStiffness()

get the stiffness of the spring

Returns
float

NaN if not set

getSpringStopThreshold

Added in 1.1.0-alpha13
public float getSpringStopThreshold()

The threshold for spring motion to stop.

getTouchAnchorId

Added in 1.1.0-alpha13
public String getTouchAnchorId()

getTouchAnchorSide

Added in 1.1.0-alpha13
public OnSwipe.Side getTouchAnchorSide()

setAutoCompleteMode

Added in 1.1.0-alpha13
public void setAutoCompleteMode(OnSwipe.Mode autoCompleteMode)

sets the behaviour at the boundaries 0 and 1 COMPLETE_MODE_CONTINUOUS_VELOCITY = 0; COMPLETE_MODE_SPRING = 1;

setDragDirection

Added in 1.1.0-alpha13
public OnSwipe setDragDirection(OnSwipe.Drag dragDirection)

The direction of the drag.

setDragScale

Added in 1.1.0-alpha13
public OnSwipe setDragScale(int dragScale)

Normally 1 this can be tweaked to make the acceleration faster

setDragThreshold

Added in 1.1.0-alpha13
public OnSwipe setDragThreshold(int dragThreshold)

This sets the threshold before the animation is kicked off. It is important when have multi state animations the have some play before the System decides which animation to jump on.

setLimitBoundsTo

Added in 1.1.0-alpha13
public OnSwipe setLimitBoundsTo(String id)

Only allow touch actions to be initiated within this region

setMaxAcceleration

Added in 1.1.0-alpha13
public OnSwipe setMaxAcceleration(int maxAcceleration)

The maximum acceleration and deceleration of the animation (Change in Change in progress per second) Faster makes the object seem lighter and quicker

setMaxVelocity

Added in 1.1.0-alpha13
public OnSwipe setMaxVelocity(int maxVelocity)

The maximum velocity (Change in progress per second) animation can achieve

setOnTouchUp

Added in 1.1.0-alpha13
public OnSwipe setOnTouchUp(OnSwipe.TouchUp mode)

Configures what happens when the user releases on mouse up. One of: ON_UP_AUTOCOMPLETE, ON_UP_AUTOCOMPLETE_TO_START, ON_UP_AUTOCOMPLETE_TO_END, ON_UP_STOP, ON_UP_DECELERATE, ON_UP_DECELERATE_AND_COMPLETE

Parameters
OnSwipe.TouchUp mode

default = ON_UP_AUTOCOMPLETE

setRotateCenter

Added in 1.1.0-alpha13
public OnSwipe setRotateCenter(String rotationCenterId)

The view to center the rotation about

Returns
OnSwipe

this

setSpringBoundary

Added in 1.1.0-alpha13
public OnSwipe setSpringBoundary(OnSwipe.Boundary springBoundary)

The behaviour at the boundaries 0 and 1.

Parameters
OnSwipe.Boundary springBoundary

behaviour at the boundaries

setSpringDamping

Added in 1.1.0-alpha13
public OnSwipe setSpringDamping(float springDamping)

Set the damping of the spring if using spring. c in "a = (-k*x-c*v)/m" equation for the acceleration of a spring

Returns
OnSwipe

this

setSpringMass

Added in 1.1.0-alpha13
public OnSwipe setSpringMass(float springMass)

Set the Mass of the spring if using spring. m in "a = (-k*x-c*v)/m" equation for the acceleration of a spring

Returns
OnSwipe

this

setSpringStiffness

Added in 1.1.0-alpha13
public OnSwipe setSpringStiffness(float springStiffness)

set the stiffness of the spring if using spring. If this is set the swipe will use a spring return system. If set to NaN it will revert to the norm system. K in "a = (-k*x-c*v)/m" equation for the acceleration of a spring

setSpringStopThreshold

Added in 1.1.0-alpha13
public OnSwipe setSpringStopThreshold(float springStopThreshold)

set the threshold for spring motion to stop. This is in change in progress / second If the spring will never go above that threshold again it will stop.

Parameters
float springStopThreshold

when to stop.

setTouchAnchorId

Added in 1.1.0-alpha13
public OnSwipe setTouchAnchorId(String id)

The id of the view who's movement is matched to your drag If not specified it will map to a linear movement across the width of the motionLayout

setTouchAnchorSide

Added in 1.1.0-alpha13
public OnSwipe setTouchAnchorSide(OnSwipe.Side side)

This side of the view that matches the drag movement. Only meaning full if the object changes size during the movement. (rotation is not considered)

toString

public String toString()