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 { |
| 26 | |
| 27 | /** |
| 28 | * Handle an object being dropped on the DropTarget |
| 29 | * |
| 30 | * @param source DragSource where the drag started |
| 31 | * @param x X coordinate of the drop location |
| 32 | * @param y Y coordinate of the drop location |
Joe Onorato | 00acb12 | 2009-08-04 16:04:30 -0400 | [diff] [blame^] | 33 | * @param xOffset Horizontal offset with the object being dragged where the original |
| 34 | * touch happened |
| 35 | * @param yOffset Vertical offset with the object being dragged where the original |
| 36 | * touch happened |
| 37 | * @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] | 38 | * @param dragInfo Data associated with the object being dragged |
| 39 | * |
| 40 | */ |
Joe Onorato | 00acb12 | 2009-08-04 16:04:30 -0400 | [diff] [blame^] | 41 | void onDrop(DragSource source, int x, int y, int xOffset, int yOffset, |
| 42 | DragView dragView, Object dragInfo); |
The Android Open Source Project | 31dd503 | 2009-03-03 19:32:27 -0800 | [diff] [blame] | 43 | |
Joe Onorato | 00acb12 | 2009-08-04 16:04:30 -0400 | [diff] [blame^] | 44 | void onDragEnter(DragSource source, int x, int y, int xOffset, int yOffset, |
| 45 | DragView dragView, Object dragInfo); |
The Android Open Source Project | 31dd503 | 2009-03-03 19:32:27 -0800 | [diff] [blame] | 46 | |
Joe Onorato | 00acb12 | 2009-08-04 16:04:30 -0400 | [diff] [blame^] | 47 | void onDragOver(DragSource source, int x, int y, int xOffset, int yOffset, |
| 48 | DragView dragView, Object dragInfo); |
The Android Open Source Project | 31dd503 | 2009-03-03 19:32:27 -0800 | [diff] [blame] | 49 | |
Joe Onorato | 00acb12 | 2009-08-04 16:04:30 -0400 | [diff] [blame^] | 50 | void onDragExit(DragSource source, int x, int y, int xOffset, int yOffset, |
| 51 | DragView dragView, Object dragInfo); |
The Android Open Source Project | 31dd503 | 2009-03-03 19:32:27 -0800 | [diff] [blame] | 52 | |
| 53 | /** |
Jeff Sharkey | 7086428 | 2009-04-07 21:08:40 -0700 | [diff] [blame] | 54 | * Check if a drop action can occur at, or near, the requested location. |
| 55 | * This may be called repeatedly during a drag, so any calls should return |
| 56 | * quickly. |
| 57 | * |
The Android Open Source Project | 31dd503 | 2009-03-03 19:32:27 -0800 | [diff] [blame] | 58 | * @param source DragSource where the drag started |
| 59 | * @param x X coordinate of the drop location |
| 60 | * @param y Y coordinate of the drop location |
Jeff Sharkey | 7086428 | 2009-04-07 21:08:40 -0700 | [diff] [blame] | 61 | * @param xOffset Horizontal offset with the object being dragged where the |
| 62 | * original touch happened |
| 63 | * @param yOffset Vertical offset with the object being dragged where the |
| 64 | * original touch happened |
Joe Onorato | 00acb12 | 2009-08-04 16:04:30 -0400 | [diff] [blame^] | 65 | * @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] | 66 | * @param dragInfo Data associated with the object being dragged |
Jeff Sharkey | 7086428 | 2009-04-07 21:08:40 -0700 | [diff] [blame] | 67 | * @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] | 68 | */ |
Joe Onorato | 00acb12 | 2009-08-04 16:04:30 -0400 | [diff] [blame^] | 69 | boolean acceptDrop(DragSource source, int x, int y, int xOffset, int yOffset, |
| 70 | DragView dragView, Object dragInfo); |
Jeff Sharkey | 7086428 | 2009-04-07 21:08:40 -0700 | [diff] [blame] | 71 | |
| 72 | /** |
| 73 | * Estimate the surface area where this object would land if dropped at the |
| 74 | * given location. |
| 75 | * |
| 76 | * @param source DragSource where the drag started |
| 77 | * @param x X coordinate of the drop location |
| 78 | * @param y Y coordinate of the drop location |
| 79 | * @param xOffset Horizontal offset with the object being dragged where the |
| 80 | * original touch happened |
| 81 | * @param yOffset Vertical offset with the object being dragged where the |
| 82 | * original touch happened |
Joe Onorato | 00acb12 | 2009-08-04 16:04:30 -0400 | [diff] [blame^] | 83 | * @param dragView The DragView that's being dragged around on screen. |
Jeff Sharkey | 7086428 | 2009-04-07 21:08:40 -0700 | [diff] [blame] | 84 | * @param dragInfo Data associated with the object being dragged |
| 85 | * @param recycle {@link Rect} object to be possibly recycled. |
| 86 | * @return Estimated area that would be occupied if object was dropped at |
| 87 | * the given location. Should return null if no estimate is found, |
| 88 | * or if this target doesn't provide estimations. |
| 89 | */ |
Joe Onorato | 00acb12 | 2009-08-04 16:04:30 -0400 | [diff] [blame^] | 90 | Rect estimateDropLocation(DragSource source, int x, int y, int xOffset, int yOffset, |
| 91 | DragView dragView, Object dragInfo, Rect recycle); |
| 92 | |
| 93 | // These methods are implemented in Views |
| 94 | void getHitRect(Rect outRect); |
| 95 | void getLocationOnScreen(int[] loc); |
| 96 | int getLeft(); |
| 97 | int getTop(); |
The Android Open Source Project | 31dd503 | 2009-03-03 19:32:27 -0800 | [diff] [blame] | 98 | } |