org.androidannotations.annotations.FocusChange 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 events defined
 * by
 * {@link android.view.View.OnFocusChangeListener#onFocusChange(android.view.View, boolean)}
 * after focus is changed on the targeted View or subclass of View.
 * 
 * 
 * The annotation value should be one or several R.id.* fields that refers to
 * View or subclasses of View. If not set, the method name will be used as the
 * R.id.* field name.
 * 
 * 
 * The method MAY have multiple parameter:
 * 
 * 
 * A {@link android.view.View} (or a subclass) parameter to know which view
 * has targeted this event
 * An {@link boolean} to know the view has focus.
 * 
 *
 * 
 * 
 * Example :
 * 
 *  * @FocusChange(R.id.myButton)
 * void focusChangedOnMyButton(boolean isChecked, View button) {
 * 	// Something Here
 * }
 * 
 * @FocusChange
 * void myButtonFocusChanged(View button) {
 * 	// Something Here
 * }
 * 
 * @FocusChange
 * void myTextFocusChanged(EditText button) {
 * 	// Something Here
 * }
 * 
 * @FocusChange({R.id.myButton, R.id.myButton1})
 * void focusChangedOnSomeButtons(View button, boolean isChecked) {
 * 	// Something Here
 * }
 * 
 * @FocusChange(R.id.myButton)
 * void focusChangedOnMyButton() {
 * 	// Something Here
 * }
 * 
 * 
 * 
 */
@Retention(RetentionPolicy.CLASS)
@Target(ElementType.METHOD)
public @interface FocusChange {

	/**
	 * The R.id.* fields which refer to the Views.
	 * 
	 * @return the ids of the Views
	 */
	int[] value() default ResId.DEFAULT_VALUE;

	/**
	 * The resource names as strings which refer to the Views.
	 * 
	 * @return the resource names of the Views
	 */
	String[] resName() default "";
}