PreferenceManager

KEY_HAS_SET_DEFAULT_VALUES

String KEY_HAS_SET_DEFAULT_VALUES

Constant Value: "_has_set_default_values"

createPreferenceScreen

PreferenceScreen createPreferenceScreen (Context context)

findPreference

Preference findPreference (CharSequence key)

Finds a Preference based on its key.

getContext

Context getContext ()

Returns the context.

getDefaultSharedPreferences

SharedPreferences getDefaultSharedPreferences (Context context)

Gets a SharedPreferences instance that points to the default file that is used by the preference framework in the given context.

getOnDisplayPreferenceDialogListener

PreferenceManager.OnDisplayPreferenceDialogListener getOnDisplayPreferenceDialogListener ()

getOnNavigateToScreenListener

PreferenceManager.OnNavigateToScreenListener getOnNavigateToScreenListener ()

Returns the PreferenceManager.OnNavigateToScreenListener, if one has been set.

getOnPreferenceTreeClickListener

PreferenceManager.OnPreferenceTreeClickListener getOnPreferenceTreeClickListener ()

getPreferenceComparisonCallback

PreferenceManager.PreferenceComparisonCallback getPreferenceComparisonCallback ()

getPreferenceDataStore

PreferenceDataStore getPreferenceDataStore ()

Returns the PreferenceDataStore associated with this manager or null if the default SharedPreferences are used instead.

getPreferenceScreen

PreferenceScreen getPreferenceScreen ()

Returns the root of the preference hierarchy managed by this class.

getSharedPreferences

SharedPreferences getSharedPreferences ()

Gets a SharedPreferences instance that preferences managed by this will use.

getSharedPreferencesMode

int getSharedPreferencesMode ()

Returns the current mode of the SharedPreferences file that preferences managed by this will use.

getSharedPreferencesName

String getSharedPreferencesName ()

Returns the current name of the SharedPreferences file that preferences managed by this will use.

isStorageDefault

boolean isStorageDefault ()

Indicates if the storage location used internally by this class is the default provided by the hosting Context.

isStorageDeviceProtected

boolean isStorageDeviceProtected ()

Indicates if the storage location used internally by this class is backed by device-protected storage.

setDefaultValues

void setDefaultValues (Context context, 
                String sharedPreferencesName, 
                int sharedPreferencesMode, 
                int resId, 
                boolean readAgain)

Similar to setDefaultValues(Context, int, boolean) but allows the client to provide the filename and mode of the shared preferences file.

setDefaultValues

void setDefaultValues (Context context, 
                int resId, 
                boolean readAgain)

Sets the default values from an XML preference file by reading the values defined by each Preference item's android:defaultValue attribute. This should be called by the application's main activity.

setOnDisplayPreferenceDialogListener

void setOnDisplayPreferenceDialogListener (PreferenceManager.OnDisplayPreferenceDialogListener onDisplayPreferenceDialogListener)

setOnNavigateToScreenListener

void setOnNavigateToScreenListener (PreferenceManager.OnNavigateToScreenListener listener)

Sets the callback to be invoked when a PreferenceScreen in the hierarchy rooted at this PreferenceManager is clicked.

setOnPreferenceTreeClickListener

void setOnPreferenceTreeClickListener (PreferenceManager.OnPreferenceTreeClickListener listener)

Sets the callback to be invoked when a Preference in the hierarchy rooted at this PreferenceManager is clicked.

setPreferenceComparisonCallback

void setPreferenceComparisonCallback (PreferenceManager.PreferenceComparisonCallback preferenceComparisonCallback)

setPreferenceDataStore

void setPreferenceDataStore (PreferenceDataStore dataStore)

Sets a PreferenceDataStore to be used by all Preferences associated with this manager that don't have a custom PreferenceDataStore assigned via setPreferenceDataStore(PreferenceDataStore). Also if the data store is set, the child preferences won't use SharedPreferences as long as they are assigned to this manager.

setPreferences

boolean setPreferences (PreferenceScreen preferenceScreen)

Sets the root of the preference hierarchy.

setSharedPreferencesMode

void setSharedPreferencesMode (int sharedPreferencesMode)

Sets the mode of the SharedPreferences file that preferences managed by this will use.

setSharedPreferencesName

void setSharedPreferencesName (String sharedPreferencesName)

Sets the name of the SharedPreferences file that preferences managed by this will use.

If custom PreferenceDataStore is set, this won't override its usage.

setStorageDefault

void setStorageDefault ()

Sets the storage location used internally by this class to be the default provided by the hosting Context.

setStorageDeviceProtected

void setStorageDeviceProtected ()

Explicitly set the storage location used internally by this class to be device-protected storage.

On devices with direct boot, data stored in this location is encrypted with a key tied to the physical device, and it can be accessed immediately after the device has booted successfully, both before and after the user has authenticated with their credentials (such as a lock pattern or PIN).

Because device-protected data is available without user authentication, you should carefully limit the data you store using this Context. For example, storing sensitive authentication tokens or passwords in the device-protected area is strongly discouraged.

Prior to API 24 this method has no effect, since device-protected storage is not available.

showDialog

void showDialog (Preference preference)

Called when a preference requests that a dialog be shown to complete a user interaction.