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

Class DynamicThemeFragment

java.lang.Object

androidx.fragment.app.Fragment

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

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

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

All Implemented Interfaces:

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

public class DynamicThemeFragment
extends ThemeFragment<DynamicAppTheme>

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 DynamicSpinnerPreference	mBackgroundAwarePreference	Dynamic spinner preference to control the background aware functionality.
protected DynamicColorPreference	mColorAccentDarkPreference	Dynamic color preference to control the dark accent colors.
protected DynamicColorPreference	mColorAccentPreference	Dynamic color preference to control the accent colors.
protected DynamicColorPreference	mColorBackgroundPreference	Dynamic color preference to control the background colors.
protected DynamicColorPreference	mColorErrorPreference	Dynamic color preference to control the error colors.
protected DynamicColorPreference	mColorPrimaryDarkPreference	Dynamic color preference to control the dark primary colors.
protected DynamicColorPreference	mColorPrimaryPreference	Dynamic color preference to control the primary colors.
protected DynamicColorPreference	mColorSurfacePreference	Dynamic color preference to control the surface color.
protected DynamicSliderPreference	mContrastPreference	Dynamic slider preference to control the contrast.
protected DynamicSliderPreference	mCornerSizePreference	Dynamic slider preference to control the corner radius.
protected DynamicSpinnerPreference	mElevationPreference	Dynamic spinner preference to control the elevation functionality.
protected DynamicSliderPreference	mFontScalePreference	Dynamic slider preference to control the font scale.
protected DynamicSliderPreference	mOpacityPreference	Dynamic slider preference to control the opacity.
protected DynamicPresetsView<DynamicAppTheme>	mPresetsView	View to show the theme presets.
protected DynamicSpinnerPreference	mStylePreference	Dynamic spinner preference to control the style functionality.
protected DynamicColorPreference	mTextPrimaryPreference	Dynamic color preference to control the primary text colors.
protected DynamicColorPreference	mTextSecondaryPreference	Dynamic color preference to control the secondary text colors.

Fields inherited from class com.pranavpandey.android.dynamic.support.theme.fragment.ThemeFragment

mDynamicTheme, mDynamicThemeDefault, mProgressDialog, mSettingsChanged, mThemeExported, mThemePreview

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
DynamicThemeFragment()

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	getStyle()	Returns the resolved style for the theme.
DynamicAppTheme	getThemeFromArguments(String key)	Retrieves the theme from the supplies arguments
boolean	isOnSharedPreferenceChangeListener()	Returns whether to register a shared preferences listener for this fragment.
static DynamicThemeFragment	newInstance(String dynamicAppTheme, String dynamicAppThemeDefault)	Initialize the new instance of this fragment.
static DynamicThemeFragment	newInstance(String dynamicAppTheme, String dynamicAppThemeDefault, boolean showPresets)	Initialize the new instance of this fragment.
void	onCreate(Bundle savedInstanceState)
View	onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState)
DynamicAppTheme	onImportTheme(String theme)	This method will be called on importing the theme.
void	onLoadTheme(DynamicAppTheme theme)	This method will called to load settings from the supplied theme.
void	onResume()
void	onSetAction(int themeAction, ThemePreview<DynamicAppTheme> themePreview, boolean enable)	This method will be called on setting the action icon.
void	onSharedPreferenceChanged(SharedPreferences sharedPreferences, String key)
void	onViewCreated(View view, Bundle savedInstanceState)
boolean	setHasOptionsMenu()	Returns whether to set the options menu for this fragment.

Methods inherited from class com.pranavpandey.android.dynamic.support.theme.fragment.ThemeFragment

getPreferenceValue, getPreferenceValue, getShareTitle, getThemeBitmap, getThemeExportTask, getThemePreview, importTheme, importTheme, importTheme, onActivityResult, onCreateMenu, onMenuItemSelected, onPrepareMenu, onThemeError, saveTheme, saveThemeSettings, setProgress

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, isSearchViewExpanded, isSearchViewListenerListener, isSupportActionBar, onAddActivityHeader, onAddMenuProvider, onAdjustEnterReturnTransition, onAdjustExitReenterTransition, onApplyTransitions, onDestroy, onDynamicPause, onDynamicResume, onFindView, onMenuClosed, onPause, onRemoveProvider, onSaveInstanceState, onSearchViewCollapsed, onSearchViewExpanded, onStart, onStartActivityException, postponeEnterTransition, 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, 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

Field Details

mPresetsView

protected DynamicPresetsView<DynamicAppTheme> mPresetsView

View to show the theme presets.

mColorBackgroundPreference

protected DynamicColorPreference mColorBackgroundPreference

Dynamic color preference to control the background colors.

mColorSurfacePreference

protected DynamicColorPreference mColorSurfacePreference

Dynamic color preference to control the surface color.

mColorPrimaryPreference

protected DynamicColorPreference mColorPrimaryPreference

Dynamic color preference to control the primary colors.

mColorAccentPreference

protected DynamicColorPreference mColorAccentPreference

Dynamic color preference to control the accent colors.

mColorPrimaryDarkPreference

protected DynamicColorPreference mColorPrimaryDarkPreference

Dynamic color preference to control the dark primary colors.

mColorAccentDarkPreference

protected DynamicColorPreference mColorAccentDarkPreference

Dynamic color preference to control the dark accent colors.

mColorErrorPreference

protected DynamicColorPreference mColorErrorPreference

Dynamic color preference to control the error colors.

mTextPrimaryPreference

protected DynamicColorPreference mTextPrimaryPreference

Dynamic color preference to control the primary text colors.

mTextSecondaryPreference

protected DynamicColorPreference mTextSecondaryPreference

Dynamic color preference to control the secondary text colors.

mFontScalePreference

protected DynamicSliderPreference mFontScalePreference

Dynamic slider preference to control the font scale.

mCornerSizePreference

protected DynamicSliderPreference mCornerSizePreference

Dynamic slider preference to control the corner radius.

mBackgroundAwarePreference

protected DynamicSpinnerPreference mBackgroundAwarePreference

Dynamic spinner preference to control the background aware functionality.

mContrastPreference

protected DynamicSliderPreference mContrastPreference

Dynamic slider preference to control the contrast.

mOpacityPreference

protected DynamicSliderPreference mOpacityPreference

Dynamic slider preference to control the opacity.

mElevationPreference

protected DynamicSpinnerPreference mElevationPreference

Dynamic spinner preference to control the elevation functionality.

mStylePreference

protected DynamicSpinnerPreference mStylePreference

Dynamic spinner preference to control the style functionality.

Constructor Details

DynamicThemeFragment

public DynamicThemeFragment()

Method Details

newInstance

@NonNull
public static DynamicThemeFragment newInstance(@Nullable
 String dynamicAppTheme,
 @Nullable
 String dynamicAppThemeDefault)

Initialize the new instance of this fragment.

Parameters:

dynamicAppTheme - The dynamic app theme.

dynamicAppThemeDefault - The default dynamic app theme.

Returns:

An instance of DynamicThemeFragment.

See Also:

• newInstance(String, String, boolean)

newInstance

@NonNull
public static DynamicThemeFragment newInstance(@Nullable
 String dynamicAppTheme,
 @Nullable
 String dynamicAppThemeDefault,
 boolean showPresets)

Initialize the new instance of this fragment.

Parameters:

dynamicAppTheme - The dynamic app theme.

dynamicAppThemeDefault - The default dynamic app theme.

showPresets - true to show the presets.

Returns:

An instance of DynamicThemeFragment.

onCreate

public void onCreate(@Nullable
 Bundle savedInstanceState)

Overrides:

onCreate in class DynamicFragment

onCreateView

@Nullable
public View onCreateView(@NonNull
 LayoutInflater inflater,
 @Nullable
 ViewGroup container,
 @Nullable
 Bundle savedInstanceState)

Overrides:

onCreateView in class Fragment

onViewCreated

public void onViewCreated(@NonNull
 View view,
 @Nullable
 Bundle savedInstanceState)

Overrides:

onViewCreated in class DynamicFragment

setHasOptionsMenu

public boolean setHasOptionsMenu()

Description copied from class: DynamicFragment

Returns whether to set the options menu for this fragment.

Overrides:

setHasOptionsMenu in class DynamicFragment

Returns:

true if set the options menu for this fragment.

See Also:

• Fragment.setHasOptionsMenu(boolean)
• DynamicFragment.onDynamicResume(boolean)

onResume

public void onResume()

Overrides:

onResume in class DynamicFragment

getThemeFromArguments

@Nullable
public DynamicAppTheme getThemeFromArguments(@NonNull
 String key)

Retrieves the theme from the supplies arguments

Parameters:

key - The key to be retrieved.

Returns:

The dynamic theme from the supplied arguments.

onImportTheme

@NonNull
public DynamicAppTheme onImportTheme(@NonNull
 String theme)

Description copied from interface: ThemeListener.Import

This method will be called on importing the theme.

Parameters:

theme - The theme string to be imported.

Returns:

The imported theme.

onLoadTheme

public void onLoadTheme(@NonNull
 DynamicAppTheme theme)

Description copied from interface: ThemeListener

This method will called to load settings from the supplied theme.

Parameters:

theme - The dynamic app theme to be loaded.

onSetAction

public void onSetAction(int themeAction,
 @Nullable
 ThemePreview<DynamicAppTheme> themePreview,
 boolean enable)

Description copied from interface: ThemeListener

This method will be called on setting the action icon.

It can be used to change the action icon while sharing the theme.

Parameters:

themeAction - The theme action to be used.

themePreview - The theme preview to set the share action.

enable - true to enable the share action.

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

Overrides:

getFontScale in class ThemeFragment<DynamicAppTheme>

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

Overrides:

getCornerSize in class ThemeFragment<DynamicAppTheme>

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

Overrides:

getBackgroundAware in class ThemeFragment<DynamicAppTheme>

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

Overrides:

getContrast in class ThemeFragment<DynamicAppTheme>

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

Overrides:

getOpacity in class ThemeFragment<DynamicAppTheme>

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

Overrides:

getElevation in class ThemeFragment<DynamicAppTheme>

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

Overrides:

getStyle in class ThemeFragment<DynamicAppTheme>

Returns:

The resolved style for the theme.

isOnSharedPreferenceChangeListener

public boolean isOnSharedPreferenceChangeListener()

Description copied from class: DynamicFragment

Returns whether to register a shared preferences listener for this fragment.

Overrides:

isOnSharedPreferenceChangeListener in class DynamicFragment

Returns:

true to register a SharedPreferences.OnSharedPreferenceChangeListener to receive preference change callback.

onSharedPreferenceChanged

public void onSharedPreferenceChanged(SharedPreferences sharedPreferences,
 @Nullable
 String key)

Specified by:

onSharedPreferenceChanged in interface SharedPreferences.OnSharedPreferenceChangeListener

Overrides:

onSharedPreferenceChanged in class DynamicFragment