WizardControllerImpl class

Coordinates the wizard steps and its input control states.

The default implementation of WizardController.

Implemented types

• WizardController

Constructors

WizardControllerImpl({required List<WizardStepController> stepControllers, int initialIndex = 0, StepCallback? onStepChanged})

Creates a WizardControllerImpl implementation of the WizardController contract.

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, override

hashCode → int

The hash code for this object.

no setter, inherited

index → int

The current wizard step index.

no setter, override

indexStream → Stream<int>

Streams the wizard step index.

no setter, override

pageController → PageController

Controller to control the page view.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

stepControllers → List<WizardStepController>

The step controllers.

final

stepCount → int

The step count.

no setter, override

Methods

copyWith({List<WizardStepController>? stepControllers, int? index, StepCallback? onStepChanged}) → WizardController

Create a copy with the provided values

override

disableGoBack(int index) → void

Disable the back button for specified index.

override

disableGoNext(int index, {Duration duration = const Duration(milliseconds: 150), Curve curve = Curves.easeIn}) → 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.

override

dispose() → void

Dispose the controller

override

enableGoBack(int index) → void

Enable the back button for specified index.

override

enableGoNext(int index) → void

Enable the next button for specified index.

override

getIsGoBackEnabled() → bool

Indicates whether the back button currently is enabled for current index.

override

getIsGoBackEnabledStream() → Stream<bool>

Streams whether the back button is enabled for current index.

override

getIsGoNextEnabled() → bool

Indicates whether the next button currently is enabled for current index.

override

getIsGoNextEnabledStream([int? index]) → Stream<bool>

Stream whether the next button is enabled for current index.

override

getIsGoToEnabled(int index) → bool

Indicates whether its allowed to go to specified index.

override

getIsGoToEnabledStream(int index) → Stream<bool>

Stream whether its allowed to go to specified index.

override

getStepIndex(WizardStep step) → int

Gets the index for the provided step.

override

goBack({Duration duration = const Duration(milliseconds: 150), Curve curve = Curves.easeIn}) → Future<void>

Show the previous step. If current step equals the first step nothing will happen.

override

goNext({Duration? delay, Duration duration = const Duration(milliseconds: 150), Curve curve = Curves.easeIn}) → Future<void>

Show the next step. If the current step equals the last step nothing will happen.

override

goTo({required int index, Duration? delay, Duration duration = const Duration(milliseconds: 150), Curve curve = Curves.easeIn}) → Future<void>

Animate to the step index. If the current step index equals the provided step index nothing will happen.

override

isFirstStep(int index) → bool

Indicates whether the step index matches the first step.

override

isLastStep(int index) → bool

Indicates whether the step index matches the last step.

override

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