org.androidannotations.annotations.ViewsById 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
Show all versions of androidannotations-api Show documentation
The API jar containing the annotations and the runtime helpers
/**
* 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;
/**
*
* Use it on a {@link java.util.List} of {@link android.view.View} or
* {@link android.view.View} subtype fields or methods with applicable
* parameters in a view related (ie
* {@link org.androidannotations.annotations.EActivity},
* {@link org.androidannotations.annotations.EFragment},
* {@link org.androidannotations.annotations.EViewGroup}, ...) annotated class.
*
*
* The annotation value should be an array of R.id.* fields.
*
*
* Your code related to injected views should go in an
* {@link org.androidannotations.annotations.AfterViews} annotated method.
*
*
*
* Example :
*
*
* @EActivity(R.layout.main)
* public class MyActivity extends Activity {
*
* // Injects R.id.edit1 and R.id.edit2 into the List.
* @ViewsById({ R.id.edit1, R.id.edit2 })
* List<EditText> myEditTexts;
*
* @ViewsById({ R.id.myTextView1, R.id.myOtherTextView })
* List<TextView> textViews;
*
* @ViewsById({ R.id.edit1, R.id.edit2 })
* void singleInjection(List<EditText> myEditTexts) {
* // do stuff
* }
*
* void multiInjection(@ViewsById({ R.id.edit1, R.id.edit2 }) List<EditText> myEditTexts, @ViewsById({ R.id.myTextView1, R.id.myOtherTextView }) List<TextView> textViews) {
* // do stuff
* }
*
* @AfterViews
* void updateTextWithDate() {
* for (TextView textView : textViews) {
* textView.setText("Date: " + new Date());
* }
* }
* }
*
*
*
*
* @see org.androidannotations.annotations.AfterViews
*/
@Retention(RetentionPolicy.CLASS)
@Target({ ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER })
public @interface ViewsById {
/**
* The array of R.id.* fields which refer to the injected Views.
*
* @return the ids of the Views
*/
int[] value() default ResId.DEFAULT_VALUE;
/**
* The array resource names which refer to the injected Views.
*
* @return the resource names of the Views
*/
String[] resName() default "";
}