The Android Open Source Project | 31dd503 | 2009-03-03 19:32:27 -0800 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2008 The Android Open Source Project |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
Daniel Sandler | 325dc23 | 2013-06-05 22:57:57 -0400 | [diff] [blame] | 17 | package com.android.launcher3; |
The Android Open Source Project | 31dd503 | 2009-03-03 19:32:27 -0800 | [diff] [blame] | 18 | |
Hyunyoung Song | 1ae4242 | 2020-01-26 23:25:14 -0800 | [diff] [blame] | 19 | import android.content.Context; |
Jeff Sharkey | 7086428 | 2009-04-07 21:08:40 -0700 | [diff] [blame] | 20 | import android.graphics.Rect; |
| 21 | |
Sunny Goyal | e78e3d7 | 2015-09-24 11:23:31 -0700 | [diff] [blame] | 22 | import com.android.launcher3.accessibility.DragViewStateAnnouncer; |
Hyunyoung Song | 1ae4242 | 2020-01-26 23:25:14 -0800 | [diff] [blame] | 23 | import com.android.launcher3.config.FeatureFlags; |
Sunny Goyal | 3dce5f3 | 2017-10-05 11:40:05 -0700 | [diff] [blame] | 24 | import com.android.launcher3.dragndrop.DragOptions; |
Sunny Goyal | 0f76b56 | 2016-12-13 19:37:10 -0800 | [diff] [blame] | 25 | import com.android.launcher3.dragndrop.DragView; |
Adam Cohen | 6508699 | 2020-02-19 08:40:49 -0800 | [diff] [blame] | 26 | import com.android.launcher3.dragndrop.DraggableView; |
Hyunyoung Song | 1ae4242 | 2020-01-26 23:25:14 -0800 | [diff] [blame] | 27 | import com.android.launcher3.folder.FolderNameProvider; |
Sunny Goyal | e396abf | 2020-04-06 15:11:17 -0700 | [diff] [blame^] | 28 | import com.android.launcher3.model.data.ItemInfo; |
Sunny Goyal | e78e3d7 | 2015-09-24 11:23:31 -0700 | [diff] [blame] | 29 | |
The Android Open Source Project | 31dd503 | 2009-03-03 19:32:27 -0800 | [diff] [blame] | 30 | /** |
| 31 | * Interface defining an object that can receive a drag. |
| 32 | * |
| 33 | */ |
| 34 | public interface DropTarget { |
Adam Cohen | cb3382b | 2011-05-24 14:07:08 -0700 | [diff] [blame] | 35 | |
Sunny Goyal | 9eba1fd | 2015-10-16 08:58:57 -0700 | [diff] [blame] | 36 | class DragObject { |
Adam Cohen | cb3382b | 2011-05-24 14:07:08 -0700 | [diff] [blame] | 37 | public int x = -1; |
| 38 | public int y = -1; |
| 39 | |
| 40 | /** X offset from the upper-left corner of the cell to where we touched. */ |
| 41 | public int xOffset = -1; |
| 42 | |
| 43 | /** Y offset from the upper-left corner of the cell to where we touched. */ |
| 44 | public int yOffset = -1; |
| 45 | |
Adam Cohen | bfbfd26 | 2011-06-13 16:55:12 -0700 | [diff] [blame] | 46 | /** This indicates whether a drag is in final stages, either drop or cancel. It |
| 47 | * differentiates onDragExit, since this is called when the drag is ending, above |
| 48 | * the current drag target, or when the drag moves off the current drag object. |
| 49 | */ |
| 50 | public boolean dragComplete = false; |
| 51 | |
Adam Cohen | cb3382b | 2011-05-24 14:07:08 -0700 | [diff] [blame] | 52 | /** The view that moves around while you drag. */ |
| 53 | public DragView dragView = null; |
| 54 | |
Hyunyoung Song | 59a2380 | 2016-09-01 12:47:12 -0700 | [diff] [blame] | 55 | /** The data associated with the object, after item is dropped. */ |
Sunny Goyal | aa8ef11 | 2015-06-12 20:04:41 -0700 | [diff] [blame] | 56 | public ItemInfo dragInfo = null; |
Adam Cohen | cb3382b | 2011-05-24 14:07:08 -0700 | [diff] [blame] | 57 | |
Hyunyoung Song | 59a2380 | 2016-09-01 12:47:12 -0700 | [diff] [blame] | 58 | /** The data associated with the object being dragged */ |
| 59 | public ItemInfo originalDragInfo = null; |
| 60 | |
Adam Cohen | cb3382b | 2011-05-24 14:07:08 -0700 | [diff] [blame] | 61 | /** Where the drag originated */ |
| 62 | public DragSource dragSource = null; |
| 63 | |
Adam Cohen | 36cc09b | 2011-09-29 17:33:15 -0700 | [diff] [blame] | 64 | /** Indicates that the drag operation was cancelled */ |
| 65 | public boolean cancelled = false; |
| 66 | |
Winson Chung | 7bd1bbb | 2012-02-13 18:29:29 -0800 | [diff] [blame] | 67 | /** Defers removing the DragView from the DragLayer until after the drop animation. */ |
| 68 | public boolean deferDragViewCleanupPostAnimation = true; |
| 69 | |
Sunny Goyal | e78e3d7 | 2015-09-24 11:23:31 -0700 | [diff] [blame] | 70 | public DragViewStateAnnouncer stateAnnouncer; |
| 71 | |
Hyunyoung Song | 1ae4242 | 2020-01-26 23:25:14 -0800 | [diff] [blame] | 72 | public FolderNameProvider folderNameProvider; |
| 73 | |
Adam Cohen | 6508699 | 2020-02-19 08:40:49 -0800 | [diff] [blame] | 74 | /** The source view (ie. icon, widget etc.) that is being dragged and which the |
| 75 | * DragView represents. May be an actual View class or a virtual stand-in */ |
| 76 | public DraggableView originalView = null; |
| 77 | |
Hyunyoung Song | 1ae4242 | 2020-01-26 23:25:14 -0800 | [diff] [blame] | 78 | public DragObject(Context context) { |
| 79 | if (FeatureFlags.FOLDER_NAME_SUGGEST.get()) { |
| 80 | folderNameProvider = FolderNameProvider.newInstance(context); |
| 81 | } |
Adam Cohen | cb3382b | 2011-05-24 14:07:08 -0700 | [diff] [blame] | 82 | } |
Sunny Goyal | 1587d53 | 2015-01-29 09:57:16 -0800 | [diff] [blame] | 83 | |
| 84 | /** |
| 85 | * This is used to compute the visual center of the dragView. This point is then |
| 86 | * used to visualize drop locations and determine where to drop an item. The idea is that |
| 87 | * the visual center represents the user's interpretation of where the item is, and hence |
| 88 | * is the appropriate point to use when determining drop location. |
| 89 | */ |
| 90 | public final float[] getVisualCenter(float[] recycle) { |
| 91 | final float res[] = (recycle == null) ? new float[2] : recycle; |
Jon Miranda | 23c2a02 | 2019-01-04 14:30:26 -0800 | [diff] [blame] | 92 | Rect dragRegion = dragView.getDragRegion(); |
Sunny Goyal | 1587d53 | 2015-01-29 09:57:16 -0800 | [diff] [blame] | 93 | |
| 94 | // These represent the visual top and left of drag view if a dragRect was provided. |
| 95 | // If a dragRect was not provided, then they correspond to the actual view left and |
| 96 | // top, as the dragRect is in that case taken to be the entire dragView. |
Jon Miranda | 23c2a02 | 2019-01-04 14:30:26 -0800 | [diff] [blame] | 97 | int left = x - xOffset - dragRegion.left; |
| 98 | int top = y - yOffset - dragRegion.top; |
Sunny Goyal | 1587d53 | 2015-01-29 09:57:16 -0800 | [diff] [blame] | 99 | |
| 100 | // In order to find the visual center, we shift by half the dragRect |
Jon Miranda | 23c2a02 | 2019-01-04 14:30:26 -0800 | [diff] [blame] | 101 | res[0] = left + dragRegion.width() / 2; |
| 102 | res[1] = top + dragRegion.height() / 2; |
Sunny Goyal | 1587d53 | 2015-01-29 09:57:16 -0800 | [diff] [blame] | 103 | |
| 104 | return res; |
| 105 | } |
Adam Cohen | cb3382b | 2011-05-24 14:07:08 -0700 | [diff] [blame] | 106 | } |
| 107 | |
Michael Jurka | 0280c3b | 2010-09-17 15:00:07 -0700 | [diff] [blame] | 108 | /** |
| 109 | * Used to temporarily disable certain drop targets |
| 110 | * |
| 111 | * @return boolean specifying whether this drop target is currently enabled |
| 112 | */ |
| 113 | boolean isDropEnabled(); |
The Android Open Source Project | 31dd503 | 2009-03-03 19:32:27 -0800 | [diff] [blame] | 114 | |
| 115 | /** |
Sunny Goyal | 1797af4 | 2017-10-06 13:29:57 -0700 | [diff] [blame] | 116 | * Handle an object being dropped on the DropTarget. |
| 117 | * |
| 118 | * This will be called only if this target previously returned true for {@link #acceptDrop}. It |
| 119 | * is the responsibility of this target to exit out of the spring loaded mode (either |
| 120 | * immediately or after any pending animations). |
| 121 | * |
| 122 | * If the drop was cancelled for some reason, onDrop will never get called, the UI will |
| 123 | * automatically exit out of this mode. |
The Android Open Source Project | 31dd503 | 2009-03-03 19:32:27 -0800 | [diff] [blame] | 124 | */ |
Sunny Goyal | 3dce5f3 | 2017-10-05 11:40:05 -0700 | [diff] [blame] | 125 | void onDrop(DragObject dragObject, DragOptions options); |
The Android Open Source Project | 31dd503 | 2009-03-03 19:32:27 -0800 | [diff] [blame] | 126 | |
Adam Cohen | cb3382b | 2011-05-24 14:07:08 -0700 | [diff] [blame] | 127 | void onDragEnter(DragObject dragObject); |
The Android Open Source Project | 31dd503 | 2009-03-03 19:32:27 -0800 | [diff] [blame] | 128 | |
Adam Cohen | cb3382b | 2011-05-24 14:07:08 -0700 | [diff] [blame] | 129 | void onDragOver(DragObject dragObject); |
| 130 | |
| 131 | void onDragExit(DragObject dragObject); |
The Android Open Source Project | 31dd503 | 2009-03-03 19:32:27 -0800 | [diff] [blame] | 132 | |
| 133 | /** |
Jeff Sharkey | 7086428 | 2009-04-07 21:08:40 -0700 | [diff] [blame] | 134 | * Check if a drop action can occur at, or near, the requested location. |
Patrick Dubroy | 4ed6278 | 2010-08-17 15:11:18 -0700 | [diff] [blame] | 135 | * This will be called just before onDrop. |
Jeff Sharkey | 7086428 | 2009-04-07 21:08:40 -0700 | [diff] [blame] | 136 | * @return True if the drop will be accepted, false otherwise. |
The Android Open Source Project | 31dd503 | 2009-03-03 19:32:27 -0800 | [diff] [blame] | 137 | */ |
Adam Cohen | cb3382b | 2011-05-24 14:07:08 -0700 | [diff] [blame] | 138 | boolean acceptDrop(DragObject dragObject); |
Jeff Sharkey | 7086428 | 2009-04-07 21:08:40 -0700 | [diff] [blame] | 139 | |
Sunny Goyal | e9b651e | 2015-04-24 11:44:51 -0700 | [diff] [blame] | 140 | void prepareAccessibilityDrop(); |
| 141 | |
Joe Onorato | 00acb12 | 2009-08-04 16:04:30 -0400 | [diff] [blame] | 142 | // These methods are implemented in Views |
Adam Cohen | 7d30a37 | 2013-07-01 17:03:59 -0700 | [diff] [blame] | 143 | void getHitRectRelativeToDragLayer(Rect outRect); |
The Android Open Source Project | 31dd503 | 2009-03-03 19:32:27 -0800 | [diff] [blame] | 144 | } |