Package com.pranavpandey.android.dynamic.support.theme.fragment

Class ThemeFragment<T extends DynamicAppTheme>

java.lang.Object

androidx.fragment.app.Fragment

com.pranavpandey.android.dynamic.support.fragment.DynamicFragment

com.pranavpandey.android.dynamic.support.theme.fragment.ThemeFragment<T>

Type Parameters:

T - The type of the dynamic app theme this fragment will handle.

All Implemented Interfaces:

ComponentCallbacks, SharedPreferences.OnSharedPreferenceChangeListener, View.OnCreateContextMenuListener, ActivityResultCaller, MenuProvider, HasDefaultViewModelProviderFactory, LifecycleOwner, ViewModelStoreOwner, androidx.savedstate.SavedStateRegistryOwner, DynamicLifecycle, DynamicSearchListener, DynamicTransitionListener, ThemeListener<T>, ThemeListener.Export<T>, ThemeListener.Import<T>, ThemeListener.Value, DynamicProductFlavor

Direct Known Subclasses:

DynamicRemoteThemeFragment, DynamicThemeFragment

public abstract class ThemeFragment<T extends DynamicAppTheme>
extends DynamicFragment
implements ThemeListener.Value, ThemeListener.Import<T>, ThemeListener.Export<T>

Base theme fragment to provide theme editing functionality.

Extend this fragment to implement theme attributes according to the requirements.

Nested Class Summary

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

Fragment.InstantiationException, Fragment.SavedState

Nested classes/interfaces inherited from interface com.pranavpandey.android.dynamic.support.theme.listener.ThemeListener

ThemeListener.Code, ThemeListener.Export<T extends DynamicAppTheme>, ThemeListener.Import<T extends DynamicAppTheme>, ThemeListener.Select, ThemeListener.Value

Nested classes/interfaces inherited from interface com.pranavpandey.android.dynamic.support.theme.listener.ThemeListener.Import

ThemeListener.Import.File<T>

Field Summary

Fields

Modifier and Type	Field	Description
protected T	mDynamicTheme	Dynamic app theme used by this fragment.
protected T	mDynamicThemeDefault	Default dynamic app theme used by this fragment.
protected DynamicDialogFragment	mProgressDialog	Dialog fragment to show the progress.
protected boolean	mSettingsChanged	true if the settings have been changed.
protected Uri	mThemeExported	Temporary file URI to store the exported theme.
protected ThemePreview<T>	mThemePreview	Theme preview used by this fragment.

Fields inherited from class androidx.fragment.app.Fragment

mPreviousWho

Fields inherited from interface com.pranavpandey.android.dynamic.support.theme.listener.ThemeListener

ADS_NAME_THEME_PREVIEW, ADS_NAME_THEME_PREVIEW_ACTION, ADS_NAME_THEME_PREVIEW_ICON, ADS_PREF_THEME_BACKGROUND_AWARE, ADS_PREF_THEME_COLOR_ACCENT, ADS_PREF_THEME_COLOR_ACCENT_DARK, ADS_PREF_THEME_COLOR_BACKGROUND, ADS_PREF_THEME_COLOR_ERROR, ADS_PREF_THEME_COLOR_PRIMARY, ADS_PREF_THEME_COLOR_PRIMARY_DARK, ADS_PREF_THEME_COLOR_SURFACE, ADS_PREF_THEME_COLOR_TINT_ACCENT, ADS_PREF_THEME_COLOR_TINT_ACCENT_DARK, ADS_PREF_THEME_COLOR_TINT_BACKGROUND, ADS_PREF_THEME_COLOR_TINT_ERROR, ADS_PREF_THEME_COLOR_TINT_PRIMARY, ADS_PREF_THEME_COLOR_TINT_PRIMARY_DARK, ADS_PREF_THEME_COLOR_TINT_SURFACE, ADS_PREF_THEME_CONTRAST, ADS_PREF_THEME_CONTRAST_ALT, ADS_PREF_THEME_CORNER_SIZE, ADS_PREF_THEME_CORNER_SIZE_ALT, ADS_PREF_THEME_ELEVATION, ADS_PREF_THEME_FONT_SCALE, ADS_PREF_THEME_FONT_SCALE_ALT, ADS_PREF_THEME_OPACITY, ADS_PREF_THEME_OPACITY_ALT, ADS_PREF_THEME_STYLE, ADS_PREF_THEME_TEXT_INVERSE_PRIMARY, ADS_PREF_THEME_TEXT_INVERSE_SECONDARY, ADS_PREF_THEME_TEXT_PRIMARY, ADS_PREF_THEME_TEXT_SECONDARY, REQUEST_THEME_CAPTURE, REQUEST_THEME_CODE_LOCATION, REQUEST_THEME_CODE_LOCATION_ALT, REQUEST_THEME_IMPORT, REQUEST_THEME_LOCATION

Constructor Summary

Constructors

Constructor	Description
ThemeFragment()

Method Summary

Modifier and Type	Method	Description
int	getBackgroundAware()	Returns the resolved background aware for the theme.
int	getContrast()	Returns the resolved contrast for the theme.
int	getCornerSize()	Returns the resolved corner size for the theme.
int	getElevation()	Returns the resolved elevation for the theme.
int	getFontScale()	Returns the resolved font scale for the theme.
int	getOpacity()	Returns the resolved opacity for the theme.
int	getPreferenceValue(DynamicSliderPreference preference, int fallback)	Try to resolve theme value from the slider preference.
int	getPreferenceValue(DynamicSpinnerPreference preference, int fallback)	Try to resolve theme value from the spinner preference.
String	getShareTitle()	This method will be called to get the share title.
int	getStyle()	Returns the resolved style for the theme.
Bitmap	getThemeBitmap(ThemePreview<T> themePreview, int themeAction)	This method will be called to return a bitmap.
DynamicTask<?,?,?>	getThemeExportTask(DialogInterface dialog, int themeAction, ThemePreview<T> themePreview)	This method will be called to get the theme export task.
ThemePreview<T>	getThemePreview()	Get the theme preview associated with this listener.
void	importTheme(int themeAction)	This method will be called on importing the theme.
void	importTheme(String theme)	This method will be called on importing the theme.
void	importTheme(String theme, int themeAction)	This method will be called on importing the theme.
void	onActivityResult(int requestCode, int resultCode, Intent data)
void	onCreateMenu(Menu menu, MenuInflater inflater)
boolean	onMenuItemSelected(MenuItem item)
void	onPrepareMenu(Menu menu)
void	onThemeError(int themeAction, ThemePreview<T> themePreview, Exception e)	This method will be called on error while doing theme operations.
protected void	saveTheme(int requestCode, Uri file)	Save theme according to the supplied parameters.
void	saveThemeSettings()	Set the theme and finish this activity.
protected void	setProgress(int requestCode, boolean visible)	Set progress for the theme tasks.

Methods inherited from class com.pranavpandey.android.dynamic.support.fragment.DynamicFragment

finishActivity, getBooleanFromArguments, getCheckedMenuItemId, getDynamicActivity, getDynamicEnterTransition, getDynamicExitTransition, getDynamicReenterTransition, getDynamicReturnTransition, getHostMenu, getIntFromArguments, getNavigationViewId, getParcelableFromArguments, getPostponeTransitionView, getProductFlavor, getSavedInstanceState, getStringFromArguments, getStringFromArguments, getSubtitle, getSystemActivity, getTextWatcher, getTitle, invalidateHostMenu, isAppCompatActivity, isEnableMenu, isForceMenuIcons, isHasMenuProvider, isOnSharedPreferenceChangeListener, isSearchViewExpanded, isSearchViewListenerListener, isSupportActionBar, onAddActivityHeader, onAddMenuProvider, onAdjustEnterReturnTransition, onAdjustExitReenterTransition, onApplyTransitions, onCreate, onDestroy, onDynamicPause, onDynamicResume, onFindView, onMenuClosed, onPause, onRemoveProvider, onResume, onSaveInstanceState, onSearchViewCollapsed, onSearchViewExpanded, onSharedPreferenceChanged, onStart, onStartActivityException, onViewCreated, postponeEnterTransition, setHasOptionsMenu, setHostMenuItemVisible, setMenuVisibility, setResult, setResult, setResult, setResult, startActivity, startActivity, startActivityForResult, startActivityForResult, startMotionActivity, startMotionActivityForResult, startPostponedEnterTransition

Methods inherited from class androidx.fragment.app.Fragment

dump, equals, getActivity, getAllowEnterTransitionOverlap, getAllowReturnTransitionOverlap, getArguments, getChildFragmentManager, getContext, getDefaultViewModelCreationExtras, getDefaultViewModelProviderFactory, getEnterTransition, getExitTransition, getFragmentManager, getHost, getId, getLayoutInflater, getLayoutInflater, getLifecycle, getLoaderManager, getParentFragment, getParentFragmentManager, 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, onAttach, onAttach, onAttachFragment, onConfigurationChanged, onContextItemSelected, onCreateAnimation, onCreateAnimator, onCreateContextMenu, onCreateOptionsMenu, onCreateView, onDestroyOptionsMenu, onDestroyView, onDetach, onGetLayoutInflater, onHiddenChanged, onInflate, onInflate, onLowMemory, onMultiWindowModeChanged, onOptionsItemSelected, onOptionsMenuClosed, onPictureInPictureModeChanged, onPrepareOptionsMenu, onPrimaryNavigationFragmentChanged, onRequestPermissionsResult, onStop, onViewStateRestored, postponeEnterTransition, registerForActivityResult, registerForActivityResult, registerForContextMenu, requestPermissions, requireActivity, requireArguments, requireContext, requireFragmentManager, requireHost, requireParentFragment, requireView, setAllowEnterTransitionOverlap, setAllowReturnTransitionOverlap, setArguments, setEnterSharedElementCallback, setEnterTransition, setExitSharedElementCallback, setExitTransition, setHasOptionsMenu, setInitialSavedState, setReenterTransition, setRetainInstance, setReturnTransition, setSharedElementEnterTransition, setSharedElementReturnTransition, setTargetFragment, setUserVisibleHint, shouldShowRequestPermissionRationale, startIntentSenderForResult, toString, unregisterForContextMenu

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.pranavpandey.android.dynamic.support.theme.listener.ThemeListener

onLoadTheme, onSetAction

Methods inherited from interface com.pranavpandey.android.dynamic.support.theme.listener.ThemeListener.Import

onImportTheme

Field Details

mDynamicTheme

protected T extends DynamicAppTheme mDynamicTheme

Dynamic app theme used by this fragment.

mDynamicThemeDefault

protected T extends DynamicAppTheme mDynamicThemeDefault

Default dynamic app theme used by this fragment.

mThemeExported

protected Uri mThemeExported

Temporary file URI to store the exported theme.

mSettingsChanged

protected boolean mSettingsChanged

true if the settings have been changed.

mThemePreview

protected ThemePreview<T extends DynamicAppTheme> mThemePreview

Theme preview used by this fragment.

mProgressDialog

protected DynamicDialogFragment mProgressDialog

Dialog fragment to show the progress.

Constructor Details

ThemeFragment

public ThemeFragment()

Method Details

getShareTitle

@Nullable
public String getShareTitle()

This method will be called to get the share title.

Returns:

The title for the share menu.

onCreateMenu

public void onCreateMenu(@NonNull
 Menu menu,
 @NonNull
 MenuInflater inflater)

Specified by:

onCreateMenu in interface MenuProvider

Overrides:

onCreateMenu in class DynamicFragment

onPrepareMenu

public void onPrepareMenu(@NonNull
 Menu menu)

Specified by:

onPrepareMenu in interface MenuProvider

Overrides:

onPrepareMenu in class DynamicFragment

onMenuItemSelected

public boolean onMenuItemSelected(@NonNull
 MenuItem item)

Specified by:

onMenuItemSelected in interface MenuProvider

Overrides:

onMenuItemSelected in class DynamicFragment

saveTheme

protected void saveTheme(int requestCode,
 @Nullable
 Uri file)

Save theme according to the supplied parameters.

Parameters:

requestCode - The request code to be used.

file - The file URI to be used.

onActivityResult

public void onActivityResult(int requestCode,
 int resultCode,
 @Nullable
 Intent data)

Overrides:

onActivityResult in class Fragment

setProgress

protected void setProgress(int requestCode,
 boolean visible)

Set progress for the theme tasks.

Parameters:

requestCode - The request code to be used.

visible - true to make the progress visible.

getPreferenceValue

public int getPreferenceValue(@Nullable
 DynamicSliderPreference preference,
 int fallback)

Try to resolve theme value from the slider preference.

Parameters:

preference - The slider preference to be used.

fallback - The fallback value to be used in case of any issues.

Returns:

The resolved theme value from the slider preference.

getPreferenceValue

public int getPreferenceValue(@Nullable
 DynamicSpinnerPreference preference,
 int fallback)

Try to resolve theme value from the spinner preference.

Parameters:

preference - The spinner preference to be used.

fallback - The fallback value to be used in case of any issues.

Returns:

The resolved theme value from the spinner preference.

getFontScale

public int getFontScale()

Description copied from interface: ThemeListener.Value

Returns the resolved font scale for the theme.

Specified by:

getFontScale in interface ThemeListener.Value

Returns:

The resolved font scale for the theme.

getCornerSize

public int getCornerSize()

Description copied from interface: ThemeListener.Value

Returns the resolved corner size for the theme.

Specified by:

getCornerSize in interface ThemeListener.Value

Returns:

The resolved corner size for the theme.

getBackgroundAware

public int getBackgroundAware()

Description copied from interface: ThemeListener.Value

Returns the resolved background aware for the theme.

Specified by:

getBackgroundAware in interface ThemeListener.Value

Returns:

The resolved background aware for the theme.

getContrast

public int getContrast()

Description copied from interface: ThemeListener.Value

Returns the resolved contrast for the theme.

Specified by:

getContrast in interface ThemeListener.Value

Returns:

The resolved contrast for the theme.

getOpacity

public int getOpacity()

Description copied from interface: ThemeListener.Value

Returns the resolved opacity for the theme.

Specified by:

getOpacity in interface ThemeListener.Value

Returns:

The resolved opacity for the theme.

getElevation

public int getElevation()

Description copied from interface: ThemeListener.Value

Returns the resolved elevation for the theme.

Specified by:

getElevation in interface ThemeListener.Value

Returns:

The resolved elevation for the theme.

getStyle

public int getStyle()

Description copied from interface: ThemeListener.Value

Returns the resolved style for the theme.

Specified by:

getStyle in interface ThemeListener.Value

Returns:

The resolved style for the theme.

getThemePreview

@NonNull
public ThemePreview<T> getThemePreview()

Description copied from interface: ThemeListener

Get the theme preview associated with this listener.

Specified by:

getThemePreview in interface ThemeListener<T extends DynamicAppTheme>

Returns:

The theme preview associated with this listener.

onThemeError

public void onThemeError(int themeAction,
 @Nullable
 ThemePreview<T> themePreview,
 @Nullable
 Exception e)

Description copied from interface: ThemeListener

This method will be called on error while doing theme operations.

Specified by:

onThemeError in interface ThemeListener<T extends DynamicAppTheme>

Parameters:

themeAction - The theme action to be used.

themePreview - The theme preview to set the share action.

e - The optional exception.

importTheme

public void importTheme(int themeAction)

Description copied from interface: ThemeListener.Import

This method will be called on importing the theme.

Specified by:

importTheme in interface ThemeListener.Import<T extends DynamicAppTheme>

Parameters:

themeAction - The theme action to be used.

importTheme

public void importTheme(@Nullable
 String theme)

Description copied from interface: ThemeListener.Import

This method will be called on importing the theme.

Specified by:

importTheme in interface ThemeListener.Import<T extends DynamicAppTheme>

Parameters:

theme - The theme string to be imported.

importTheme

public void importTheme(@Nullable
 String theme,
 int themeAction)

Description copied from interface: ThemeListener.Import

This method will be called on importing the theme.

Specified by:

importTheme in interface ThemeListener.Import<T extends DynamicAppTheme>

Parameters:

theme - The theme string to be imported.

themeAction - The theme action to be used.

getThemeBitmap

@Nullable
public Bitmap getThemeBitmap(@Nullable
 ThemePreview<T> themePreview,
 int themeAction)

Description copied from interface: ThemeListener.Export

This method will be called to return a bitmap.

Specified by:

getThemeBitmap in interface ThemeListener.Export<T extends DynamicAppTheme>

Parameters:

themePreview - The theme preview associated with this listener.

themeAction - The theme action associated with this listener.

Returns:

The theme bitmap.

getThemeExportTask

@NonNull
public DynamicTask<?,?,?> getThemeExportTask(@Nullable
 DialogInterface dialog,
 int themeAction,
 @Nullable
 ThemePreview<T> themePreview)

Description copied from interface: ThemeListener.Export

This method will be called to get the theme export task.

Specified by:

getThemeExportTask in interface ThemeListener.Export<T extends DynamicAppTheme>

Parameters:

dialog - The dialog interface if applicable.

themeAction - The theme action to be used.

themePreview - The theme preview for the task.

Returns:

The DynamicTask to perform theme export operations.

saveThemeSettings

public void saveThemeSettings()

Set the theme and finish this activity.