org.androidannotations.annotations.KeyDown Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of androidannotations-api Show documentation

The API jar containing the annotations and the runtime helpers

There is a newer version: 4.8.0

Show newest version

/**
 * Copyright (C) 2010-2016 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;

/**
 * 
 * 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}.
 * 
 * 
 * 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.
 * 
 * 
 * The method may return a boolean, void, or a
 * {@link Boolean}. If returning void, it will be considered as
 * returning true (ie: the method has handled the event).
 * 
 * 
 * The method MAY have one parameter:
 * 
 * 
 * A {@link android.view.KeyEvent} parameter to know which key has been down
 * 
 * 
 * 
 * 
 * Example :
 * 
 * 
 *  * @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;
 * 	}
 * }
 * 
 *
 * @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 {};
}