com.vaadin.client.connectors.grid

Class GridDragSourceConnector

java.lang.Object

com.vaadin.client.ui.AbstractConnector

com.vaadin.client.extensions.AbstractExtensionConnector

com.vaadin.client.extensions.DragSourceExtensionConnector

com.vaadin.client.connectors.grid.GridDragSourceConnector

All Implemented Interfaces:

com.google.gwt.event.shared.EventHandler, StateChangeEvent.StateChangeHandler, ServerConnector, Connector, Serializable

Direct Known Subclasses:

TreeGridDragSourceConnector

public class GridDragSourceConnector
extends DragSourceExtensionConnector

Adds HTML5 drag and drop functionality to a Grid's rows. This is the client side counterpart of GridDragSource.

Since:

8.1

Author:

Vaadin Ltd

See Also:

Serialized Form

Field Summary

Fields inherited from class com.vaadin.client.extensions.DragSourceExtensionConnector

STYLE_SUFFIX_DRAGGED, STYLE_SUFFIX_DRAGSOURCE

Constructor Summary

Constructors

Constructor and Description
GridDragSourceConnector()

Method Summary

Modifier and Type	Method and Description
protected void	addDraggedStyle(com.google.gwt.dom.client.NativeEvent event) Add v-grid-row-dragged class name to each row being dragged.
protected Map<String,String>	createDataTransferData(com.google.gwt.dom.client.NativeEvent dragStartEvent) Creates the data map to be set as the DataTransfer object's data.
protected void	extend(ServerConnector target) Called when the extension is attached to its parent.
GridDragSourceState	getState() Returns the shared state object for this connector.
protected void	onDragEnd(elemental.events.Event event) Event handler for the dragend event.
protected void	onDragStart(elemental.events.Event event) Event handler for the dragstart event.
void	onUnregister() Event called when connector has been unregistered.
protected void	removeDraggedStyle(com.google.gwt.dom.client.NativeEvent event) Remove v-grid-row-dragged class name from dragged rows.
protected void	sendDragEndEventToServer(com.google.gwt.dom.client.NativeEvent dragEndEvent, DropEffect dropEffect) Initiates a server RPC for the drag end event.
protected void	sendDragStartEventToServer(com.google.gwt.dom.client.NativeEvent dragStartEvent) Initiates a server RPC for the drag start event.
protected void	setDragImage(com.google.gwt.dom.client.NativeEvent dragStartEvent) Sets the drag image to be displayed.

Methods inherited from class com.vaadin.client.extensions.DragSourceExtensionConnector

addDraggable, addDragListeners, fixDragImageOffsetsForDesktop, fixDragImageTransformForMobile, getDraggableElement, getDropEffect, isAndoidChrome, isNativeDragEvent, removeDraggable, removeDragListeners

Methods inherited from class com.vaadin.client.extensions.AbstractExtensionConnector

setParent

Methods inherited from class com.vaadin.client.ui.AbstractConnector

addStateChangeHandler, addStateChangeHandler, createState, doInit, ensureHandlerManager, fireEvent, forceStateChange, getChildren, getConnection, getConnectorId, getParent, getResourceUrl, getRpcImplementations, getRpcProxy, getStateType, getTag, hasEventListener, init, isEnabled, onStateChanged, registerRpc, removeStateChangeHandler, removeStateChangeHandler, setChildren, setTag, unregisterRpc, updateEnabledState

Methods inherited from class java.lang.Object

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

Constructor Detail

GridDragSourceConnector

public GridDragSourceConnector()

Method Detail

extend

protected void extend(ServerConnector target)

Description copied from class: AbstractExtensionConnector

Called when the extension is attached to its parent. This method is only called once as an extension cannot be moved from one parent to another.

Overrides:

extend in class DragSourceExtensionConnector

Parameters:

target - The connector this extension extends

onDragStart

protected void onDragStart(elemental.events.Event event)

Description copied from class: DragSourceExtensionConnector

Event handler for the dragstart event. Called when dragstart event occurs.

Overrides:

onDragStart in class DragSourceExtensionConnector

Parameters:

event - browser event to be handled

setDragImage

protected void setDragImage(com.google.gwt.dom.client.NativeEvent dragStartEvent)

Description copied from class: DragSourceExtensionConnector

Sets the drag image to be displayed.

Override this method in case you need custom drag image setting. Called from DragSourceExtensionConnector.onDragStart(Event).

Overrides:

setDragImage in class DragSourceExtensionConnector

Parameters:

dragStartEvent - The drag start event.

createDataTransferData

protected Map<String,String> createDataTransferData(com.google.gwt.dom.client.NativeEvent dragStartEvent)

Description copied from class: DragSourceExtensionConnector

Creates the data map to be set as the DataTransfer object's data.

Overrides:

createDataTransferData in class DragSourceExtensionConnector

Parameters:

dragStartEvent - The drag start event

Returns:

The map from type to data, or null for not setting any data. Returning null will cancel the drag start.

sendDragStartEventToServer

protected void sendDragStartEventToServer(com.google.gwt.dom.client.NativeEvent dragStartEvent)

Description copied from class: DragSourceExtensionConnector

Initiates a server RPC for the drag start event.

This method is called only if there is a server side drag start event handler attached.

Overrides:

sendDragStartEventToServer in class DragSourceExtensionConnector

Parameters:

dragStartEvent - Client side dragstart event.

onDragEnd

protected void onDragEnd(elemental.events.Event event)

Description copied from class: DragSourceExtensionConnector

Event handler for the dragend event. Called when dragend event occurs.

Overrides:

onDragEnd in class DragSourceExtensionConnector

Parameters:

event - browser event to be handled

sendDragEndEventToServer

protected void sendDragEndEventToServer(com.google.gwt.dom.client.NativeEvent dragEndEvent,
                                        DropEffect dropEffect)

Description copied from class: DragSourceExtensionConnector

Initiates a server RPC for the drag end event.

Overrides:

sendDragEndEventToServer in class DragSourceExtensionConnector

Parameters:

dragEndEvent - Client side dragend event.

dropEffect - Drop effect of the dragend event, extracted from DataTransfer.dropEffect parameter.

addDraggedStyle

protected void addDraggedStyle(com.google.gwt.dom.client.NativeEvent event)

Add v-grid-row-dragged class name to each row being dragged.

Overrides:

addDraggedStyle in class DragSourceExtensionConnector

Parameters:

event - The dragstart event.

removeDraggedStyle

protected void removeDraggedStyle(com.google.gwt.dom.client.NativeEvent event)

Remove v-grid-row-dragged class name from dragged rows.

Overrides:

removeDraggedStyle in class DragSourceExtensionConnector

Parameters:

event - The dragend event.

onUnregister

public void onUnregister()

Description copied from interface: ServerConnector

Event called when connector has been unregistered.

Specified by:

onUnregister in interface ServerConnector

Overrides:

onUnregister in class DragSourceExtensionConnector

getState

public GridDragSourceState getState()

Description copied from class: AbstractConnector

Returns the shared state object for this connector. Override this method to define the shared state type for your connector.

Specified by:

getState in interface ServerConnector

Overrides:

getState in class DragSourceExtensionConnector

Returns:

the current shared state (never null)