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

/**
 * 
 * Should be used on {@link android.view.View} classes to enable usage of
 * AndroidAnnotations.
 * 
 * 
 * Your code related to injected beans should go in an {@link AfterInject}
 * annotated method.
 * 
 * 
 * Any view related code should happen in an {@link AfterViews} annotated
 * method.
 * 
 * 
 * If the class is abstract, the enhanced view will not be generated. Otherwise,
 * it will be generated as a final class. You can use AndroidAnnotations to
 * create Abstract classes that handle common code.
 * 
 * 
 * The annotation value should be one of R.layout.* fields. If not set, no
 * content view will be set, and you should inflate the layout yourself by
 * calling View.inflate() method
 * 
 *
 * 
 *
 * Example :
 * 
 *  * @EViewGroup(R.layout.component)
 * public class CustomFrameLayout extends FrameLayout {
 * 
 * 	@ViewById
 * 	TextView titleView;
 * 
 * 	@AfterViews
 * 	void initViews() {
 * 		titleView.setText("test");
 * 	}
 * }
 * 
 * 
 * 
 * 
 * @see AfterInject
 * @see AfterViews
 * @see ViewById
 * @see android.view.View
 * @see How to build a custom component.
 */
@Retention(RetentionPolicy.CLASS)
@Target(ElementType.TYPE)
public @interface EViewGroup {

	/**
	 * The R.layout.* field which refer to the layout.
	 * 
	 * @return the id of the layout
	 */
	int value() default ResId.DEFAULT_VALUE;

	/**
	 * The resource name as a string which refer to the layout.
	 * 
	 * @return the resource name of the layout
	 */
	String resName() default "";
}