JavaTM 2 Platform
Std. Ed. v1.3.1

com.apple.mrj.dnd
Class OutgoingDrag

java.lang.Object
  |
  +--com.apple.mrj.dnd.Drag
        |
        +--com.apple.mrj.dnd.OutgoingDrag

Deprecated. As of MacOSX 10.2, replaced by Java2 DnD.

public final class OutgoingDrag
extends Drag

The context for the source of a Mac OS drag-and-drop operation. It extends the Drag class to add the ability to create items and flavors.

How an OutgoingDrag is obtained depends on the host framework. When a user gesture occurs that can initiate a drag, the framework will present you with an OutgoingDrag object. If you want to initiate a drag, you then call addFlavor one or more times to add items and data "flavors". The framework will take care of tracking the drag for you.

Specifically, if using AWT, you add a DragInitiatorListener to a Component to be notified of drag gestures within that Component -- the listener's dragGesture method will be called upon such a gesture, and you can get an OutgoingDrag instance from the DragInitiatorEvent parameter.


Method Summary
 void addItem(Transferable item)
          Deprecated.  
 void dispose()
          Deprecated. Marks this Drag as no longer usable.
 void finalize()
          Deprecated. Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
 Cursor getCursor()
          Deprecated.  
 void setCursor(Cursor c)
          Deprecated.  
 void setImage(Image image, com.apple.mrj.macos.generated.PointStruct globalLocation)
          Deprecated. Sets the image used for the drag and draws it starting from the given location.
 
Methods inherited from class com.apple.mrj.dnd.Drag
allItemsContainFlavors, check, equals, equals, findItemFlavor, getDestination, getHasLeftSource, getInsideSenderWindow, getItem, getItemCount, getRef, getSource, hashCode, isDisposed, isDropAccepted, toString
 
Methods inherited from class java.lang.Object
clone, getClass, notify, notifyAll, wait, wait, wait
 

Method Detail

finalize

public void finalize()
Deprecated. 
Description copied from class: Object
Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. A subclass overrides the finalize method to dispose of system resources or to perform other cleanup.

The general contract of finalize is that it is invoked if and when the JavaTM virtual machine has determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, except as a result of an action taken by the finalization of some other object or class which is ready to be finalized. The finalize method may take any action, including making this object available again to other threads; the usual purpose of finalize, however, is to perform cleanup actions before the object is irrevocably discarded. For example, the finalize method for an object that represents an input/output connection might perform explicit I/O transactions to break the connection before the object is permanently discarded.

The finalize method of class Object performs no special action; it simply returns normally. Subclasses of Object may override this definition.

The Java programming language does not guarantee which thread will invoke the finalize method for any given object. It is guaranteed, however, that the thread that invokes finalize will not be holding any user-visible synchronization locks when finalize is invoked. If an uncaught exception is thrown by the finalize method, the exception is ignored and finalization of that object terminates.

After the finalize method has been invoked for an object, no further action is taken until the Java virtual machine has again determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, including possible actions by other objects or classes which are ready to be finalized, at which point the object may be discarded.

The finalize method is never invoked more than once by a Java virtual machine for any given object.

Any exception thrown by the finalize method causes the finalization of this object to be halted, but is otherwise ignored.

Overrides:
finalize in class Object
Following copied from class: java.lang.Object
Throws:
Throwable - the Exception raised by this method

dispose

public void dispose()
Deprecated. 
Description copied from class: Drag
Marks this Drag as no longer usable.
Overrides:
dispose in class Drag

addItem

public void addItem(Transferable item)
Deprecated. 

setCursor

public void setCursor(Cursor c)
Deprecated. 

getCursor

public Cursor getCursor()
Deprecated. 

setImage

public void setImage(Image image,
                     com.apple.mrj.macos.generated.PointStruct globalLocation)
Deprecated. 
Sets the image used for the drag and draws it starting from the given location. If anything goes wrong in setting the image, the standard outline will be used instead. If the image parameter is null, the method returns without doing anything. This can only be called once per OutgoingDrag.
Parameters:
image - The image to use for the drag
globalLocation - The location, in global coordinates, at which to initially draw the image

JavaTM 2 Platform
Std. Ed. v1.3.1

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Java, Java 2D, and JDBC are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries.
Copyright 1993-2001 Sun Microsystems, Inc. 901 San Antonio Road
Palo Alto, California, 94303, U.S.A. All Rights Reserved.