org.androidannotations.annotations.PreferenceChange Maven / Gradle / Ivy
Show all versions of androidannotations-api Show documentation
/**
* 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
* OnPreferenceChangeListener#onPreferenceChange(Preference, Object)
* when the value of a Preference has been changed by the user and
* is about to be set and/or persisted.
*
*
* The annotation value should be one or several R.string.* fields that refers
* to {@link android.preference.Preference Preference} or subclasses of
* {@link android.preference.Preference Preference} or
* android.support.v7.preference.Preference or subclasses of
* android.support.v7.preference.Preference. If not set, the method
* name will be used as the R.string.* field name. 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 method MAY have multiple parameter:
*
*
* - A {@link android.preference.Preference Preference} (or a subclass) or
*
android.support.v7.preference.Preference (or a subclass)
* parameter to know which preference was targeted by this event
* - An {@link Object}, {@link String}, {@link java.util.Set Set of strings}
* and also a {@link Boolean}, {@link Float}, {@link Integer}, {@link Long} or
* their corresponding primitive types to obtain the new value of the
*
Preference. Please note with number types, we assume that the
* newValue parameter coming from the Preference is a
* {@link String}, so we parse it to a number object (Android
* Preference classes use {@link String}s instead of number
* objects).
*
*
*
* Example :
*
*
* @PreferenceChange(R.string.myPref)
* void checkedChangedOnMyButton(boolean newValue, Preference preference) {
* // Something Here
* }
*
* @PreferenceChange
* void myPrefPreferenceChanged(Preference preference) {
* // Something Here
* }
*
* @PreferenceChange
* void myPrefPreferenceChanged(ListPreference preference) {
* // Something Here
* }
*
* @PreferenceChange({R.string.myPref1, R.string.myPref2})
* void preferenceChangeOnMultiplePrefs(Preference preference, String newValue) {
* // Something Here
* }
*
* @PreferenceChange(R.string.myPref)
* void preferenceChangeOnMyPref() {
* // Something Here
* }
*
*
*
*
* @see PreferenceClick
*/
@Retention(RetentionPolicy.CLASS)
@Target(ElementType.METHOD)
public @interface PreferenceChange {
/**
* 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 "";
}