com.sencha.gxt.core.client.gestures

Class ScrollGestureRecognizer

java.lang.Object

com.sencha.gxt.core.client.gestures.AbstractGestureRecognizer

com.sencha.gxt.core.client.gestures.DragGestureRecognizer

com.sencha.gxt.core.client.gestures.ScrollGestureRecognizer

All Implemented Interfaces:

GestureRecognizer

public class ScrollGestureRecognizer
extends DragGestureRecognizer

GestureRecognizer to handle scrolling gestures

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ScrollGestureRecognizer.ScrollDirection
static class	ScrollGestureRecognizer.ScrollGestureCancelEvent
static class	ScrollGestureRecognizer.ScrollGestureEndEvent
static class	ScrollGestureRecognizer.ScrollGestureMoveEvent

Nested classes/interfaces inherited from class com.sencha.gxt.core.client.gestures.DragGestureRecognizer

DragGestureRecognizer.CellDragGestureRecognizer<T>, DragGestureRecognizer.DragGestureCancelEvent, DragGestureRecognizer.DragGestureEndEvent, DragGestureRecognizer.DragGestureMoveEvent, DragGestureRecognizer.DragGestureStartEvent

Nested classes/interfaces inherited from class com.sencha.gxt.core.client.gestures.AbstractGestureRecognizer

AbstractGestureRecognizer.ExtraTouchBehavior

Field Summary

Fields

Modifier and Type	Field and Description
protected AbstractGestureRecognizer.ExtraTouchBehavior	extraTouchBehavior
protected double	heavyFactor Used to tweak how "heavy" the scrolling is.
protected Point	initialPosition
protected Stack<com.sencha.gxt.core.client.gestures.ScrollGestureRecognizer.TemporalPoint>	lastTouchPoints Stack keeping track of all TemporalPoints in the Gesture
protected com.sencha.gxt.core.client.gestures.ScrollGestureRecognizer.MomentumCommand	momentumCommand Command used to animate the scrolling after gesture ends

Fields inherited from class com.sencha.gxt.core.client.gestures.DragGestureRecognizer

dragging

Fields inherited from class com.sencha.gxt.core.client.gestures.AbstractGestureRecognizer

pointerEventsSupport

Constructor Summary

Constructors

Constructor and Description
ScrollGestureRecognizer(Element scrollElement)
ScrollGestureRecognizer(Element scrollElement, ScrollGestureRecognizer.ScrollDirection direction)
ScrollGestureRecognizer(Element scrollElement, ScrollGestureRecognizer.ScrollDirection direction, AbstractGestureRecognizer.ExtraTouchBehavior extraTouchBehavior)

Method Summary

Modifier and Type	Method and Description
protected com.sencha.gxt.core.client.gestures.ScrollGestureRecognizer.Velocity	calculateEndVelocity() Calculates the velocity at the end of touchmove events
void	cancel() Ends recognition of the gesture, and fires any cancel events that apply.
protected void	fireEvent(<any> event)
protected ScrollGestureRecognizer.ScrollDirection	getDirection()
protected void	onCancel(List<TouchData> touches) Indicates that one or more touches have been canceled by the browser or by the gesture itself being canceled (see #cancel).
protected void	onEnd(List<TouchData> touches) Indicates that one or more touches have ended.
protected void	onInitialPosition(Element scrollElement)
protected void	onMove(List<TouchData> touches) Indicates that on or more touches are moving
protected void	onScrollCancel(List<TouchData> event)
protected void	onScrollEnd(List<TouchData> event)
protected void	onScrollMove(List<TouchData> touches)
protected void	onScrollMoveHorizontal(Element scrollElement, TouchData touch)
protected void	onScrollMoveVertical(Element scrollElement, TouchData touch)
protected boolean	onStart(TouchData startedTouch) Indicates that a touch has started, giving the gesture the chance to exclusively handle this touch as it moves.
void	setDelegate(HasHandlers eventDelegate) Sets delegate to receive Gesture events

Methods inherited from class com.sencha.gxt.core.client.gestures.DragGestureRecognizer

handle, handleMousePointers

Methods inherited from class com.sencha.gxt.core.client.gestures.AbstractGestureRecognizer

getTouches, handleCancel, handleEnd, handleMove, handlePreventDefault, handleStart, setCaptured, setInterest, start

Methods inherited from class java.lang.Object

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

Field Detail

heavyFactor

protected double heavyFactor

Used to tweak how "heavy" the scrolling is.

If you want to make the list feel "heavy" reduce the number. Consequently, a higher factor will give the illusion of a smooth and frictionless list.

lastTouchPoints

protected final Stack<com.sencha.gxt.core.client.gestures.ScrollGestureRecognizer.TemporalPoint> lastTouchPoints

Stack keeping track of all TemporalPoints in the Gesture

momentumCommand

protected com.sencha.gxt.core.client.gestures.ScrollGestureRecognizer.MomentumCommand momentumCommand

Command used to animate the scrolling after gesture ends

initialPosition

protected Point initialPosition

extraTouchBehavior

protected AbstractGestureRecognizer.ExtraTouchBehavior extraTouchBehavior

Constructor Detail

ScrollGestureRecognizer

public ScrollGestureRecognizer(Element scrollElement)

ScrollGestureRecognizer

public ScrollGestureRecognizer(Element scrollElement,
                               ScrollGestureRecognizer.ScrollDirection direction)

ScrollGestureRecognizer

public ScrollGestureRecognizer(Element scrollElement,
                               ScrollGestureRecognizer.ScrollDirection direction,
                               AbstractGestureRecognizer.ExtraTouchBehavior extraTouchBehavior)

Method Detail

cancel

public void cancel()

Description copied from interface: GestureRecognizer

Ends recognition of the gesture, and fires any cancel events that apply. Any touch events being recognized by this object will now be ignored.

Specified by:

cancel in interface GestureRecognizer

Overrides:

cancel in class AbstractGestureRecognizer

getDirection

protected ScrollGestureRecognizer.ScrollDirection getDirection()

setDelegate

public void setDelegate(HasHandlers eventDelegate)

Description copied from interface: GestureRecognizer

Sets delegate to receive Gesture events

Specified by:

setDelegate in interface GestureRecognizer

Overrides:

setDelegate in class AbstractGestureRecognizer

Parameters:

eventDelegate - the event handler delegate

calculateEndVelocity

protected com.sencha.gxt.core.client.gestures.ScrollGestureRecognizer.Velocity calculateEndVelocity()

Calculates the velocity at the end of touchmove events

Returns:

Velocity used for scroll

onStart

protected boolean onStart(TouchData startedTouch)

Description copied from class: AbstractGestureRecognizer

Indicates that a touch has started, giving the gesture the chance to exclusively handle this touch as it moves.

Overrides:

onStart in class DragGestureRecognizer

Parameters:

startedTouch - the touch that has begun

Returns:

false to not capture the touch passed in, true to capture it so that later gestures do not hear about it. Returning true is equivelent to calling setCaptured(startedTouch, true)

onMove

protected void onMove(List<TouchData> touches)

Description copied from class: AbstractGestureRecognizer

Indicates that on or more touches are moving

Overrides:

onMove in class DragGestureRecognizer

onEnd

protected void onEnd(List<TouchData> touches)

Description copied from class: AbstractGestureRecognizer

Indicates that one or more touches have ended.

Overrides:

onEnd in class DragGestureRecognizer

Parameters:

touches - data for the now-ended touches (as opposed to #getTouches which no longer has those entries)

onCancel

protected void onCancel(List<TouchData> touches)

Description copied from class: AbstractGestureRecognizer

Indicates that one or more touches have been canceled by the browser or by the gesture itself being canceled (see #cancel).

Overrides:

onCancel in class DragGestureRecognizer

Parameters:

touches - data for the now-canceled touches (as opposed to #getTouches which no longer has those entries)

fireEvent

protected void fireEvent(<any> event)

Overrides:

fireEvent in class AbstractGestureRecognizer

onScrollMove

protected void onScrollMove(List<TouchData> touches)

onInitialPosition

protected void onInitialPosition(Element scrollElement)

onScrollMoveVertical

protected void onScrollMoveVertical(Element scrollElement,
                                    TouchData touch)

onScrollMoveHorizontal

protected void onScrollMoveHorizontal(Element scrollElement,
                                      TouchData touch)

onScrollEnd

protected void onScrollEnd(List<TouchData> event)

onScrollCancel

protected void onScrollCancel(List<TouchData> event)