summaryrefslogtreecommitdiffstats
path: root/src/com/vaadin/event/dd/DropTarget.java
diff options
context:
space:
mode:
authorMatti Tahvonen <matti.tahvonen@itmill.com>2010-03-17 15:35:41 +0000
committerMatti Tahvonen <matti.tahvonen@itmill.com>2010-03-17 15:35:41 +0000
commit0a049a0d913a548cd327542320bc8c22f5184f91 (patch)
tree946a1cc2175cd16a7dc653d211dd538fc19407bf /src/com/vaadin/event/dd/DropTarget.java
parent013788fd8db3bf57dff411c18b65265322d954ac (diff)
downloadvaadin-framework-0a049a0d913a548cd327542320bc8c22f5184f91.tar.gz
vaadin-framework-0a049a0d913a548cd327542320bc8c22f5184f91.zip
DD related javadocs, cleanup, small refactoring
svn changeset:11938/svn branch:6.3
Diffstat (limited to 'src/com/vaadin/event/dd/DropTarget.java')
-rw-r--r--src/com/vaadin/event/dd/DropTarget.java19
1 files changed, 13 insertions, 6 deletions
diff --git a/src/com/vaadin/event/dd/DropTarget.java b/src/com/vaadin/event/dd/DropTarget.java
index 1d032c42e4..b2ab244c43 100644
--- a/src/com/vaadin/event/dd/DropTarget.java
+++ b/src/com/vaadin/event/dd/DropTarget.java
@@ -16,17 +16,24 @@ import com.vaadin.ui.Component;
*/
public interface DropTarget extends Component {
+ /**
+ * @return the drop hanler that will receive the dragged data or null if
+ * drops are not currently accepted
+ */
public DropHandler getDropHandler();
/**
- * Called before a drop operation to translate the drop target details
- * provided by the client widget (drop target). Should return a DropData
- * implementation with the new values. If null is returned the terminal
- * implementation will automatically create a {@link DropTargetDetails} with
- * all the client variables.
+ * Called before the {@link DragAndDropEvent} is passed to
+ * {@link DropHandler}. Implementation may for exmaple translate the drop
+ * target details provided by the client side (drop target) to meaningful
+ * server side values. If null is returned the terminal implementation will
+ * automatically create a {@link DropTargetDetails} with raw client side
+ * data.
+ *
+ * @see DragSource#getTransferable(Map)
*
* @param rawVariables
- * Parameters passed from the client side widget.
+ * data passed from the DropTargets client side counterpart.
* @return A DropTargetDetails object with the translated data or null to
* use a default implementation.
*/