blob: 90b8f1c75009801d79050225b01c4052ba7a1adc [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
Vadim Tryshevfedca432015-08-19 17:55:02 -070019import com.android.launcher3.dragndrop.DragView;
20
Winson Chung043f2af2012-03-01 16:09:54 -080021import android.graphics.PointF;
Jeff Sharkey70864282009-04-07 21:08:40 -070022import android.graphics.Rect;
23
Sunny Goyale78e3d72015-09-24 11:23:31 -070024import com.android.launcher3.accessibility.DragViewStateAnnouncer;
25
The Android Open Source Project31dd5032009-03-03 19:32:27 -080026/**
27 * Interface defining an object that can receive a drag.
28 *
29 */
30public interface DropTarget {
Adam Cohencb3382b2011-05-24 14:07:08 -070031
Sunny Goyal9eba1fd2015-10-16 08:58:57 -070032 class DragObject {
Adam Cohencb3382b2011-05-24 14:07:08 -070033 public int x = -1;
34 public int y = -1;
35
36 /** X offset from the upper-left corner of the cell to where we touched. */
37 public int xOffset = -1;
38
39 /** Y offset from the upper-left corner of the cell to where we touched. */
40 public int yOffset = -1;
41
Adam Cohenbfbfd262011-06-13 16:55:12 -070042 /** This indicates whether a drag is in final stages, either drop or cancel. It
43 * differentiates onDragExit, since this is called when the drag is ending, above
44 * the current drag target, or when the drag moves off the current drag object.
45 */
46 public boolean dragComplete = false;
47
Adam Cohencb3382b2011-05-24 14:07:08 -070048 /** The view that moves around while you drag. */
49 public DragView dragView = null;
50
51 /** The data associated with the object being dragged */
Sunny Goyalaa8ef112015-06-12 20:04:41 -070052 public ItemInfo dragInfo = null;
Adam Cohencb3382b2011-05-24 14:07:08 -070053
54 /** Where the drag originated */
55 public DragSource dragSource = null;
56
Adam Cohenc9735cf2015-01-23 16:11:55 -080057 /** The object is part of an accessible drag operation */
58 public boolean accessibleDrag;
59
Winson Chung557d6ed2011-07-08 15:34:52 -070060 /** Post drag animation runnable */
61 public Runnable postAnimationRunnable = null;
62
Adam Cohen36cc09b2011-09-29 17:33:15 -070063 /** Indicates that the drag operation was cancelled */
64 public boolean cancelled = false;
65
Winson Chung7bd1bbb2012-02-13 18:29:29 -080066 /** Defers removing the DragView from the DragLayer until after the drop animation. */
67 public boolean deferDragViewCleanupPostAnimation = true;
68
Sunny Goyale78e3d72015-09-24 11:23:31 -070069 public DragViewStateAnnouncer stateAnnouncer;
70
Adam Cohencb3382b2011-05-24 14:07:08 -070071 public DragObject() {
72 }
Sunny Goyal1587d532015-01-29 09:57:16 -080073
74 /**
75 * This is used to compute the visual center of the dragView. This point is then
76 * used to visualize drop locations and determine where to drop an item. The idea is that
77 * the visual center represents the user's interpretation of where the item is, and hence
78 * is the appropriate point to use when determining drop location.
79 */
80 public final float[] getVisualCenter(float[] recycle) {
81 final float res[] = (recycle == null) ? new float[2] : recycle;
82
83 // These represent the visual top and left of drag view if a dragRect was provided.
84 // If a dragRect was not provided, then they correspond to the actual view left and
85 // top, as the dragRect is in that case taken to be the entire dragView.
86 // R.dimen.dragViewOffsetY.
87 int left = x - xOffset;
88 int top = y - yOffset;
89
90 // In order to find the visual center, we shift by half the dragRect
91 res[0] = left + dragView.getDragRegion().width() / 2;
92 res[1] = top + dragView.getDragRegion().height() / 2;
93
94 return res;
95 }
Adam Cohencb3382b2011-05-24 14:07:08 -070096 }
97
Michael Jurka0280c3b2010-09-17 15:00:07 -070098 /**
99 * Used to temporarily disable certain drop targets
100 *
101 * @return boolean specifying whether this drop target is currently enabled
102 */
103 boolean isDropEnabled();
The Android Open Source Project31dd5032009-03-03 19:32:27 -0800104
105 /**
106 * Handle an object being dropped on the DropTarget
Sunny Goyalfa401a12015-04-10 13:45:42 -0700107 *
The Android Open Source Project31dd5032009-03-03 19:32:27 -0800108 * @param source DragSource where the drag started
109 * @param x X coordinate of the drop location
110 * @param y Y coordinate of the drop location
Joe Onorato00acb122009-08-04 16:04:30 -0400111 * @param xOffset Horizontal offset with the object being dragged where the original
112 * touch happened
113 * @param yOffset Vertical offset with the object being dragged where the original
114 * touch happened
115 * @param dragView The DragView that's being dragged around on screen.
The Android Open Source Project31dd5032009-03-03 19:32:27 -0800116 * @param dragInfo Data associated with the object being dragged
Mindy DelliCarpini53b8d072013-07-03 08:23:13 -0700117 *
The Android Open Source Project31dd5032009-03-03 19:32:27 -0800118 */
Adam Cohencb3382b2011-05-24 14:07:08 -0700119 void onDrop(DragObject dragObject);
The Android Open Source Project31dd5032009-03-03 19:32:27 -0800120
Adam Cohencb3382b2011-05-24 14:07:08 -0700121 void onDragEnter(DragObject dragObject);
The Android Open Source Project31dd5032009-03-03 19:32:27 -0800122
Adam Cohencb3382b2011-05-24 14:07:08 -0700123 void onDragOver(DragObject dragObject);
124
125 void onDragExit(DragObject dragObject);
The Android Open Source Project31dd5032009-03-03 19:32:27 -0800126
127 /**
Winson Chung043f2af2012-03-01 16:09:54 -0800128 * Handle an object being dropped as a result of flinging to delete and will be called in place
129 * of onDrop(). (This is only called on objects that are set as the DragController's
130 * fling-to-delete target.
131 */
Sunny Goyalddec7342015-04-29 18:12:37 -0700132 void onFlingToDelete(DragObject dragObject, PointF vec);
Winson Chung043f2af2012-03-01 16:09:54 -0800133
134 /**
Jeff Sharkey70864282009-04-07 21:08:40 -0700135 * Check if a drop action can occur at, or near, the requested location.
Patrick Dubroy4ed62782010-08-17 15:11:18 -0700136 * This will be called just before onDrop.
Sunny Goyalfa401a12015-04-10 13:45:42 -0700137 *
The Android Open Source Project31dd5032009-03-03 19:32:27 -0800138 * @param source DragSource where the drag started
139 * @param x X coordinate of the drop location
140 * @param y Y coordinate of the drop location
Jeff Sharkey70864282009-04-07 21:08:40 -0700141 * @param xOffset Horizontal offset with the object being dragged where the
142 * original touch happened
143 * @param yOffset Vertical offset with the object being dragged where the
144 * original touch happened
Joe Onorato00acb122009-08-04 16:04:30 -0400145 * @param dragView The DragView that's being dragged around on screen.
The Android Open Source Project31dd5032009-03-03 19:32:27 -0800146 * @param dragInfo Data associated with the object being dragged
Jeff Sharkey70864282009-04-07 21:08:40 -0700147 * @return True if the drop will be accepted, false otherwise.
The Android Open Source Project31dd5032009-03-03 19:32:27 -0800148 */
Adam Cohencb3382b2011-05-24 14:07:08 -0700149 boolean acceptDrop(DragObject dragObject);
Jeff Sharkey70864282009-04-07 21:08:40 -0700150
Sunny Goyale9b651e2015-04-24 11:44:51 -0700151 void prepareAccessibilityDrop();
152
Joe Onorato00acb122009-08-04 16:04:30 -0400153 // These methods are implemented in Views
Adam Cohen7d30a372013-07-01 17:03:59 -0700154 void getHitRectRelativeToDragLayer(Rect outRect);
The Android Open Source Project31dd5032009-03-03 19:32:27 -0800155}