summaryrefslogtreecommitdiffstats
path: root/server/src/com/vaadin/event/Transferable.java
diff options
context:
space:
mode:
Diffstat (limited to 'server/src/com/vaadin/event/Transferable.java')
-rw-r--r--server/src/com/vaadin/event/Transferable.java57
1 files changed, 57 insertions, 0 deletions
diff --git a/server/src/com/vaadin/event/Transferable.java b/server/src/com/vaadin/event/Transferable.java
new file mode 100644
index 0000000000..838d8ad7e2
--- /dev/null
+++ b/server/src/com/vaadin/event/Transferable.java
@@ -0,0 +1,57 @@
+/*
+@VaadinApache2LicenseForJavaFiles@
+ */
+package com.vaadin.event;
+
+import java.io.Serializable;
+import java.util.Collection;
+
+import com.vaadin.ui.Component;
+
+/**
+ * Transferable wraps the data that is to be imported into another component.
+ * Currently Transferable is only used for drag and drop.
+ *
+ * @since 6.3
+ */
+public interface Transferable extends Serializable {
+
+ /**
+ * Returns the data from Transferable by its data flavor (aka data type).
+ * Data types can be any string keys, but MIME types like "text/plain" are
+ * commonly used.
+ * <p>
+ * Note, implementations of {@link Transferable} often provide a better
+ * typed API for accessing data.
+ *
+ * @param dataFlavor
+ * the data flavor to be returned from Transferable
+ * @return the data stored in the Transferable or null if Transferable
+ * contains no data for given data flavour
+ */
+ public Object getData(String dataFlavor);
+
+ /**
+ * Stores data of given data flavor to Transferable. Possibly existing value
+ * of the same data flavor will be replaced.
+ *
+ * @param dataFlavor
+ * the data flavor
+ * @param value
+ * the new value of the data flavor
+ */
+ public void setData(String dataFlavor, Object value);
+
+ /**
+ * @return a collection of data flavors ( data types ) available in this
+ * Transferable
+ */
+ public Collection<String> getDataFlavors();
+
+ /**
+ * @return the component that created the Transferable or null if the source
+ * component is unknown
+ */
+ public Component getSourceComponent();
+
+}