HapticFeedbackConstants.java revision 1ea7edd77e616a97f12af821e2f03c7e3b26d49a 
1/*
2 * Copyright (C) 2009 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
17package android.view;
18
19/**
20 * Constants to be used to perform haptic feedback effects via
21 * {@link View#performHapticFeedback(int)}
22 */
23public class HapticFeedbackConstants {
24
25    private HapticFeedbackConstants() {}
26
27    /**
28     * The user has performed a long press on an object that is resulting
29     * in an action being performed.
30     */
31    public static final int LONG_PRESS = 0;
32
33    /**
34     * The user has pressed on a virtual on-screen key.
35     */
36    public static final int VIRTUAL_KEY = 1;
37
38    /**
39     * The user has pressed a soft keyboard key.
40     */
41    public static final int KEYBOARD_TAP = 3;
42
43    /**
44     * The user has pressed either an hour or minute tick of a Clock.
45     */
46    public static final int CLOCK_TICK = 4;
47
48    /**
49     * The user has pressed either a day or month or year date of a Calendar.
50     * @hide
51     */
52    public static final int CALENDAR_DATE = 5;
53
54    /**
55     * The user has performed a context click on an object.
56     */
57    public static final int CONTEXT_CLICK = 6;
58
59    /**
60     * The user has pressed a virtual or software keyboard key.
61     */
62    public static final int KEYBOARD_PRESS = KEYBOARD_TAP;
63
64    /**
65     * The user has released a virtual keyboard key.
66     */
67    public static final int KEYBOARD_RELEASE = 7;
68
69    /**
70     * The user has released a virtual key.
71     */
72    public static final int VIRTUAL_KEY_RELEASE = 8;
73
74    /**
75     * The user has performed a selection/insertion handle move on text field.
76     */
77    public static final int TEXT_HANDLE_MOVE = 9;
78
79    /**
80     * The user unlocked the device
81     * @hide
82     */
83    public static final int ENTRY_BUMP = 10;
84
85    /**
86     * The user has moved the dragged object within a droppable area.
87     * @hide
88     */
89    public static final int DRAG_CROSSING = 11;
90
91    /**
92     * The user has started a gesture (e.g. on the soft keyboard).
93     * @hide
94     */
95    public static final int GESTURE_START = 12;
96
97    /**
98     * The user has finished a gesture (e.g. on the soft keyboard).
99     * @hide
100     */
101    public static final int GESTURE_END = 13;
102
103    /**
104     * The user's squeeze crossed the gesture's initiation threshold.
105     * @hide
106     */
107    public static final int EDGE_SQUEEZE = 14;
108
109    /**
110     * The user's squeeze crossed the gesture's release threshold.
111     * @hide
112     */
113    public static final int EDGE_RELEASE = 15;
114
115    /**
116     * A haptic effect to signal the confirmation or successful completion of a user
117     * interaction.
118     * @hide
119     */
120    public static final int CONFIRM = 16;
121
122    /**
123     * A haptic effect to signal the rejection or failure of a user interaction.
124     * @hide
125     */
126    public static final int REJECT = 17;
127
128    /**
129     * The phone has booted with safe mode enabled.
130     * This is a private constant.  Feel free to renumber as desired.
131     * @hide
132     */
133    public static final int SAFE_MODE_ENABLED = 10001;
134
135    /**
136     * Flag for {@link View#performHapticFeedback(int, int)
137     * View.performHapticFeedback(int, int)}: Ignore the setting in the
138     * view for whether to perform haptic feedback, do it always.
139     */
140    public static final int FLAG_IGNORE_VIEW_SETTING = 0x0001;
141
142    /**
143     * Flag for {@link View#performHapticFeedback(int, int)
144     * View.performHapticFeedback(int, int)}: Ignore the global setting
145     * for whether to perform haptic feedback, do it always.
146     */
147    public static final int FLAG_IGNORE_GLOBAL_SETTING = 0x0002;
148}
149