org.androidannotations.annotations.PreferenceClick 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 OnPreferenceClickListener#onPreferenceClick(Preference) when
 * the Preference has been clicked by the user.
 * 
 * 
 * This annotation only can be used inside
 * {@link org.androidannotations.annotations.EActivity EActivity} or
 * {@link org.androidannotations.annotations.EFragment EFragment} annotated
 * class, which is a subclass of {@link android.preference.PreferenceActivity
 * PreferenceActivity} or PreferenceFragment(Compat), respectively.
 * 
 * 
 * The annotation value should be one or several of R.string.* fields. If not
 * set, the method name will be used as the R.string.* field name.
 * 
 * 
 * The method MAY have one parameter:
 * 
 * 
 * A {@link android.preference.Preference Preference} (or a subclass) or
 * android.support.v7.preference.Preference (or a subclass)
 * parameter to know which preference has been clicked
 * 
 * 
 * 
 * Example :
 * 
 *  * @PreferenceClick(R.string.myPref)
 * void clickOnMyPref() {
 * 	// Something Here
 * }
 * 
 * @PreferenceClick
 * void myPrefPreferenceClicked(Preference preference) {
 * 	// Something Here
 * }
 * 
 * @PreferenceClick
 * void myPrefPreferenceClicked(ListPreference preference) {
 * 	// Something Here
 * }
 * 
 * 
 * 
 * 
 * @see PreferenceChange
 */
@Retention(RetentionPolicy.CLASS)
@Target(ElementType.METHOD)
public @interface PreferenceClick {

	/**
	 * The R.string.* fields which refer to the Preferences.
	 * @return the keys of the Preferences
	 */
	int[] value() default ResId.DEFAULT_VALUE;

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