Package com.vaadin.event.dd

Interface DragSource

All Superinterfaces:

ClientConnector, Component, Connector, Serializable, Sizeable

All Known Implementing Classes:

DragAndDropWrapper, Table, Tree, TreeTable

public interface DragSource
extends Component

DragSource is a Component that builds a Transferable for a drag and drop operation.

In Vaadin the drag and drop operation practically starts from client side component. The client side component initially defines the data that will be present in Transferable object on server side. If the server side counterpart of the component implements this interface, terminal implementation lets it create the Transferable instance from the raw client side "seed data". This way server side implementation may translate or extend the data that will be available for DropHandler.

Since:

6.3

Nested Class Summary

Nested classes/interfaces inherited from interface com.vaadin.server.ClientConnector

ClientConnector.AttachEvent, ClientConnector.AttachListener, ClientConnector.ConnectorErrorEvent, ClientConnector.DetachEvent, ClientConnector.DetachListener

Nested classes/interfaces inherited from interface com.vaadin.ui.Component

Component.ErrorEvent, Component.Event, Component.Focusable, Component.Listener

Nested classes/interfaces inherited from interface com.vaadin.server.Sizeable

Sizeable.Unit

Field Summary

Fields inherited from interface com.vaadin.server.Sizeable

SIZE_UNDEFINED, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS

Method Summary

Modifier and Type	Method	Description
Transferable	getTransferable(Map<String,Object> rawVariables)	DragSource may convert data added by client side component to meaningful values for server side developer or add other data based on it.

Methods inherited from interface com.vaadin.server.ClientConnector

addAttachListener, addDetachListener, beforeClientResponse, detach, encodeState, getErrorHandler, getExtensions, getRpcManager, getStateType, handleConnectorRequest, isAttached, isConnectorEnabled, markAsDirty, markAsDirtyRecursive, removeAttachListener, removeDetachListener, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler

Methods inherited from interface com.vaadin.ui.Component

addListener, addStyleName, attach, getCaption, getDescription, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getUI, isEnabled, isReadOnly, isVisible, readDesign, removeListener, removeStyleName, setCaption, setEnabled, setIcon, setId, setParent, setPrimaryStyleName, setReadOnly, setStyleName, setVisible, writeDesign

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

Methods inherited from interface com.vaadin.server.Sizeable

getHeight, getHeightUnits, getWidth, getWidthUnits, setHeight, setHeight, setHeightUndefined, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthUndefined

Method Detail

getTransferable

Transferable getTransferable(Map<String,Object> rawVariables)

DragSource may convert data added by client side component to meaningful values for server side developer or add other data based on it.

For example Tree converts item identifiers to generated string keys for the client side. Vaadin developer don't and can't know anything about these generated keys, only about item identifiers. When tree node is dragged client puts that key to Transferables client side counterpart. In Tree.getTransferable(Map) the key is converted back to item identifier that the server side developer can use.

Parameters:

rawVariables - the data that client side initially included in Transferables client side counterpart.

Returns:

the Transferable instance that will be passed to DropHandler (and/or AcceptCriterion)

Since:

6.3