universum.studios.android.universi

Class UniversiContextDelegate

java.lang.Object

universum.studios.android.universi.UniversiContextDelegate

Direct Known Subclasses:

UniversiActivityDelegate, UniversiFragmentDelegate

public abstract class UniversiContextDelegate
extends Object

Context delegate of which implementations are used by UniversiActivity, UniversiCompatActivity and UniversiActivity to provide features in unified 'fashion' regardless of context in which are these features supported.

A the current version this context delegate supports features described below:

1) DialogFragments management

This feature is supported using DialogController. This controller can be accessed via getDialogController() and custom controller can be specified via setDialogController(DialogController).

Without any set up this delegate can be used to show any implementation of XmlDialog via showXmlDialog(int, DialogOptions) where for such case will be created internal instance of DialogXmlFactory used to inflate such dialogs from an Xml file containing a single dialog entry.

If the associated context wants to display XmlDialogs from an Xml file containing a set of multiple dialog entries or just simple dialogs instantiated via plain Java code it need to set instance of DialogFactory that can provide that dialogs via setDialogFactory(DialogFactory). Such dialogs can be than displayed via showDialogWithId(int, DialogOptions).

Already showing dialogs can be dismissed via dismissDialogWithId(int) or dismissXmlDialog(int).

If the associated context is paused (indicated via setPaused(boolean)), invoking one of showDialog(...) methods will be ignored.

2) Connection checking

Check whether there is some network connection established or not can be done via isActiveNetworkConnected() or for a specific connection type via isNetworkConnected(int) for that matter.

Since:

1.0

Author:

Martin Albedinsky

Method Summary

Modifier and Type	Method and Description
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).
DialogController	getDialogController() Returns the controller that can be used to show and dismiss dialogs within context that uses this delegate
DialogFactory	getDialogFactory() Returns the current dialog factory specified for this delegate.
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.
boolean	isPaused() Returns the boolean flag indicating whether the related context is paused or not.
boolean	isRequestRegistered(int requestFlag) Checks whether a request with the specified request flag is registered or not.
boolean	isStateSaved() Returns the boolean flag indicating whether state of the associated context has been already saved or not.
boolean	isViewCreated() Returns the boolean flag indicating whether view hierarchy of the associated context is created or not.
void	registerRequest(int requestFlag) Adds a request with the specified request flag into the registered ones.
void	setDialogController(DialogController controller) Sets a controller that should be used to show and dismiss dialogs within context that uses this delegate.
void	setDialogFactory(DialogFactory factory) Specifies a factory that should provide dialog instances for DialogController of this delegate.
void	setDialogXmlFactory(int xmlDialogsSet) Same as setDialogFactory(DialogFactory) where will be passed instance of DialogXmlFactory with the specified xmlDialogsSet.
void	setPaused(boolean paused) Sets a boolean flag indicating whether the associated context has been paused or not.
void	setStateSaved(boolean saved) Sets a boolean flag indicating whether state of the associated context has been saved or not.
void	setViewCreated(boolean created) Sets a boolean flag indicating whether a view hierarchy of the associated context is created or not.
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, 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.
void	unregisterRequest(int requestFlag) Removes request with the specified request flag from the registered ones.

Methods inherited from class java.lang.Object

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

Method Detail

setDialogController

public void setDialogController(@Nullable
                                DialogController controller)

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

Parameters:

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

See Also:

getDialogController()

getDialogController

@NonNull
public DialogController getDialogController()

Returns the controller that can be used to show and dismiss dialogs within context that uses this delegate

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

Returns:

The dialog controller of this delegate.

See Also:

setDialogController(DialogController)

setDialogXmlFactory

public void setDialogXmlFactory(@XmlRes
                                int xmlDialogsSet)

Same as setDialogFactory(DialogFactory) where will be passed instance of DialogXmlFactory with the specified xmlDialogsSet.

Parameters:

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

setDialogFactory

public void setDialogFactory(@Nullable
                             DialogFactory factory)

Specifies a factory that should provide dialog instances for DialogController of this delegate.

Parameters:

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

See Also:

getDialogFactory(), showDialogWithId(int, DialogOptions)

getDialogFactory

@Nullable
public DialogFactory getDialogFactory()

Returns the current dialog factory specified for this delegate.

Returns:

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

See Also:

setDialogFactory(DialogFactory)

showDialogWithId

public 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 context that uses this delegate is currently paused or its state has been already saved or does not have its dialog factory specified.

See Also:

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

dismissDialogWithId

public 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 context that uses this delegate is currently paused or does not have its dialog factory specified.

See Also:

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

showXmlDialog

public 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 context that uses this delegate is currently paused or its state has been already saved or dialog failed to be inflated.

See Also:

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

dismissXmlDialog

public 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 context that uses this delegate is currently paused.

See Also:

showXmlDialog(int, DialogOptions)

isActiveNetworkConnected

public 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

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

setViewCreated

public void setViewCreated(boolean created)

Sets a boolean flag indicating whether a view hierarchy of the associated context is created or not.

Parameters:

created - True if view hierarchy is created, false otherwise.

See Also:

isViewCreated()

isViewCreated

public boolean isViewCreated()

Returns the boolean flag indicating whether view hierarchy of the associated context is created or not.

Returns:

True if view is created, false otherwise.

See Also:

setViewCreated(boolean)

setStateSaved

public void setStateSaved(boolean saved)

Sets a boolean flag indicating whether state of the associated context has been saved or not.

Parameters:

saved - True if state has been saved, false otherwise.

See Also:

isStateSaved()

isStateSaved

public boolean isStateSaved()

Returns the boolean flag indicating whether state of the associated context has been already saved or not.

This should be true after state of context is saved and before that context is resumed.

Returns:

True if state has been saved, false otherwise.

See Also:

setStateSaved(boolean)

setPaused

public void setPaused(boolean paused)

Sets a boolean flag indicating whether the associated context has been paused or not.

Parameters:

paused - True if context is paused, false otherwise.

See Also:

()

isPaused

public boolean isPaused()

Returns the boolean flag indicating whether the related context is paused or not.

This should be true after context is paused and before it is again resumed.

Returns:

True if context is paused, false otherwise.

See Also:

setPaused(boolean)

registerRequest

public void registerRequest(int requestFlag)

Adds a request with the specified request flag into the registered ones.

Parameters:

requestFlag - The request flag that should be registered.

See Also:

isRequestRegistered(int), unregisterRequest(int)

unregisterRequest

public void unregisterRequest(int requestFlag)

Removes request with the specified request flag from the registered ones.

Parameters:

requestFlag - The request flag that should be unregistered.

See Also:

registerRequest(int), isRequestRegistered(int)

isRequestRegistered

public boolean isRequestRegistered(int requestFlag)

Checks whether a request with the specified request flag is registered or not.

Parameters:

requestFlag - The request flag for which to check if it is registered.

Returns:

True if request is registered, false otherwise.

See Also:

registerRequest(int), unregisterRequest(int)