Draggable (GXT 4.0.2)

java.lang.Object
- com.sencha.gxt.fx.client.Draggable

All Implemented Interfaces:

DragCancelEvent.HasDragCancelHandlers, DragEndEvent.HasDragEndHandlers, DragHandler.HasDragHandlers, DragMoveEvent.HasDragMoveHandlers, DragStartEvent.HasDragStartHandlers
```
public class Draggable
extends Object
implements DragStartEvent.HasDragStartHandlers, DragEndEvent.HasDragEndHandlers, DragMoveEvent.HasDragMoveHandlers, DragCancelEvent.HasDragCancelHandlers, DragHandler.HasDragHandlers
```
Adds drag behavior to any widget. Drag operations can be initiated from the widget itself, or another widget, such as the header in a dialog.

It is possible to specify event targets that will be ignored. If the target element has the CommonStyles.Styles.nodrag() style (as returned by CommonStyles.get()) it will not trigger a drag operation.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Draggable.DraggableAppearance

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Draggable.DraggableAppearance`

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`conHeight`
`protected int`	`conWidth`
`protected int`	`conX`
`protected int`	`conY`
`protected DragGestureRecognizer`	`dragGestureRecognizer`
`protected int`	`dragStartX`
`protected int`	`dragStartY`
`protected int`	`lastX`
`protected int`	`lastY`
`protected XElement`	`proxyEl`
`protected Rectangle`	`startBounds`

Constructor Summary

Constructors
Constructor and Description
`Draggable(Widget dragWidget)` Creates a new draggable instance.
`Draggable(Widget dragWidget, Draggable.DraggableAppearance appearance)` Creates a new draggable instance.
`Draggable(Widget dragWidget, Widget handleWidget)` Create a new draggable instance.
`Draggable(Widget dragWidget, Widget handleWidget, Draggable.DraggableAppearance appearance)` Create a new draggable instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HandlerRegistration`	`addDragCancelHandler(DragCancelEvent.DragCancelHandler handler)` Adds a `DragCancelEvent.DragCancelHandler` handler for `DragCancelEvent` events.
`HandlerRegistration`	`addDragEndHandler(DragEndEvent.DragEndHandler handler)` Adds a `DragEndEvent.DragEndHandler` handler for `DragEndEvent` events.
`HandlerRegistration`	`addDragHandler(DragHandler handler)` Adds a `DragHandler` handler for `DragStartEvent` , `DragEndEvent`, `DragCancelEvent`, `DragMoveEvent` events.
`HandlerRegistration`	`addDragMoveHandler(DragMoveEvent.DragMoveHandler handler)` Adds a `DragMoveEvent.DragMoveHandler` handler for `DragMoveEvent` events.
`HandlerRegistration`	`addDragStartHandler(DragStartEvent.DragStartHandler handler)` Adds a `DragStartEvent.DragStartHandler` handler for `DragStartEvent` events.
`protected void`	`afterDrag()`
`void`	`cancelDrag()` Cancels the drag if running.
`protected XElement`	`createProxy()`
`Widget`	`getContainer()` Returns the drag container.
`protected DragGestureRecognizer`	`getDragGestureRecognizer()` Crates the drag gesture recognizer and passes along the touch events to Draggable.
`Widget`	`getDragHandle()` Returns the drag handleWidget.
`Widget`	`getDragWidget()` Returns the widget being dragged.
`int`	`getStartDragDistance()` Returns the number of pixels the cursor must move before dragging begins.
`protected void`	`handleMove(int x, int y, Event event)`
`protected void`	`handleStart(int x, int y, Event event, Element target)`
`boolean`	`isConstrainClient()` Returns true if drag is constrained to the viewport.
`boolean`	`isConstrainHorizontal()` Returns true if horizontal movement is constrained.
`boolean`	`isConstrainVertical()` Returns true if vertical movement is constrained.
`boolean`	`isDragging()` Returns `true` if a drag is in progress.
`boolean`	`isEnabled()` Returns `true` if enabled.
`boolean`	`isMoveAfterProxyDrag()` Returns true if the drag widget is moved after a proxy drag.
`boolean`	`isSizeProxyToSource()` Returns true if the proxy element is sized to match the drag widget.
`boolean`	`isUpdateZIndex()` Returns true if the z-index is updated after a drag.
`boolean`	`isUseProxy()` Returns true if proxy element is enabled.
`protected void`	`onMouseDown(MouseDownEvent e)`
`protected void`	`onMouseMove(Event event)`
`protected void`	`onTouchEnd(List<TouchData> touches)`
`protected void`	`onTouchMove(List<TouchData> touches)`
`protected boolean`	`onTouchStart(TouchData startedTouch)`
`void`	`release()` Removes the drag handles.
`void`	`setConstrainClient(boolean constrainClient)` True to set constrain movement to the viewport (defaults to true).
`void`	`setConstrainHorizontal(boolean constrainHorizontal)` True to stop horizontal movement (defaults to false).
`void`	`setConstrainVertical(boolean constrainVertical)` True to stop vertical movement (defaults to false).
`void`	`setContainer(Widget container)` Specifies a container to which the drag widget is constrained.
`void`	`setEnabled(boolean enabled)` Enables dragging if the argument is `true`, and disables it otherwise.
`void`	`setMoveAfterProxyDrag(boolean moveAfterProxyDrag)` True to move source widget after a proxy drag (defaults to true).
`void`	`setProxy(XElement element)` Sets the proxy element.
`void`	`setProxyStyle(String proxyClass)`
`void`	`setSizeProxyToSource(boolean sizeProxyToSource)` True to set proxy dimensions the same as the drag widget (defaults to true).
`void`	`setStartDragDistance(int startDragDistance)` Specifies how far the cursor must move after mousedown to start dragging (defaults to 2).
`void`	`setUpdateZIndex(boolean updateZIndex)` True if the CSS z-index should be updated on the widget being dragged.
`void`	`setUseProxy(boolean useProxy)` True to use a proxy widget during drag operation (defaults to true).
`void`	`setXConstraint(int left, int right)` Constrains the horizontal travel.
`void`	`setYConstraint(int top, int bottom)` Constrains the vertical travel.
`protected void`	`startDrag(Event event)`
`protected void`	`stopDrag(Event event)`

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

- Field Detail
  - conX
```
protected int conX
```
  - conY
```
protected int conY
```
  - conWidth
```
protected int conWidth
```
  - conHeight
```
protected int conHeight
```
  - dragStartX
```
protected int dragStartX
```
  - dragStartY
```
protected int dragStartY
```
  - lastX
```
protected int lastX
```
  - lastY
```
protected int lastY
```
  - proxyEl
```
protected XElement proxyEl
```
  - startBounds
```
protected Rectangle startBounds
```
  - dragGestureRecognizer
```
protected DragGestureRecognizer dragGestureRecognizer
```
- Constructor Detail
  - Draggable
```
public Draggable(Widget dragWidget)
```
    Creates a new draggable instance.
    
    Parameters:
    
    dragWidget - the widget to be dragged
  - Draggable
```
public Draggable(Widget dragWidget,
                 Draggable.DraggableAppearance appearance)
```
    Creates a new draggable instance.
    
    Parameters:
    
    dragWidget - the widget to be dragged
    
    appearance - the appearance with which to render the component
  - Draggable
```
public Draggable(Widget dragWidget,
                 Widget handleWidget)
```
    Create a new draggable instance.
    
    Parameters:
    
    dragWidget - the widget to be dragged
    
    handleWidget - the widget drags will be initiated from
  - Draggable
```
public Draggable(Widget dragWidget,
                 Widget handleWidget,
                 Draggable.DraggableAppearance appearance)
```
    Create a new draggable instance.
    
    Parameters:
    
    dragWidget - the widget to be dragged
    
    handleWidget - the widget drags will be initiated from
    
    appearance - the appearance with which to render the component
- Method Detail
  - getDragGestureRecognizer
```
protected DragGestureRecognizer getDragGestureRecognizer()
```
    Crates the drag gesture recognizer and passes along the touch events to Draggable.
    
    Returns:
    
    the grag gesture recognizer
  - onTouchEnd
```
protected void onTouchEnd(List<TouchData> touches)
```
  - onTouchMove
```
protected void onTouchMove(List<TouchData> touches)
```
  - onTouchStart
```
protected boolean onTouchStart(TouchData startedTouch)
```
  - addDragCancelHandler
```
public HandlerRegistration addDragCancelHandler(DragCancelEvent.DragCancelHandler handler)
```
    Description copied from interface: DragCancelEvent.HasDragCancelHandlers
    
    Adds a DragCancelEvent.DragCancelHandler handler for DragCancelEvent events.
    
    Specified by:
    
    addDragCancelHandler in interface DragCancelEvent.HasDragCancelHandlers
    
    Parameters:
    
    handler - the handler
    
    Returns:
    
    the registration for the event
  - addDragEndHandler
```
public HandlerRegistration addDragEndHandler(DragEndEvent.DragEndHandler handler)
```
    Description copied from interface: DragEndEvent.HasDragEndHandlers
    
    Adds a DragEndEvent.DragEndHandler handler for DragEndEvent events.
    
    Specified by:
    
    addDragEndHandler in interface DragEndEvent.HasDragEndHandlers
    
    Parameters:
    
    handler - the handler
    
    Returns:
    
    the registration for the event
  - addDragHandler
```
public HandlerRegistration addDragHandler(DragHandler handler)
```
    Description copied from interface: DragHandler.HasDragHandlers
    
    Adds a DragHandler handler for DragStartEvent , DragEndEvent, DragCancelEvent, DragMoveEvent events.
    
    Specified by:
    
    addDragHandler in interface DragHandler.HasDragHandlers
    
    Parameters:
    
    handler - the handler
    
    Returns:
    
    the registration for the event
  - addDragMoveHandler
```
public HandlerRegistration addDragMoveHandler(DragMoveEvent.DragMoveHandler handler)
```
    Description copied from interface: DragMoveEvent.HasDragMoveHandlers
    
    Adds a DragMoveEvent.DragMoveHandler handler for DragMoveEvent events.
    
    Specified by:
    
    addDragMoveHandler in interface DragMoveEvent.HasDragMoveHandlers
    
    Parameters:
    
    handler - the handler
    
    Returns:
    
    the registration for the event
  - addDragStartHandler
```
public HandlerRegistration addDragStartHandler(DragStartEvent.DragStartHandler handler)
```
    Description copied from interface: DragStartEvent.HasDragStartHandlers
    
    Adds a DragStartEvent.DragStartHandler handler for DragStartEvent events.
    
    Specified by:
    
    addDragStartHandler in interface DragStartEvent.HasDragStartHandlers
    
    Parameters:
    
    handler - the handler
    
    Returns:
    
    the registration for the event
  - cancelDrag
```
public void cancelDrag()
```
    Cancels the drag if running.
  - getContainer
```
public Widget getContainer()
```
    Returns the drag container.
    
    Returns:
    
    the drag container
  - setContainer
```
public void setContainer(Widget container)
```
    Specifies a container to which the drag widget is constrained.
    
    Parameters:
    
    container - the container
  - getDragHandle
```
public Widget getDragHandle()
```
    Returns the drag handleWidget.
    
    Returns:
    
    the drag handleWidget
  - getDragWidget
```
public Widget getDragWidget()
```
    Returns the widget being dragged.
    
    Returns:
    
    the drag widget
  - getStartDragDistance
```
public int getStartDragDistance()
```
    Returns the number of pixels the cursor must move before dragging begins.
    
    Returns:
    
    the distance in pixels
  - setStartDragDistance
```
public void setStartDragDistance(int startDragDistance)
```
    Specifies how far the cursor must move after mousedown to start dragging (defaults to 2).
    
    Parameters:
    
    startDragDistance - the start distance in pixels
  - isConstrainClient
```
public boolean isConstrainClient()
```
    Returns true if drag is constrained to the viewport.
    
    Returns:
    
    the constrain client state
  - setConstrainClient
```
public void setConstrainClient(boolean constrainClient)
```
    True to set constrain movement to the viewport (defaults to true).
    
    Parameters:
    
    constrainClient - true to constrain to viewport
  - isConstrainHorizontal
```
public boolean isConstrainHorizontal()
```
    Returns true if horizontal movement is constrained.
    
    Returns:
    
    the horizontal constrain state
  - setConstrainHorizontal
```
public void setConstrainHorizontal(boolean constrainHorizontal)
```
    True to stop horizontal movement (defaults to false).
    
    Parameters:
    
    constrainHorizontal - true to stop horizontal movement
  - isConstrainVertical
```
public boolean isConstrainVertical()
```
    Returns true if vertical movement is constrained.
    
    Returns:
    
    true if vertical movement is constrained
  - setConstrainVertical
```
public void setConstrainVertical(boolean constrainVertical)
```
    True to stop vertical movement (defaults to false).
    
    Parameters:
    
    constrainVertical - true to stop vertical movement
  - isDragging
```
public boolean isDragging()
```
    Returns true if a drag is in progress.
    
    Returns:
    
    the drag state
  - isEnabled
```
public boolean isEnabled()
```
    Returns true if enabled.
    
    Returns:
    
    the enable state
  - setEnabled
```
public void setEnabled(boolean enabled)
```
    Enables dragging if the argument is true, and disables it otherwise.
    
    Parameters:
    
    enabled - the new enabled state
  - isMoveAfterProxyDrag
```
public boolean isMoveAfterProxyDrag()
```
    Returns true if the drag widget is moved after a proxy drag.
    
    Returns:
    
    the move after proxy state
  - setMoveAfterProxyDrag
```
public void setMoveAfterProxyDrag(boolean moveAfterProxyDrag)
```
    True to move source widget after a proxy drag (defaults to true).
    
    Parameters:
    
    moveAfterProxyDrag - true to move after a proxy drag
  - isSizeProxyToSource
```
public boolean isSizeProxyToSource()
```
    Returns true if the proxy element is sized to match the drag widget.
    
    Returns:
    
    the size proxy to source state
  - setSizeProxyToSource
```
public void setSizeProxyToSource(boolean sizeProxyToSource)
```
    True to set proxy dimensions the same as the drag widget (defaults to true).
    
    Parameters:
    
    sizeProxyToSource - true to update proxy size
  - isUpdateZIndex
```
public boolean isUpdateZIndex()
```
    Returns true if the z-index is updated after a drag.
    
    Returns:
    
    the update z-index state
  - setUpdateZIndex
```
public void setUpdateZIndex(boolean updateZIndex)
```
    True if the CSS z-index should be updated on the widget being dragged. Setting this value to true will ensure that the dragged element is always displayed over all other widgets (defaults to true).
    
    Parameters:
    
    updateZIndex - true update the z-index
  - isUseProxy
```
public boolean isUseProxy()
```
    Returns true if proxy element is enabled.
    
    Returns:
    
    the use proxy state
  - setUseProxy
```
public void setUseProxy(boolean useProxy)
```
    True to use a proxy widget during drag operation (defaults to true).
    
    Parameters:
    
    useProxy - true use a proxy
  - release
```
public void release()
```
    Removes the drag handles.
  - setProxy
```
public void setProxy(XElement element)
```
    Sets the proxy element.
    
    Parameters:
    
    element - the proxy element
  - setProxyStyle
```
public void setProxyStyle(String proxyClass)
```
  - setXConstraint
```
public void setXConstraint(int left,
                           int right)
```
    Constrains the horizontal travel.
    
    Parameters:
    
    left - the number of pixels the element can move to the left
    
    right - the number of pixels the element can move to the right
  - setYConstraint
```
public void setYConstraint(int top,
                           int bottom)
```
    Constrains the vertical travel.
    
    Parameters:
    
    top - the number of pixels the element can move to the up
    
    bottom - the number of pixels the element can move to the down
  - afterDrag
```
protected void afterDrag()
```
  - createProxy
```
protected XElement createProxy()
```
  - handleStart
```
protected void handleStart(int x,
                           int y,
                           Event event,
                           Element target)
```
  - onMouseDown
```
protected void onMouseDown(MouseDownEvent e)
```
  - handleMove
```
protected void handleMove(int x,
                          int y,
                          Event event)
```
  - onMouseMove
```
protected void onMouseMove(Event event)
```
  - startDrag
```
protected void startDrag(Event event)
```
  - stopDrag
```
protected void stopDrag(Event event)
```

Class Draggable

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

conX

conY

conWidth

conHeight

dragStartX

dragStartY

lastX

lastY

proxyEl

startBounds

dragGestureRecognizer

Constructor Detail

Draggable

Draggable

Draggable

Draggable

Method Detail

getDragGestureRecognizer

onTouchEnd

onTouchMove

onTouchStart

addDragCancelHandler

addDragEndHandler

addDragHandler

addDragMoveHandler

addDragStartHandler

cancelDrag

getContainer

setContainer

getDragHandle

getDragWidget

getStartDragDistance

setStartDragDistance

isConstrainClient

setConstrainClient

isConstrainHorizontal

setConstrainHorizontal

isConstrainVertical

setConstrainVertical

isDragging

isEnabled

setEnabled

isMoveAfterProxyDrag

setMoveAfterProxyDrag

isSizeProxyToSource

setSizeProxyToSource

isUpdateZIndex

setUpdateZIndex

isUseProxy

setUseProxy

release

setProxy

setProxyStyle

setXConstraint

setYConstraint

afterDrag

createProxy

handleStart

onMouseDown

handleMove

onMouseMove

startDrag

stopDrag