ORKFormStepViewController Class Reference

Inherits from ORKStepViewController : UIViewController
Declared in ORKFormStepViewController.h
ORKFormStepViewController.m

Overview

The ORKFormStepViewController class is the concrete ORKStepViewController implementation for ORKFormStep.

You should not need to instantiate a form step view controller directly. Instead, create an ORKFormStep object and include it in a task for an ORKTaskViewController object, and present the task view controller. The task view controller automatically instantiates the form step view controller when it encounters a form step and needs to present it.

– initWithStep:

Returns a new step view controller for the specified step.

- (instancetype)initWithStep:(ORKStep *)step

Parameters

step

The step to be presented.

Return Value

A newly initialized step view controller.

Declared In

ORKStepViewController.h

– initWithStep:result:

Returns a new step view controller for the specified step.

- (instancetype)initWithStep:(ORKStep *)step result:(ORKResult *)result

Parameters

step

The step to be presented.

result

The current step result for this step.

Return Value

A newly initialized step view controller.

Declared In

ORKStepViewController.h

– setCancelButtonItem:

The cancel button item.

- (void)setCancelButtonItem:(UIBarButtonItem *)cancelButtonItem

Discussion

The cancel button item controls the Cancel button displayed in the navigation bar when the step view controller is current. This property lets you control the appearance and target of the Cancel button at runtime.

When the value of the property is nil, the Cancel button is not displayed; otherwise, the title, target, and action associated with the Cancel button item are used (other properties of UIBarButtonItem are ignored).

The cancel button item is updated during view loading and when the value of the step property is changed, but is safe to set in the taskViewController:stepViewControllerWillAppear: delegate callback.

Subclasses can safely modify this property any time after calling viewWillAppear: on super.

Declared In

ORKStepViewController.h

– result

The current state of the result. (read-only)

- (ORKStepResult *)result

Discussion

The task view controller uses this property to get the results for the step, and to collate them into the task result.

The current step result and any subsidiary results representing data collected so far are available in this property. You can detect significant changes to the result, such as when the user enters a new answer, using the stepViewControllerResultDidChange: delegate callback.

Subclasses must use this property to return the current results. Subclasses may call super to obtain a clean, empty result object appropriate for the step, to which they can attach appropriate child results.

The implementations of this method in the ResearchKit framework currently create a new result object on every call, so do not call this method unless it is actually necessary.

Declared In

ORKStepViewController.h

– skipForward

This method is called when the user taps the skip button. By default, it calls goForward.

- (void)skipForward

Declared In

ORKStepViewController.h

– goBackward

Navigates backward to the previous step.

- (void)goBackward

Discussion

When a user taps the Back button, the information passes through this method. You can use this method as an override point or a target action for a subclass.

Declared In

ORKStepViewController.h