1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
|
/*
* Copyright (C) 2010 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package android.view;
import android.content.ClipData;
import android.content.ClipDescription;
import android.os.Parcel;
import android.os.Parcelable;
//TODO: Improve Javadoc
/**
* Represents an event that is sent out by the system at various times during a drag and drop
* operation. It is a complex data structure that contains several important pieces of data about
* the operation and the underlying data.
* <p>
* View objects that receive a DragEvent call {@link #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 {@link #ACTION_DRAG_ENTERED} action type by
* by changing one or more colors in its displayed image.
* </p>
* <p>
* 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.
* </p>
* <p>
* Most methods return valid data only for certain event actions. This is summarized in the
* following table. Each possible {@link #getAction()} value is listed in the first column. The
* other columns indicate which method or methods return valid data for that getAction() value:
* </p>
* <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;"> </td>
* <td style="text-align: center;"> </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;"> </td>
* <td style="text-align: center;"> </td>
* <td style="text-align: center;"> </td>
* <td style="text-align: center;"> </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;"> </td>
* <td style="text-align: center;"> </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;"> </td>
* <td style="text-align: center;"> </td>
* <td style="text-align: center;"> </td>
* <td style="text-align: center;"> </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;"> </td>
* </tr>
* <tr>
* <td>ACTION_DRAG_ENDED</td>
* <td style="text-align: center;">X</td>
* <td style="text-align: center;">X</td>
* <td style="text-align: center;"> </td>
* <td style="text-align: center;"> </td>
* <td style="text-align: center;"> </td>
* <td style="text-align: center;">X</td>
* </tr>
* </table>
* <p>
* The {@link android.view.DragEvent#getAction()},
* {@link android.view.DragEvent#describeContents()},
* {@link android.view.DragEvent#writeToParcel(Parcel,int)}, and
* {@link android.view.DragEvent#toString()} methods always return valid data.
* </p>
*/
public class DragEvent implements Parcelable {
private static final boolean TRACK_RECYCLED_LOCATION = false;
int mAction;
float mX, mY;
ClipDescription mClipDescription;
ClipData mClipData;
Object mLocalState;
boolean mDragResult;
private DragEvent mNext;
private RuntimeException mRecycledLocation;
private boolean mRecycled;
private static final int MAX_RECYCLED = 10;
private static final Object gRecyclerLock = new Object();
private static int gRecyclerUsed = 0;
private static DragEvent gRecyclerTop = null;
/**
* Action constant returned by {@link #getAction()}: Signals the start of a
* drag and drop operation. The View should return {@code true} from its
* {@link View#onDragEvent(DragEvent) onDragEvent()} handler method or
* {@link View.View.OnDragListener#onDrag(View,DragEvent) OnDragListener.onDrag()} listener
* if it can accept a drop. The onDragEvent() or onDrag() methods usually inspect the metadata
* from {@link #getClipDescription()} to determine if they can accept the data contained in
* this drag. For an operation that doesn't represent data transfer, these methods may
* perform other actions to determine whether or not the View should accept the drag.
* If the View wants to indicate that it is a valid drop target, it can also react by
* changing its appearance.
* <p>
* A View only receives further drag events if it returns {@code true} in response to
* ACTION_DRAG_STARTED.
* </p>
* @see #ACTION_DRAG_ENDED
*/
public static final int ACTION_DRAG_STARTED = 1;
/**
* Action constant returned by {@link #getAction()}: Sent to a View after
* {@link #ACTION_DRAG_ENTERED} if the drag shadow is still within the View object's bounding
* box. The {@link #getX()} and {@link #getY()} methods supply
* the X and Y position of of the drag point within the View object's bounding box.
* <p>
* A View receives an {@link #ACTION_DRAG_ENTERED} event before receiving any
* ACTION_DRAG_LOCATION events.
* </p>
* <p>
* The system stops sending ACTION_DRAG_LOCATION events to a View once the user moves the
* drag shadow out of the View object's bounding box. If the user moves the drag shadow back
* into the View object's bounding box, the View receives an ACTION_DRAG_ENTERED again before
* receiving any more ACTION_DRAG_LOCATION events.
* </p>
* @see #ACTION_DRAG_ENTERED
* @see #getX()
* @see #getY()
*/
public static final int ACTION_DRAG_LOCATION = 2;
/**
* Action constant returned by {@link #getAction()}: Signals to a View that the user
* has released the drag shadow, and the drag point is within the bounding box of the View.
* The View should retrieve the data from the DragEvent by calling {@link #getClipData()}.
* The methods {@link #getX()} and {@link #getY()} return the X and Y position of the drop point
* within the View object's bounding box.
* <p>
* The View should return {@code true} from its {@link View#onDragEvent(DragEvent)}
* handler or {@link View.View.OnDragListener#onDrag(View,DragEvent) OnDragListener.onDrag()}
* listener if it accepted the drop, and {@code false} if it ignored the drop.
* </p>
* <p>
* The View can also react to this action by changing its appearance.
* </p>
* @see #getClipData()
* @see #getX()
* @see #getY()
*/
public static final int ACTION_DROP = 3;
/**
* Action constant returned by {@link #getAction()}: Signals to a View that the drag and drop
* operation has concluded. A View that changed its appearance during the operation should
* return to its usual drawing state in response to this event.
* <p>
* All views that received an ACTION_DRAG_STARTED event will receive the
* ACTION_DRAG_ENDED event even if they are not currently visible when the drag ends.
* </p>
* <p>
* The View object can call {@link #getResult()} to see the result of the operation.
* If a View returned {@code true} in response to {@link #ACTION_DROP}, then
* getResult() returns {@code true}, otherwise it returns {@code false}.
* </p>
* @see #ACTION_DRAG_STARTED
* @see #getResult()
*/
public static final int ACTION_DRAG_ENDED = 4;
/**
* Action constant returned by {@link #getAction()}: Signals to a View that the drag point has
* entered the bounding box of the View.
* <p>
* If the View can accept a drop, it can react to ACTION_DRAG_ENTERED
* by changing its appearance in a way that tells the user that the View is the current
* drop target.
* </p>
* The system stops sending ACTION_DRAG_LOCATION events to a View once the user moves the
* drag shadow out of the View object's bounding box. If the user moves the drag shadow back
* into the View object's bounding box, the View receives an ACTION_DRAG_ENTERED again before
* receiving any more ACTION_DRAG_LOCATION events.
* </p>
* @see #ACTION_DRAG_ENTERED
* @see #ACTION_DRAG_LOCATION
*/
public static final int ACTION_DRAG_ENTERED = 5;
/**
* Action constant returned by {@link #getAction()}: Signals that the user has moved the
* drag shadow outside the bounding box of the View.
* The View can react by changing its appearance in a way that tells the user that
* View is no longer the immediate drop target.
* <p>
* After the system sends an ACTION_DRAG_EXITED event to the View, the View receives no more
* ACTION_DRAG_LOCATION events until the user drags the drag shadow back over the View.
* </p>
*
*/
public static final int ACTION_DRAG_EXITED = 6;
private DragEvent() {
}
private void init(int action, float x, float y, ClipDescription description, ClipData data,
Object localState, boolean result) {
mAction = action;
mX = x;
mY = y;
mClipDescription = description;
mClipData = data;
mLocalState = localState;
mDragResult = result;
}
static DragEvent obtain() {
return DragEvent.obtain(0, 0f, 0f, null, null, null, false);
}
/** @hide */
public static DragEvent obtain(int action, float x, float y, Object localState,
ClipDescription description, ClipData data, boolean result) {
final DragEvent ev;
synchronized (gRecyclerLock) {
if (gRecyclerTop == null) {
ev = new DragEvent();
ev.init(action, x, y, description, data, localState, result);
return ev;
}
ev = gRecyclerTop;
gRecyclerTop = ev.mNext;
gRecyclerUsed -= 1;
}
ev.mRecycledLocation = null;
ev.mRecycled = false;
ev.mNext = null;
ev.init(action, x, y, description, data, localState, result);
return ev;
}
/** @hide */
public static DragEvent obtain(DragEvent source) {
return obtain(source.mAction, source.mX, source.mY, source.mLocalState,
source.mClipDescription, source.mClipData, source.mDragResult);
}
/**
* Inspect the action value of this event.
* @return One of the following action constants, in the order in which they usually occur
* during a drag and drop operation:
* <ul>
* <li>{@link #ACTION_DRAG_STARTED}</li>
* <li>{@link #ACTION_DRAG_ENTERED}</li>
* <li>{@link #ACTION_DRAG_LOCATION}</li>
* <li>{@link #ACTION_DROP}</li>
* <li>{@link #ACTION_DRAG_EXITED}</li>
* <li>{@link #ACTION_DRAG_ENDED}</li>
* </ul>
*/
public int getAction() {
return mAction;
}
/**
* Gets the X coordinate of the drag point. The value is only valid if the event action is
* {@link #ACTION_DRAG_LOCATION} or {@link #ACTION_DROP}.
* @return The current drag point's Y coordinate
*/
public float getX() {
return mX;
}
/**
* Gets the Y coordinate of the drag point. The value is valid if the
* event action is {@link #ACTION_DRAG_ENTERED}, {@link #ACTION_DRAG_LOCATION},
* {@link #ACTION_DROP}, or {@link #ACTION_DRAG_EXITED}.
* @return The current drag point's Y coordinate
*/
public float getY() {
return mY;
}
/**
* Returns the {@link android.content.ClipData} object sent to the system as part of the call
* to
* {@link android.view.View#startDrag(ClipData,View.DragShadowBuilder,Object,int) startDrag()}.
* This method only returns valid data if the event action is {@link #ACTION_DROP}.
* @return The ClipData sent to the system by startDrag().
*/
public ClipData getClipData() {
return mClipData;
}
/**
* Returns the {@link android.content.ClipDescription} object contained in the
* {@link android.content.ClipData} object sent to the system as part of the call to
* {@link android.view.View#startDrag(ClipData,View.DragShadowBuilder,Object,int) startDrag()}.
* The drag handler or listener for a View can use the metadata in this object to decide if the
* View can accept the dragged View object's data.
* <p>
* This method returns valid data for all event actions.
* @return The ClipDescription that was part of the ClipData sent to the system by startDrag().
*/
public ClipDescription getClipDescription() {
return mClipDescription;
}
/**
* Returns the local state object sent to the system as part of the call to
* {@link android.view.View#startDrag(ClipData,View.DragShadowBuilder,Object,int) startDrag()}.
* The object is intended to provide local information about the drag and drop operation. For
* example, it can indicate whether the drag and drop operation is a copy or a move.
* <p>
* This method returns valid data for all event actions.
* </p>
* @return The local state object sent to the system by startDrag().
*/
public Object getLocalState() {
return mLocalState;
}
/**
* <p>
* Returns an indication of the result of the drag and drop operation.
* This method only returns valid data if the action type is {@link #ACTION_DRAG_ENDED}.
* The return value depends on what happens after the user releases the drag shadow.
* </p>
* <p>
* If the user releases the drag shadow on a View that can accept a drop, the system sends an
* {@link #ACTION_DROP} event to the View object's drag event listener. If the listener
* returns {@code true}, then getResult() will return {@code true}.
* If the listener returns {@code false}, then getResult() returns {@code false}.
* </p>
* <p>
* Notice that getResult() also returns {@code false} if no {@link #ACTION_DROP} is sent. This
* happens, for example, when the user releases the drag shadow over an area outside of the
* application. In this case, the system sends out {@link #ACTION_DRAG_ENDED} for the current
* operation, but never sends out {@link #ACTION_DROP}.
* </p>
* @return {@code true} if a drag event listener returned {@code true} in response to
* {@link #ACTION_DROP}. If the system did not send {@link #ACTION_DROP} before
* {@link #ACTION_DRAG_ENDED}, or if the listener returned {@code false} in response to
* {@link #ACTION_DROP}, then {@code false} is returned.
*/
public boolean getResult() {
return mDragResult;
}
/**
* Recycle the DragEvent, to be re-used by a later caller. After calling
* this function you must never touch the event again.
*
* @hide
*/
public final void recycle() {
// Ensure recycle is only called once!
if (TRACK_RECYCLED_LOCATION) {
if (mRecycledLocation != null) {
throw new RuntimeException(toString() + " recycled twice!", mRecycledLocation);
}
mRecycledLocation = new RuntimeException("Last recycled here");
} else {
if (mRecycled) {
throw new RuntimeException(toString() + " recycled twice!");
}
mRecycled = true;
}
mClipData = null;
mClipDescription = null;
mLocalState = null;
synchronized (gRecyclerLock) {
if (gRecyclerUsed < MAX_RECYCLED) {
gRecyclerUsed++;
mNext = gRecyclerTop;
gRecyclerTop = this;
}
}
}
/**
* Returns a string containing a concise, human-readable representation of this DragEvent
* object.
* @return A string representation of the DragEvent object.
*/
@Override
public String toString() {
return "DragEvent{" + Integer.toHexString(System.identityHashCode(this))
+ " action=" + mAction + " @ (" + mX + ", " + mY + ") desc=" + mClipDescription
+ " data=" + mClipData + " local=" + mLocalState + " result=" + mDragResult
+ "}";
}
/* Parcelable interface */
/**
* Returns information about the {@link android.os.Parcel} representation of this DragEvent
* object.
* @return Information about the {@link android.os.Parcel} representation.
*/
public int describeContents() {
return 0;
}
/**
* Creates a {@link android.os.Parcel} object from this DragEvent object.
* @param dest A {@link android.os.Parcel} object in which to put the DragEvent object.
* @param flags Flags to store in the Parcel.
*/
public void writeToParcel(Parcel dest, int flags) {
dest.writeInt(mAction);
dest.writeFloat(mX);
dest.writeFloat(mY);
dest.writeInt(mDragResult ? 1 : 0);
if (mClipData == null) {
dest.writeInt(0);
} else {
dest.writeInt(1);
mClipData.writeToParcel(dest, flags);
}
if (mClipDescription == null) {
dest.writeInt(0);
} else {
dest.writeInt(1);
mClipDescription.writeToParcel(dest, flags);
}
}
/**
* A container for creating a DragEvent from a Parcel.
*/
public static final Parcelable.Creator<DragEvent> CREATOR =
new Parcelable.Creator<DragEvent>() {
public DragEvent createFromParcel(Parcel in) {
DragEvent event = DragEvent.obtain();
event.mAction = in.readInt();
event.mX = in.readFloat();
event.mY = in.readFloat();
event.mDragResult = (in.readInt() != 0);
if (in.readInt() != 0) {
event.mClipData = ClipData.CREATOR.createFromParcel(in);
}
if (in.readInt() != 0) {
event.mClipDescription = ClipDescription.CREATOR.createFromParcel(in);
}
return event;
}
public DragEvent[] newArray(int size) {
return new DragEvent[size];
}
};
}
|