com.sencha.gxt.core.client.gestures

Class DragGestureRecognizer

java.lang.Object

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

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

All Implemented Interfaces:

GestureRecognizer

Direct Known Subclasses:

ScrollGestureRecognizer

public class DragGestureRecognizer
extends AbstractGestureRecognizer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DragGestureRecognizer.CellDragGestureRecognizer<T>
static class	DragGestureRecognizer.DragGestureCancelEvent
static class	DragGestureRecognizer.DragGestureEndEvent
static class	DragGestureRecognizer.DragGestureMoveEvent
static class	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 boolean	dragging

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

pointerEventsSupport

Constructor Summary

Constructors

Constructor and Description
DragGestureRecognizer()
DragGestureRecognizer(int minMoveDistance)
DragGestureRecognizer(int minMoveDistance, AbstractGestureRecognizer.ExtraTouchBehavior extraTouchBehavior)

Method Summary

Modifier and Type	Method and Description
boolean	handle(NativeEvent event) Takes a browser event, and checks to see if it should decipher a gesture from it.
protected boolean	handleMousePointers() Returns true if the DragGR can handle mouse pointers.
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	onMove(List<TouchData> touches) Indicates that on or more touches are moving
protected boolean	onStart(TouchData startedTouch) Indicates that a touch has started, giving the gesture the chance to exclusively handle this touch as it moves.

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

cancel, fireEvent, getTouches, handleCancel, handleEnd, handleMove, handlePreventDefault, handleStart, setCaptured, setDelegate, setInterest, start

Methods inherited from class java.lang.Object

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

Field Detail

dragging

protected boolean dragging

Constructor Detail

DragGestureRecognizer

public DragGestureRecognizer()

DragGestureRecognizer

public DragGestureRecognizer(int minMoveDistance)

DragGestureRecognizer

public DragGestureRecognizer(int minMoveDistance,
                             AbstractGestureRecognizer.ExtraTouchBehavior extraTouchBehavior)

Method Detail

handle

public boolean handle(NativeEvent event)

Description copied from interface: GestureRecognizer

Takes a browser event, and checks to see if it should decipher a gesture from it.

Callers of this are expected to do their own vetting to decide if the given event should be handled by this gesture - for example, if a cell accepts a tap on one part of it and a longpress on another, the cell should determine where the touch events occur and send to the right recognizer accordingly.

Specified by:

handle in interface GestureRecognizer

Overrides:

handle in class AbstractGestureRecognizer

Parameters:

event - the browser event to read for a gesture.

Returns:

true if the gesture is not handling the event and can allow it to be propagated, false to indicate that it has been handled and should not be given to other handlers. Should always return true for any start event.

handleMousePointers

protected boolean handleMousePointers()

Returns true if the DragGR can handle mouse pointers. By default DragGR only operates on touch pointers, this method can be overridden to allow widgets to drag on mouse pointers as well.

Returns:

true if the DragGR can handle mouse pointers.

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.

Specified by:

onStart in class AbstractGestureRecognizer

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

Specified by:

onMove in class AbstractGestureRecognizer

onEnd

protected void onEnd(List<TouchData> touches)

Description copied from class: AbstractGestureRecognizer

Indicates that one or more touches have ended.

Specified by:

onEnd in class AbstractGestureRecognizer

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

Specified by:

onCancel in class AbstractGestureRecognizer

Parameters:

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