GetxScrollController class abstract
A controller for managing scroll events at the top and bottom of scrollable content. Provides automatic handling of scroll edge detection with debouncing.
- Inheritance
-
- Object
- Listenable
- ListNotifier
- GetxController
- GetxScrollController
Constructors
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- initialized → bool
-
Checks whether the controller has already been initialized.
no setterinherited
- isClosed → bool
-
Checks whether the controller has already been closed.
no setterinherited
- isDisposed → bool
-
Checks if the notifier has been disposed.
no setterinherited
- listenersLength → int
-
Returns the number of active listeners.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- scroll ↔ ScrollController
-
The scroll controller that monitors scroll position.
latefinal
Methods
-
addListener(
GetStateUpdate listener) → Disposer -
Adds a listener and returns a Disposer to remove it later.
inherited
-
addListenerId(
Object? key, GetStateUpdate listener) → Disposer -
Adds a listener to a specific group ID.
inherited
-
containsId(
Object id) → bool -
Checks if a specific ID exists in the group.
inherited
-
containsListener(
GetStateUpdate listener) → bool -
Checks if a given listener is already registered.
inherited
-
dispose(
) → void -
Disposes all listeners in the group.
inherited
-
disposeId(
Object id) → void -
Disposes of a specific ID from future updates.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
notifyGroupChildren(
Object id) → void -
Notifies all children of a given group ID.
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
-
onDelete(
) → void -
Called when the controller is removed from memory.
inherited
-
onEndScroll(
) → Future< void> - Called when the scroll reaches the bottom. Implement this method to load more content or perform other actions.
-
onInit(
) → void -
Called immediately after the widget is allocated in memory.
You might use this to initialize something for the controller.
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
-
onStart(
) → void -
Called at the exact moment the widget is allocated in memory.
It uses an internal "callable" type, to avoid any @overrides in subclasses.
This method should be internal and is required to define the
lifetime cycle of the subclass.
inherited
-
onTopScroll(
) → Future< void> - Called when the scroll reaches the top. Implement this method to refresh content or perform other actions.
-
refresh(
) → void -
Notifies all registered listeners of an update.
inherited
-
refreshGroup(
Object id) → void -
Refreshes all listeners associated with a specific ID.
inherited
-
removeListener(
VoidCallback listener) → void -
Removes a registered listener.
inherited
-
removeListenerId(
Object id, VoidCallback listener) → void -
Removes a specific listener from a group by ID.
inherited
-
reportAdd(
VoidCallback disposer) → void -
Reports a new listener addition.
inherited
-
reportRead(
) → void -
Reports that a read operation has occurred.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
-
update(
[List< Object> ? ids, bool condition = true]) → void -
Rebuilds the associated widgets.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited