RPFormStep class

A RPFormStep is a special type of RPQuestionStep, used for presenting multiple questions on a single scrollable page.

Questions in the form is represented by an list of questions and all questions needs to be answered (or be optional) in order to proceed from the form.

The result of an RPFormStep is an RPStepResult that consists further RPStepResults for each question in the form.

Inheritance
Annotations
  • @JsonSerializable(includeIfNull: false, explicitToJson: true)

Constructors

RPFormStep({required String identifier, required String title, bool optional = false, bool autoSkip = false, Duration timeout = const Duration(seconds: 0), required List<RPQuestionStep> questions, bool saveResultsOnAutoSkip = false, bool forceWait = false, String? footnote})
Create a new RPFormStep holding a list of questions.
RPFormStep.fromJson(Map<String, dynamic> json)
factory

Properties

$type ↔ String?
The runtime class name (type) of this object. Used for deserialization from JSON objects.
getter/setter pairinherited
answerFormat ↔ RPAnswerFormat
The answer format which describes the format how a question can be answered.
getter/setter pairinherited
autoFocus ↔ bool
Should the keyboard automatically be displayed when asking a text question? Applies only to RPTextAnswerFormat questions. False by default.
getter/setter pairinherited
autoSkip ↔ bool
Should we automatically move to the next step after timeout seconds? False by default.
getter/setter pairinherited
footnote ↔ String?
Optional footer text to be displayed below the question. This can be used to provide additional information, such as copyright, or instructions. This text will be displayed in a smaller font size.
getter/setter pairinherited
forceWait ↔ bool
If forceWait is true, the RPTimerStep will only allow to move to next step after finishing the countdown. If 'false' the "next" will be possible respecting the mandatory/optional option defined above. This is false by default.
getter/setter pair
fromJsonFunction → Function
The function which can convert a JSON string to an object of this type.
no setteroverride
hashCode → int
The hash code for this object.
no setterinherited
identifier → String
A unique identifier of the Step. This identifier connects the step to its result (RPResult) object.
finalinherited
jsonType → String
Return the __type to be used for JSON serialization of this class. Default is runtimeType. Only specify this if you need another type.
no setterinherited
optional ↔ bool
Can this step be skipped? If so, the result for the step will be null.
getter/setter pairinherited
placeholder ↔ String?
The placeholder text for the Question Steps using an answer format which requires text entry
getter/setter pairinherited
questions ↔ List<RPQuestionStep>
The list of questions to be shown on the form.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
saveResultsOnAutoSkip ↔ bool
Should any preliminary results from this form be collected and saved, even if autoSkip is enabled?
getter/setter pair
stepWidget → Widget
The widget (UI representation) of the step.
no setteroverride
text ↔ String?
The text of the Step. Different types of Steps are using the text text differently.
getter/setter pairinherited
timeout ↔ Duration
If autoSkip is true, defines how long to wait for the answer before automatically skipping to the next step.
getter/setter pairinherited
timer ↔ Timer?
getter/setter pairinherited
title ↔ String
The title text. Different types of Steps are using the title text differently.
getter/setter pairinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
Return a JSON encoding of this object.
override
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited