blob: 0a0f9adb82fee12505597b11ef3648262932fce0 [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;
Sunny Goyale396abf2020-04-06 15:11:17 -070028import com.android.launcher3.model.data.ItemInfo;
Sunny Goyale78e3d72015-09-24 11:23:31 -070029
The Android Open Source Project31dd5032009-03-03 19:32:27 -080030/**
31 * Interface defining an object that can receive a drag.
32 *
33 */
34public interface DropTarget {
Adam Cohencb3382b2011-05-24 14:07:08 -070035
Sunny Goyal9eba1fd2015-10-16 08:58:57 -070036 class DragObject {
Adam Cohencb3382b2011-05-24 14:07:08 -070037 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 Cohenbfbfd262011-06-13 16:55:12 -070046 /** 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 Cohencb3382b2011-05-24 14:07:08 -070052 /** The view that moves around while you drag. */
53 public DragView dragView = null;
54
Hyunyoung Song59a23802016-09-01 12:47:12 -070055 /** The data associated with the object, after item is dropped. */
Sunny Goyalaa8ef112015-06-12 20:04:41 -070056 public ItemInfo dragInfo = null;
Adam Cohencb3382b2011-05-24 14:07:08 -070057
Hyunyoung Song59a23802016-09-01 12:47:12 -070058 /** The data associated with the object being dragged */
59 public ItemInfo originalDragInfo = null;
60
Adam Cohencb3382b2011-05-24 14:07:08 -070061 /** Where the drag originated */
62 public DragSource dragSource = null;
63
Adam Cohen36cc09b2011-09-29 17:33:15 -070064 /** Indicates that the drag operation was cancelled */
65 public boolean cancelled = false;
66
Winson Chung7bd1bbb2012-02-13 18:29:29 -080067 /** Defers removing the DragView from the DragLayer until after the drop animation. */
68 public boolean deferDragViewCleanupPostAnimation = true;
69
Sunny Goyale78e3d72015-09-24 11:23:31 -070070 public DragViewStateAnnouncer stateAnnouncer;
71
Hyunyoung Song1ae42422020-01-26 23:25:14 -080072 public FolderNameProvider folderNameProvider;
73
Adam Cohen65086992020-02-19 08:40:49 -080074 /** 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 Song1ae42422020-01-26 23:25:14 -080078 public DragObject(Context context) {
79 if (FeatureFlags.FOLDER_NAME_SUGGEST.get()) {
80 folderNameProvider = FolderNameProvider.newInstance(context);
81 }
Adam Cohencb3382b2011-05-24 14:07:08 -070082 }
Sunny Goyal1587d532015-01-29 09:57:16 -080083
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 Miranda23c2a022019-01-04 14:30:26 -080092 Rect dragRegion = dragView.getDragRegion();
Sunny Goyal1587d532015-01-29 09:57:16 -080093
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 Miranda23c2a022019-01-04 14:30:26 -080097 int left = x - xOffset - dragRegion.left;
98 int top = y - yOffset - dragRegion.top;
Sunny Goyal1587d532015-01-29 09:57:16 -080099
100 // In order to find the visual center, we shift by half the dragRect
Jon Miranda23c2a022019-01-04 14:30:26 -0800101 res[0] = left + dragRegion.width() / 2;
102 res[1] = top + dragRegion.height() / 2;
Sunny Goyal1587d532015-01-29 09:57:16 -0800103
104 return res;
105 }
Adam Cohencb3382b2011-05-24 14:07:08 -0700106 }
107
Michael Jurka0280c3b2010-09-17 15:00:07 -0700108 /**
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 Project31dd5032009-03-03 19:32:27 -0800114
115 /**
Sunny Goyal1797af42017-10-06 13:29:57 -0700116 * 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 Project31dd5032009-03-03 19:32:27 -0800124 */
Sunny Goyal3dce5f32017-10-05 11:40:05 -0700125 void onDrop(DragObject dragObject, DragOptions options);
The Android Open Source Project31dd5032009-03-03 19:32:27 -0800126
Adam Cohencb3382b2011-05-24 14:07:08 -0700127 void onDragEnter(DragObject dragObject);
The Android Open Source Project31dd5032009-03-03 19:32:27 -0800128
Adam Cohencb3382b2011-05-24 14:07:08 -0700129 void onDragOver(DragObject dragObject);
130
131 void onDragExit(DragObject dragObject);
The Android Open Source Project31dd5032009-03-03 19:32:27 -0800132
133 /**
Jeff Sharkey70864282009-04-07 21:08:40 -0700134 * Check if a drop action can occur at, or near, the requested location.
Patrick Dubroy4ed62782010-08-17 15:11:18 -0700135 * This will be called just before onDrop.
Jeff Sharkey70864282009-04-07 21:08:40 -0700136 * @return True if the drop will be accepted, false otherwise.
The Android Open Source Project31dd5032009-03-03 19:32:27 -0800137 */
Adam Cohencb3382b2011-05-24 14:07:08 -0700138 boolean acceptDrop(DragObject dragObject);
Jeff Sharkey70864282009-04-07 21:08:40 -0700139
Sunny Goyale9b651e2015-04-24 11:44:51 -0700140 void prepareAccessibilityDrop();
141
Joe Onorato00acb122009-08-04 16:04:30 -0400142 // These methods are implemented in Views
Adam Cohen7d30a372013-07-01 17:03:59 -0700143 void getHitRectRelativeToDragLayer(Rect outRect);
The Android Open Source Project31dd5032009-03-03 19:32:27 -0800144}