DNDHandler (Alkacon Geranium)

java.lang.Object
- com.alkacon.geranium.client.dnd.DNDHandler

All Implemented Interfaces:

com.google.gwt.event.dom.client.MouseDownHandler, com.google.gwt.event.shared.EventHandler
```
public class DNDHandler
extends java.lang.Object
implements com.google.gwt.event.dom.client.MouseDownHandler
```
Drag and drop handler.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`DNDHandler.Direction` Scroll direction enumeration.
`protected class`	`DNDHandler.DNDEventPreviewHandler` Drag and drop event preview handler.
`static class`	`DNDHandler.Orientation` The allowed drag and drop orientation.
`protected class`	`DNDHandler.ScrollTimer` Timer to schedule automated scrolling.

Constructor Summary

Constructors
Constructor and Description

DNDHandler(I_DNDController controller)
Constructor.

Constructors
Constructor and Description
`DNDHandler(I_DNDController controller)` Constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addTarget(I_DropTarget target)` Adds a drop target.
`protected void`	`animateCancel(I_Draggable draggable, I_DNDController controller)` Clears the drag process with a move animation of the drag element to it's original position.
`protected void`	`animateDrop(I_Draggable draggable, I_DropTarget target, I_DNDController controller)` Clears the drag process with a move animation of the drag element to the place-holder position.
`void`	`cancel()` Cancels the dragging process.
`protected void`	`clear()` Clears all references used within the current drag process.
`protected void`	`clearScrollTimer()` Cancels the scroll timer and removes the timer reference.
`void`	`clearTargets()` Clears the drop target register.
`void`	`drop()` Drops the draggable.
`I_DNDController`	`getController()` Returns the drag and drop controller.
`I_DropTarget`	`getCurrentTarget()` Returns the current drop target.
`int`	`getCursorOffsetX()` Returns the cursor offset x.
`int`	`getCursorOffsetY()` Returns the cursor offset y.
`I_Draggable`	`getDraggable()` Returns the current draggable.
`com.google.gwt.dom.client.Element`	`getDragHelper()` Returns the drag helper element.
`DNDHandler.Orientation`	`getOrientation()` Returns the allowed drag and drop orientation.
`com.google.gwt.dom.client.Element`	`getPlaceholder()` Returns the place holder element.
`boolean`	`isAnimationEnabled()` Returns if the animation is enabled.
`boolean`	`isDragging()` Returns if a dragging process is taking place.
`boolean`	`isScrollEnabled()` Returns if automated scrolling is enabled.
`void`	`onMouseDown(com.google.gwt.event.dom.client.MouseDownEvent event)`
`protected void`	`onMouseWheelScroll(com.google.gwt.user.client.Event event)` Execute on mouse wheel event.
`protected void`	`onMove(com.google.gwt.user.client.Event event)` Executed on mouse move while dragging.
`protected void`	`onUp(com.google.gwt.user.client.Event event)` Executed on mouse up while dragging.
`protected void`	`positionHelper()` Positions an element depending on the current events client position and the cursor offset.
`void`	`removeTarget(I_DropTarget target)` Removes a drop target from the register.
`void`	`setAnimationEnabled(boolean animationEnabled)` Sets the animation enabled.
`void`	`setController(I_DNDController controller)` Sets the drag and drop controller.
`void`	`setCursorOffsetX(int cursorOffsetX)` Sets the cursor offset x.
`void`	`setCursorOffsetY(int cursorOffsetY)` Sets the cursor offset y.
`void`	`setDraggable(I_Draggable draggable)` Sets the draggable.
`void`	`setDragHelper(com.google.gwt.dom.client.Element dragHelper)` Sets the drag helper element.
`void`	`setOrientation(DNDHandler.Orientation orientation)` Sets the allowed drag and drop orientation.
`void`	`setPlaceholder(com.google.gwt.dom.client.Element placeholder)` Sets the placeholder element.
`void`	`setScrollElement(com.google.gwt.dom.client.Element scrollElement)` Sets the scroll element in case not the window but another element needs scrolling.
`void`	`setScrollEnabled(boolean scrollEnabled)` Sets the scrolling enabled.
`void`	`setStartPosition(int left, int top)` Sets the start position.
`protected void`	`stopDragging()` Sets dragging to false and removes the event preview handler.

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

- Constructor Detail
  - DNDHandler
```
public DNDHandler(I_DNDController controller)
```
    Constructor.
    
    Parameters:
    controller - the drag and drop controller
- Method Detail
  - addTarget
```
public void addTarget(I_DropTarget target)
```
    Adds a drop target.
    
    Parameters:
    target - the target to add
  - cancel
```
public void cancel()
```
    Cancels the dragging process.
  - clearTargets
```
public void clearTargets()
```
    Clears the drop target register.
  - drop
```
public void drop()
```
    Drops the draggable.
  - getController
```
public I_DNDController getController()
```
    Returns the drag and drop controller.
    
    Returns:
    the drag and drop controller
  - getCurrentTarget
```
public I_DropTarget getCurrentTarget()
```
    Returns the current drop target.
    
    Returns:
    the current drop target
  - getCursorOffsetX
```
public int getCursorOffsetX()
```
    Returns the cursor offset x.
    
    Returns:
    the cursor offset x
  - getCursorOffsetY
```
public int getCursorOffsetY()
```
    Returns the cursor offset y.
    
    Returns:
    the cursor offset y
  - getDraggable
```
public I_Draggable getDraggable()
```
    Returns the current draggable.
    
    Returns:
    the draggable
  - getDragHelper
```
public com.google.gwt.dom.client.Element getDragHelper()
```
    Returns the drag helper element.
    
    Returns:
    the drag helper
  - getOrientation
```
public DNDHandler.Orientation getOrientation()
```
    Returns the allowed drag and drop orientation.
    
    Returns:
    the drag and drop orientation
  - getPlaceholder
```
public com.google.gwt.dom.client.Element getPlaceholder()
```
    Returns the place holder element.
    
    Returns:
    the place holder element
  - isAnimationEnabled
```
public boolean isAnimationEnabled()
```
    Returns if the animation is enabled.
    
    Returns:
    true if the animation is enabled
  - isDragging
```
public boolean isDragging()
```
    Returns if a dragging process is taking place.
    
    Returns:
    true if the handler is currently dragging
  - isScrollEnabled
```
public boolean isScrollEnabled()
```
    Returns if automated scrolling is enabled.
    
    Returns:
    if automated scrolling is enabled
  - onMouseDown
```
public void onMouseDown(com.google.gwt.event.dom.client.MouseDownEvent event)
```
    Specified by:
    
    onMouseDown in interface com.google.gwt.event.dom.client.MouseDownHandler
    
    See Also:
    MouseDownHandler.onMouseDown(com.google.gwt.event.dom.client.MouseDownEvent)
  - removeTarget
```
public void removeTarget(I_DropTarget target)
```
    Removes a drop target from the register.
    
    Parameters:
    target - the target to remove
  - setAnimationEnabled
```
public void setAnimationEnabled(boolean animationEnabled)
```
    Sets the animation enabled.
    
    Parameters:
    animationEnabled - true to enable the animation
  - setController
```
public void setController(I_DNDController controller)
```
    Sets the drag and drop controller.
    
    Parameters:
    controller - the drag and drop controller to set
  - setCursorOffsetX
```
public void setCursorOffsetX(int cursorOffsetX)
```
    Sets the cursor offset x.
    
    Parameters:
    cursorOffsetX - the cursor offset x to set
  - setCursorOffsetY
```
public void setCursorOffsetY(int cursorOffsetY)
```
    Sets the cursor offset y.
    
    Parameters:
    cursorOffsetY - the cursor offset y to set
  - setDraggable
```
public void setDraggable(I_Draggable draggable)
```
    Sets the draggable.
    
    Parameters:
    draggable - the draggable
  - setDragHelper
```
public void setDragHelper(com.google.gwt.dom.client.Element dragHelper)
```
    Sets the drag helper element.
    
    Parameters:
    dragHelper - the drag helper element
  - setOrientation
```
public void setOrientation(DNDHandler.Orientation orientation)
```
    Sets the allowed drag and drop orientation.
    
    Parameters:
    orientation - the drag and drop orientation to set
  - setPlaceholder
```
public void setPlaceholder(com.google.gwt.dom.client.Element placeholder)
```
    Sets the placeholder element.
    
    Parameters:
    placeholder - the placeholder element
  - setScrollEnabled
```
public void setScrollEnabled(boolean scrollEnabled)
```
    Sets the scrolling enabled.
    
    Parameters:
    scrollEnabled - true to enable scrolling
  - setScrollElement
```
public void setScrollElement(com.google.gwt.dom.client.Element scrollElement)
```
    Sets the scroll element in case not the window but another element needs scrolling.
    
    Parameters:
    scrollElement - the scroll element
  - setStartPosition
```
public void setStartPosition(int left,
                    int top)
```
    Sets the start position.
    In case of a canceled drag and drop and enabled animation, the draggable helper element will be reverted to the start position.
    Values <0 will be ignored.
    
    Parameters:
    left - the left position
    top - the top position
  - animateCancel
```
protected void animateCancel(I_Draggable draggable,
                 I_DNDController controller)
```
    Clears the drag process with a move animation of the drag element to it's original position.
    
    Parameters:
    draggable - the draggable
    controller - the drag and drop controller
  - animateDrop
```
protected void animateDrop(I_Draggable draggable,
               I_DropTarget target,
               I_DNDController controller)
```
    Clears the drag process with a move animation of the drag element to the place-holder position.
    
    Parameters:
    draggable - the draggable
    target - the drop target
    controller - the drag and drop controller
  - clear
```
protected void clear()
```
    Clears all references used within the current drag process.
  - clearScrollTimer
```
protected void clearScrollTimer()
```
    Cancels the scroll timer and removes the timer reference.
  - onMouseWheelScroll
```
protected void onMouseWheelScroll(com.google.gwt.user.client.Event event)
```
    Execute on mouse wheel event.
    
    Parameters:
    event - the native event
  - onMove
```
protected void onMove(com.google.gwt.user.client.Event event)
```
    Executed on mouse move while dragging.
    
    Parameters:
    event - the event
  - onUp
```
protected void onUp(com.google.gwt.user.client.Event event)
```
    Executed on mouse up while dragging.
    
    Parameters:
    event - the event
  - positionHelper
```
protected void positionHelper()
```
    Positions an element depending on the current events client position and the cursor offset. This method assumes that the element parent is positioned relative.
  - stopDragging
```
protected void stopDragging()
```
    Sets dragging to false and removes the event preview handler.

Class DNDHandler

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DNDHandler

Method Detail

addTarget

cancel

clearTargets

drop

getController

getCurrentTarget

getCursorOffsetX

getCursorOffsetY

getDraggable

getDragHelper

getOrientation

getPlaceholder

isAnimationEnabled

isDragging

isScrollEnabled

onMouseDown

removeTarget

setAnimationEnabled

setController

setCursorOffsetX

setCursorOffsetY

setDraggable

setDragHelper

setOrientation

setPlaceholder

setScrollEnabled

setScrollElement

setStartPosition

animateCancel

animateDrop

clear

clearScrollTimer

onMouseWheelScroll

onMove

onUp

positionHelper

stopDragging