org.researchstack.backbone.step

Class InstructionStep

java.lang.Object

org.researchstack.backbone.step.Step

org.researchstack.backbone.step.InstructionStep

All Implemented Interfaces:

java.io.Serializable

public class InstructionStep
extends Step

An InstructionStep object gives the participant instructions for a task.

You can use instruction steps to present various types of content during a task, such as introductory content, instructions in the middle of a task, or a final message at the completion of a task.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
InstructionStep(java.lang.String identifier, java.lang.String title, java.lang.String detailText)

Method Summary

Modifier and Type	Method and Description
java.lang.Class	getStepLayoutClass() Returns the class that the ViewTaskActivity should instantiate to display this step.

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

getIdentifier, getStepTitle, 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

InstructionStep

public InstructionStep(java.lang.String identifier,
                       java.lang.String title,
                       java.lang.String detailText)

Method Detail

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