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 | |
Joe Onorato | a590252 | 2009-07-30 13:37:37 -0700 | [diff] [blame] | 17 | package com.android.launcher2; |
The Android Open Source Project | 31dd503 | 2009-03-03 19:32:27 -0800 | [diff] [blame] | 18 | |
Jeff Sharkey | 7086428 | 2009-04-07 21:08:40 -0700 | [diff] [blame] | 19 | import android.graphics.Rect; |
| 20 | |
The Android Open Source Project | 31dd503 | 2009-03-03 19:32:27 -0800 | [diff] [blame] | 21 | /** |
| 22 | * Interface defining an object that can receive a drag. |
| 23 | * |
| 24 | */ |
| 25 | public interface DropTarget { |
Adam Cohen | cb3382b | 2011-05-24 14:07:08 -0700 | [diff] [blame] | 26 | |
| 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 Cohen | bfbfd26 | 2011-06-13 16:55:12 -0700 | [diff] [blame] | 37 | /** 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 Cohen | cb3382b | 2011-05-24 14:07:08 -0700 | [diff] [blame] | 43 | /** 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 | |
| 52 | public DragObject() { |
| 53 | } |
| 54 | } |
| 55 | |
Michael Jurka | 0280c3b | 2010-09-17 15:00:07 -0700 | [diff] [blame] | 56 | /** |
| 57 | * Used to temporarily disable certain drop targets |
| 58 | * |
| 59 | * @return boolean specifying whether this drop target is currently enabled |
| 60 | */ |
| 61 | boolean isDropEnabled(); |
The Android Open Source Project | 31dd503 | 2009-03-03 19:32:27 -0800 | [diff] [blame] | 62 | |
| 63 | /** |
| 64 | * Handle an object being dropped on the DropTarget |
| 65 | * |
| 66 | * @param source DragSource where the drag started |
| 67 | * @param x X coordinate of the drop location |
| 68 | * @param y Y coordinate of the drop location |
Joe Onorato | 00acb12 | 2009-08-04 16:04:30 -0400 | [diff] [blame] | 69 | * @param xOffset Horizontal offset with the object being dragged where the original |
| 70 | * touch happened |
| 71 | * @param yOffset Vertical offset with the object being dragged where the original |
| 72 | * touch happened |
| 73 | * @param dragView The DragView that's being dragged around on screen. |
The Android Open Source Project | 31dd503 | 2009-03-03 19:32:27 -0800 | [diff] [blame] | 74 | * @param dragInfo Data associated with the object being dragged |
| 75 | * |
| 76 | */ |
Adam Cohen | cb3382b | 2011-05-24 14:07:08 -0700 | [diff] [blame] | 77 | void onDrop(DragObject dragObject); |
The Android Open Source Project | 31dd503 | 2009-03-03 19:32:27 -0800 | [diff] [blame] | 78 | |
Adam Cohen | cb3382b | 2011-05-24 14:07:08 -0700 | [diff] [blame] | 79 | void onDragEnter(DragObject dragObject); |
The Android Open Source Project | 31dd503 | 2009-03-03 19:32:27 -0800 | [diff] [blame] | 80 | |
Adam Cohen | cb3382b | 2011-05-24 14:07:08 -0700 | [diff] [blame] | 81 | void onDragOver(DragObject dragObject); |
| 82 | |
| 83 | void onDragExit(DragObject dragObject); |
The Android Open Source Project | 31dd503 | 2009-03-03 19:32:27 -0800 | [diff] [blame] | 84 | |
| 85 | /** |
Patrick Dubroy | 440c360 | 2010-07-13 17:50:32 -0700 | [diff] [blame] | 86 | * Allows a DropTarget to delegate drag and drop events to another object. |
| 87 | * |
| 88 | * Most subclasses will should just return null from this method. |
| 89 | * |
| 90 | * @param source DragSource where the drag started |
| 91 | * @param x X coordinate of the drop location |
| 92 | * @param y Y coordinate of the drop location |
| 93 | * @param xOffset Horizontal offset with the object being dragged where the original |
| 94 | * touch happened |
| 95 | * @param yOffset Vertical offset with the object being dragged where the original |
| 96 | * touch happened |
| 97 | * @param dragView The DragView that's being dragged around on screen. |
| 98 | * @param dragInfo Data associated with the object being dragged |
| 99 | * |
| 100 | * @return The DropTarget to delegate to, or null to not delegate to another object. |
| 101 | */ |
Adam Cohen | cb3382b | 2011-05-24 14:07:08 -0700 | [diff] [blame] | 102 | DropTarget getDropTargetDelegate(DragObject dragObject); |
Patrick Dubroy | 440c360 | 2010-07-13 17:50:32 -0700 | [diff] [blame] | 103 | |
| 104 | /** |
Jeff Sharkey | 7086428 | 2009-04-07 21:08:40 -0700 | [diff] [blame] | 105 | * 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] | 106 | * This will be called just before onDrop. |
Jeff Sharkey | 7086428 | 2009-04-07 21:08:40 -0700 | [diff] [blame] | 107 | * |
The Android Open Source Project | 31dd503 | 2009-03-03 19:32:27 -0800 | [diff] [blame] | 108 | * @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 |
Jeff Sharkey | 7086428 | 2009-04-07 21:08:40 -0700 | [diff] [blame] | 111 | * @param xOffset Horizontal offset with the object being dragged where the |
| 112 | * original touch happened |
| 113 | * @param yOffset Vertical offset with the object being dragged where the |
| 114 | * original touch happened |
Joe Onorato | 00acb12 | 2009-08-04 16:04:30 -0400 | [diff] [blame] | 115 | * @param dragView The DragView that's being dragged around on screen. |
The Android Open Source Project | 31dd503 | 2009-03-03 19:32:27 -0800 | [diff] [blame] | 116 | * @param dragInfo Data associated with the object being dragged |
Jeff Sharkey | 7086428 | 2009-04-07 21:08:40 -0700 | [diff] [blame] | 117 | * @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] | 118 | */ |
Adam Cohen | cb3382b | 2011-05-24 14:07:08 -0700 | [diff] [blame] | 119 | boolean acceptDrop(DragObject dragObject); |
Jeff Sharkey | 7086428 | 2009-04-07 21:08:40 -0700 | [diff] [blame] | 120 | |
Joe Onorato | 00acb12 | 2009-08-04 16:04:30 -0400 | [diff] [blame] | 121 | // These methods are implemented in Views |
| 122 | void getHitRect(Rect outRect); |
Adam Cohen | 8dfcba4 | 2011-07-07 16:38:18 -0700 | [diff] [blame] | 123 | void getLocationInDragLayer(int[] loc); |
Joe Onorato | 00acb12 | 2009-08-04 16:04:30 -0400 | [diff] [blame] | 124 | int getLeft(); |
| 125 | int getTop(); |
The Android Open Source Project | 31dd503 | 2009-03-03 19:32:27 -0800 | [diff] [blame] | 126 | } |