DragController (Mobile-GWT-Bibliothek der SWM 2.7 API)

java.lang.Object
- de.swm.commons.mobile.client.event.DragController

All Implemented Interfaces:

com.google.gwt.user.client.EventListener

Direct Known Subclasses:

DragControllerDesktop, DragControllerMobile
```
public abstract class DragController
extends Object
implements com.google.gwt.user.client.EventListener
```
Is handling HTML5 drag events. The sublassed DragControllerMobile and DragControllerDesktop are plantfom specific.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addDragEventsHandler(DragEventsHandler dragHandler)` Allow components to register drag events.
`void`	`addSwipeEventsHandler(SwipeEventsHandler swipeHandler)` Allow components to register swipe events.
`boolean`	`captureDragEvents(DragEventsHandler cachingHandler)` Will capture drag events.
`boolean`	`captureSwipeEvents(SwipeEventsHandler cachingHandler)` Will capture swipe events.
`protected void`	`fireDragEvent(DragEvent e)` Fires a drag event after a drag event was recognized.
`protected void`	`fireSwipeEvent(SwipeEvent e)` Fires a drag swipe event after a drag event was recognized.
`static DragController`	`get()` Returns the singleton instance of this controller.
`com.google.gwt.core.client.JavaScriptObject`	`getDragEndListener()` Returns the dragEndListener.
`com.google.gwt.core.client.JavaScriptObject`	`getDragMoveListener()` Returns the dragMoveListener.
`com.google.gwt.core.client.JavaScriptObject`	`getDragStartListener()` Returns the dragStartListener.
`DragControllerOptions`	`getOptions()` Returns the options.
`com.google.gwt.user.client.ui.Widget`	`getSource()` Returns the source.
`protected void`	`init()` Initializes the controller.
`boolean`	`isNextClickSuppressed()` Check if next click is suppressed.
`void`	`onBrowserEvent(com.google.gwt.user.client.Event e)`
`protected void`	`onEnd(com.google.gwt.user.client.Event e, Point p)` Will be invoked after the movement of an element is completed.
`protected void`	`onMove(com.google.gwt.user.client.Event e, Point p)` Will be invoked after an element will be moved.
`protected void`	`onStart(com.google.gwt.user.client.Event e, Point p)` May need an onPreStart event to indicate that mouse is down, but no movement yet, // so onStart event can actually mean drag is indeed started.
`protected void`	`registerEvents()` Subscribes base browser events - equal for all DragController implementations..
`boolean`	`releaseDragCapture(DragEventsHandler cachingHandler)` Will capture release drag events.
`boolean`	`releaseSwipeCapture(SwipeEventsHandler cachingHandler)` Will capture release swipe events.
`void`	`removeDragEventsHandler(DragEventsHandler dragHandler)` Allow components to remove registered drag events.
`void`	`removeSwipeEventHandler(SwipeEventsHandler swipeHandler)` Allow components to remove registered swipe events.
`void`	`resume()` Enabeld the drag controller after an suspend.
`void`	`setDragEndListener(com.google.gwt.core.client.JavaScriptObject dragEndListener)` dragEndListener the dragEndListener to set.
`void`	`setDragMoveListener(com.google.gwt.core.client.JavaScriptObject dragMoveListener)` dragMoveListener the dragMoveListener to set.
`void`	`setDragStartListener(com.google.gwt.core.client.JavaScriptObject dragStartListener)` dragStartListener the dragStartListener to set.
`void`	`setSource(com.google.gwt.user.client.ui.Widget source)` source the source to set.
`void`	`setSuppressNextClick(boolean suppressNextClick)`
`void`	`suppressNextClick()` Will supressed next click.
`void`	`suspend()` Supends the drag controller.
`protected void`	`unregisterEvents()` un-Subscribes base browser events - equal for all DragController implementations..

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getOptions
```
public DragControllerOptions getOptions()
```
    Returns the options.
    
    Returns:
    the options
  - get
```
public static DragController get()
```
    Returns the singleton instance of this controller.
    
    Returns:
    the singleton instance.
  - init
```
protected void init()
```
    Initializes the controller.
  - addDragEventsHandler
```
public void addDragEventsHandler(DragEventsHandler dragHandler)
```
    Allow components to register drag events.
    
    Parameters:
    dragHandler - the handler.
  - addSwipeEventsHandler
```
public void addSwipeEventsHandler(SwipeEventsHandler swipeHandler)
```
    Allow components to register swipe events.
    
    Parameters:
    swipeHandler - the handler.
  - removeDragEventsHandler
```
public void removeDragEventsHandler(DragEventsHandler dragHandler)
```
    Allow components to remove registered drag events.
    
    Parameters:
    dragHandler - the handler.
  - removeSwipeEventHandler
```
public void removeSwipeEventHandler(SwipeEventsHandler swipeHandler)
```
    Allow components to remove registered swipe events.
    
    Parameters:
    swipeHandler - the handler.
  - onBrowserEvent
```
public void onBrowserEvent(com.google.gwt.user.client.Event e)
```
    Specified by:
    
    onBrowserEvent in interface com.google.gwt.user.client.EventListener
  - onStart
```
protected void onStart(com.google.gwt.user.client.Event e,
           Point p)
```
    May need an onPreStart event to indicate that mouse is down, but no movement yet, // so onStart event can actually mean drag is indeed started.
    
    Parameters:
    e - event
    p - point
  - onMove
```
protected void onMove(com.google.gwt.user.client.Event e,
          Point p)
```
    Will be invoked after an element will be moved.
    
    Parameters:
    e - the event
    p - the new position
  - onEnd
```
protected void onEnd(com.google.gwt.user.client.Event e,
         Point p)
```
    Will be invoked after the movement of an element is completed.
    
    Parameters:
    e - the event
    p - the new position
  - fireDragEvent
```
protected void fireDragEvent(DragEvent e)
```
    Fires a drag event after a drag event was recognized.
    
    Parameters:
    e - event
  - fireSwipeEvent
```
protected void fireSwipeEvent(SwipeEvent e)
```
    Fires a drag swipe event after a drag event was recognized.
    
    Parameters:
    e - event
  - suppressNextClick
```
public void suppressNextClick()
```
    Will supressed next click.
  - isNextClickSuppressed
```
public boolean isNextClickSuppressed()
```
    Check if next click is suppressed.
  - registerEvents
```
protected void registerEvents()
```
    Subscribes base browser events - equal for all DragController implementations..
  - unregisterEvents
```
protected void unregisterEvents()
```
    un-Subscribes base browser events - equal for all DragController implementations..
  - suspend
```
public void suspend()
```
    Supends the drag controller.
  - resume
```
public void resume()
```
    Enabeld the drag controller after an suspend.
  - captureDragEvents
```
public boolean captureDragEvents(DragEventsHandler cachingHandler)
```
    Will capture drag events.
    
    Parameters:
    cachingHandler - the handler.
    
    Returns:
    true if already captured
  - releaseDragCapture
```
public boolean releaseDragCapture(DragEventsHandler cachingHandler)
```
    Will capture release drag events.
    
    Parameters:
    cachingHandler - the handler.
    
    Returns:
    true if already captured
  - captureSwipeEvents
```
public boolean captureSwipeEvents(SwipeEventsHandler cachingHandler)
```
    Will capture swipe events.
    
    Parameters:
    cachingHandler - the handler.
    
    Returns:
    true if already captured
  - releaseSwipeCapture
```
public boolean releaseSwipeCapture(SwipeEventsHandler cachingHandler)
```
    Will capture release swipe events.
    
    Parameters:
    cachingHandler - the handler.
    
    Returns:
    true if already captured
  - getDragStartListener
```
public com.google.gwt.core.client.JavaScriptObject getDragStartListener()
```
    Returns the dragStartListener.
    
    Returns:
    the dragStartListener
  - setDragStartListener
```
public void setDragStartListener(com.google.gwt.core.client.JavaScriptObject dragStartListener)
```
    dragStartListener the dragStartListener to set.
    
    Parameters:
    dragStartListener - the dragStartListener to set
  - getDragMoveListener
```
public com.google.gwt.core.client.JavaScriptObject getDragMoveListener()
```
    Returns the dragMoveListener.
    
    Returns:
    the dragMoveListener
  - setDragMoveListener
```
public void setDragMoveListener(com.google.gwt.core.client.JavaScriptObject dragMoveListener)
```
    dragMoveListener the dragMoveListener to set.
    
    Parameters:
    dragMoveListener - the dragMoveListener to set
  - getDragEndListener
```
public com.google.gwt.core.client.JavaScriptObject getDragEndListener()
```
    Returns the dragEndListener.
    
    Returns:
    the dragEndListener
  - setDragEndListener
```
public void setDragEndListener(com.google.gwt.core.client.JavaScriptObject dragEndListener)
```
    dragEndListener the dragEndListener to set.
    
    Parameters:
    dragEndListener - the dragEndListener to set
  - getSource
```
public com.google.gwt.user.client.ui.Widget getSource()
```
    Returns the source.
    
    Returns:
    the source
  - setSource
```
public void setSource(com.google.gwt.user.client.ui.Widget source)
```
    source the source to set.
    
    Parameters:
    source - the source to set
  - setSuppressNextClick
```
public void setSuppressNextClick(boolean suppressNextClick)
```

Class DragController

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getOptions

get

init

addDragEventsHandler

addSwipeEventsHandler

removeDragEventsHandler

removeSwipeEventHandler

onBrowserEvent

onStart

onMove

onEnd

fireDragEvent

fireSwipeEvent

suppressNextClick

isNextClickSuppressed

registerEvents

unregisterEvents

suspend

resume

captureDragEvents

releaseDragCapture

captureSwipeEvents

releaseSwipeCapture

getDragStartListener

setDragStartListener

getDragMoveListener

setDragMoveListener

getDragEndListener

setDragEndListener

getSource

setSource

setSuppressNextClick