universum.studios.android.universi

Interface UniversiActivityContext

All Known Implementing Classes:

UniversiActivity, UniversiCompatActivity

public interface UniversiActivityContext

Unified interface for activities provided by the Universi framework.

Since:

1.0

Author:

Martin Albedinsky

Method Summary

Modifier and Type	Method and Description
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 showXmlDialog(int, DialogOptions).
boolean	finishWithNavigationalTransition() Finishes this activity with navigational transition specified via setNavigationalTransition(BaseNavigationalTransition) (if any).
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> Loader<D>	initLoader(int id, Bundle params, 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.
<D> Loader<D>	restartLoader(int id, Bundle params, 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.
boolean	showDialogWithId(int dialogId) Same as 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 showXmlDialog(int, DialogOptions) with null options.
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.
<D> Loader<D>	startLoader(int id, Bundle params, LoaderManager.LoaderCallbacks<D> callbacks) Starts a loader with the specified id.

Method Detail

startLoader

@Nullable
<D> Loader<D> startLoader(int id,
                                    @Nullable
                                    Bundle params,
                                    @NonNull
                                    LoaderManager.LoaderCallbacks<D> callbacks)

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.

Type Parameters:

D - Type of data the loader loads.

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:

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

initLoader

@Nullable
<D> Loader<D> initLoader(int id,
                                   @Nullable
                                   Bundle params,
                                   @NonNull
                                   LoaderManager.LoaderCallbacks<D> callbacks)

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

Type Parameters:

D - Type of data the loader loads.

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:

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

restartLoader

@Nullable
<D> Loader<D> restartLoader(int id,
                                      @Nullable
                                      Bundle params,
                                      @NonNull
                                      LoaderManager.LoaderCallbacks<D> callbacks)

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

Type Parameters:

D - Type of data the loader loads.

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:

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

destroyLoader

void destroyLoader(int id)

Destroys a loader with the specified id.

Parameters:

id - Id of the desired loader to destroy.

See Also:

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

setNavigationalTransition

void setNavigationalTransition(@Nullable
                               BaseNavigationalTransition transition)

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

If the given transition is not null this method will also configure incoming transitions for this activity via BaseNavigationalTransition.configureIncomingTransitions(Activity).

Parameters:

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

See Also:

getNavigationalTransition()

getNavigationalTransition

@Nullable
BaseNavigationalTransition getNavigationalTransition()

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

Returns:

Transition or null if no transition has been specified.

See Also:

setNavigationalTransition(BaseNavigationalTransition)

setFragmentController

void setFragmentController(@Nullable
                           FragmentController controller)

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

Parameters:

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

See Also:

getFragmentController(), setFragmentFactory(FragmentFactory)

getFragmentController

@NonNull
FragmentController getFragmentController()

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.

Returns:

The fragment controller of this activity.

See Also:

setFragmentController(FragmentController)

setFragmentFactory

void setFragmentFactory(@Nullable
                        FragmentFactory factory)

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

Parameters:

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

See Also:

getFragmentFactory(), setFragmentController(FragmentController), getFragmentController()

getFragmentFactory

@Nullable
FragmentFactory getFragmentFactory()

Returns the current fragment factory specified for this activity.

Returns:

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

See Also:

setFragmentFactory(FragmentFactory)

setDialogController

void setDialogController(@Nullable
                         DialogController controller)

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

Parameters:

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

See Also:

getDialogController(), setFragmentFactory(FragmentFactory)

getDialogController

@NonNull
DialogController getDialogController()

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.

Returns:

The dialog controller of this activity.

See Also:

setDialogController(DialogController)

setDialogXmlFactory

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 activity.

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:

setDialogFactory(DialogFactory)

setDialogFactory

void setDialogFactory(@Nullable
                      DialogFactory factory)

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

Parameters:

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

See Also:

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

getDialogFactory

@Nullable
DialogFactory getDialogFactory()

Returns the current dialog factory specified for this activity.

Returns:

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

See Also:

setDialogFactory(DialogFactory)

showDialogWithId

boolean showDialogWithId(int dialogId)

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

showDialogWithId

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 activity is currently paused or does not have its dialog factory specified.

See Also:

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

dismissDialogWithId

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 activity is currently paused or does not have its dialog factory specified.

See Also:

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

showXmlDialog

boolean showXmlDialog(@XmlRes
                      int resId)

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

showXmlDialog

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

See Also:

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

dismissXmlDialog

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

See Also:

showXmlDialog(int, DialogOptions)

isActiveNetworkConnected

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

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

finishWithNavigationalTransition

boolean finishWithNavigationalTransition()

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

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.