From 048f3bfaf0c4b03880706eec88e66d5d2c704c1e Mon Sep 17 00:00:00 2001 From: Vladislav Kaznacheev Date: Thu, 8 Sep 2016 16:37:23 -0700 Subject: [PATCH] Update JavaDoc for DragEvent.getLocalState Explicitly state that "local state" is local to the window which has started the drag operation. Bug: 31372686 Change-Id: Idbea7586c4e74097362067fa90390b97744181bb --- core/java/android/view/DragEvent.java | 4 ++++ core/java/android/view/View.java | 6 ++++-- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/core/java/android/view/DragEvent.java b/core/java/android/view/DragEvent.java index b0f15b5f2329f..a394f351b7f3d 100644 --- a/core/java/android/view/DragEvent.java +++ b/core/java/android/view/DragEvent.java @@ -377,6 +377,10 @@ public class DragEvent implements Parcelable { * 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. *

+ * The local state is available only to views in the activity which has started the drag + * operation. In all other activities this method will return null + *

+ *

* This method returns valid data for all event actions except for {@link #ACTION_DRAG_ENDED}. *

* @return The local state object sent to the system by startDrag(). diff --git a/core/java/android/view/View.java b/core/java/android/view/View.java index 22091c7a70efd..47cffac755938 100644 --- a/core/java/android/view/View.java +++ b/core/java/android/view/View.java @@ -20524,8 +20524,10 @@ public class View implements Drawable.Callback, KeyEvent.Callback, * @param shadowBuilder A {@link android.view.View.DragShadowBuilder} object for building the * drag shadow. * @param myLocalState An {@link java.lang.Object} containing local data about the drag and - * drop operation. This Object is put into every DragEvent object sent by the system during the - * current drag. + * drop operation. When dispatching drag events to views in the same activity this object + * will be available through {@link android.view.DragEvent#getLocalState()}. Views in other + * activities will not have access to this data ({@link android.view.DragEvent#getLocalState()} + * will return null). *

* myLocalState is a lightweight mechanism for the sending information from the dragged View * to the target Views. For example, it can contain flags that differentiate between a