universum.studios.android.universi

Class UniversiActivityDelegate

java.lang.Object

universum.studios.android.universi.UniversiContextDelegate

universum.studios.android.universi.UniversiActivityDelegate

public class UniversiActivityDelegate
extends UniversiContextDelegate

An UniversiContextDelegate implementation that can be used within context of Activity. Activity delegate has additional support for Fragments management via FragmentController. Fragment controller can be accessed via getFragmentController() and custom controller can be specified via setFragmentController(FragmentController). Fragment factory that provides fragments to be displayed in a context of a specific UniversiActivity can be specified via setFragmentFactory(FragmentFactory).

Navigational transition that can be specified via setNavigationalTransition(BaseNavigationalTransition) can be used to finish the associated activity.

Note that this class has not been made final on purpose so it may be easily mocked in tests, thought it should not been extended.

Since:

1.0

Author:

Martin Albedinsky

See Also:

UniversiFragmentDelegate

Method Summary

Modifier and Type	Method and Description
static UniversiActivityDelegate	create(androidx.fragment.app.FragmentActivity activity) Creates a new instance of UniversiActivityDelegate for the given activity.
protected DialogController	createDialogController() Invoked to create a new instance of DialogController for the context that uses this delegate.
androidx.fragment.app.Fragment	findCurrentFragment() Searches for current fragment displayed in container that is used by FragmentController of this delegate to show fragments in the context of the associated activity.
boolean	finishWithNavigationalTransition() Finishes the associated activity with navigational transition specified via setNavigationalTransition(BaseNavigationalTransition) (if any).
FragmentController	getFragmentController() Returns the default controller or the one specified via setFragmentController(FragmentController) that is used to manage fragments of the associated activity.
FragmentFactory	getFragmentFactory() Returns the factory providing fragment instances for fragment controller of this delegate.
BaseNavigationalTransition	getNavigationalTransition() Returns the navigational transition used to finish associated activity via finishWithNavigationalTransition().
protected void	onDestroy() Invoked whenever UniversiContextDelegate.destroy() is called for this delegate to perform its destroy operation while this delegate is not yet in destroyed state.
boolean	popFragmentsBackStack() Pops stack with fragments of the associated activity via FragmentManager.popBackStack()
protected android.content.Context	requireContext() Called to obtain context to be used by this delegate.
void	setFragmentController(FragmentController controller) Sets a controller used to manage (show/hide) fragments in context of the associated activity.
void	setFragmentFactory(FragmentFactory factory) Sets a factory that provides fragment instances for fragment controller of this delegate.
void	setNavigationalTransition(BaseNavigationalTransition transition) Sets a navigational transition that can be used to finish associated activity via finishWithNavigationalTransition().

Methods inherited from class universum.studios.android.universi.UniversiContextDelegate

destroy, dismissDialogWithId, dismissXmlDialog, getDialogController, getDialogFactory, isDestroyed, isPaused, isRequestRegistered, isViewCreated, registerRequest, setDialogController, setDialogFactory, setDialogXmlFactory, setPaused, setViewCreated, showDialogWithId, showXmlDialog, unregisterRequest

Methods inherited from class java.lang.Object

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

Method Detail

create

@NonNull
public static UniversiActivityDelegate create(@NonNull
                                                       androidx.fragment.app.FragmentActivity activity)

Creates a new instance of UniversiActivityDelegate for the given activity.

Do not forget to destroy the new delegate via UniversiContextDelegate.destroy() when the activity is also destroyed.

Parameters:

activity - The activity context in which will be the new delegate used.

Returns:

Ready to be used delegate.

requireContext

@NonNull
protected android.content.Context requireContext()

Description copied from class: UniversiContextDelegate

Called to obtain context to be used by this delegate.

Specified by:

requireContext in class UniversiContextDelegate

Returns:

The context ready to be used.

createDialogController

@NonNull
protected final DialogController createDialogController()

Description copied from class: UniversiContextDelegate

Invoked to create a new instance of DialogController for the context that uses this delegate.

Specified by:

createDialogController in class UniversiContextDelegate

Returns:

New DialogController instance.

setNavigationalTransition

public void setNavigationalTransition(@Nullable
                                      BaseNavigationalTransition transition)

Sets a navigational transition that can be used to finish associated activity via finishWithNavigationalTransition().

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

Parameters:

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

See Also:

getNavigationalTransition()

getNavigationalTransition

@Nullable
public BaseNavigationalTransition getNavigationalTransition()

Returns the navigational transition used to finish associated activity via finishWithNavigationalTransition().

Returns:

Attached navigational transition or null if no transition has been specified.

See Also:

setNavigationalTransition(BaseNavigationalTransition)

finishWithNavigationalTransition

public boolean finishWithNavigationalTransition()

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

Returns:

True if transition has been started, false otherwise.

setFragmentController

public void setFragmentController(@Nullable
                                  FragmentController controller)

Sets a controller used to manage (show/hide) fragments in context of the associated activity.

Parameters:

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

See Also:

getFragmentController(), setFragmentFactory(FragmentFactory)

getFragmentController

@NonNull
public FragmentController getFragmentController()

Returns the default controller or the one specified via setFragmentController(FragmentController) that is used to manage fragments of the associated activity.

Returns:

Fragment controller instance ready to show/hide fragment instances.

setFragmentFactory

public void setFragmentFactory(@Nullable
                               FragmentFactory factory)

Sets a factory that provides fragment instances for fragment controller of this delegate.

Parameters:

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

See Also:

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

getFragmentFactory

@Nullable
public FragmentFactory getFragmentFactory()

Returns the factory providing fragment instances for fragment controller of this delegate.

Returns:

Instance of fragment factory or null if no factory has been specified.

See Also:

setFragmentFactory(FragmentFactory)

findCurrentFragment

@Nullable
public androidx.fragment.app.Fragment findCurrentFragment()

Searches for current fragment displayed in container that is used by FragmentController of this delegate to show fragments in the context of the associated activity.

Returns:

Instance of current fragment found via FragmentController.findCurrentFragment() or null if there is no fragment displayed.

popFragmentsBackStack

public boolean popFragmentsBackStack()

Pops stack with fragments of the associated activity via FragmentManager.popBackStack()

Returns:

True if the stack has ben popped, false otherwise.

onDestroy

protected void onDestroy()

Description copied from class: UniversiContextDelegate

Invoked whenever UniversiContextDelegate.destroy() is called for this delegate to perform its destroy operation while this delegate is not yet in destroyed state.

Overrides:

onDestroy in class UniversiContextDelegate