com.vaadin.event.dd.


Interface DropTarget

All Superinterfaces:

Component, EventListener, Paintable, Serializable, Sizeable, VariableOwner

All Known Implementing Classes:

DragAndDropWrapper, Table, Tree, TreeTable

public interface DropTarget
extends Component

DropTarget is an interface for components supporting drop operations. A component that wants to receive drop events should implement this interface and provide a DropHandler which will handle the actual drop event.

Since:

6.3

Nested Class Summary
 
Nested classes/interfaces inherited from interface com.vaadin.ui.Component
Component.ErrorEvent, Component.ErrorListener, Component.Event, Component.Focusable, Component.Listener
 
Nested classes/interfaces inherited from interface com.vaadin.terminal.Paintable
Paintable.RepaintRequestEvent, Paintable.RepaintRequestListener
 
Field Summary
 
Fields inherited from interface com.vaadin.terminal.Sizeable
SIZE_UNDEFINED, UNIT_SYMBOLS, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS
 
Method Summary
 DropHandler getDropHandler()
           
 TargetDetails translateDropTargetDetails(Map<String,Object> clientVariables)
          Called before the DragAndDropEvent is passed to DropHandler.
 
Methods inherited from interface com.vaadin.ui.Component
addListener, addStyleName, attach, childRequestedRepaint, detach, getApplication, getCaption, getIcon, getLocale, getParent, getStyleName, getWindow, isEnabled, isReadOnly, isVisible, removeListener, removeStyleName, setCaption, setEnabled, setIcon, setParent, setReadOnly, setStyleName, setVisible
 
Methods inherited from interface com.vaadin.terminal.Paintable
addListener, getDebugId, paint, removeListener, requestRepaint, requestRepaintRequests, setDebugId
 
Methods inherited from interface com.vaadin.terminal.VariableOwner
changeVariables, isImmediate
 
Methods inherited from interface com.vaadin.terminal.Sizeable
getHeight, getHeightUnits, getWidth, getWidthUnits, setHeight, setHeight, setHeight, setHeightUnits, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidth, setWidthUnits
 

Method Detail

getDropHandler

DropHandler getDropHandler()

Returns:
the drop hanler that will receive the dragged data or null if drops are not currently accepted

translateDropTargetDetails

TargetDetails translateDropTargetDetails(Map<String,Object> clientVariables)

Called before the DragAndDropEvent is passed to DropHandler. Implementation may for example translate the drop target details provided by the client side (drop target) to meaningful server side values. If null is returned the terminal implementation will automatically create a TargetDetails with raw client side data.

Parameters:
clientVariables - data passed from the DropTargets client side counterpart.
Returns:
A DropTargetDetails object with the translated data or null to use a default implementation.
See Also:
DragSource.getTransferable(Map)