universum.studios.android.setting

Class SettingsBaseFragment

java.lang.Object

android.app.Fragment

android.preference.PreferenceFragment

universum.studios.android.setting.SettingsBaseFragment

All Implemented Interfaces:

android.content.ComponentCallbacks, android.content.ComponentCallbacks2, android.view.View.OnCreateContextMenuListener

public abstract class SettingsBaseFragment
extends android.preference.PreferenceFragment

A PreferenceFragment implementation which inflates its layout from a style specified in the current theme.

Theme style attribute

uiSettingsFragmentStyle

Author:

Martin Albedinsky

Nested Class Summary

Nested classes/interfaces inherited from class android.preference.PreferenceFragment

android.preference.PreferenceFragment.OnPreferenceStartFragmentCallback

Nested classes/interfaces inherited from class android.app.Fragment

android.app.Fragment.InstantiationException, android.app.Fragment.SavedState

Field Summary

Fields inherited from interface android.content.ComponentCallbacks2

TRIM_MEMORY_BACKGROUND, TRIM_MEMORY_COMPLETE, TRIM_MEMORY_MODERATE, TRIM_MEMORY_RUNNING_CRITICAL, TRIM_MEMORY_RUNNING_LOW, TRIM_MEMORY_RUNNING_MODERATE, TRIM_MEMORY_UI_HIDDEN

Constructor Summary

Constructors

Constructor and Description
SettingsBaseFragment()

Method Summary

Modifier and Type	Method and Description
void	addPreferencesFromIntent(android.content.Intent intent) Adds a preferences from the specified intent and registers this fragment as Preference.OnPreferenceChangeListener on the current preference screen and calls onPreferencesAdded().
void	addPreferencesFromResource(int preferencesResId) Adds a preferences from the specified preferencesResId Xml resource and registers this fragment as Preference.OnPreferenceChangeListener on the current preference screen and calls onPreferencesAdded().
protected int	checkSelfPermission(String permission) Delegated call to ActivityCompat#checkSelfPermission(Context, String).
protected void	onBindPreferences() Called immediately after requestBindPreferences() if preferences for this fragment has been already added via one of addPreferencesFromIntent(Intent) or addPreferencesFromResource(int) methods.
android.view.View	onCreateView(android.view.LayoutInflater inflater, android.view.ViewGroup container, android.os.Bundle savedInstanceState)
void	onDestroyView() This implementation saves the current scroll position of the preferences list view.
protected void	onPreferencesAdded() Called immediately after addPreferencesFromResource(int) or addPreferencesFromIntent(Intent) when preferences for this fragment has been added into the associated preference screen.
void	onRequestPermissionsResult(int requestCode, String[] permissions, int[] grantResults)
void	onSaveInstanceState(android.os.Bundle state)
void	onViewCreated(android.view.View view, android.os.Bundle savedInstanceState) This implementation restores the first visible item's position and its offset.
protected void	requestBindPreferences() Requests binding of preferences via onBindPreferences().
protected void	setPreferenceScreenKeyModificator(PreferenceScreenKeyModificator keyModificator) Sets a modificator that should be used to modify keys of preferences displayed in preference screen associated with this fragment.
boolean	shouldShowRequestPermissionRationale(String permission)
protected void	supportRequestPermissions(String[] permissions, int requestCode) Invokes Fragment.requestPermissions(String[], int) on Android versions above Marshmallow (including).

Methods inherited from class android.preference.PreferenceFragment

findPreference, getPreferenceManager, getPreferenceScreen, onActivityCreated, onActivityResult, onCreate, onDestroy, onPreferenceTreeClick, onStart, onStop, setPreferenceScreen

Methods inherited from class android.app.Fragment

dump, equals, getActivity, getAllowEnterTransitionOverlap, getAllowReturnTransitionOverlap, getArguments, getChildFragmentManager, getContext, getEnterTransition, getExitTransition, getFragmentManager, getHost, getId, getLoaderManager, getParentFragment, getReenterTransition, getResources, getRetainInstance, getReturnTransition, getSharedElementEnterTransition, getSharedElementReturnTransition, getString, getString, getTag, getTargetFragment, getTargetRequestCode, getText, getUserVisibleHint, getView, hashCode, instantiate, instantiate, isAdded, isDetached, isHidden, isInLayout, isRemoving, isResumed, isVisible, onAttach, onAttach, onAttachFragment, onConfigurationChanged, onContextItemSelected, onCreateAnimator, onCreateContextMenu, onCreateOptionsMenu, onDestroyOptionsMenu, onDetach, onHiddenChanged, onInflate, onInflate, onInflate, onLowMemory, onMultiWindowModeChanged, onOptionsItemSelected, onOptionsMenuClosed, onPause, onPictureInPictureModeChanged, onPrepareOptionsMenu, onResume, onTrimMemory, onViewStateRestored, registerForContextMenu, requestPermissions, setAllowEnterTransitionOverlap, setAllowReturnTransitionOverlap, setArguments, setEnterSharedElementCallback, setEnterTransition, setExitSharedElementCallback, setExitTransition, setHasOptionsMenu, setInitialSavedState, setMenuVisibility, setReenterTransition, setRetainInstance, setReturnTransition, setSharedElementEnterTransition, setSharedElementReturnTransition, setTargetFragment, setUserVisibleHint, startActivity, startActivity, startActivityForResult, startActivityForResult, startIntentSenderForResult, toString, unregisterForContextMenu

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SettingsBaseFragment

public SettingsBaseFragment()

Method Detail

setPreferenceScreenKeyModificator

protected void setPreferenceScreenKeyModificator(PreferenceScreenKeyModificator keyModificator)

Sets a modificator that should be used to modify keys of preferences displayed in preference screen associated with this fragment.

If you want to store setting preferences in a multi-account application where each account should have its associated set of settings stored separately, consider using Context.getSharedPreferences(String, int) where you would create SharedPreferences for each of accounts by its unique identifier used as name for shared preferences file. You can always attach the account dependent preferences to a settings fragment via its associated PreferenceManager. This approach is a more elegant and error-prone solution than specifying key modificator for that matter.

Parameters:

keyModificator - The desired modificator. May be null to clear the current one.

checkSelfPermission

protected int checkSelfPermission(String permission)

Delegated call to ActivityCompat#checkSelfPermission(Context, String).

Parameters:

permission - The desired permission for which to perform check.

Returns:

PackageManager.PERMISSION_GRANTED if you have the permission, or PackageManager.PERMISSION_DENIED if not.

shouldShowRequestPermissionRationale

public boolean shouldShowRequestPermissionRationale(String permission)

Overrides:

shouldShowRequestPermissionRationale in class android.app.Fragment

supportRequestPermissions

protected void supportRequestPermissions(String[] permissions,
                                         int requestCode)

Invokes Fragment.requestPermissions(String[], int) on Android versions above Marshmallow (including).

Calling this method on Android versions before MARSHMALLOW will be ignored.

Parameters:

permissions - The desired set of permissions to request.

requestCode - Code to identify this request in onRequestPermissionsResult(int, String[], int[]).

onRequestPermissionsResult

public void onRequestPermissionsResult(int requestCode,
                                       String[] permissions,
                                       int[] grantResults)

Overrides:

onRequestPermissionsResult in class android.app.Fragment

addPreferencesFromResource

public void addPreferencesFromResource(int preferencesResId)

Adds a preferences from the specified preferencesResId Xml resource and registers this fragment as Preference.OnPreferenceChangeListener on the current preference screen and calls onPreferencesAdded().

Overrides:

addPreferencesFromResource in class android.preference.PreferenceFragment

addPreferencesFromIntent

public void addPreferencesFromIntent(android.content.Intent intent)

Adds a preferences from the specified intent and registers this fragment as Preference.OnPreferenceChangeListener on the current preference screen and calls onPreferencesAdded().

Overrides:

addPreferencesFromIntent in class android.preference.PreferenceFragment

onPreferencesAdded

protected void onPreferencesAdded()

Called immediately after addPreferencesFromResource(int) or addPreferencesFromIntent(Intent) when preferences for this fragment has been added into the associated preference screen.

Default implementation invokes onBindPreferences() if binding of preferences has been requested before actually adding them.

Note, that if this fragment has attached PreferenceScreenKeyModificator the added preferences have already theirs keys modified. #setPreferenceScreenKeyModificator(PreferenceScreenKeyModificator)

See Also:

PreferenceFragment.getPreferenceScreen()

requestBindPreferences

protected void requestBindPreferences()

Requests binding of preferences via onBindPreferences().

If preferences for this fragment has not been added yet via one of addPreferencesFromResource(int) or addPreferencesFromIntent(Intent) methods, a pending request to bind preferences is registered and binding will be performed when onPreferencesAdded() is called, otherwise call to this method immediately invokes onBindPreferences().

onBindPreferences

protected void onBindPreferences()

Called immediately after requestBindPreferences() if preferences for this fragment has been already added via one of addPreferencesFromIntent(Intent) or addPreferencesFromResource(int) methods.

onCreateView

public android.view.View onCreateView(android.view.LayoutInflater inflater,
                                      android.view.ViewGroup container,
                                      android.os.Bundle savedInstanceState)

Overrides:

onCreateView in class android.preference.PreferenceFragment

onViewCreated

public void onViewCreated(android.view.View view,
                          android.os.Bundle savedInstanceState)

This implementation restores the first visible item's position and its offset.

Overrides:

onViewCreated in class android.preference.PreferenceFragment

onDestroyView

public void onDestroyView()

This implementation saves the current scroll position of the preferences list view.

Overrides:

onDestroyView in class android.preference.PreferenceFragment

onSaveInstanceState

public void onSaveInstanceState(android.os.Bundle state)

Overrides:

onSaveInstanceState in class android.preference.PreferenceFragment