WizardController class abstract

Coordinates the wizard steps and its input control states.

Implementers

Constructors

WizardController()

Properties

eventStream → Stream<WizardEvent>
Streams the events that happen on this WizardController. The events have a base type of WizardEvent and can be casted to the specific event type. The events are:
no setter
hashCode → int
The hash code for this object.
no setterinherited
index → int
The current wizard step index.
no setter
indexStream → Stream<int>
Streams the wizard step index.
no setter
pageController → PageController
Controller to control the page view.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
stepControllers → List<WizardStepController>
The step controllers.
no setter
stepCount → int
The step count.
no setter

Methods

copyWith({List<WizardStepController>? stepControllers, int? index, StepCallback? onStepChanged}) → WizardController
Create a copy with the provided values
disableGoBack(int index) → void
Disable the back button for specified index.
disableGoNext(int index, {Duration duration, Curve curve}) → Future<void>
Disable the next button for specified index. When disabling an index that is lower then the current index the Wizard will automatically animate back to the provided index.
dispose() → void
Dispose the controller
enableGoBack(int index) → void
Enable the back button for specified index.
enableGoNext(int index) → void
Enable the next button for specified index.
getIsGoBackEnabled() → bool
Indicates whether the back button currently is enabled for current index.
getIsGoBackEnabledStream() → Stream<bool>
Streams whether the back button is enabled for current index.
getIsGoNextEnabled() → bool
Indicates whether the next button currently is enabled for current index.
getIsGoNextEnabledStream() → Stream<bool>
Stream whether the next button is enabled for current index.
getIsGoToEnabled(int index) → bool
Indicates whether its allowed to go to specified index.
getIsGoToEnabledStream(int index) → Stream<bool>
Stream whether its allowed to go to specified index.
getStepIndex(WizardStep step) → int
Gets the index for the provided step.
goBack({Duration duration, Curve curve}) → Future<void>
Show the previous step. If current step equals the first step nothing will happen.
goNext({Duration delay, Duration duration, Curve curve}) → Future<void>
Show the next step. If the current step equals the last step nothing will happen.
goTo({required int index, Duration delay, Duration duration, Curve curve}) → Future<void>
Animate to the step index. If the current step index equals the provided step index nothing will happen.
isFirstStep(int index) → bool
Indicates whether the step index matches the first step.
isLastStep(int index) → bool
Indicates whether the step index matches the last step.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

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

Static Methods

of(BuildContext context) → WizardController
The closest instance of this class that encloses the given context.