xref: /aosp_15_r20/developers/build/prebuilts/gradle/DragAndDropAcrossApps/README.md (revision d353a188ca6ec4b5eba25b5fbd7bcb8ce61322fb)
1*d353a188SXin Li
2*d353a188SXin LiAndroid DragAndDropAcrossApps-new Sample
3*d353a188SXin Li===================================
4*d353a188SXin Li
5*d353a188SXin LiThis sample contains two separate Android applications: DragSource and
6*d353a188SXin LiDropTarget. DragSource contains images and text that can be dropped into the DropTarget
7*d353a188SXin Liapp. Images are shared between the two apps through a URI for which the receiving app
8*d353a188SXin Limust request permission first, before it can be used.
9*d353a188SXin Li
10*d353a188SXin LiIt also demonstrates the use of the DragStartHelper from the v13 support library to easily
11*d353a188SXin Lihandle drag and drop events.
12*d353a188SXin Li
13*d353a188SXin LiIntroduction
14*d353a188SXin Li------------
15*d353a188SXin Li
16*d353a188SXin LiAndroid N introduces support for drag and drop between applications,
17*d353a188SXin Liaugmenting the existing APIs that have enabled this within a single
18*d353a188SXin Liwindow before.
19*d353a188SXin Li
20*d353a188SXin LiTo start a drag operation you need to call `View.startDragAndDrop`.
21*d353a188SXin LiWhich gesture or action triggers this is up to you as an app developer.
22*d353a188SXin LiThe API guide recommends doing this from
23*d353a188SXin Li`View.OnLongClickListener.onLongClick` and this seems to be the de-facto
24*d353a188SXin Listandard, but you are free to use other gestures (single tap, tap and drag
25*d353a188SXin Lietc).
26*d353a188SXin LiHowever, if you go for a unconventional drag start gesture, note that
27*d353a188SXin Lithe framework implementation assumes that the pointer (touch or mouse)
28*d353a188SXin Liis down while the drag is starting, and the most recent touch/click
29*d353a188SXin Liposition is used as the original position of the drag shadow.
30*d353a188SXin Li
31*d353a188SXin LiSee also `android.support.v13.view.DragStartHelper` which uses different
32*d353a188SXin Ligestures for touch and mouse (click and drag works better for mouse
33*d353a188SXin Lithan a long click).
34*d353a188SXin Li
35*d353a188SXin LiBy default a drag and drop operation is constrained by the window
36*d353a188SXin Licontaining the view that started the drag.
37*d353a188SXin LiTo enable cross-window and cross-app drag and drop add
38*d353a188SXin Li`View.DRAG_FLAG_GLOBAL` to the flags passed to the `View.startDragAndDrop`
39*d353a188SXin Licall.
40*d353a188SXin Li
41*d353a188SXin LiIf a Uri requiring permission grants is being sent, then the
42*d353a188SXin Li`android.view.View.DRAG_FLAG_GLOBAL_URI_READ` and/or the
43*d353a188SXin Li`android.view.View.DRAG_FLAG_GLOBAL_URI_WRITE` flags must be used also.
44*d353a188SXin LiTo access content URIs requiring permissions on the receiving side, the target
45*d353a188SXin Liapp needs to request the `android.view.DropPermissions` from the activity via
46*d353a188SXin Li`android.app.Activity.requestDropPermissions`. This permission will stay either
47*d353a188SXin Liuntil the activity is alive, or until the `release()` method is called on the
48*d353a188SXin Li`android.view.DropPermissions` object.
49*d353a188SXin Li
50*d353a188SXin LiPre-requisites
51*d353a188SXin Li--------------
52*d353a188SXin Li
53*d353a188SXin Li- Android SDK 27
54*d353a188SXin Li- Android Build Tools v27.0.2
55*d353a188SXin Li- Android Support Repository
56*d353a188SXin Li
57*d353a188SXin LiScreenshots
58*d353a188SXin Li-------------
59*d353a188SXin Li
60*d353a188SXin Li<img src="screenshots/phone.png" height="400" alt="Screenshot"/> <img src="screenshots/tablet.png" height="400" alt="Screenshot"/>
61*d353a188SXin Li
62*d353a188SXin LiGetting Started
63*d353a188SXin Li---------------
64*d353a188SXin Li
65*d353a188SXin LiThis sample uses the Gradle build system. To build this project, use the
66*d353a188SXin Li"gradlew build" command or use "Import Project" in Android Studio.
67*d353a188SXin Li
68*d353a188SXin LiSupport
69*d353a188SXin Li-------
70*d353a188SXin Li
71*d353a188SXin Li- Google+ Community: https://plus.google.com/communities/105153134372062985968
72*d353a188SXin Li- Stack Overflow: http://stackoverflow.com/questions/tagged/android
73*d353a188SXin Li
74*d353a188SXin LiIf you've found an error in this sample, please file an issue:
75*d353a188SXin Lihttps://github.com/googlesamples/android-DragAndDropAcrossApps-new
76*d353a188SXin Li
77*d353a188SXin LiPatches are encouraged, and may be submitted by forking this project and
78*d353a188SXin Lisubmitting a pull request through GitHub. Please see CONTRIBUTING.md for more details.
79*d353a188SXin Li
80*d353a188SXin LiLicense
81*d353a188SXin Li-------
82*d353a188SXin Li
83*d353a188SXin LiCopyright 2017 The Android Open Source Project, Inc.
84*d353a188SXin Li
85*d353a188SXin LiLicensed to the Apache Software Foundation (ASF) under one or more contributor
86*d353a188SXin Lilicense agreements.  See the NOTICE file distributed with this work for
87*d353a188SXin Liadditional information regarding copyright ownership.  The ASF licenses this
88*d353a188SXin Lifile to you under the Apache License, Version 2.0 (the "License"); you may not
89*d353a188SXin Liuse this file except in compliance with the License.  You may obtain a copy of
90*d353a188SXin Lithe License at
91*d353a188SXin Li
92*d353a188SXin Lihttp://www.apache.org/licenses/LICENSE-2.0
93*d353a188SXin Li
94*d353a188SXin LiUnless required by applicable law or agreed to in writing, software
95*d353a188SXin Lidistributed under the License is distributed on an "AS IS" BASIS, WITHOUT
96*d353a188SXin LiWARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
97*d353a188SXin LiLicense for the specific language governing permissions and limitations under
98*d353a188SXin Lithe License.
99