blob: 34fa893164612f96003ab47d78e23d09266a32ef [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
Joe Onoratoa5902522009-07-30 13:37:37 -070017package com.android.launcher2;
The Android Open Source Project31dd5032009-03-03 19:32:27 -080018
Jeff Sharkey70864282009-04-07 21:08:40 -070019import android.graphics.Rect;
20
The Android Open Source Project31dd5032009-03-03 19:32:27 -080021/**
22 * Interface defining an object that can receive a drag.
23 *
24 */
25public interface DropTarget {
Adam Cohencb3382b2011-05-24 14:07:08 -070026
27 class DragObject {
28 public int x = -1;
29 public int y = -1;
30
31 /** X offset from the upper-left corner of the cell to where we touched. */
32 public int xOffset = -1;
33
34 /** Y offset from the upper-left corner of the cell to where we touched. */
35 public int yOffset = -1;
36
Adam Cohenbfbfd262011-06-13 16:55:12 -070037 /** This indicates whether a drag is in final stages, either drop or cancel. It
38 * differentiates onDragExit, since this is called when the drag is ending, above
39 * the current drag target, or when the drag moves off the current drag object.
40 */
41 public boolean dragComplete = false;
42
Adam Cohencb3382b2011-05-24 14:07:08 -070043 /** The view that moves around while you drag. */
44 public DragView dragView = null;
45
46 /** The data associated with the object being dragged */
47 public Object dragInfo = null;
48
49 /** Where the drag originated */
50 public DragSource dragSource = null;
51
Winson Chung557d6ed2011-07-08 15:34:52 -070052 /** Post drag animation runnable */
53 public Runnable postAnimationRunnable = null;
54
Adam Cohencb3382b2011-05-24 14:07:08 -070055 public DragObject() {
56 }
57 }
58
Michael Jurka0280c3b2010-09-17 15:00:07 -070059 /**
60 * Used to temporarily disable certain drop targets
61 *
62 * @return boolean specifying whether this drop target is currently enabled
63 */
64 boolean isDropEnabled();
The Android Open Source Project31dd5032009-03-03 19:32:27 -080065
66 /**
67 * Handle an object being dropped on the DropTarget
68 *
69 * @param source DragSource where the drag started
70 * @param x X coordinate of the drop location
71 * @param y Y coordinate of the drop location
Joe Onorato00acb122009-08-04 16:04:30 -040072 * @param xOffset Horizontal offset with the object being dragged where the original
73 * touch happened
74 * @param yOffset Vertical offset with the object being dragged where the original
75 * touch happened
76 * @param dragView The DragView that's being dragged around on screen.
The Android Open Source Project31dd5032009-03-03 19:32:27 -080077 * @param dragInfo Data associated with the object being dragged
78 *
79 */
Adam Cohencb3382b2011-05-24 14:07:08 -070080 void onDrop(DragObject dragObject);
The Android Open Source Project31dd5032009-03-03 19:32:27 -080081
Adam Cohencb3382b2011-05-24 14:07:08 -070082 void onDragEnter(DragObject dragObject);
The Android Open Source Project31dd5032009-03-03 19:32:27 -080083
Adam Cohencb3382b2011-05-24 14:07:08 -070084 void onDragOver(DragObject dragObject);
85
86 void onDragExit(DragObject dragObject);
The Android Open Source Project31dd5032009-03-03 19:32:27 -080087
88 /**
Patrick Dubroy440c3602010-07-13 17:50:32 -070089 * Allows a DropTarget to delegate drag and drop events to another object.
90 *
91 * Most subclasses will should just return null from this method.
92 *
93 * @param source DragSource where the drag started
94 * @param x X coordinate of the drop location
95 * @param y Y coordinate of the drop location
96 * @param xOffset Horizontal offset with the object being dragged where the original
97 * touch happened
98 * @param yOffset Vertical offset with the object being dragged where the original
99 * touch happened
100 * @param dragView The DragView that's being dragged around on screen.
101 * @param dragInfo Data associated with the object being dragged
102 *
103 * @return The DropTarget to delegate to, or null to not delegate to another object.
104 */
Adam Cohencb3382b2011-05-24 14:07:08 -0700105 DropTarget getDropTargetDelegate(DragObject dragObject);
Patrick Dubroy440c3602010-07-13 17:50:32 -0700106
107 /**
Jeff Sharkey70864282009-04-07 21:08:40 -0700108 * Check if a drop action can occur at, or near, the requested location.
Patrick Dubroy4ed62782010-08-17 15:11:18 -0700109 * This will be called just before onDrop.
Jeff Sharkey70864282009-04-07 21:08:40 -0700110 *
The Android Open Source Project31dd5032009-03-03 19:32:27 -0800111 * @param source DragSource where the drag started
112 * @param x X coordinate of the drop location
113 * @param y Y coordinate of the drop location
Jeff Sharkey70864282009-04-07 21:08:40 -0700114 * @param xOffset Horizontal offset with the object being dragged where the
115 * original touch happened
116 * @param yOffset Vertical offset with the object being dragged where the
117 * original touch happened
Joe Onorato00acb122009-08-04 16:04:30 -0400118 * @param dragView The DragView that's being dragged around on screen.
The Android Open Source Project31dd5032009-03-03 19:32:27 -0800119 * @param dragInfo Data associated with the object being dragged
Jeff Sharkey70864282009-04-07 21:08:40 -0700120 * @return True if the drop will be accepted, false otherwise.
The Android Open Source Project31dd5032009-03-03 19:32:27 -0800121 */
Adam Cohencb3382b2011-05-24 14:07:08 -0700122 boolean acceptDrop(DragObject dragObject);
Jeff Sharkey70864282009-04-07 21:08:40 -0700123
Joe Onorato00acb122009-08-04 16:04:30 -0400124 // These methods are implemented in Views
125 void getHitRect(Rect outRect);
Adam Cohen8dfcba42011-07-07 16:38:18 -0700126 void getLocationInDragLayer(int[] loc);
Joe Onorato00acb122009-08-04 16:04:30 -0400127 int getLeft();
128 int getTop();
The Android Open Source Project31dd5032009-03-03 19:32:27 -0800129}