BookmarksCtrl class

Controller that handles the bookmarks of the user.

This controller is a singleton and can be accessed through BookmarksCtrl.instance.

It provides methods to add, remove and get bookmarks.

The bookmarks are stored in the device's storage and are loaded when the app starts.

The BookmarksCtrl is also responsible for updating the UI when the bookmarks change.

Inheritance
  • Object
  • GetLifeCycle
  • DisposableInterface
  • GetxController
  • BookmarksCtrl
Implemented types

Constructors

BookmarksCtrl.new({QuranRepository? quranRepository})
Constructor for BookmarksCtrl.

Properties

bookmarks → Map<int, List<BookmarkModel>>
A map of color codes to lists of BookmarkModels.
final
bookmarksAyahs → List<int>
A list of ayah Ids that have bookmarks.
no setter
hashCode → int
The hash code for this object.
no setterinherited
hasListeners → bool
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
listeners → int
no setterinherited
onDelete → InternalFinalCallback<void>
Internal callback that starts the cycle of this controller.
finalinherited
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
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

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
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
hasBookmark(int surahNum, int ayahUQNum, List? bookmarkList) → bool
Checks if the given bookmark list contains a bookmark with the given Surah number and Ayah UQ number.
initBookmarks({Map<int, List<BookmarkModel>>? userBookmarks, bool overwrite = false}) → void
Initializes the bookmarks of the user.
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.
inherited
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
refresh() → void
inherited
refreshGroup(Object id) → void
inherited
removeBookmark(int bookmarkId) → void
Removes a bookmark from the list of bookmarks.
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
saveBookmark({required String surahName, required int ayahId, required int ayahNumber, required int page, required int colorCode}) → void
Saves a new bookmark to the list of bookmarks.
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

Static Properties

instance → BookmarksCtrl
The singleton instance of BookmarksCtrl.
no setter