org.researchstack.backbone.step

Class ConsentVisualStep

java.lang.Object

org.researchstack.backbone.step.Step

org.researchstack.backbone.step.ConsentVisualStep

All Implemented Interfaces:

java.io.Serializable

public class ConsentVisualStep
extends Step

The ConsentVisualStep class represents a step in the visual consent sequence.

In the ResearchStack framework, an ConsentVisualStep object is used to present a simple graphic to help study participants understand the content of an informed consent document.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ConsentVisualStep(java.lang.String identifier)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getNextButtonString() Deprecated.
ConsentSection	getSection() Returns the ConsentSection associated with this step.
java.lang.Class	getStepLayoutClass() Returns the class that the ViewTaskActivity should instantiate to display this step.
int	getStepTitle() Gets the int id for the title to display in the action bar (optional).
void	setNextButtonString(java.lang.String nextButtonString) Deprecated.
void	setSection(ConsentSection section) Sets the ConsentSection for this step.

Methods inherited from class org.researchstack.backbone.step.Step

getIdentifier, getText, getTitle, isOptional, setOptional, setStepLayoutClass, setStepTitle, setText, setTitle

Methods inherited from class java.lang.Object

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

Constructor Detail

ConsentVisualStep

public ConsentVisualStep(java.lang.String identifier)

Method Detail

getStepTitle

public int getStepTitle()

Description copied from class: Step

Gets the int id for the title to display in the action bar (optional).

Overrides:

getStepTitle in class Step

Returns:

the id for the title to display in the action bar

getStepLayoutClass

public java.lang.Class getStepLayoutClass()

Description copied from class: Step

Returns the class that the ViewTaskActivity should instantiate to display this step.

This method is used within the framework so that steps can define their step view controller pairing.

Outside the framework, developers should instantiate the required view controller in their ViewTaskActivity delegate to override the ViewTaskActivity's default.

Overrides:

getStepLayoutClass in class Step

Returns:

the class of the StepLayout for this step

getSection

public ConsentSection getSection()

Returns the ConsentSection associated with this step.

Returns:

the consent section for this step

setSection

public void setSection(ConsentSection section)

Sets the ConsentSection for this step.

This includes everything needed by the ConsentVisualStepLayout to render the step.

Parameters:

section - the consent section

getNextButtonString

@Deprecated
public java.lang.String getNextButtonString()

Deprecated.

setNextButtonString

@Deprecated
public void setNextButtonString(java.lang.String nextButtonString)

Deprecated.