This repository was archived by the owner on Feb 26, 2023. It is now read-only.
Repository navigation
Expand file tree
/
Copy pathKeyMultiple.java
More file actions
107 lines (104 loc) · 2.86 KB
/
Copy pathKeyMultiple.java
File metadata and controls
107 lines (104 loc) · 2.86 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
/**
* Copyright (C) 2010-2016 eBusiness Information, Excilys Group
* Copyright (C) 2016-2020 the AndroidAnnotations project
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed To in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
package org.androidannotations.annotations;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* <p>
* This annotation is intended to be used on methods to receive action multiple
* event on a key. This annotation can be used on methods of classes which
* implements {@link android.view.KeyEvent.Callback}.
* </p>
* <p>
* The annotation value should be one or several of
* {@link android.view.KeyEvent} constant fields which name contains KEYCODE. If
* not set, the method name will be used as the {@link android.view.KeyEvent}
* .KEYCODE_* field name.
* </p>
* <p>
* The method may return a <code>boolean</code>, <code>void</code>, or a
* {@link Boolean}. If returning void, it will be considered as returning true
* (ie: the method has handled the event).
* </p>
* <p>
* The method MAY have one or two parameter:
* </p>
* <ul>
* <li>A {@link android.view.KeyEvent} parameter to know which key has been down
* </li>
* <li>A <code>int</code> or {@link Integer} paramter to know the key is how
* many times repeated</li>
* </ul>
*
* <p>
* Example :
* </p>
*
* <pre>
* @EActivity
* public class MyActivity extends Activity {
*
* @KeyMultiple
* void enter() {
* // ...
* }
*
* @KeyMultiple
* void onEnter() {
* // ...
* }
*
* @KeyMultiple
* void onEnterPressed() {
* // ...
* }
*
* @KeyMultiple
* void enterPressed() {
* // ...
* }
*
* @KeyMultiple(KeyEvent.KEYCODE_0)
* void keyZeroMultiple(KeyEvent keyEvent) {
* // ...
* }
*
* @KeyMultiple({ KeyEvent.KEYCODE_M, KeyEvent.KEYCODE_N })
* boolean multipleKeys(KeyEvent keyEvent) {
* return false;
* }
* }
* </pre>
*
* @see android.view.KeyEvent
* @see android.view.KeyEvent.Callback
* @see android.view.KeyEvent.Callback#onKeyMultiple(int, int,
* android.view.KeyEvent)
*/
@Retention(RetentionPolicy.CLASS)
@Target(ElementType.METHOD)
public @interface KeyMultiple {
/**
* The {@link android.view.KeyEvent} class constants which name contains
* KEYCODE.
*
* @return the value of the key code
*/
int[] value() default {};
}