DisabledState

⚠️ This class is for internal use only.

class DisabledState extends State

A state that activates when Flicking is stopped by event's stop method

Properties

Methods

holding
animating
delta

onEnter
onHold
onChange
onRelease
onAnimationEnd
onFinish

Properties

holding

readonly

Whether user is clicking or touching

Type: false

animating

readonly

Whether Flicking's animating

Type: true

delta

readonlyinherited

A sum of delta values of change events from the last hold event of Axes

Type: number

Methods

onEnter

inherited

An callback which is called when state has changed to this state

Returns: void

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
prevState	State	no		An previous state

onHold

inherited

An event handler for Axes's hold event

Returns: void

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
ctx	object	yes		Event context
ctx.flicking	Flicking	yes		An instance of Flicking
ctx.axesEvent	object	yes		A hold event of Axes
ctx.transitTo	function	yes		A function for changing current state to other state

onChange

inherited

An event handler for Axes's change event

Returns: void

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
ctx	object	yes		Event context
ctx.flicking	Flicking	yes		An instance of Flicking
ctx.axesEvent	object	yes		A change event of Axes
ctx.transitTo	function	yes		A function for changing current state to other state

onRelease

inherited

An event handler for Axes's release event

Returns: void

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
ctx	object	yes		Event context
ctx.flicking	Flicking	yes		An instance of Flicking
ctx.axesEvent	object	yes		A release event of Axes
ctx.transitTo	function	yes		A function for changing current state to other state

onAnimationEnd

inherited

An event handler for Axes's animationEnd event

Returns: void

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
ctx	object	yes		Event context
ctx.flicking	Flicking	yes		An instance of Flicking
ctx.axesEvent	object	yes		A animationEnd event of Axes
ctx.transitTo	function	yes		A function for changing current state to other state

onFinish

inherited

An event handler for Axes's finish event

Returns: void

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
ctx	object	yes		Event context
ctx.flicking	Flicking	yes		An instance of Flicking
ctx.axesEvent	object	yes		A finish event of Axes
ctx.transitTo	function	yes		A function for changing current state to other state