WorkflowController<STATES_ENUM> class Null safety

Controller to manage a workflow

Inheritance
Implementers

Constructors

WorkflowController(STATES_ENUM initialState, {bool emitMinorEvents = false})
Workflow controller

Properties

container → WorkflowContainer
Container to store data to be transferred between listener plugins
final
emitMinorEvents → bool
Should minor events be emitted
final
events → Rx<PluginEvent<STATES_ENUM>>
Events occurring within the workflow
final
hashCode → int
The hash code for this object. [...]
read-only, inherited
hasListeners → bool
read-only, inherited
initialized → bool
Checks whether the controller has already been initialized.
read-only, inherited
isClosed → bool
Checks whether the controller has already been closed.
read-only, inherited
lastEvent → PluginEvent<STATES_ENUM>
The last event that occurred in this workflow
read-only
listeners → int
read-only, inherited
minorEvents → Rx<MinorPluginEvent<STATES_ENUM>>
Minor events occurring within the workflow
final
onDelete → InternalFinalCallback<void>
Internal callback that starts the cycle of this controller.
final, inherited
onStart → InternalFinalCallback<void>
Called at the exact moment the widget is allocated in memory. It uses an internal "callable" type, to avoid any @overrides in subclases. This method should be internal and is required to define the lifetime cycle of the subclass.
final, inherited
registry → WorkflowStateListenerMap<STATES_ENUM>
Registry mapping state to the plugins to be executed for that state
final
runtimeType → Type
A representation of the runtime type of the object.
read-only, inherited
state → STATES_ENUM
The current state of this workflow
read-only

Methods

$configureLifeCycle() → void
inherited
addListener(GetStateUpdate listener) → Disposer
Register a closure to be called when the object notifies its listeners.
inherited
addListenerId(Object? key, GetStateUpdate listener) → Disposer
inherited
changeState(STATES_ENUM state, {Json? params, Object? data, bool resetData = false}) → Future<void>
Change the current state [...]
dispose() → void
@mustCallSuper, inherited
disposeId(Object id) → void
To dispose an id from future updates(), this ids are registered by GetBuilder() or similar, so is a way to unlink the state change with the Widget from the Controller.
inherited
executeListeners(PluginEvent<STATES_ENUM> event) → Future
Executes listeners in registry for the specified event
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
inherited
notifyChildrens() → void
@protected, inherited
onceState(STATES_ENUM state, dynamic callback(PluginEvent<STATES_ENUM>)) → dynamic
Executes the callback once state is emitted
onClose() → void
Called before onDelete method. onClose might be used to dispose resources used by the controller. Like closing events, or streams before the controller is destroyed. Or dispose objects that can potentially create some memory leaks, like TextEditingControllers, AnimationControllers. Might be useful as well to persist some data on disk.
inherited
onInit() → void
Start listening to state changes
override
onReady() → void
Called 1 frame after onInit(). It is the perfect place to enter navigation events, like snackbar, dialogs, or a new route, or async request.
inherited
refresh() → void
@protected, inherited
refreshGroup(Object id) → void
@protected, inherited
registerListenerPlugin(WorkflowStateListener<STATES_ENUM> plugin) → dynamic
Registers a listener plugin
removeListener(VoidCallback listener) → void
Remove a previously registered closure from the list of closures that the object notifies.
inherited
removeListenerId(Object id, VoidCallback listener) → void
inherited
toString() → String
A string representation of this object. [...]
inherited
update([List<Object>? ids, bool condition = true]) → void
Rebuilds GetBuilder each time you call update(); Can take a List of ids, that will only update the matching GetBuilder( id: ), ids can be reused among GetBuilders like group tags. The update will only notify the Widgets, if condition is true.
inherited

Operators

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