/*
* Copyright (c) 2009, 2013, Oracle and/or its affiliates. All rights reserved.
* ORACLE PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*/
package com.sun.javafx.tk;
import javafx.scene.input.
TransferMode;
/**
* Listens for drop target events on a TKScene.
* <br>
* The implementation of this interface uses the event objects' pointer position
* to determine if any nodes in the scene graph are to be notified
* of drag gesture events.
* <br>
* TODO: extend this interface to include dropActionChanged() notification
*/
public interface
TKDropTargetListener {
/**
* Called during a drag gesture, when the mouse pointer enters
* the operable part of the Scene.
*
* @return transfer mode chosen by potential target
*/
public
TransferMode dragEnter(double
x, double
y, double
screenX, double
screenY,
TransferMode transferMode,
TKClipboard dragboard);
/**
* Called during a drag gesture, while the mouse pointer is still
* over (is moving over) the operable part of the Sceme.
*
* @return transfer mode chosen by potential target
*/
public
TransferMode dragOver(double
x, double
y, double
screenX, double
screenY,
TransferMode transferMode);
/**
* Called during a drag gesture, when the mouse pointer exits
* the operable part of the Scene.
*/
public void
dragExit(double
x, double
y, double
screenX, double
screenY);
/**
* Called when the drag gesture is being terminated with a drop on
* the operable part Scene.
* <br>
* This method is responsible for undertaking
* the transfer of the data associated with the
* gesture. The <code>dropTargetDropEvent</code>
* provides a means to obtain an
* object that represents the data object(s) to
* be transfered.
* <br>
* From this method, the implemenation needs to
* allow {javafx.scene.transfer.DragEvent#accept()} or
* {javafx.scene.transfer.DragEvent#reject()} to be called from a drop
* target node in the scene graph.
* <br>
* Subsequent to {javafx.scene.transfer.DragEvent#accept()}, the target
* node should retrieve the drag gesture's data via the
* {javafx.scene.transfer.DragEvent#dragboard}
* <br>
* At the completion of a drop, the target node is required to call
* {javafx.scene.transfer.DragEvent#dropComplete(boolean))}.
* <br>
* Note: The data transfer should be completed before the call to
* {javafx.scene.transfer.DragEvent#dropComplete(boolean))}.
* After that, the transfer of data can only succeed if the data transfer is
* local (within the same VM hosting the running JavaFX code).
* <br>
* @return transfer mode chosen by target
*/
public
TransferMode drop(double
x, double
y, double
screenX, double
screenY,
TransferMode transferMode);
}