com.vaadin.ui.components.grid.TreeGridDragSource API 8.27.7 | Vaadin

com.vaadin.ui.components.grid.

java.lang.Object
- com.vaadin.server.AbstractClientConnector
- - com.vaadin.server.AbstractExtension
  - - com.vaadin.ui.dnd.DragSourceExtension<Grid<T>>
    - - com.vaadin.ui.components.grid.GridDragSource<T>
      - com.vaadin.ui.components.grid.TreeGridDragSource<T>

Type Parameters:

T - The TreeGrid bean type.

All Implemented Interfaces:

MethodEventSource, ClientConnector, Extension, Connector, Serializable
```
public class TreeGridDragSource<T>
extends GridDragSource<T>
```
Makes a TreeGrid's rows draggable for HTML5 drag and drop functionality.
When dragging a selected row, all the visible selected rows are dragged. Note that ONLY visible rows are taken into account and the subtree belonging to a selected row is not dragged either.

Since:

8.1

Author:

Vaadin Ltd.

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface com.vaadin.server.ClientConnector
  ClientConnector.AttachEvent, ClientConnector.AttachListener, ClientConnector.ConnectorErrorEvent, ClientConnector.DetachEvent, ClientConnector.DetachListener

Constructor Summary

Constructors
Constructor Description

TreeGridDragSource(TreeGrid<T> target)
Extends a TreeGrid and makes it's rows draggable.

Method Summary

All Methods
Modifier and Type	Method	Description
`protected TreeGridDragSourceState`	`getState()`	Returns the shared state for this connector.
`protected TreeGridDragSourceState`	`getState(boolean markAsDirty)`	Returns the shared state for this connector.

Methods inherited from class com.vaadin.ui.components.grid.GridDragSource
addGridDragEndListener, addGridDragStartListener, clearDragDataGenerator, getDragDataGenerator, getGrid, registerDragSourceRpc, remove, setDragDataGenerator

Methods inherited from class com.vaadin.ui.dnd.DragSourceExtension
addDragEndListener, addDragStartListener, attach, clearDataTransferData, clearDataTransferData, getDataTransferData, getDataTransferData, getDataTransferText, getDragData, getEffectAllowed, getParent, onDragEnd, onDragStart, setDataTransferData, setDataTransferText, setDragData, setDragImage, setEffectAllowed, setPayload, setPayload, setPayload

Methods inherited from class com.vaadin.server.AbstractExtension
extend, getSupportedParentType, setParent

Methods inherited from class com.vaadin.server.AbstractClientConnector
addAttachListener, addDetachListener, addExtension, addListener, addListener, addListener, addListener, addListener, addListener, addMethodInvocationToQueue, beforeClientResponse, createState, detach, encodeState, equals, fireEvent, getAllChildrenIterable, getConnectorId, getErrorHandler, getExtensions, getListeners, getResource, getRpcManager, getRpcProxy, getSession, getStateType, getUI, handleConnectorRequest, hashCode, hasListeners, isAttached, isConnectorEnabled, isThis, markAsDirty, markAsDirtyRecursive, registerRpc, registerRpc, removeAttachListener, removeDetachListener, removeExtension, removeListener, removeListener, removeListener, removeListener, removeListener, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler, setResource, updateDiffstate

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

Methods inherited from interface com.vaadin.server.ClientConnector
addAttachListener, addDetachListener, beforeClientResponse, detach, encodeState, getErrorHandler, getExtensions, getRpcManager, getStateType, getUI, handleConnectorRequest, isAttached, isConnectorEnabled, markAsDirty, markAsDirtyRecursive, removeAttachListener, removeDetachListener, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler

Methods inherited from interface com.vaadin.shared.Connector
getConnectorId

- Constructor Detail
  - TreeGridDragSource
```
public TreeGridDragSource(TreeGrid<T> target)
```
    Extends a TreeGrid and makes it's rows draggable.
    
    Parameters:
    
    target - TreeGrid to be extended.
- Method Detail
  - getState
```
protected TreeGridDragSourceState getState()
```
    Description copied from class: AbstractClientConnector
    
    Returns the shared state for this connector. The shared state object is shared between the server connector and the client connector. Changes are only communicated from the server to the client and not in the other direction.
    As a side effect, marks the connector dirty so any changes done to the state will be sent to the client. Use getState(false) to avoid marking the connector as dirty.
    
    Overrides:
    
    getState in class GridDragSource<T>
    
    Returns:
    
    The shared state for this connector. Never null.
  - getState
```
protected TreeGridDragSourceState getState(boolean markAsDirty)
```
    Description copied from class: AbstractClientConnector
    
    Returns the shared state for this connector.
    
    Overrides:
    
    getState in class GridDragSource<T>
    
    Parameters:
    
    markAsDirty - true if the connector should automatically be marked dirty, false otherwise
    
    Returns:
    
    The shared state for this connector. Never null.
    
    See Also:
    
    AbstractClientConnector.getState()