This repository has been archived by the owner on Feb 26, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 2.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1539 from simopete/1238_Keyevents
Annotations to handle key events
- Loading branch information
Showing
26 changed files
with
1,631 additions
and
1 deletion.
There are no files selected for viewing
103 changes: 103 additions & 0 deletions
103
...core/androidannotations-api/src/main/java/org/androidannotations/annotations/KeyDown.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,103 @@ | ||
| /** | ||
| * Copyright (C) 2010-2015 eBusiness Information, Excilys Group | ||
| * | ||
| * 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 down | ||
| * 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 parameter: | ||
| * </p> | ||
| * <ul> | ||
| * <li>A {@link android.view.KeyEvent} parameter to know which key has been down | ||
| * </li> | ||
| * </ul> | ||
| * | ||
| * <p> | ||
| * Example : | ||
| * </p> | ||
| * | ||
| * <pre> | ||
| * @EActivity | ||
| * public class MyActivity extends Activity { | ||
| * | ||
| * @KeyDown | ||
| * void enter() { | ||
| * // ... | ||
| * } | ||
| * | ||
| * @KeyDown | ||
| * void onEnter() { | ||
| * // ... | ||
| * } | ||
| * | ||
| * @KeyDown | ||
| * void onEnterPressed() { | ||
| * // ... | ||
| * } | ||
| * | ||
| * @KeyDown | ||
| * void enterPressed() { | ||
| * // ... | ||
| * } | ||
| * | ||
| * @KeyDown(KeyEvent.KEYCODE_0) | ||
| * void keyZeroIsDown(KeyEvent keyEvent) { | ||
| * // ... | ||
| * } | ||
| * | ||
| * @KeyDown({ 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#onKeyDown(int, android.view.KeyEvent) | ||
| */ | ||
| @Retention(RetentionPolicy.CLASS) | ||
| @Target(ElementType.METHOD) | ||
| public @interface KeyDown { | ||
|
|
||
| /** | ||
| * The {@link android.view.KeyEvent} class constants which name contains | ||
| * KEYCODE. | ||
| * | ||
| * @return the value of the key code | ||
| */ | ||
| int[] value() default {}; | ||
| } |
103 changes: 103 additions & 0 deletions
103
...androidannotations-api/src/main/java/org/androidannotations/annotations/KeyLongPress.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,103 @@ | ||
| /** | ||
| * Copyright (C) 2010-2015 eBusiness Information, Excilys Group | ||
| * | ||
| * 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 long press 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 parameter: | ||
| * </p> | ||
| * <ul> | ||
| * <li>A {@link android.view.KeyEvent} parameter to know which key has been down | ||
| * </li> | ||
| * </ul> | ||
| * | ||
| * <p> | ||
| * Example : | ||
| * </p> | ||
| * | ||
| * <pre> | ||
| * @EActivity | ||
| * public class MyActivity extends Activity { | ||
| * | ||
| * @KeyLongPress | ||
| * void enter() { | ||
| * // ... | ||
| * } | ||
| * | ||
| * @KeyLongPress | ||
| * void onEnter() { | ||
| * // ... | ||
| * } | ||
| * | ||
| * @KeyLongPress | ||
| * void onEnterPressed() { | ||
| * // ... | ||
| * } | ||
| * | ||
| * @KeyLongPress | ||
| * void enterPressed() { | ||
| * // ... | ||
| * } | ||
| * | ||
| * @KeyLongPress(KeyEvent.KEYCODE_0) | ||
| * void keyZeroIsLongPressed(KeyEvent keyEvent) { | ||
| * // ... | ||
| * } | ||
| * | ||
| * @KeyLongPress({ 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#onKeyLongPress(int, android.view.KeyEvent) | ||
| */ | ||
| @Retention(RetentionPolicy.CLASS) | ||
| @Target(ElementType.METHOD) | ||
| public @interface KeyLongPress { | ||
|
|
||
| /** | ||
| * The {@link android.view.KeyEvent} class constants which name contains | ||
| * KEYCODE. | ||
| * | ||
| * @return the value of the key code | ||
| */ | ||
| int[] value() default {}; | ||
| } |
105 changes: 105 additions & 0 deletions
105
.../androidannotations-api/src/main/java/org/androidannotations/annotations/KeyMultiple.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,105 @@ | ||
| /** | ||
| * Copyright (C) 2010-2015 eBusiness Information, Excilys Group | ||
| * | ||
| * 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 {}; | ||
| } |
Oops, something went wrong.