/** * 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; /** * <p> * Use it on a {@link android.preference.Preference Preference} or * {@link android.preference.Preference Preference} subtype or * <code>android.support.v7.preference.Preference</code> or * <code>android.support.v7.preference.Preference</code> subtype fields or methods with applicable parameters in a * {@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 <code>PreferenceFragment(Compat)</code>, respectively. * </p> * <p> * The annotation value should be an array of R.string.* fields. * </p> * <p> * Your code related to injected preferences should go in an * {@link org.androidannotations.annotations.AfterPreferences AfterPreferences} * annotated method. * </p> * <blockquote> * * Example : * * <pre> * @EActivity * public class SettingsActivity extends PreferenceActivity { * * @PreferenceByKey(R.string.myPref1) * Preference myPreference1; * * @PreferenceByKey(R.string.checkBoxPref) * CheckBoxPreference checkBoxPref; * * @PreferenceByKey * void singleInjection(Preference myPreference1) { * // do stuff * } * * void multiInjection(@PreferenceByKey Preference myPreference1, @PreferenceByKey(R.string.checkBoxPref) CheckBoxPreference checkBoxPref) { * // do stuff * } * * @AfterPreferences * void initPrefs() { * checkBoxPref.setChecked(false); * } * } * </pre> * * </blockquote> * * @see org.androidannotations.annotations.AfterPreferences AfterPreferences */ @Retention(RetentionPolicy.CLASS) @Target({ ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER }) public @interface PreferenceByKey { /** * The R.string.* field which refers to the injected Preference. * @return the key of the Preference */ int value() default ResId.DEFAULT_VALUE; /** * The resource name which refers to the injected Preference. * @return the key of the Preference */ String resName() default ""; }