PreferenceManager

public static final String KEY_HAS_SET_DEFAULT_VALUES = "_has_set_default_values"

public @NonNull PreferenceScreen createPreferenceScreen(@NonNull Context context)

public @Nullable T <T extends Preference> findPreference(@NonNull CharSequence key)

Finds a Preference with the given key. Returns null if no Preference could be found with the given key.

public @NonNull Context getContext()

Returns the context.

public static SharedPreferences getDefaultSharedPreferences(@NonNull Context context)

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

public @Nullable PreferenceManager.OnDisplayPreferenceDialogListener getOnDisplayPreferenceDialogListener()

public @Nullable PreferenceManager.OnNavigateToScreenListener getOnNavigateToScreenListener()

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

public @Nullable PreferenceManager.OnPreferenceTreeClickListener getOnPreferenceTreeClickListener()

public @Nullable PreferenceManager.PreferenceComparisonCallback getPreferenceComparisonCallback()

public @Nullable PreferenceDataStore getPreferenceDataStore()

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

public PreferenceScreen getPreferenceScreen()

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

public @Nullable SharedPreferences getSharedPreferences()

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

public int getSharedPreferencesMode()

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

public String getSharedPreferencesName()

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

public boolean isStorageDefault()

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

public boolean isStorageDeviceProtected()

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

public static void setDefaultValues(@NonNull 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.

public static void setDefaultValues(
    @NonNull Context context,
    String sharedPreferencesName,
    int sharedPreferencesMode,
    int resId,
    boolean readAgain
)

Similar to setDefaultValues but allows the client to provide the filename and mode of the shared preferences file.

public void setOnDisplayPreferenceDialogListener(
    @Nullable PreferenceManager.OnDisplayPreferenceDialogListener onDisplayPreferenceDialogListener
)

public void setOnNavigateToScreenListener(
    @Nullable PreferenceManager.OnNavigateToScreenListener listener
)

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

public void setOnPreferenceTreeClickListener(
    @Nullable PreferenceManager.OnPreferenceTreeClickListener listener
)

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

public void setPreferenceComparisonCallback(
    @Nullable PreferenceManager.PreferenceComparisonCallback preferenceComparisonCallback
)

public void setPreferenceDataStore(@Nullable 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. Also if the data store is set, the child preferences won't use SharedPreferences as long as they are assigned to this manager.

public boolean setPreferences(PreferenceScreen preferenceScreen)

Sets the root of the preference hierarchy.

public void setSharedPreferencesMode(int sharedPreferencesMode)

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

public 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.

public void setStorageDefault()

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

public 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.

public void showDialog(@NonNull Preference preference)

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