ModProgressController class - mod_progress_controller library

Constructors

ModProgressController({required String id})

Properties

errorMessage → RxString: Observable error message
final
hasError → RxBool: Observable error state
final
hashCode → int: The hash code for this object.
no setterinherited
hasListeners → bool: no setterinherited
id → String: Unique identifier for this progress instance
final
initialized → bool: Checks whether the controller has already been initialized.
no setterinherited
isClosed → bool: Checks whether the controller has already been closed.
no setterinherited
isCompleted → RxBool: Observable completion state
final
isVisible → RxBool: Observable visibility state
final
listeners → int: no setterinherited
onCloseCallback ↔ VoidCallback?: Callback when progress is closed
getter/setter pair
onCompleteCallback ↔ VoidCallback?: Callback when progress completes
getter/setter pair
onDelete → InternalFinalCallback<void>: Internal callback that starts the cycle of this controller.
finalinherited
onErrorCallback ↔ void Function(String error)?: Callback when progress encounters an error
getter/setter pair
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.
finalinherited
progress → Rx<double?>: Observable progress value (0.0 to 1.0) null means indeterminate progress
final
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
subtitle → RxString: Observable subtitle/message text
final
title → RxString: Observable title text
final

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
close() → void: Closes the progress widget
complete({String? message}) → void: Marks progress as complete
connectToStream(Stream<ProgressUpdate> stream) → void: Connects to a stream for real-time progress updates Useful for gRPC streaming or other async sources
dispose() → void: 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
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
notifyChildrens() → void: inherited
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.
override
onInit() → void: Called immediately after the widget is allocated in memory. You might use this to initialize something for the controller.
inherited
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
open({String? title, String? subtitle, double? initialProgress}) → void: Opens the progress widget with initial values
refresh() → void: inherited
refreshGroup(Object id) → void: inherited
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
reset() → void: Resets the controller to initial state
setError(String message) → void: Sets error state with message
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
updateAll({String? title, String? subtitle, double? progress}) → void: Updates title, subtitle, and progress at once
updateProgress(double? value) → void: Updates the progress value (0.0 to 1.0) Pass null for indeterminate progress
updateSubtitle(String newSubtitle) → void: Updates the subtitle/message text
updateTitle(String newTitle) → void: Updates the title text

Operators

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