javax/swing/TransferHandler.java

59  * to/from a clipboard.  It is also used in drag-and-drop operations
60  * to represent a drag from a component, and a drop to a component.
64  * that automatically supports drag and drop that uses the functionality
72  * one component to another either via the clipboard or a drag and drop operation
98      * or copied elsewhere in a drag and drop operation.
105      * or moved elsewhere in a drag and drop operation.
118      * and drop operation.
140      * Components supporting drop may provide subclasses of this
155          * Constructs a drop location for the given point.
157          * @param dropPoint the drop point, representing the mouse's
171          * Returns the drop point, representing the mouse's
174          * @return the drop point.
181          * Returns a string representation of this drop location.
186          * @return a string representation of this drop location
195      * or drag and drop transfer, and also allows for customizing
196      * aspects of the drag and drop experience.
202      * and drop, such as whether or not to show the drop location,
203      * and which drop action to use.
305              * The drop location may be null at this point if the component
306              * doesn't return custom drop locations. In this case, a point-only
307              * drop location will be created lazily when requested.
313          * represents a drop operation.
315          * @return <code>true</code> if this is a drop operation,
332          * Checks that this is a drop and throws an
339                 throw new IllegalStateException("Not a drop");
344          * Returns the current (non-{@code null}) drop location for the component,
345          * when this {@code TransferSupport} represents a drop.
347          * Note: For components with built-in drop support, this location
351          * This method is only for use with drag and drop transfers.
355          * @return the drop location
356          * @throws IllegalStateException if this is not a drop
364                  * component didn't give us a custom drop location,
378          * Sets whether or not the drop location should be visually indicated
379          * for the transfer - which must represent a drop. This is applicable to
381          * show the drop location when appropriate during a drag and drop
382          * operation). By default, the drop location is shown only when the
385          * drop location to always be shown, or always not be shown.
387          * This method is only for use with drag and drop transfers.
391          * @param showDropLocation whether or not to indicate the drop location
392          * @throws IllegalStateException if this is not a drop
403          * Sets the drop action for the transfer - which must represent a drop
405          * instead of the default user drop action. The action must be
406          * supported by the source's drop actions, and must be one
409          * This method is only for use with drag and drop transfers.
413          * @param dropAction the drop action
414          * @throws IllegalStateException if this is not a drop
427                 throw new IllegalArgumentException("unsupported drop action: " + dropAction);
434          * Returns the action chosen for the drop, when this
435          * {@code TransferSupport} represents a drop.
438          * this returns the user drop action provided by
445          * This method is only for use with drag and drop transfers.
449          * @return the action chosen for the drop
450          * @throws IllegalStateException if this is not a drop
460          * Returns the user drop action for the drop, when this
461          * {@code TransferSupport} represents a drop.
463          * The user drop action is chosen for a drop as described in the
466          * may be chosen as the drop action by way of the {@code setDropAction}
471          * drop or when deciding on a drop action to explicitly choose.
473          * This method is only for use with drag and drop transfers.
477          * @return the user drop action
478          * @throws IllegalStateException if this is not a drop
492          * Returns the drag source's supported drop actions, when this
493          * {@code TransferSupport} represents a drop.
499          * {@code canImport} method when determining the suitability of a drop
500          * or when deciding on a drop action to explicitly choose. To determine
502          * the action with the source drop actions, and then compare the result
508          * This method is only for use with drag and drop transfers.
512          * @return the drag source's supported drop actions
513          * @throws IllegalStateException if this is not a drop
622      * from one component to another via the clipboard or a drag and drop
713      * return of this call (i.e. the call does not block waiting for the drop).
802      * drop operation. The <code>Transferable</code> to be
806      * While the drag and drop implementation calls {@code canImport}
833      * DND drop operation.  The <code>Transferable</code> represents
880      * This method is called repeatedly during a drag and drop operation
888      * For those components that automatically display a drop location during
889      * drag and drop, accepting the transfer, by default, tells them to show
890      * the drop location. This can be changed by calling
893      * By default, when the transfer is accepted, the chosen drop action is that
900      * call. Upon a drop, {@code canImport} is called one final time before
1199      * This is the default drop target for drag and drop operations if
1203      * This class sets the one listener as the linkage of drop handling
1206      * implementations install to manipulate a drop insertion location.
1281         public void drop(DropTargetDropEvent e) {
1282             super.drop(e);
1287                         ((DropTargetListener)listeners[i+1]).drop(e);
1519         public void drop(DropTargetDropEvent e) {
1586      * This is the default drag handler for drag and drop operations that
1624          * as the hotspot enters a platform dependent drop site
1630          * as the hotspot moves over a platform dependent drop site
1636          * as the hotspot exits a platform dependent drop site