src/com/vaadin/event/dd/DragSource.java


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

/*
@ITMillApache2LicenseForJavaFiles@
 */
package com.vaadin.event.dd;

import java.io.Serializable;
import java.util.Map;

import com.vaadin.event.Transferable;

/**
 * TODO Javadoc
 * 
 * @since 6.3
 * 
 */
public interface DragSource extends Serializable {

    /**
     * DragSource may convert client side variables to meaningful values on
     * server side. For example Tree converts item identifiers to generated
     * string keys for the client side. Translators in Selects should convert
     * them back to item identifiers.
     * 
     * <p>
     * Translator should remove variables it handled from rawVariables. All non
     * handled variables are added to Transferable automatically by terminal.
     * </p>
     * 
     * <p>
     * 
     * @since 6.3
     * @param rawVariables
     * @return the drag source related transferable
     */
    public Transferable getTransferable(Map<String, Object> rawVariables);

}