universum.studios.android.universi

Class UniversiFragment

java.lang.Object

androidx.fragment.app.Fragment

universum.studios.android.fragment.BaseFragment

universum.studios.android.fragment.ActionBarFragment

universum.studios.android.universi.UniversiFragment

All Implemented Interfaces:

android.content.ComponentCallbacks, android.view.View.OnCreateContextMenuListener, androidx.lifecycle.LifecycleOwner, androidx.lifecycle.ViewModelStoreOwner, BackPressWatcher, ViewClickWatcher

public abstract class UniversiFragment
extends ActionBarFragment

An ActionBarFragment implementation that provides Universi context features via UniversiFragmentDelegate including other features described below.

1) Data binding

Whether it is used data binding provided by Google to bind application logic and layouts or some custom data binding logic, this fragment class provides a simple way to manage data binding requests and to perform actual binding. Whether a new data need to be bound to a view hierarchy of a specific instance of UniversiFragment, requestBindData() need to be called. This method can be invoked from any thread. If data binding request has been registered, UniversiFragment will invoke onBindData() method whenever its view hierarchy is already created or waits until it is created.

2) Permissions

This fragment class has support for a new permissions management model introduced in the Marshmallow Android version. Permissions related methods like checkSelfPermission(String) or supportRequestPermissions(String[], int) can be invoked regardless of current Android version.

Since:

1.0

Author:

Martin Albedinsky

Nested Class Summary

Nested classes/interfaces inherited from class universum.studios.android.fragment.ActionBarFragment

ActionBarFragment.ActionModeCallback

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

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

Constructor Summary

Constructors

Constructor and Description
UniversiFragment()

Method Summary

Modifier and Type	Method and Description
protected int	checkSelfPermission(String permission) Delegated call to ContextCompat.checkSelfPermission(Context, String).
protected boolean	dismissDialogWithId(int dialogId) Dismisses a dialog that is provided by the current dialog factory under the specified dialogId.
protected boolean	dismissXmlDialog(int resId) Dismisses an Xml dialog that has been shown via showXmlDialog(int, DialogOptions).
protected DialogController	getDialogController() Returns the controller that can be used to show and dismiss dialogs within context of this fragment.
protected DialogFactory	getDialogFactory() Returns the current dialog factory specified for this fragment.
protected boolean	isActiveNetworkConnected() Checks whether the current active network is at this time connected or not.
protected boolean	isNetworkConnected(int networkType) Checks whether a network with the specified networkType is at this time connected or no.
protected void	onBindData() Invoked due to call to requestBindData() to perform data binding specific for this fragment instance.
protected void	onBindViews(android.view.View rootView, android.os.Bundle savedInstanceState) Invoked from onViewCreated(View, Bundle) to bind all views presented within context of this fragment.
void	onDestroyView()
void	onPause()
void	onRequestPermissionsResult(int requestCode, String[] permissions, int[] grantResults)
void	onResume()
void	onSaveInstanceState(android.os.Bundle state)
void	onViewCreated(android.view.View view, android.os.Bundle savedInstanceState)
protected void	requestBindData() Requests performing of data binding specific for this fragment via onBindData().
protected void	setDialogController(DialogController controller) Sets a controller that should be used to show and dismiss dialogs within context of this fragment.
protected void	setDialogFactory(DialogFactory factory) Specifies a factory that should provide dialog instances for DialogController of this fragment to show.
protected void	setDialogXmlFactory(int xmlDialogsSet) Specifies a factory that should provide dialog instances that can be parsed from an Xml file with the specified xmlDialogsSet for DialogController of this fragment.
boolean	shouldShowRequestPermissionRationale(String permission)
protected boolean	showDialogWithId(int dialogId) Same as showDialogWithId(int, DialogOptions) with null options.
protected boolean	showDialogWithId(int dialogId, DialogOptions options) Shows a dialog that is provided by the current dialog factory under the specified dialogId.
protected boolean	showXmlDialog(int resId) Same as showXmlDialog(int, DialogOptions) with null options.
protected boolean	showXmlDialog(int resId, DialogOptions options) Like showDialogWithId(int, DialogOptions), but in this case will be used internal instance of DialogXmlFactory to create (inflate) the desired dialog instance to be shown.
protected void	supportRequestPermissions(String[] permissions, int requestCode) Invokes Fragment.requestPermissions(String[], int) on Android versions above Marshmallow (including).

Methods inherited from class universum.studios.android.fragment.ActionBarFragment

finishActionMode, getActionBar, getActionBarDelegate, getActionMode, getAnnotationHandler, getSupportActionBar, invalidateActionBar, isActionBarAvailable, isInActionMode, onActionModeFinished, onActionModeStarted, onActivityCreated, onBackPress, onCreate, onCreateOptionsMenu, startActionMode, startActionMode

Methods inherited from class universum.studios.android.fragment.BaseFragment

dispatchBackPress, dispatchViewClick, getContextTheme, inflateTransition, invalidateOptionsMenu, isAttached, isCreated, isDestroyed, isPaused, isStarted, isStopped, isViewCreated, newInstanceWithArguments, onAttach, onCreateView, onDestroy, onDetach, onStart, onStop, onViewClick, runOnUiThread

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, 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, onActivityResult, onAttach, onAttachFragment, onConfigurationChanged, onContextItemSelected, onCreateAnimation, onCreateAnimator, onCreateContextMenu, onDestroyOptionsMenu, onGetLayoutInflater, onHiddenChanged, onInflate, onInflate, onLowMemory, onMultiWindowModeChanged, onOptionsItemSelected, onOptionsMenuClosed, onPictureInPictureModeChanged, onPrepareOptionsMenu, onViewStateRestored, postponeEnterTransition, registerForContextMenu, requestPermissions, requireActivity, requireContext, requireFragmentManager, requireHost, 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

UniversiFragment

public UniversiFragment()

Method Detail

setDialogController

protected void setDialogController(@Nullable
                                   DialogController controller)

Sets a controller that should be used to show and dismiss dialogs within context of this fragment.

Parameters:

controller - The desired controller. May be null to use the default one.

See Also:

getDialogController()

getDialogController

@NonNull
protected DialogController getDialogController()

Returns the controller that can be used to show and dismiss dialogs within context of this fragment.

If not specified, instance of DialogController is instantiated by default.

Returns:

The dialog controller of this fragment.

See Also:

setDialogController(DialogController)

setDialogXmlFactory

protected void setDialogXmlFactory(@XmlRes
                                   int xmlDialogsSet)

Specifies a factory that should provide dialog instances that can be parsed from an Xml file with the specified xmlDialogsSet for DialogController of this fragment.

Parameters:

xmlDialogsSet - Resource id of the desired Xml file containing Xml dialogs that the factory should provide for this fragment. May be 0 to remove the current one.

setDialogFactory

protected void setDialogFactory(@Nullable
                                DialogFactory factory)

Specifies a factory that should provide dialog instances for DialogController of this fragment to show.

Parameters:

factory - The desired factory. May be null to remove the current one.

See Also:

getDialogFactory(), showDialogWithId(int), showDialogWithId(int, DialogOptions)

getDialogFactory

@Nullable
protected DialogFactory getDialogFactory()

Returns the current dialog factory specified for this fragment.

Returns:

Dialog factory or null if no factory has been specified yet.

See Also:

setDialogFactory(DialogFactory)

onViewCreated

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

Overrides:

onViewCreated in class BaseFragment

onBindViews

protected void onBindViews(@NonNull
                           android.view.View rootView,
                           @Nullable
                           android.os.Bundle savedInstanceState)

Invoked from onViewCreated(View, Bundle) to bind all views presented within context of this fragment.

Parameters:

rootView - The root view of this fragment.

onResume

public void onResume()

Overrides:

onResume in class BaseFragment

requestBindData

protected void requestBindData()

Requests performing of data binding specific for this fragment via onBindData(). If this fragment has its view hierarchy already created onBindData() will be invoked immediately, otherwise will wait until onViewCreated(View, Bundle) is invoked.

This method may be invoked also from a background-thread.

onBindData

@UiThread
protected void onBindData()

Invoked due to call to requestBindData() to perform data binding specific for this fragment instance.

This is always invoked on the UI thread.

isActiveNetworkConnected

@CheckResult
protected boolean isActiveNetworkConnected()

Checks whether the current active network is at this time connected or not.

Returns:

True if active network is connected, false otherwise.

See Also:

ConnectivityManager.getActiveNetworkInfo(), NetworkInfo.isConnected(), isNetworkConnected(int)

isNetworkConnected

@CheckResult
protected boolean isNetworkConnected(int networkType)

Checks whether a network with the specified networkType is at this time connected or no.

Parameters:

networkType - The desired network type to check for connection.

Returns:

True if the requested network is connected, false otherwise.

See Also:

ConnectivityManager.getNetworkInfo(int), NetworkInfo.isConnected()

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

showDialogWithId

protected boolean showDialogWithId(int dialogId)

Same as showDialogWithId(int, DialogOptions) with null options.

showDialogWithId

protected boolean showDialogWithId(int dialogId,
                                   @Nullable
                                   DialogOptions options)

Shows a dialog that is provided by the current dialog factory under the specified dialogId.

Parameters:

dialogId - Id of the desired dialog to show.

options - Options for the dialog.

Returns:

True if dialog has been shown, false if this fragment is currently paused or does not have its dialog factory specified.

See Also:

DialogController.newRequest(int), setDialogFactory(DialogFactory), dismissDialogWithId(int)

dismissDialogWithId

protected boolean dismissDialogWithId(int dialogId)

Dismisses a dialog that is provided by the current dialog factory under the specified dialogId.

Parameters:

dialogId - Id of the desired dialog to dismiss.

Returns:

True if dialog has been dismissed, false if this fragment is currently paused or does not have its dialog factory specified.

See Also:

DialogController.newRequest(int), showDialogWithId(int, DialogOptions)

showXmlDialog

protected boolean showXmlDialog(@XmlRes
                                int resId)

Same as showXmlDialog(int, DialogOptions) with null options.

showXmlDialog

protected boolean showXmlDialog(@XmlRes
                                int resId,
                                @Nullable
                                DialogOptions options)

Like showDialogWithId(int, DialogOptions), but in this case will be used internal instance of DialogXmlFactory to create (inflate) the desired dialog instance to be shown.

Parameters:

resId - Resource id of Xml file containing the desired dialog (its specification) to show.

options - Options for the dialog.

Returns:

True if dialog has been successfully inflated and shown, false if this fragment is currently paused or dialog failed to be inflated.

See Also:

DialogXmlFactory.createDialog(int, DialogOptions), dismissXmlDialog(int)

dismissXmlDialog

protected boolean dismissXmlDialog(@XmlRes
                                   int resId)

Dismisses an Xml dialog that has been shown via showXmlDialog(int, DialogOptions).

Parameters:

resId - Resource id of Xml file containing the desired dialog (its specification) to dismiss.

Returns:

True if dialog has been dismissed, false if this fragment is currently paused.

See Also:

showXmlDialog(int, DialogOptions)

onSaveInstanceState

public void onSaveInstanceState(@NonNull
                                android.os.Bundle state)

Overrides:

onSaveInstanceState in class androidx.fragment.app.Fragment

onPause

public void onPause()

Overrides:

onPause in class BaseFragment

onDestroyView

public void onDestroyView()

Overrides:

onDestroyView in class androidx.fragment.app.Fragment