DragEvent Class

Definition

[Android.Runtime.Register("android/view/DragEvent", DoNotGenerateAcw=true)]
public class DragEvent : Java.Lang.Object, Android.OS.IParcelable, IDisposable

[<Android.Runtime.Register("android/view/DragEvent", DoNotGenerateAcw=true)>]
type DragEvent = class
    inherit Object
    interface IParcelable
    interface IJavaObject
    interface IDisposable
    interface IJavaPeerable

Inheritance

Object

JavaObject

Object

DragEvent

Attributes

RegisterAttribute

Implements

IParcelable IJavaObject IJavaPeerable IDisposable

Remarks

Represents an event that is sent out by the system at various times during a drag and drop operation. It is a data structure that contains several important pieces of data about the operation and the underlying data.

View objects that receive a DragEvent call #getAction(), which returns an action type that indicates the state of the drag and drop operation. This allows a View object to react to a change in state by changing its appearance or performing other actions. For example, a View can react to the #ACTION_DRAG_ENTERED action type by by changing one or more colors in its displayed image.

During a drag and drop operation, the system displays an image that the user drags. This image is called a drag shadow. Several action types reflect the position of the drag shadow relative to the View receiving the event.

Most methods return valid data only for certain event actions. This is summarized in the following table. Each possible #getAction() value is listed in the first column. The other columns indicate which method or methods return valid data for that getAction() value:

<table> <tr> <th scope="col">getAction() Value</th> <th scope="col">getClipDescription()</th> <th scope="col">getLocalState()</th> <th scope="col">getX()</th> <th scope="col">getY()</th> <th scope="col">getClipData()</th> <th scope="col">getResult()</th> </tr> <tr> <td>ACTION_DRAG_STARTED</td> <td style="text-align: center;">X</td> <td style="text-align: center;">X</td> <td style="text-align: center;">X</td> <td style="text-align: center;">X</td> <td style="text-align: center;">&nbsp;</td> <td style="text-align: center;">&nbsp;</td> </tr> <tr> <td>ACTION_DRAG_ENTERED</td> <td style="text-align: center;">X</td> <td style="text-align: center;">X</td> <td style="text-align: center;">&nbsp;</td> <td style="text-align: center;">&nbsp;</td> <td style="text-align: center;">&nbsp;</td> <td style="text-align: center;">&nbsp;</td> </tr> <tr> <td>ACTION_DRAG_LOCATION</td> <td style="text-align: center;">X</td> <td style="text-align: center;">X</td> <td style="text-align: center;">X</td> <td style="text-align: center;">X</td> <td style="text-align: center;">&nbsp;</td> <td style="text-align: center;">&nbsp;</td> </tr> <tr> <td>ACTION_DRAG_EXITED</td> <td style="text-align: center;">X</td> <td style="text-align: center;">X</td> <td style="text-align: center;">&nbsp;</td> <td style="text-align: center;">&nbsp;</td> <td style="text-align: center;">&nbsp;</td> <td style="text-align: center;">&nbsp;</td> </tr> <tr> <td>ACTION_DROP</td> <td style="text-align: center;">X</td> <td style="text-align: center;">X</td> <td style="text-align: center;">X</td> <td style="text-align: center;">X</td> <td style="text-align: center;">X</td> <td style="text-align: center;">&nbsp;</td> </tr> <tr> <td>ACTION_DRAG_ENDED</td> <td style="text-align: center;">&nbsp;</td> <td style="text-align: center;">X</td> <td style="text-align: center;">&nbsp;</td> <td style="text-align: center;">&nbsp;</td> <td style="text-align: center;">&nbsp;</td> <td style="text-align: center;">X</td> </tr> </table>

The android.view.DragEvent#getAction(), android.view.DragEvent#getLocalState()android.view.DragEvent#describeContents(), android.view.DragEvent#writeToParcel(Parcel,int), and android.view.DragEvent#toString() methods always return valid data.

<div class="special reference"> <h3>Developer Guides</h3>

For a guide to implementing drag and drop features, read the Drag and Drop developer guide.

</div>

Java documentation for android.view.DragEvent.

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.