org.androidannotations.annotations.Touch 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

The 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.OnTouchListener#onTouch(android.view.View, android.view.MotionEvent)
 * View.OnTouchListener#onTouch(View, MotionEvent)} when the view has been
 * touched by the user.
 * 
 * 
 * The annotation value should be one or several of R.id.* fields. If not set,
 * the method name will be used as the R.id.* 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 or two parameters:
 * 
 * 
 * A {@link android.view.View} (or a subclass) parameter to know which view
 * has been clicked
 * A {@link android.view.MotionEvent} parameter
 * 
 * 
 * 
 * Example :
 * 
 *  * @Touch(R.id.myButton)
 * void touchOnMyButton() {
 * 	// Something Here
 * }
 * 
 * @Touch
 * void myButtonTouched(View view) {
 * 	// Something Here
 * }
 * 
 * @Touch
 * void myTextTouched(TextView view) {
 * 	// Something Here
 * }
 * 
 * @Touch
 * void myButtonTouched(View view, MotionEvent motionEvent) {
 * 	// Something Here
 * }
 * 
 * 
 * 
 * 
 * @see Click
 * @see LongClick
 */
@Retention(RetentionPolicy.CLASS)
@Target(ElementType.METHOD)
public @interface Touch {

	/**
	 * 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 "";
}