1 /*
2  * Copyright (C) 2016 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 
17 package com.android.launcher3.dragndrop;
18 
19 import android.graphics.Point;
20 
21 import com.android.launcher3.DropTarget;
22 
23 /**
24  * Set of options to control the drag and drop behavior.
25  */
26 public class DragOptions {
27 
28     /** Whether or not an accessible drag operation is in progress. */
29     public boolean isAccessibleDrag = false;
30 
31     /**
32      * Specifies the start location for a simulated DnD (like system drag or accessibility drag),
33      * null when using internal DnD
34      */
35     public Point simulatedDndStartPoint = null;
36 
37     /** Determines when a pre-drag should transition to a drag. By default, this is immediate. */
38     public PreDragCondition preDragCondition = null;
39 
40     /** Scale of the icons over the workspace icon size. */
41     public float intrinsicIconScaleFactor = 1f;
42 
43     public boolean isFlingToDelete;
44 
45     /**
46      * Specifies a condition that must be met before DragListener#onDragStart() is called.
47      * By default, there is no condition and onDragStart() is called immediately following
48      * DragController#startDrag().
49      *
50      * This condition can be overridden, and callbacks are provided for the following cases:
51      * - The pre-drag starts, but onDragStart() is deferred (onPreDragStart()).
52      * - The pre-drag ends before the condition is met (onPreDragEnd(false)).
53      * - The actual drag starts when the condition is met (onPreDragEnd(true)).
54      */
55     public interface PreDragCondition {
56 
shouldStartDrag(double distanceDragged)57         public boolean shouldStartDrag(double distanceDragged);
58 
59         /**
60          * The pre-drag has started, but onDragStart() is
61          * deferred until shouldStartDrag() returns true.
62          */
onPreDragStart(DropTarget.DragObject dragObject)63         void onPreDragStart(DropTarget.DragObject dragObject);
64 
65         /**
66          * The pre-drag has ended. This gets called at the same time as onDragStart()
67          * if the condition is met, otherwise at the same time as onDragEnd().
68          * @param dragStarted Whether the pre-drag ended because the actual drag started.
69          *                    This will be true if the condition was met, otherwise false.
70          */
onPreDragEnd(DropTarget.DragObject dragObject, boolean dragStarted)71         void onPreDragEnd(DropTarget.DragObject dragObject, boolean dragStarted);
72     }
73 }
74