org.androidannotations.annotations.EditorAction Maven / Gradle / Ivy
Show all versions of androidannotations-api Show documentation
/**
* 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 events defined
* by
* {@link android.widget.TextView.OnEditorActionListener#onEditorAction(android.widget.TextView, int, android.view.KeyEvent)}
* when an action is performed on the editor.
*
*
* The annotation value should be one or several R.id.* fields that refers to
* TextView or subclasses of TextView. If not set, the method name will be used
* as the R.id.* field name.
*
*
* The method MAY have multiple parameter :
*
*
* - A {@link android.widget.TextView} (or a subclass) parameter to know which
* view has targeted this event
* - An int parameter to get the actionId
* - A {@link android.view.KeyEvent} parameter
*
*
* The return type of the method can be either void or boolean. In
* case of boolean, the value returned from the annotated method will be
* returned in the generated listener method (indicating event consumption). If
* the annotated method is void, always true will be returned in
* the listener method (so the event is consumed).
*
*
*
* Examples :
*
*
* @EditorAction(R.id.helloTextView)
* void onEditorActionsOnHelloTextView(TextView hello, int actionId, KeyEvent keyEvent) {
* // Something Here
* }
*
* @EditorAction
* void helloTextViewEditorAction(TextView hello) {
* // Something Here
* }
*
* @EditorAction
* void helloEditTextEditorAction(EditText hello) {
* // Something Here
* }
*
* @EditorAction({R.id.editText, R.id.helloTextView})
* void onEditorActionsOnSomeTextViews(TextView tv, int actionId) {
* // Something Here
* }
*
* @EditorAction(R.id.helloTextView)
* void onEditorActionsOnHelloTextView() {
* // Something Here
* }
*
* @EditorAction(R.id.helloTextView)
* boolean onEditorActionsOnHelloTextView() {
* // Something Here
* return false;
* }
*
*
*
*/
@Retention(RetentionPolicy.CLASS)
@Target(ElementType.METHOD)
public @interface EditorAction {
/**
* The R.id.* fields which refer to the TextViews.
*
* @return the ids of the TextViews
*/
int[] value() default ResId.DEFAULT_VALUE;
/**
* The resource names as a strings which refer to the TextViews.
*
* @return the resource names of the TextViews
*/
String[] resName() default "";
}