org.androidannotations.annotations.EActivity 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
 * Copyright (C) 2016-2020 the AndroidAnnotations project
 *
 * 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;

import org.androidannotations.api.KotlinOpen;

/**
 * 
 * Should be used on {@link android.app.Activity} 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 activity 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 call the
 * setContentView() method yourself, in onCreate()
 * 
 * 
 * 
 * Example :
 * 
 *  * @EActivity(R.layout.main)
 * public class MyActivity extends Activity {
 * 
 * 	public void launchActivity() {
 * 		// Note the use of generated class instead of original one
 * 		MyActivityTwo_.intent(this).startActivity();
 * 	}
 * }
 * 
 * @EActivity(R.layout.main)
 * public class MyActivityTwo extends Activity {
 * 
 * 	@Bean
 * 	MyBean myBean;
 * 
 * 	@ViewById
 * 	TextView myTextView;
 * 
 * 	@AfterInject
 * 	void init() {
 * 		myBean.doSomeStuff();
 * 	}
 * 
 * 	@AfterViews
 * 	void initViews() {
 * 		myTextView.setText("test");
 * 	}
 * }
 * 
 * 
 * 
 * 
 * @see AfterInject
 * @see AfterViews
 * @see Extra
 */
@Retention(RetentionPolicy.CLASS)
@Target(ElementType.TYPE)
@KotlinOpen
public @interface EActivity {

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