com.nomagic.magicdraw.ui.dnd

Class CustomDragAndDropHandler

java.lang.Object

com.nomagic.magicdraw.ui.dnd.CustomDragAndDropHandler

@OpenApiAll
public abstract class CustomDragAndDropHandler
extends java.lang.Object

Drop Diagram Handler interface used to implement drag and drop actions for browser drops

Using this interface you can implement the main methods that are responsible for drag and drop actions. And later register your custom drag and drop action using CustomDropDiagramHandlerFactory

See Also:

CustomDropDiagramHandlerFactory

Constructor Summary

Constructors

Constructor and Description
CustomDragAndDropHandler()

Method Summary

Methods

Modifier and Type	Method and Description
abstract boolean	drop(java.awt.Point location, PresentationElement elementOver, java.util.List<Element> draggedElements, DiagramPresentationElement diagramPresentationElement) Executes the drop action
abstract java.lang.String	getDescription() Returns the description of the drop diagram handler
abstract boolean	willAcceptDrop(java.awt.Point location, PresentationElement elementOver, java.util.List<Element> draggedElements, DiagramPresentationElement diagramPresentationElement) Checks if drop can be executed

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomDragAndDropHandler

public CustomDragAndDropHandler()

Method Detail

getDescription

public abstract java.lang.String getDescription()

Returns the description of the drop diagram handler

Returns:

description of drop diagram handler

willAcceptDrop

public abstract boolean willAcceptDrop(@CheckForNull
                     java.awt.Point location,
                     @CheckForNull
                     PresentationElement elementOver,
                     @CheckForNull
                     java.util.List<Element> draggedElements,
                     @CheckForNull
                     DiagramPresentationElement diagramPresentationElement)

Checks if drop can be executed

Parameters:

location - drop location

elementOver - presentation element on which data is dragged

draggedElements - dragged elements

diagramPresentationElement - diagram presentation element on which Drag and Drop action is executed

Returns:

true if element can accept dragged data, else false

drop

public abstract boolean drop(@CheckForNull
           java.awt.Point location,
           @CheckForNull
           PresentationElement elementOver,
           @CheckForNull
           java.util.List<Element> draggedElements,
           @CheckForNull
           DiagramPresentationElement diagramPresentationElement)

Executes the drop action

Parameters:

location - drop location

elementOver - presentation element on which drop is executed

draggedElements - dragged elements over drop target

diagramPresentationElement - diagram presentation element on which Drag and Drop action is executed

Returns:

returns true if drop was successful, else false (it is important to return true after successful action, as else this and next Drag and Drop action will be executed)