com.vaadin.ui

Class DragAndDropWrapper

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.ui.AbstractComponent

com.vaadin.ui.CustomComponent

com.vaadin.ui.DragAndDropWrapper

All Implemented Interfaces:

com.vaadin.event.ConnectorEventListener, com.vaadin.event.ContextClickEvent.ContextClickNotifier, com.vaadin.event.dd.DragSource, com.vaadin.event.dd.DropTarget, com.vaadin.event.MethodEventSource, com.vaadin.server.ClientConnector, com.vaadin.server.Sizeable, com.vaadin.server.VariableOwner, com.vaadin.shared.Connector, com.vaadin.ui.Component, com.vaadin.ui.HasComponents, com.vaadin.ui.LegacyComponent, Serializable, Iterable<com.vaadin.ui.Component>, EventListener

Direct Known Subclasses:

AbstractFavoritesDragAndDropWrapper

public class DragAndDropWrapper
extends com.vaadin.ui.CustomComponent
implements com.vaadin.event.dd.DropTarget, com.vaadin.event.dd.DragSource, com.vaadin.ui.LegacyComponent

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DragAndDropWrapper.DragStartMode
class	DragAndDropWrapper.WrapperTargetDetails
class	DragAndDropWrapper.WrapperTransferable

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

com.vaadin.ui.Component.ErrorEvent, com.vaadin.ui.Component.Event, com.vaadin.ui.Component.Focusable, com.vaadin.ui.Component.Listener

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

com.vaadin.server.ClientConnector.AttachEvent, com.vaadin.server.ClientConnector.AttachListener, com.vaadin.server.ClientConnector.ConnectorErrorEvent, com.vaadin.server.ClientConnector.DetachEvent, com.vaadin.server.ClientConnector.DetachListener

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

com.vaadin.server.Sizeable.Unit

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

com.vaadin.ui.HasComponents.ComponentAttachDetachNotifier, com.vaadin.ui.HasComponents.ComponentAttachEvent, com.vaadin.ui.HasComponents.ComponentAttachListener, com.vaadin.ui.HasComponents.ComponentDetachEvent, com.vaadin.ui.HasComponents.ComponentDetachListener

Field Summary

Fields inherited from class com.vaadin.ui.AbstractComponent

DESIGN_ATTR_PLAIN_TEXT

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

Constructor Summary

Constructors

Constructor and Description
DragAndDropWrapper() Deprecated.
DragAndDropWrapper(com.vaadin.ui.Component root) Wraps given component in a DragAndDropWrapper.

Method Summary

Modifier and Type	Method and Description
void	changeVariables(Object source, Map<String,Object> variables)
com.vaadin.ui.Component	getDragImageComponent() Gets the component that will be used as the drag image.
DragAndDropWrapper.DragStartMode	getDragStartMode()
com.vaadin.event.dd.DropHandler	getDropHandler()
com.vaadin.event.Transferable	getTransferable(Map<String,Object> rawVariables)
void	paintContent(com.vaadin.server.PaintTarget target)
void	readDesign(org.jsoup.nodes.Element design, com.vaadin.ui.declarative.DesignContext designContext)
void	setDragImageComponent(com.vaadin.ui.Component dragImageComponent) Sets the component that will be used as the drag image.
void	setDragStartMode(DragAndDropWrapper.DragStartMode dragStartMode)
void	setDropHandler(com.vaadin.event.dd.DropHandler dropHandler)
void	setHTML5DataFlavor(String type, Object value) Sets data flavors available in the DragAndDropWrapper is used to start an HTML5 style drags.
com.vaadin.event.dd.TargetDetails	translateDropTargetDetails(Map<String,Object> clientVariables)
void	writeDesign(org.jsoup.nodes.Element design, com.vaadin.ui.declarative.DesignContext designContext)

Methods inherited from class com.vaadin.ui.CustomComponent

getComponentCount, getCompositionRoot, iterator, setCompositionRoot

Methods inherited from class com.vaadin.ui.AbstractComponent

addContextClickListener, addListener, addShortcutListener, addStyleName, attach, beforeClientResponse, detach, findAncestor, fireComponentErrorEvent, fireComponentEvent, focus, getActionManager, getCaption, getComponentError, getCustomAttributes, getData, getDebugId, getDescription, getErrorMessage, getExplicitImmediateValue, getHeight, getHeightUnits, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getState, getState, getStyleName, getWidth, getWidthUnits, isCaptionAsHtml, isConnectorEnabled, isEnabled, isImmediate, isOrHasAncestor, isReadOnly, isResponsive, isVisible, removeContextClickListener, removeListener, removeShortcutListener, removeStyleName, setCaption, setCaptionAsHtml, setComponentError, setData, setDebugId, setDescription, setEnabled, setHeight, setHeight, setHeightUndefined, setIcon, setId, setImmediate, setLocale, setParent, setPrimaryStyleName, setReadOnly, setResponsive, setSizeFull, setSizeUndefined, setStyleName, setStyleName, setVisible, setWidth, setWidth, setWidthUndefined

Methods inherited from class com.vaadin.server.AbstractClientConnector

addAttachListener, addDetachListener, addExtension, addListener, addListener, addListener, addMethodInvocationToQueue, createState, encodeState, equals, fireEvent, getAllChildrenIterable, getConnectorId, getErrorHandler, getExtensions, getListeners, getResource, getRpcManager, getRpcProxy, getSession, getStateType, getUI, handleConnectorRequest, hashCode, hasListeners, isAttached, isThis, markAsDirty, markAsDirtyRecursive, registerRpc, registerRpc, removeAttachListener, removeDetachListener, removeExtension, removeListener, removeListener, removeListener, removeListener, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler, setResource

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.vaadin.ui.LegacyComponent

markAsDirty

Methods inherited from interface com.vaadin.server.VariableOwner

isEnabled, isImmediate

Methods inherited from interface com.vaadin.ui.Component

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

Methods inherited from interface com.vaadin.server.ClientConnector

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

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

DragAndDropWrapper

@Deprecated
public DragAndDropWrapper()

Deprecated.

This is an internal constructor. Use DragAndDropWrapper(Component) instead.

Since:

7.5.0

DragAndDropWrapper

public DragAndDropWrapper(com.vaadin.ui.Component root)

Wraps given component in a DragAndDropWrapper.

Parameters:

root - the component to be wrapped

Method Detail

setHTML5DataFlavor

public void setHTML5DataFlavor(String type,
                               Object value)

Sets data flavors available in the DragAndDropWrapper is used to start an HTML5 style drags. Most commonly the "Text" flavor should be set. Multiple data types can be set.

Parameters:

type - the string identifier of the drag "payload". E.g. "Text" or "text/html"

value - the value

changeVariables

public void changeVariables(Object source,
                            Map<String,Object> variables)

Specified by:

changeVariables in interface com.vaadin.server.VariableOwner

paintContent

public void paintContent(com.vaadin.server.PaintTarget target)
                  throws com.vaadin.server.PaintException

Specified by:

paintContent in interface com.vaadin.ui.LegacyComponent

Throws:

com.vaadin.server.PaintException

getDropHandler

public com.vaadin.event.dd.DropHandler getDropHandler()

Specified by:

getDropHandler in interface com.vaadin.event.dd.DropTarget

setDropHandler

public void setDropHandler(com.vaadin.event.dd.DropHandler dropHandler)

translateDropTargetDetails

public com.vaadin.event.dd.TargetDetails translateDropTargetDetails(Map<String,Object> clientVariables)

Specified by:

translateDropTargetDetails in interface com.vaadin.event.dd.DropTarget

getTransferable

public com.vaadin.event.Transferable getTransferable(Map<String,Object> rawVariables)

Specified by:

getTransferable in interface com.vaadin.event.dd.DragSource

setDragStartMode

public void setDragStartMode(DragAndDropWrapper.DragStartMode dragStartMode)

getDragStartMode

public DragAndDropWrapper.DragStartMode getDragStartMode()

setDragImageComponent

public void setDragImageComponent(com.vaadin.ui.Component dragImageComponent)

Sets the component that will be used as the drag image. Only used when wrapper is set to DragAndDropWrapper.DragStartMode.COMPONENT_OTHER

Parameters:

dragImageComponent -

getDragImageComponent

public com.vaadin.ui.Component getDragImageComponent()

Gets the component that will be used as the drag image. Only used when wrapper is set to DragAndDropWrapper.DragStartMode.COMPONENT_OTHER

Returns:

null if no component is set.

readDesign

public void readDesign(org.jsoup.nodes.Element design,
                       com.vaadin.ui.declarative.DesignContext designContext)

Specified by:

readDesign in interface com.vaadin.ui.Component

Overrides:

readDesign in class com.vaadin.ui.AbstractComponent

writeDesign

public void writeDesign(org.jsoup.nodes.Element design,
                        com.vaadin.ui.declarative.DesignContext designContext)

Specified by:

writeDesign in interface com.vaadin.ui.Component

Overrides:

writeDesign in class com.vaadin.ui.AbstractComponent