universum.studios.android.setting

Class SettingsBaseFragment

java.lang.Object

androidx.fragment.app.Fragment

androidx.preference.PreferenceFragmentCompat

universum.studios.android.setting.SettingsBaseFragment

All Implemented Interfaces:

android.content.ComponentCallbacks, android.view.View.OnCreateContextMenuListener, androidx.lifecycle.LifecycleOwner, androidx.lifecycle.ViewModelStoreOwner, androidx.preference.DialogPreference.TargetFragment, androidx.preference.PreferenceManager.OnDisplayPreferenceDialogListener, androidx.preference.PreferenceManager.OnNavigateToScreenListener, androidx.preference.PreferenceManager.OnPreferenceTreeClickListener, androidx.savedstate.SavedStateRegistryOwner

public abstract class SettingsBaseFragment
extends androidx.preference.PreferenceFragmentCompat

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

Since:

1.0

Author:

Martin Albedinsky

Nested Class Summary

Nested classes/interfaces inherited from class androidx.preference.PreferenceFragmentCompat

androidx.preference.PreferenceFragmentCompat.OnPreferenceDisplayDialogCallback, androidx.preference.PreferenceFragmentCompat.OnPreferenceStartFragmentCallback, androidx.preference.PreferenceFragmentCompat.OnPreferenceStartScreenCallback

Nested classes/interfaces inherited from class androidx.fragment.app.Fragment

androidx.fragment.app.Fragment.InstantiationException, androidx.fragment.app.Fragment.SavedState

Field Summary

Fields inherited from class androidx.preference.PreferenceFragmentCompat

ARG_PREFERENCE_ROOT

Constructor Summary

Constructors

Constructor and Description
SettingsBaseFragment()

Method Summary

Modifier and Type	Method and Description
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 ContextCompat.checkSelfPermission(Context, String).
protected void	onBindPreferences() Called immediately after requestBindPreferences() if preferences for this fragment has been already added via addPreferencesFromResource(int) methods.
protected void	onPreferencesAdded() Called immediately after addPreferencesFromResource(int) or when preferences for this fragment has been added into the associated preference screen.
void	onRequestPermissionsResult(int requestCode, String[] permissions, int[] grantResults)
protected void	requestBindPreferences() Requests binding of preferences via onBindPreferences().
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 androidx.preference.PreferenceFragmentCompat

findPreference, getCallbackFragment, getListView, getPreferenceManager, getPreferenceScreen, onCreate, onCreateAdapter, onCreateLayoutManager, onCreatePreferences, onCreateRecyclerView, onCreateView, onDestroyView, onDisplayPreferenceDialog, onNavigateToScreen, onPreferenceTreeClick, onSaveInstanceState, onStart, onStop, onUnbindPreferences, onViewCreated, scrollToPreference, scrollToPreference, setDivider, setDividerHeight, setPreferenceScreen, setPreferencesFromResource

Methods inherited from class androidx.fragment.app.Fragment

dump, equals, getActivity, getAllowEnterTransitionOverlap, getAllowReturnTransitionOverlap, getArguments, getChildFragmentManager, getContext, getEnterTransition, getExitTransition, getFragmentManager, getHost, getId, getLayoutInflater, getLayoutInflater, getLifecycle, getLoaderManager, getParentFragment, getReenterTransition, getResources, getRetainInstance, getReturnTransition, getSavedStateRegistry, getSharedElementEnterTransition, getSharedElementReturnTransition, getString, getString, getTag, getTargetFragment, getTargetRequestCode, getText, getUserVisibleHint, getView, getViewLifecycleOwner, getViewLifecycleOwnerLiveData, getViewModelStore, hashCode, hasOptionsMenu, instantiate, instantiate, isAdded, isDetached, isHidden, isInLayout, isMenuVisible, isRemoving, isResumed, isStateSaved, isVisible, onActivityCreated, onActivityResult, onAttach, onAttach, onAttachFragment, onConfigurationChanged, onContextItemSelected, onCreateAnimation, onCreateAnimator, onCreateContextMenu, onCreateOptionsMenu, onDestroy, onDestroyOptionsMenu, onDetach, onGetLayoutInflater, onHiddenChanged, onInflate, onInflate, onLowMemory, onMultiWindowModeChanged, onOptionsItemSelected, onOptionsMenuClosed, onPause, onPictureInPictureModeChanged, onPrepareOptionsMenu, onPrimaryNavigationFragmentChanged, onResume, onViewStateRestored, postponeEnterTransition, postponeEnterTransition, registerForContextMenu, requestPermissions, requireActivity, requireArguments, requireContext, requireFragmentManager, requireHost, requireParentFragment, requireView, setAllowEnterTransitionOverlap, setAllowReturnTransitionOverlap, setArguments, setEnterSharedElementCallback, setEnterTransition, setExitSharedElementCallback, setExitTransition, setHasOptionsMenu, setInitialSavedState, setMenuVisibility, setReenterTransition, setRetainInstance, setReturnTransition, setSharedElementEnterTransition, setSharedElementReturnTransition, setTargetFragment, setUserVisibleHint, startActivity, startActivity, startActivityForResult, startActivityForResult, startIntentSenderForResult, startPostponedEnterTransition, toString, unregisterForContextMenu

Methods inherited from class java.lang.Object

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

Constructor Detail

SettingsBaseFragment

public SettingsBaseFragment()

Method Detail

checkSelfPermission

@CheckResult
protected int checkSelfPermission(@NonNull
                                               String permission)

Delegated call to ContextCompat.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

@CheckResult
public boolean shouldShowRequestPermissionRationale(@NonNull
                                                                 String permission)

Overrides:

shouldShowRequestPermissionRationale in class androidx.fragment.app.Fragment

supportRequestPermissions

protected void supportRequestPermissions(@NonNull
                                         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,
                                       @NonNull
                                       String[] permissions,
                                       @NonNull
                                       int[] grantResults)

Overrides:

onRequestPermissionsResult in class androidx.fragment.app.Fragment

addPreferencesFromResource

public void addPreferencesFromResource(@XmlRes
                                       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 androidx.preference.PreferenceFragmentCompat

onPreferencesAdded

protected void onPreferencesAdded()

Called immediately after addPreferencesFromResource(int) or 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.

See Also:

PreferenceFragmentCompat.getPreferenceScreen()

requestBindPreferences

protected void requestBindPreferences()

Requests binding of preferences via onBindPreferences().

If preferences for this fragment has not been added yet via addPreferencesFromResource(int), 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 addPreferencesFromResource(int) methods.

Overrides:

onBindPreferences in class androidx.preference.PreferenceFragmentCompat