com.robopupu.api.feature

Interface Feature

All Superinterfaces:

PluginComponent, PluginStateComponent, PresenterListener

All Known Implementing Classes:

AbstractFeature

public interface Feature
extends PresenterListener, PluginStateComponent

Feature defines an interface for PluginStateComponents that implement of application feature as a component. A concrete Feature implementation may implement logic for UI navigation and UI flow logic. A Feature is also a DependencyScopeOwner that provides a DependencyScope for providing dependencies.

Method Summary

Modifier and Type	Method and Description
FeatureView	addActiveView(FeatureView view) Adds the given FeatureView to the set of currently active FeatureViews of this Feature.
boolean	canGoBack() Tests if the previous FeatureView can be navigated back to.
void	clearBackStack() Clears the back stack managed by FragmentManager.
void	finish() Finishes this Feature.
java.util.List<FeatureView>	getActiveViews() Gets the currently active FeatureViews.
FeatureContainer	getFeatureContainer() Gets the FeatureContainer that hosts the FeatureCompatFragments of this Feature.
Params	getParams() Gets the Params provided for the Feature when started.
Feature	getParentFeature() Gets the parent Feature of this Feature.
void	goBack() Goes back to previous FeatureView.
boolean	hasBackStackViews() Tests if this Feature has any FeatureViews in back stack.
boolean	hasForegroundView() Tests if this Feature is in foreground i.e.
void	hideView(java.lang.Class<? extends Presenter> presenterClass, boolean addedToBackStack, java.lang.String tag) Hides the FeatureView attached to the given Presenter.
void	hideView(FeaturePresenter presenter, boolean addedToBackStack, java.lang.String tag) Hides the FeatureView attached to the given Presenter.
boolean	isActiveView(FeatureView view) Tests if the given FeatureView is currently active one.
boolean	isActivityFeature() Tests if this Feature is set to be an Activity Feature that is owned and controlled by an Activity.
boolean	isBackPressedEventHandler() Tests if this Feature handles the back pressed event.
void	onFeatureContainerPaused(FeatureContainer container, boolean finishing) Invoked when a FeatureContainer has been paused.
void	onFeatureContainerResumed(FeatureContainer container) Invoked when a FeatureContainer has been resumed.
void	onFeatureContainerStarted(FeatureContainer container) Invoked when a FeatureContainer has been started.
void	onFeatureContainerStopped(FeatureContainer container, boolean finishing) Invoked when a FeatureContainer has been stopped.
void	pause(boolean finishing) Invoked to pause this Feature.
FeatureView	removeActiveView(FeatureView view) Removes the given FeatureView from the set of currently active FeatureViews of this Feature.
void	setActivityFeature(boolean isActivityFeature) Sets this Feature to be an Activity Feature that is owned and controlled by an Activity.
void	setFeatureContainer(FeatureContainer container) Sets the the FeatureContainer that hosts the FeatureCompatFragments of this Feature.
void	setFeatureManager(FeatureManager manager) Sets the FeatureManager that started this Feature.
void	setParentFeature(Feature parentFeature) Sets the parent Feature of this Feature.
FeatureView	showView(java.lang.Class<? extends Presenter> presenterClass, boolean addToBackStack, Params... params) Shows the FeatureView attached to the specified Presenter.
FeatureView	showView(FeatureTransitionManager transitionManager, java.lang.Class<? extends Presenter> presenterClass, boolean addToBackStack, java.lang.String tag, Params... params) Shows the FeatureView attached to the specified Presenter.
FeatureView	showView(int featureContainerId, java.lang.Class<? extends Presenter> presenterClass, boolean addToBackStack, java.lang.String tag, Params... params) Shows the FeatureView attached to the specified Presenter.

Methods inherited from interface com.robopupu.api.mvp.PresenterListener

onPresenterFinished

Methods inherited from interface com.robopupu.api.plugin.PluginStateComponent

destroy, getLifecycleState, getState, isDestroyed, isPaused, isRestarted, isResumed, isStarted, isStopped, pause, restart, resume, start, start, stop

Methods inherited from interface com.robopupu.api.plugin.PluginComponent

onPlugged, onPluginPlugged, onPluginUnplugged, onUnplugged

Method Detail

getActiveViews

java.util.List<FeatureView> getActiveViews()

Gets the currently active FeatureViews.

Returns:

A List containing the currently active views as FeatureViews.

isActiveView

boolean isActiveView(FeatureView view)

Tests if the given FeatureView is currently active one.

Parameters:

view - A FeatureView.

Returns:

A boolean value.

getParams

Params getParams()

Gets the Params provided for the Feature when started.

Returns:

A Params. May return null.

addActiveView

FeatureView addActiveView(FeatureView view)

Adds the given FeatureView to the set of currently active FeatureViews of this Feature.

Parameters:

view - A FeatureView to be added.

Returns:

The FeatureView if it was added as a new active FeatureView.

removeActiveView

FeatureView removeActiveView(FeatureView view)

Removes the given FeatureView from the set of currently active FeatureViews of this Feature.

Parameters:

view - A FeatureView to be removed.

Returns:

The FeatureView if it was removed from being an active FeatureView.

setFeatureManager

void setFeatureManager(FeatureManager manager)

Sets the FeatureManager that started this Feature.

Parameters:

manager - A FeatureManager.

getFeatureContainer

FeatureContainer getFeatureContainer()

Gets the FeatureContainer that hosts the FeatureCompatFragments of this Feature.

Returns:

A FeatureContainer.

setFeatureContainer

void setFeatureContainer(FeatureContainer container)

Sets the the FeatureContainer that hosts the FeatureCompatFragments of this Feature.

Parameters:

container - A FeatureContainer.

getParentFeature

Feature getParentFeature()

Gets the parent Feature of this Feature.

Returns:

A Feature.

setParentFeature

void setParentFeature(Feature parentFeature)

Sets the parent Feature of this Feature.

Parameters:

parentFeature - A Feature.

setActivityFeature

void setActivityFeature(boolean isActivityFeature)

Sets this Feature to be an Activity Feature that is owned and controlled by an Activity.

Parameters:

isActivityFeature - A boolean value.

isActivityFeature

boolean isActivityFeature()

Tests if this Feature is set to be an Activity Feature that is owned and controlled by an Activity.

Returns:

A boolean value.

hasForegroundView

boolean hasForegroundView()

Tests if this Feature is in foreground i.e. it has at least one visible FeatureView.

Returns:

A boolean value.

isBackPressedEventHandler

boolean isBackPressedEventHandler()

Tests if this Feature handles the back pressed event.

Returns:

A boolean value.

hasBackStackViews

boolean hasBackStackViews()

Tests if this Feature has any FeatureViews in back stack.

Returns:

A boolean value.

clearBackStack

void clearBackStack()

Clears the back stack managed by FragmentManager.

canGoBack

boolean canGoBack()

Tests if the previous FeatureView can be navigated back to.

Returns:

A boolean value.

goBack

void goBack()

Goes back to previous FeatureView.

pause

void pause(boolean finishing)

Invoked to pause this Feature.

Parameters:

finishing - A boolean value indicating if the Feature is going to be finished i.e. it is not resumed nor restarted anymore.

finish

void finish()

Finishes this Feature. A finished Feature is stopped and destroyed. If a Feature is implements a PluginComponent it is unplugged from a PluginBus.

showView

FeatureView showView(java.lang.Class<? extends Presenter> presenterClass,
                     boolean addToBackStack,
                     Params... params)

Shows the FeatureView attached to the specified Presenter.

Parameters:

presenterClass - A Class specifying the Presenter.

addToBackStack - A boolean value specifying if the FeatureView is added to back stack.

params - Optional Params.

Returns:

A FeatureView. May be PlugInvoker.

showView

FeatureView showView(int featureContainerId,
                     java.lang.Class<? extends Presenter> presenterClass,
                     boolean addToBackStack,
                     java.lang.String tag,
                     Params... params)

Shows the FeatureView attached to the specified Presenter. The FeatureView is shown using the specified FeatureContainer.

Parameters:

featureContainerId - An id of the FeatureContainer.

presenterClass - A Class specifying the Presenter.

addToBackStack - A boolean value specifying if the FeatureView is to be added to back stack.

tag - A tag for the FeatureView used for FragmentTransaction. May be null.

params - Optional Params.

Returns:

A FeatureView. May be PlugInvoker.

showView

FeatureView showView(FeatureTransitionManager transitionManager,
                     java.lang.Class<? extends Presenter> presenterClass,
                     boolean addToBackStack,
                     java.lang.String tag,
                     Params... params)

Shows the FeatureView attached to the specified Presenter. The FeatureView is shown using the given FeatureTransitionManager.

Parameters:

transitionManager - A FeatureTransitionManager.

presenterClass - A Class specifying the Presenter.

addToBackStack - A boolean value specifying if the FeatureView is to be added to back stack.

tag - A tag for the FeatureView used for FragmentTransaction. May be null.

params - Optional Params.

Returns:

A FeatureView. May be PlugInvoker.

hideView

void hideView(java.lang.Class<? extends Presenter> presenterClass,
              boolean addedToBackStack,
              java.lang.String tag)

Hides the FeatureView attached to the given Presenter.

Parameters:

presenterClass - A Presenter.

addedToBackStack - A boolean value specifying if the FeatureView was added to backstack.

tag - A tag for the FeatureView used for FragmentTransaction. May be null.

hideView

void hideView(FeaturePresenter presenter,
              boolean addedToBackStack,
              java.lang.String tag)

Hides the FeatureView attached to the given Presenter.

Parameters:

presenter - A Presenter.

addedToBackStack - A boolean value specifying if the FeatureView was added to backstack.

tag - A tag for the FeatureView used for FragmentTransaction. May be null.

onFeatureContainerStarted

void onFeatureContainerStarted(FeatureContainer container)

Invoked when a FeatureContainer has been started.

Parameters:

container - A FeatureContainer.

onFeatureContainerPaused

void onFeatureContainerPaused(FeatureContainer container,
                              boolean finishing)

Invoked when a FeatureContainer has been paused.

Parameters:

container - A FeatureContainer.

finishing - A boolean flag indicating if the FeatureContainer is finishing.

onFeatureContainerResumed

void onFeatureContainerResumed(FeatureContainer container)

Invoked when a FeatureContainer has been resumed.

Parameters:

container - A FeatureContainer.

onFeatureContainerStopped

void onFeatureContainerStopped(FeatureContainer container,
                               boolean finishing)

Invoked when a FeatureContainer has been stopped.

Parameters:

container - A FeatureContainer.

finishing - A boolean flag indicating if the FeatureContainer is finishing.