universum.studios.android.universi

Class UniversiCompatActivity

java.lang.Object

AppCompatActivity

universum.studios.android.universi.UniversiCompatActivity

All Implemented Interfaces:

UniversiActivityContext

public abstract class UniversiCompatActivity
extends AppCompatActivity
implements UniversiActivityContext

An AppCompatActivity implementation with same Universi context features provided as UniversiActivity.

Author:

Martin Albedinsky

See Also:

UniversiFragment

Constructor Summary

Constructors

Constructor and Description
UniversiCompatActivity() Creates a new instance of UniversiActivity.

Method Summary

Modifier and Type	Method and Description
int	checkSelfPermission(String permission)
void	destroyLoader(int id) Destroys a loader with the specified id.
boolean	dismissDialogWithId(int dialogId) Dismisses a dialog that is provided by the current dialog factory under the specified dialogId.
boolean	dismissXmlDialog(int resId) Dismisses an Xml dialog that has been shown via UniversiActivityContext.showXmlDialog(int, DialogOptions).
protected boolean	dispatchBackPressToCurrentFragment() Dispatches back press event to the current fragment displayed in context of this activity.
protected boolean	dispatchBackPressToFragments() Dispatches back press event to all currently visible fragments displayed in context of this activity.
protected android.app.Fragment	findCurrentFragment() Finds currently visible fragment that is displayed in context of this activity.
boolean	finishWithNavigationalTransition() Finishes this activity with navigational transition specified via UniversiActivityContext.setNavigationalTransition(BaseNavigationalTransition) (if any).
protected ActionBarFragmentAnnotationHandler	getAnnotationHandler() Returns handler that is responsible for annotations processing of this class and also for handling all annotations related operations for this class.
DialogController	getDialogController() Returns the controller that can be used to show and dismiss dialogs within context of this activity.
DialogFactory	getDialogFactory() Returns the current dialog factory specified for this activity.
FragmentController	getFragmentController() Returns the controller that can be used to show and hide fragments within context of this activity.
FragmentFactory	getFragmentFactory() Returns the current fragment factory specified for this activity.
BaseNavigationalTransition	getNavigationalTransition() Returns the navigational transition that will be used to finish this activity.
<D> android.content.Loader<D>	initLoader(int id, android.os.Bundle params, android.app.LoaderManager.LoaderCallbacks<D> callbacks) Initializes a loader with the specified id for the given callbacks.
boolean	isActiveNetworkConnected() Checks whether the current active network is at this time connected or not.
boolean	isNetworkConnected(int networkType) Checks whether a network with the specified networkType is at this time connected or no.
protected boolean	onBackPress() Invoked from onBackPressed() to give a chance to this activity instance to consume the back press event before it is delivered to its parent.
void	onBackPressed()
protected void	onBindData() Invoked due to call to requestBindData() to perform data binding specific for this activity instance.
protected void	onBindViews() Invoked from onContentChanged() to bind all views presented within context of this activity.
void	onContentChanged()
protected void	onCreate(android.os.Bundle savedInstanceState)
boolean	onCreateOptionsMenu(android.view.Menu menu)
protected void	onPause()
void	onRequestPermissionsResult(int requestCode, String[] permissions, int[] grantResults)
protected void	onResume()
protected boolean	popFragmentsBackStack() Pops stack with fragments of this activity.
protected void	requestBindData() Requests performing of data binding specific for this activity via onBindData().
<D> android.content.Loader<D>	restartLoader(int id, android.os.Bundle params, android.app.LoaderManager.LoaderCallbacks<D> callbacks) Re-starts a loader with the specified id for the given callbacks.
void	setDialogController(DialogController controller) Sets a controller that should be used to show and dismiss dialogs within context of this activity.
void	setDialogFactory(DialogFactory factory) Specifies a factory that provides dialog instances for DialogController of this activity.
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 activity.
void	setFragmentController(FragmentController controller) Sets a controller that should be used to show and hide fragments within context of this activity.
void	setFragmentFactory(FragmentFactory factory) Specifies a factory that provides fragment instances for FragmentController of his activity.
void	setNavigationalTransition(BaseNavigationalTransition transition) Sets a navigational transition that will be used to finish this activity context whenever its Activity.finishAfterTransition() is invoked.
void	setSupportActionBar(Toolbar toolbar)
boolean	shouldShowRequestPermissionRationale(String permission)
boolean	showDialogWithId(int dialogId) Same as UniversiActivityContext.showDialogWithId(int, DialogOptions) with null options.
boolean	showDialogWithId(int dialogId, DialogOptions options) Shows a dialog that is provided by the current dialog factory under the specified dialogId.
boolean	showXmlDialog(int resId) Same as UniversiActivityContext.showXmlDialog(int, DialogOptions) with null options.
boolean	showXmlDialog(int resId, DialogOptions options) Like UniversiActivityContext.showDialogWithId(int, DialogOptions), but in this case will be used internal instance of DialogXmlFactory to create (inflate) the desired dialog instance to be shown.
<D> android.content.Loader<D>	startLoader(int id, android.os.Bundle params, android.app.LoaderManager.LoaderCallbacks<D> callbacks) Starts a loader with the specified id.
void	supportRequestPermissions(String[] permissions, int requestCode) Invokes #requestPermissions(String[], int) on Android versions above Marshmallow (including).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UniversiCompatActivity

public UniversiCompatActivity()

Creates a new instance of UniversiActivity. If annotations processing is enabled via UniversiConfig all annotations supported by this activity class will be processed/obtained here so they can be later used.

Method Detail

getAnnotationHandler

protected ActionBarFragmentAnnotationHandler getAnnotationHandler()

Returns handler that is responsible for annotations processing of this class and also for handling all annotations related operations for this class.

Returns:

Annotations handler specific for this class.

Throws:

IllegalStateException - If annotations processing is not enabled for the Fragments library.

onCreate

protected void onCreate(android.os.Bundle savedInstanceState)

startLoader

public <D> android.content.Loader<D> startLoader(int id,
                                                 android.os.Bundle params,
                                                 android.app.LoaderManager.LoaderCallbacks<D> callbacks)

Description copied from interface: UniversiActivityContext

Starts a loader with the specified id. If there was already started loader with the same id before, such a loader will be re-started, otherwise new loader will be initialized.

Specified by:

startLoader in interface UniversiActivityContext

Parameters:

id - Id of the desired loader to start.

params - Params for loader.

callbacks - Callbacks for loader.

Returns:

Initialized or re-started loader instance or null if the specified callbacks do not create loader for the specified id.

See Also:

UniversiActivityContext.initLoader(int, Bundle, LoaderManager.LoaderCallbacks), UniversiActivityContext.restartLoader(int, Bundle, LoaderManager.LoaderCallbacks), UniversiActivityContext.destroyLoader(int)

initLoader

public <D> android.content.Loader<D> initLoader(int id,
                                                android.os.Bundle params,
                                                android.app.LoaderManager.LoaderCallbacks<D> callbacks)

Description copied from interface: UniversiActivityContext

Initializes a loader with the specified id for the given callbacks.

Specified by:

initLoader in interface UniversiActivityContext

Parameters:

id - Id of the desired loader to init.

params - Params for loader.

callbacks - Callbacks for loader.

Returns:

Initialized loader instance or null if the specified callbacks do not create loader for the specified id.

See Also:

UniversiActivityContext.startLoader(int, Bundle, LoaderManager.LoaderCallbacks), UniversiActivityContext.restartLoader(int, Bundle, LoaderManager.LoaderCallbacks), UniversiActivityContext.destroyLoader(int), LoaderManager.initLoader(int, Bundle, LoaderManager.LoaderCallbacks)

restartLoader

public <D> android.content.Loader<D> restartLoader(int id,
                                                   android.os.Bundle params,
                                                   android.app.LoaderManager.LoaderCallbacks<D> callbacks)

Description copied from interface: UniversiActivityContext

Re-starts a loader with the specified id for the given callbacks.

Specified by:

restartLoader in interface UniversiActivityContext

Parameters:

id - Id of the desired loader to re-start.

params - Params for loader.

callbacks - Callbacks for loader.

Returns:

Re-started loader instance or null if the specified callbacks do not create loader for the specified id.

See Also:

UniversiActivityContext.startLoader(int, Bundle, LoaderManager.LoaderCallbacks), UniversiActivityContext.initLoader(int, Bundle, LoaderManager.LoaderCallbacks), UniversiActivityContext.destroyLoader(int), LoaderManager.restartLoader(int, Bundle, LoaderManager.LoaderCallbacks)

destroyLoader

public void destroyLoader(int id)

Description copied from interface: UniversiActivityContext

Destroys a loader with the specified id.

Specified by:

destroyLoader in interface UniversiActivityContext

Parameters:

id - Id of the desired loader to destroy.

See Also:

UniversiActivityContext.initLoader(int, Bundle, LoaderManager.LoaderCallbacks), UniversiActivityContext.restartLoader(int, Bundle, LoaderManager.LoaderCallbacks), LoaderManager.destroyLoader(int)

onContentChanged

public void onContentChanged()

setSupportActionBar

public void setSupportActionBar(Toolbar toolbar)

onBindViews

protected void onBindViews()

Invoked from onContentChanged() to bind all views presented within context of this activity.

onCreateOptionsMenu

public boolean onCreateOptionsMenu(android.view.Menu menu)

setNavigationalTransition

public void setNavigationalTransition(BaseNavigationalTransition transition)

Description copied from interface: UniversiActivityContext

Sets a navigational transition that will be used to finish this activity context whenever its Activity.finishAfterTransition() is invoked.

Specified by:

setNavigationalTransition in interface UniversiActivityContext

Parameters:

transition - The desired transition. Can be null to clear the current one.

See Also:

UniversiActivityContext.getNavigationalTransition()

getNavigationalTransition

public BaseNavigationalTransition getNavigationalTransition()

Description copied from interface: UniversiActivityContext

Returns the navigational transition that will be used to finish this activity.

Specified by:

getNavigationalTransition in interface UniversiActivityContext

Returns:

Transition or null if no transition has been specified.

See Also:

UniversiActivityContext.setNavigationalTransition(BaseNavigationalTransition)

getFragmentController

public FragmentController getFragmentController()

Description copied from interface: UniversiActivityContext

Returns the controller that can be used to show and hide fragments within context of this activity.

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

Specified by:

getFragmentController in interface UniversiActivityContext

Returns:

The fragment controller of this activity.

See Also:

UniversiActivityContext.setFragmentController(FragmentController)

setFragmentController

public void setFragmentController(FragmentController controller)

Description copied from interface: UniversiActivityContext

Sets a controller that should be used to show and hide fragments within context of this activity.

Specified by:

setFragmentController in interface UniversiActivityContext

Parameters:

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

See Also:

UniversiActivityContext.getFragmentController(), UniversiActivityContext.setFragmentFactory(FragmentFactory)

setFragmentFactory

public void setFragmentFactory(FragmentFactory factory)

Description copied from interface: UniversiActivityContext

Specifies a factory that provides fragment instances for FragmentController of his activity.

Specified by:

setFragmentFactory in interface UniversiActivityContext

Parameters:

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

See Also:

UniversiActivityContext.getFragmentFactory(), UniversiActivityContext.setFragmentController(FragmentController), UniversiActivityContext.getFragmentController()

getFragmentFactory

public FragmentFactory getFragmentFactory()

Description copied from interface: UniversiActivityContext

Returns the current fragment factory specified for this activity.

Specified by:

getFragmentFactory in interface UniversiActivityContext

Returns:

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

See Also:

UniversiActivityContext.setFragmentFactory(FragmentFactory)

setDialogController

public void setDialogController(DialogController controller)

Description copied from interface: UniversiActivityContext

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

Specified by:

setDialogController in interface UniversiActivityContext

Parameters:

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

See Also:

UniversiActivityContext.getDialogController(), UniversiActivityContext.setFragmentFactory(FragmentFactory)

getDialogController

public DialogController getDialogController()

Description copied from interface: UniversiActivityContext

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

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

Specified by:

getDialogController in interface UniversiActivityContext

Returns:

The dialog controller of this activity.

See Also:

UniversiActivityContext.setDialogController(DialogController)

setDialogXmlFactory

public void setDialogXmlFactory(int xmlDialogsSet)

Description copied from interface: UniversiActivityContext

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

Specified by:

setDialogXmlFactory in interface UniversiActivityContext

Parameters:

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

See Also:

UniversiActivityContext.setDialogFactory(DialogFactory)

setDialogFactory

public void setDialogFactory(DialogFactory factory)

Description copied from interface: UniversiActivityContext

Specifies a factory that provides dialog instances for DialogController of this activity.

Specified by:

setDialogFactory in interface UniversiActivityContext

Parameters:

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

See Also:

UniversiActivityContext.getDialogFactory(), UniversiActivityContext.showDialogWithId(int), UniversiActivityContext.showDialogWithId(int, DialogOptions)

getDialogFactory

public DialogFactory getDialogFactory()

Description copied from interface: UniversiActivityContext

Returns the current dialog factory specified for this activity.

Specified by:

getDialogFactory in interface UniversiActivityContext

Returns:

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

See Also:

UniversiActivityContext.setDialogFactory(DialogFactory)

requestBindData

protected void requestBindData()

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

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

onBindData

protected void onBindData()

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

This is always invoked on the UI thread.

onResume

protected void onResume()

isActiveNetworkConnected

public boolean isActiveNetworkConnected()

Description copied from interface: UniversiActivityContext

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

Specified by:

isActiveNetworkConnected in interface UniversiActivityContext

Returns:

True if active network is connected, false otherwise.

See Also:

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

isNetworkConnected

public boolean isNetworkConnected(int networkType)

Description copied from interface: UniversiActivityContext

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

Specified by:

isNetworkConnected in interface UniversiActivityContext

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

public int checkSelfPermission(String permission)

shouldShowRequestPermissionRationale

public boolean shouldShowRequestPermissionRationale(String permission)

supportRequestPermissions

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

Invokes #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)

showDialogWithId

public boolean showDialogWithId(int dialogId)

Description copied from interface: UniversiActivityContext

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

Specified by:

showDialogWithId in interface UniversiActivityContext

showDialogWithId

public boolean showDialogWithId(int dialogId,
                                DialogOptions options)

Description copied from interface: UniversiActivityContext

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

Specified by:

showDialogWithId in interface UniversiActivityContext

Parameters:

dialogId - Id of the desired dialog to show.

options - Options for the dialog.

Returns:

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

See Also:

DialogController#newRequest(int, DialogOptions), UniversiActivityContext.setDialogFactory(DialogFactory), UniversiActivityContext.dismissDialogWithId(int)

dismissDialogWithId

public boolean dismissDialogWithId(int dialogId)

Description copied from interface: UniversiActivityContext

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

Specified by:

dismissDialogWithId in interface UniversiActivityContext

Parameters:

dialogId - Id of the desired dialog to dismiss.

Returns:

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

See Also:

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

showXmlDialog

public boolean showXmlDialog(int resId)

Description copied from interface: UniversiActivityContext

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

Specified by:

showXmlDialog in interface UniversiActivityContext

showXmlDialog

public boolean showXmlDialog(int resId,
                             DialogOptions options)

Description copied from interface: UniversiActivityContext

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

Specified by:

showXmlDialog in interface UniversiActivityContext

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 activity is currently paused or dialog failed to be inflated.

See Also:

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

dismissXmlDialog

public boolean dismissXmlDialog(int resId)

Description copied from interface: UniversiActivityContext

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

Specified by:

dismissXmlDialog in interface UniversiActivityContext

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 activity is currently paused.

See Also:

UniversiActivityContext.showXmlDialog(int, DialogOptions)

onBackPressed

public void onBackPressed()

onBackPress

protected boolean onBackPress()

Invoked from onBackPressed() to give a chance to this activity instance to consume the back press event before it is delivered to its parent.

This implementation first tries to dispatch this event to one of its visible fragment via dispatchBackPressToFragments() and if none of the currently visible fragments does not consume the event a stack with fragments will be popped via popFragmentsBackStack().

Returns:

True if the back press event has been consumed here, false otherwise.

dispatchBackPressToFragments

protected boolean dispatchBackPressToFragments()

Dispatches back press event to all currently visible fragments displayed in context of this activity.

This implementation calls dispatchBackPressToCurrentFragment() and returns its result.

Returns:

True if some of the visible fragments has consumed the back press event, false otherwise.

See Also:

BackPressWatcher#dispatchBackPress()

dispatchBackPressToCurrentFragment

protected boolean dispatchBackPressToCurrentFragment()

Dispatches back press event to the current fragment displayed in context of this activity.

Returns:

True if the current fragment has consumed the back press event, false otherwise.

See Also:

findCurrentFragment(), BackPressWatcher#dispatchBackPress()

findCurrentFragment

protected android.app.Fragment findCurrentFragment()

Finds currently visible fragment that is displayed in context of this activity.

Note, that implementation of this method assumes that this activity uses FragmentController to display its related fragments and that there may be only one fragment visible at a time, that is in a full screen container.

Returns:

Current fragment of this activity (that is at this time visible), or null if there is no fragment presented within fragment container of this activity at all.

popFragmentsBackStack

protected boolean popFragmentsBackStack()

Pops stack with fragments of this activity.

Returns:

True if there was some fragment popped from the stack, false if there were no fragments to pop from.

onPause

protected void onPause()

finishWithNavigationalTransition

public boolean finishWithNavigationalTransition()

Description copied from interface: UniversiActivityContext

Finishes this activity with navigational transition specified via UniversiActivityContext.setNavigationalTransition(BaseNavigationalTransition) (if any).

Specified by:

finishWithNavigationalTransition in interface UniversiActivityContext

Returns:

True if the transition has been used to finish this activity, false if standard framework method (either Activity.finish() or Activity.finishAfterTransition()), depending on the current API level, has been used.