org.researchstack.skin

Class UiManager

java.lang.Object

org.researchstack.skin.UiManager

public abstract class UiManager
extends java.lang.Object

UiManager is responsible for providing an a way to define certain aspects of the UI that cannot be provided / genreated by the framework.

Constructor Summary

Constructors

Constructor and Description
UiManager()

Method Summary

Modifier and Type	Method and Description
abstract org.researchstack.backbone.step.Step	getInclusionCriteriaStep(android.content.Context context) Includsion Criteria Step is one of the first Steps the user will come in contact with.
static UiManager	getInstance() Returns a singleton static instance of the this class
abstract java.util.List<ActionItem>	getMainActionBarItems() All ActionItems returned by this method should define a title, icon, and class.
abstract java.util.List<ActionItem>	getMainTabBarItems() All ActionItems returned by this method should define a title, icon, and class.
java.lang.Class<?>	getTaskNotificationReceiver() Returns the BroadCastReceiver class responsible for consuming alarms for triggering Notifications
static void	init(UiManager manager) Initializes the UiManager singleton.
boolean	isConsentSkippable() Used in onboarding to hide the "skip consent" button.
abstract boolean	isInclusionCriteriaValid(org.researchstack.backbone.result.StepResult result) Method used by the framework to show if the user the result of the getInclusionCriteriaStep(Context).

Methods inherited from class java.lang.Object

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

Constructor Detail

UiManager

public UiManager()

Method Detail

init

public static void init(UiManager manager)

Initializes the UiManager singleton. It is best to call this method inside your Application.onCreate() method.

Parameters:

manager - an implementation of UiManager

getInstance

public static UiManager getInstance()

Returns a singleton static instance of the this class

Returns:

A singleton static instance of the this class

getMainActionBarItems

public abstract java.util.List<ActionItem> getMainActionBarItems()

All ActionItems returned by this method should define a title, icon, and class. These ActionItems are used to populate an ActionBar in the main Activity, so the class should be that of activity (either SettingsActivity & LearnActivity or your own items)

Returns:

a list of ActionItems for display in the MainActivity ActionBar

getMainTabBarItems

public abstract java.util.List<ActionItem> getMainTabBarItems()

All ActionItems returned by this method should define a title, icon, and class. These items are used to fill a pager in the MainActivity. The framework uses the class objects from this list to create a Fragments for tha pager. It is imperative that the defined classes be of instance Fragment.

Returns:

a list of ActionItems for display in the MainActivity ActionBar

getInclusionCriteriaStep

public abstract org.researchstack.backbone.step.Step getInclusionCriteriaStep(android.content.Context context)

Includsion Criteria Step is one of the first Steps the user will come in contact with. It is a question / form of questions whos result is used to see if the user elligible or inelligible for the study. That result in calculate and returned within isInclusionCriteriaValid(StepResult)

Parameters:

context - android context

Returns:

a Step used for Eligibility within the onboarding process

isInclusionCriteriaValid

public abstract boolean isInclusionCriteriaValid(org.researchstack.backbone.result.StepResult result)

Method used by the framework to show if the user the result of the getInclusionCriteriaStep(Context).

Parameters:

result - StepResult object that contains the answers of the InclusionCriteria step

Returns:

true if the user is elligible for the study

isConsentSkippable

public boolean isConsentSkippable()

Used in onboarding to hide the "skip consent" button. Override this if you want to allow the user to get to the main portion of the app without signing up for the study and consenting. All data will still be collected and uploaded when the user successfully signs up for the first time Defaults to false.

Returns:

true if consent is skippable

getTaskNotificationReceiver

public java.lang.Class<?> getTaskNotificationReceiver()

Returns the BroadCastReceiver class responsible for consuming alarms for triggering Notifications

Returns:

BroadCastReceiver class responsible for consuming alarms for triggering Notifications