@API(type=EXTENDABLE, src=PUBLIC) public interface AuthorDnDListener extends AWTExtension
AuthorDnDListener
interface
is the callback interface used by the author editor page to provide
notification of DnD operations that involve it.
Create a listener object by implementing the interface and then when
the drag enters, moves over, or exits
the author editor page, when
the drop action changes, and when the drop occurs, the relevant method in
the listener object is invoked, and the DropTargetEvent
is
passed to it.
Modifier and Type | Method and Description |
---|---|
boolean |
authorDragEnter(java.awt.dnd.DropTargetDragEvent event)
Called while a drag operation is ongoing, when the mouse pointer enters
the author editor page where this listener is registered.
|
boolean |
authorDragExit(java.awt.dnd.DropTargetEvent event)
Called while a drag operation is ongoing, when the mouse pointer has
exited the author editor page where this listener is registered.
|
boolean |
authorDragOver(java.awt.dnd.DropTargetDragEvent event)
Called when a drag operation is ongoing, while the mouse pointer is still
over the author editor page where this listener is registered.
|
boolean |
authorDrop(java.awt.datatransfer.Transferable transferable,
java.awt.dnd.DropTargetDropEvent event)
Called when the drag operation has terminated with a drop on
the author editor page where this listener is registered.
|
boolean |
authorSupportsFlavor(java.awt.datatransfer.DataFlavor flavor)
Check if the data flavor can be handled by the listener.
|
void |
init(AuthorAccess authorAccess)
Initialize the DnD listener.
|
getDescription
boolean authorDragOver(java.awt.dnd.DropTargetDragEvent event)
event
- The DropTargetDropEvent
event.true
if the listener handled the event.boolean authorDrop(java.awt.datatransfer.Transferable transferable, java.awt.dnd.DropTargetDropEvent event)
This method is responsible for undertaking
the transfer of the data associated with the
gesture. The DropTargetDropEvent
provides a means to obtain a Transferable
object that represents the data object(s) to
be transfered.
transferable
- The Transferable
object.event
- The DropTargetDragEvent
event.true
if the listener handled the event.boolean authorSupportsFlavor(java.awt.datatransfer.DataFlavor flavor)
flavor
- The DataFlavor
flavor.true
if the flavor is supported.boolean authorDragExit(java.awt.dnd.DropTargetEvent event)
event
- The DropTargetEvent
event.true
if the listener consumed the drag exit event.boolean authorDragEnter(java.awt.dnd.DropTargetDragEvent event)
event
- The DropTargetDragEvent
event.true
if the listener consumed the drag enter event.void init(AuthorAccess authorAccess)
authorAccess
- The AuthorAccess
providing access to
specific components corresponding to editor, document, workspace,
tables, change tracking and utility informations and actions.© Copyright SyncRO Soft SRL 2002 - 2014. All rights reserved.