blob: fd4c30c6f2ef2f9eacfc6af376590300013e6671 [file] [log] [blame]
The Android Open Source Project31dd5032009-03-03 19:32:27 -08001/*
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 Sandler325dc232013-06-05 22:57:57 -040017package com.android.launcher3;
The Android Open Source Project31dd5032009-03-03 19:32:27 -080018
Hyunyoung Song1ae42422020-01-26 23:25:14 -080019import android.content.Context;
Jeff Sharkey70864282009-04-07 21:08:40 -070020import android.graphics.Rect;
21
Sunny Goyale78e3d72015-09-24 11:23:31 -070022import com.android.launcher3.accessibility.DragViewStateAnnouncer;
Hyunyoung Song1ae42422020-01-26 23:25:14 -080023import com.android.launcher3.config.FeatureFlags;
Sunny Goyal3dce5f32017-10-05 11:40:05 -070024import com.android.launcher3.dragndrop.DragOptions;
Sunny Goyal0f76b562016-12-13 19:37:10 -080025import com.android.launcher3.dragndrop.DragView;
Adam Cohen65086992020-02-19 08:40:49 -080026import com.android.launcher3.dragndrop.DraggableView;
Hyunyoung Song1ae42422020-01-26 23:25:14 -080027import com.android.launcher3.folder.FolderNameProvider;
thiruram59c5f392020-05-04 12:22:22 -070028import com.android.launcher3.logging.InstanceId;
29import com.android.launcher3.logging.InstanceIdSequence;
Sunny Goyale396abf2020-04-06 15:11:17 -070030import com.android.launcher3.model.data.ItemInfo;
Hyunyoung Songd98d5eb2020-06-18 22:57:50 -070031import com.android.launcher3.util.Executors;
Sunny Goyale78e3d72015-09-24 11:23:31 -070032
The Android Open Source Project31dd5032009-03-03 19:32:27 -080033/**
34 * Interface defining an object that can receive a drag.
35 *
36 */
37public interface DropTarget {
Adam Cohencb3382b2011-05-24 14:07:08 -070038
Sunny Goyal9eba1fd2015-10-16 08:58:57 -070039 class DragObject {
Adam Cohencb3382b2011-05-24 14:07:08 -070040 public int x = -1;
41 public int y = -1;
42
43 /** X offset from the upper-left corner of the cell to where we touched. */
44 public int xOffset = -1;
45
46 /** Y offset from the upper-left corner of the cell to where we touched. */
47 public int yOffset = -1;
48
Adam Cohenbfbfd262011-06-13 16:55:12 -070049 /** This indicates whether a drag is in final stages, either drop or cancel. It
50 * differentiates onDragExit, since this is called when the drag is ending, above
51 * the current drag target, or when the drag moves off the current drag object.
52 */
53 public boolean dragComplete = false;
54
Adam Cohencb3382b2011-05-24 14:07:08 -070055 /** The view that moves around while you drag. */
56 public DragView dragView = null;
57
Hyunyoung Song59a23802016-09-01 12:47:12 -070058 /** The data associated with the object, after item is dropped. */
Sunny Goyalaa8ef112015-06-12 20:04:41 -070059 public ItemInfo dragInfo = null;
Adam Cohencb3382b2011-05-24 14:07:08 -070060
Hyunyoung Song59a23802016-09-01 12:47:12 -070061 /** The data associated with the object being dragged */
62 public ItemInfo originalDragInfo = null;
63
Adam Cohencb3382b2011-05-24 14:07:08 -070064 /** Where the drag originated */
65 public DragSource dragSource = null;
66
Adam Cohen36cc09b2011-09-29 17:33:15 -070067 /** Indicates that the drag operation was cancelled */
68 public boolean cancelled = false;
69
Winson Chung7bd1bbb2012-02-13 18:29:29 -080070 /** Defers removing the DragView from the DragLayer until after the drop animation. */
71 public boolean deferDragViewCleanupPostAnimation = true;
72
Sunny Goyale78e3d72015-09-24 11:23:31 -070073 public DragViewStateAnnouncer stateAnnouncer;
74
Hyunyoung Song1ae42422020-01-26 23:25:14 -080075 public FolderNameProvider folderNameProvider;
76
Adam Cohen65086992020-02-19 08:40:49 -080077 /** The source view (ie. icon, widget etc.) that is being dragged and which the
78 * DragView represents. May be an actual View class or a virtual stand-in */
79 public DraggableView originalView = null;
80
thiruram59c5f392020-05-04 12:22:22 -070081 /** Used for matching DROP event with its corresponding DRAG event on the server side. */
thiruram5a01f0e2020-05-04 17:49:37 -070082 public final InstanceId logInstanceId =
thiruram59c5f392020-05-04 12:22:22 -070083 new InstanceIdSequence(1 << 20 /*InstanceId.INSTANCE_ID_MAX*/)
84 .newInstanceId();
85
Hyunyoung Song1ae42422020-01-26 23:25:14 -080086 public DragObject(Context context) {
87 if (FeatureFlags.FOLDER_NAME_SUGGEST.get()) {
Hyunyoung Songd98d5eb2020-06-18 22:57:50 -070088 Executors.MODEL_EXECUTOR.post(() -> {
89 folderNameProvider = FolderNameProvider.newInstance(context);
90 });
Hyunyoung Song1ae42422020-01-26 23:25:14 -080091 }
Adam Cohencb3382b2011-05-24 14:07:08 -070092 }
Sunny Goyal1587d532015-01-29 09:57:16 -080093
94 /**
95 * This is used to compute the visual center of the dragView. This point is then
96 * used to visualize drop locations and determine where to drop an item. The idea is that
97 * the visual center represents the user's interpretation of where the item is, and hence
98 * is the appropriate point to use when determining drop location.
99 */
100 public final float[] getVisualCenter(float[] recycle) {
101 final float res[] = (recycle == null) ? new float[2] : recycle;
Jon Miranda23c2a022019-01-04 14:30:26 -0800102 Rect dragRegion = dragView.getDragRegion();
Sunny Goyal1587d532015-01-29 09:57:16 -0800103
104 // These represent the visual top and left of drag view if a dragRect was provided.
105 // If a dragRect was not provided, then they correspond to the actual view left and
106 // top, as the dragRect is in that case taken to be the entire dragView.
Jon Miranda23c2a022019-01-04 14:30:26 -0800107 int left = x - xOffset - dragRegion.left;
108 int top = y - yOffset - dragRegion.top;
Sunny Goyal1587d532015-01-29 09:57:16 -0800109
110 // In order to find the visual center, we shift by half the dragRect
Jon Miranda23c2a022019-01-04 14:30:26 -0800111 res[0] = left + dragRegion.width() / 2;
112 res[1] = top + dragRegion.height() / 2;
Sunny Goyal1587d532015-01-29 09:57:16 -0800113
114 return res;
115 }
Adam Cohencb3382b2011-05-24 14:07:08 -0700116 }
117
Michael Jurka0280c3b2010-09-17 15:00:07 -0700118 /**
119 * Used to temporarily disable certain drop targets
120 *
121 * @return boolean specifying whether this drop target is currently enabled
122 */
123 boolean isDropEnabled();
The Android Open Source Project31dd5032009-03-03 19:32:27 -0800124
125 /**
Sunny Goyal1797af42017-10-06 13:29:57 -0700126 * Handle an object being dropped on the DropTarget.
127 *
128 * This will be called only if this target previously returned true for {@link #acceptDrop}. It
129 * is the responsibility of this target to exit out of the spring loaded mode (either
130 * immediately or after any pending animations).
131 *
132 * If the drop was cancelled for some reason, onDrop will never get called, the UI will
133 * automatically exit out of this mode.
The Android Open Source Project31dd5032009-03-03 19:32:27 -0800134 */
Sunny Goyal3dce5f32017-10-05 11:40:05 -0700135 void onDrop(DragObject dragObject, DragOptions options);
The Android Open Source Project31dd5032009-03-03 19:32:27 -0800136
Adam Cohencb3382b2011-05-24 14:07:08 -0700137 void onDragEnter(DragObject dragObject);
The Android Open Source Project31dd5032009-03-03 19:32:27 -0800138
Adam Cohencb3382b2011-05-24 14:07:08 -0700139 void onDragOver(DragObject dragObject);
140
141 void onDragExit(DragObject dragObject);
The Android Open Source Project31dd5032009-03-03 19:32:27 -0800142
143 /**
Jeff Sharkey70864282009-04-07 21:08:40 -0700144 * Check if a drop action can occur at, or near, the requested location.
Patrick Dubroy4ed62782010-08-17 15:11:18 -0700145 * This will be called just before onDrop.
Jeff Sharkey70864282009-04-07 21:08:40 -0700146 * @return True if the drop will be accepted, false otherwise.
The Android Open Source Project31dd5032009-03-03 19:32:27 -0800147 */
Adam Cohencb3382b2011-05-24 14:07:08 -0700148 boolean acceptDrop(DragObject dragObject);
Jeff Sharkey70864282009-04-07 21:08:40 -0700149
Sunny Goyale9b651e2015-04-24 11:44:51 -0700150 void prepareAccessibilityDrop();
151
Joe Onorato00acb122009-08-04 16:04:30 -0400152 // These methods are implemented in Views
Adam Cohen7d30a372013-07-01 17:03:59 -0700153 void getHitRectRelativeToDragLayer(Rect outRect);
The Android Open Source Project31dd5032009-03-03 19:32:27 -0800154}