DropTarget (GXT 4.0.2)

java.lang.Object
- com.sencha.gxt.dnd.core.client.DropTarget

All Implemented Interfaces:

DndDragCancelEvent.HasDndDragCancelHandlers, DndDragEnterEvent.HasDndDragEnterHandlers, DndDragLeaveEvent.HasDndDragLeaveHandlers, DndDragMoveEvent.HasDndDragMoveHandlers, DndDropEvent.HasDndDropHandlers

Direct Known Subclasses:

GridDropTarget, ListViewDropTarget, TreeDropTarget, TreeGridDropTarget
```
public class DropTarget
extends Object
implements DndDragEnterEvent.HasDndDragEnterHandlers, DndDragLeaveEvent.HasDndDragLeaveHandlers, DndDragCancelEvent.HasDndDragCancelHandlers, DndDragMoveEvent.HasDndDragMoveHandlers, DndDropEvent.HasDndDropHandlers
```
Enables a component to act as the target of a drag and drop operation (i.e. a user can drop data on the component).

While the cursor is over a target, the target is responsible for determining if the drop is valid and showing any visual indicators for the drop. The StatusProxy object should be used to specify if the drop is valid, and can also be used to change the values of the proxy object displayed by the cursor.

Field Summary

Fields
Modifier and Type Field and Description

protected Widget dropWidget

protected DND.Feedback feedback

protected DND.Operation operation

protected String overStyle

Fields
Modifier and Type	Field and Description
`protected Widget`	`dropWidget`
`protected DND.Feedback`	`feedback`
`protected DND.Operation`	`operation`
`protected String`	`overStyle`

Constructor Summary

Constructors
Constructor and Description

DropTarget(Widget dropWidget)
Creates a new drop dropWidget.

Constructors
Constructor and Description
`DropTarget(Widget dropWidget)` Creates a new drop dropWidget.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HandlerRegistration`	`addDragCancelHandler(DndDragCancelEvent.DndDragCancelHandler handler)` Adds a `DndDragCancelEvent.DndDragCancelHandler` handler for `DndDragCancelEvent` events.
`HandlerRegistration`	`addDragEnterHandler(DndDragEnterEvent.DndDragEnterHandler handler)` Adds a `DndDragEnterEvent.DndDragEnterHandler` handler for `DndDragEnterEvent` events.
`HandlerRegistration`	`addDragLeaveHandler(DndDragLeaveEvent.DndDragLeaveHandler handler)` Adds a `DndDragLeaveEvent.DndDragLeaveHandler` handler for `DndDragLeaveEvent` events.
`HandlerRegistration`	`addDragMoveHandler(DndDragMoveEvent.DndDragMoveHandler handler)` Adds a `DndDragMoveEvent.DndDragMoveHandler` handler for `DndDragMoveEvent` events.
`HandlerRegistration`	`addDropHandler(DndDropEvent.DndDropHandler handler)` Adds a `DndDropEvent.DndDropHandler` handler for `DndDropEvent` events.
`void`	`disable()` Disables the drag source.
`void`	`enable()` Enables the drag source.
`protected XElement`	`getElementFromEvent(NativeEvent event)` Obtain potential top-most target element associated with provided event.
`DND.Feedback`	`getFeedback()` Returns the target's feedback setting.
`String`	`getGroup()` Returns the target's group name.
`DND.Operation`	`getOperation()` Returns the target's operation.
`String`	`getOverStyle()` Returns the target's over style.
`Widget`	`getWidget()` Returns the target's widget.
`boolean`	`isAllowSelfAsSource()` Returns true if internal drops are allowed.
`boolean`	`isEnabled()` Returns true if the drag source is enabled.
`protected void`	`onDragCancelled(DndDragCancelEvent event)` Called if the user cancels the drag operations while the mouse is over the target.
`protected void`	`onDragDrop(DndDropEvent event)` Called when the user releases the mouse over the target widget.
`protected void`	`onDragEnter(DndDragEnterEvent event)` Called when the cursor first enters the bounds of the drop target.
`protected void`	`onDragFail(DndDropEvent event)` Called when a drop fails.
`protected void`	`onDragLeave(DndDragLeaveEvent event)` Called when the cursor leaves the target.
`protected void`	`onDragMove(DndDragMoveEvent event)` Called when the cursor is moved within the target widget.
`protected void`	`onDropWidgetAttach()`
`protected void`	`onDropWidgetDetach()`
`protected List<Object>`	`prepareDropData(Object data, boolean convertTreeStoreModel)`
`void`	`release()` Unregisters the target as a drop target.
`void`	`setAllowSelfAsSource(boolean allowSelfAsSource)` Sets whether internal drops are allowed (defaults to false).
`void`	`setFeedback(DND.Feedback feedback)` Sets the target's feedback.
`void`	`setGroup(String group)` Sets the drag group.
`void`	`setOperation(DND.Operation operation)` Sets the operation for the drop target which specifies if data should be moved or copied when dropped.
`void`	`setOverStyle(String overStyle)` Sets the style name to be applied when the cursor is over the target (defaults to null).
`protected void`	`showFeedback(DndDragMoveEvent event)` Called as the mouse is moved over the target widget.

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

- Field Detail
  - dropWidget
```
protected Widget dropWidget
```
  - feedback
```
protected DND.Feedback feedback
```
  - operation
```
protected DND.Operation operation
```
  - overStyle
```
protected String overStyle
```
- Constructor Detail
  - DropTarget
```
public DropTarget(Widget dropWidget)
```
    Creates a new drop dropWidget.
    
    Parameters:
    
    dropWidget - the dropWidget widget
- Method Detail
  - addDragCancelHandler
```
public HandlerRegistration addDragCancelHandler(DndDragCancelEvent.DndDragCancelHandler handler)
```
    Description copied from interface: DndDragCancelEvent.HasDndDragCancelHandlers
    
    Adds a DndDragCancelEvent.DndDragCancelHandler handler for DndDragCancelEvent events.
    
    Specified by:
    
    addDragCancelHandler in interface DndDragCancelEvent.HasDndDragCancelHandlers
    
    Parameters:
    
    handler - the handler
    
    Returns:
    
    the registration for the event
  - addDragEnterHandler
```
public HandlerRegistration addDragEnterHandler(DndDragEnterEvent.DndDragEnterHandler handler)
```
    Description copied from interface: DndDragEnterEvent.HasDndDragEnterHandlers
    
    Adds a DndDragEnterEvent.DndDragEnterHandler handler for DndDragEnterEvent events.
    
    Specified by:
    
    addDragEnterHandler in interface DndDragEnterEvent.HasDndDragEnterHandlers
    
    Parameters:
    
    handler - the handler
    
    Returns:
    
    the registration for the event
  - addDragLeaveHandler
```
public HandlerRegistration addDragLeaveHandler(DndDragLeaveEvent.DndDragLeaveHandler handler)
```
    Description copied from interface: DndDragLeaveEvent.HasDndDragLeaveHandlers
    
    Adds a DndDragLeaveEvent.DndDragLeaveHandler handler for DndDragLeaveEvent events.
    
    Specified by:
    
    addDragLeaveHandler in interface DndDragLeaveEvent.HasDndDragLeaveHandlers
    
    Parameters:
    
    handler - the handler
    
    Returns:
    
    the registration for the event
  - addDragMoveHandler
```
public HandlerRegistration addDragMoveHandler(DndDragMoveEvent.DndDragMoveHandler handler)
```
    Description copied from interface: DndDragMoveEvent.HasDndDragMoveHandlers
    
    Adds a DndDragMoveEvent.DndDragMoveHandler handler for DndDragMoveEvent events.
    
    Specified by:
    
    addDragMoveHandler in interface DndDragMoveEvent.HasDndDragMoveHandlers
    
    Parameters:
    
    handler - the handler
    
    Returns:
    
    the registration for the event
  - addDropHandler
```
public HandlerRegistration addDropHandler(DndDropEvent.DndDropHandler handler)
```
    Description copied from interface: DndDropEvent.HasDndDropHandlers
    
    Adds a DndDropEvent.DndDropHandler handler for DndDropEvent events.
    
    Specified by:
    
    addDropHandler in interface DndDropEvent.HasDndDropHandlers
    
    Parameters:
    
    handler - the handler
    
    Returns:
    
    the registration for the event
  - disable
```
public void disable()
```
    Disables the drag source.
  - enable
```
public void enable()
```
    Enables the drag source.
  - getFeedback
```
public DND.Feedback getFeedback()
```
    Returns the target's feedback setting.
    
    Returns:
    
    the feedback
  - getGroup
```
public String getGroup()
```
    Returns the target's group name.
    
    Returns:
    
    the group name
  - getOperation
```
public DND.Operation getOperation()
```
    Returns the target's operation.
    
    Returns:
    
    the operation
  - getOverStyle
```
public String getOverStyle()
```
    Returns the target's over style.
    
    Returns:
    
    the over style
  - getWidget
```
public Widget getWidget()
```
    Returns the target's widget.
    
    Returns:
    
    the widget
  - isAllowSelfAsSource
```
public boolean isAllowSelfAsSource()
```
    Returns true if internal drops are allowed.
    
    Returns:
    
    true for internal drops
  - isEnabled
```
public boolean isEnabled()
```
    Returns true if the drag source is enabled.
    
    Returns:
    
    true for enabled
  - release
```
public void release()
```
    Unregisters the target as a drop target.
  - setAllowSelfAsSource
```
public void setAllowSelfAsSource(boolean allowSelfAsSource)
```
    Sets whether internal drops are allowed (defaults to false).
    
    Parameters:
    
    allowSelfAsSource - true to allow internal drops
  - setFeedback
```
public void setFeedback(DND.Feedback feedback)
```
    Sets the target's feedback. Feedback determines the type of visual indicators a drop target supports. Subclasses will determine range of valid values.
    
    Parameters:
    
    feedback - the feedback
  - setGroup
```
public void setGroup(String group)
```
    Sets the drag group. If specified, only drag sources with the same group value are allowed.
    
    Parameters:
    
    group - the group name
  - setOperation
```
public void setOperation(DND.Operation operation)
```
    Sets the operation for the drop target which specifies if data should be moved or copied when dropped. Drag sources use this value to determine if the target data should be removed from the source widget.
    
    Parameters:
    
    operation - the operation
  - setOverStyle
```
public void setOverStyle(String overStyle)
```
    Sets the style name to be applied when the cursor is over the target (defaults to null).
    
    Parameters:
    
    overStyle - the over style
  - getElementFromEvent
```
protected XElement getElementFromEvent(NativeEvent event)
```
    Obtain potential top-most target element associated with provided event. For touch devices, this method will attempt to find element from contained Widget. This is due to touch events "getEventTarget" always returning the element you started the gesture on, regardless if you moved outside of the region of said element. If the event coordinates do not match up with any dropTarget elements, then null will be returned.
    
    Parameters:
    
    event -
    
    Returns:
  - onDropWidgetAttach
```
protected void onDropWidgetAttach()
```
  - onDropWidgetDetach
```
protected void onDropWidgetDetach()
```
  - onDragCancelled
```
protected void onDragCancelled(DndDragCancelEvent event)
```
    Called if the user cancels the drag operations while the mouse is over the target.
    
    Parameters:
    
    event - the drag cancel event
  - onDragDrop
```
protected void onDragDrop(DndDropEvent event)
```
    Called when the user releases the mouse over the target widget.
    
    Parameters:
    
    event - the drop event
  - onDragEnter
```
protected void onDragEnter(DndDragEnterEvent event)
```
    Called when the cursor first enters the bounds of the drop target. Subclasses or listeners can change the status of status proxy via the passed event.
    
    Parameters:
    
    event - the drag enter event
  - onDragFail
```
protected void onDragFail(DndDropEvent event)
```
    Called when a drop fails.
    
    Parameters:
    
    event - the drop event
  - onDragLeave
```
protected void onDragLeave(DndDragLeaveEvent event)
```
    Called when the cursor leaves the target.
    
    Parameters:
    
    event - the drag leave event
  - onDragMove
```
protected void onDragMove(DndDragMoveEvent event)
```
    Called when the cursor is moved within the target widget. Subclasses or listeners can change the status of status proxy via the passed event. If either a subclass or listener sets CancellableEvent.setCancelled(boolean) to true, showFeedback(DndDragMoveEvent) will be called.
    
    Parameters:
    
    event - the dd event
  - prepareDropData
```
protected List<Object> prepareDropData(Object data,
                                       boolean convertTreeStoreModel)
```
  - showFeedback
```
protected void showFeedback(DndDragMoveEvent event)
```
    Called as the mouse is moved over the target widget. The default implementation does nothing.
    
    Parameters:
    
    event - the dd event

Class DropTarget

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

dropWidget

feedback

operation

overStyle

Constructor Detail

DropTarget

Method Detail

addDragCancelHandler

addDragEnterHandler

addDragLeaveHandler

addDragMoveHandler

addDropHandler

disable

enable

getFeedback

getGroup

getOperation

getOverStyle

getWidget

isAllowSelfAsSource

isEnabled

release

setAllowSelfAsSource

setFeedback

setGroup

setOperation

setOverStyle

getElementFromEvent

onDropWidgetAttach

onDropWidgetDetach

onDragCancelled

onDragDrop

onDragEnter

onDragFail

onDragLeave

onDragMove

prepareDropData

showFeedback