DataListProvider<T> class abstract

A provider to provide a list of data with type T

Mixed in types

Constructors

DataListProvider({bool manual = false, bool isInfinity = false, int initialPage = 1, int initialPageSize = 10, bool awaitListener = false})
manual = true mean don't fetch data at create time

Properties

error → dynamic
Get latest error value
no setter
hashCode → int
The hash code for this object.
no setterinherited
hasListeners → bool
Whether any listeners are currently registered.
no setterinherited
isAdding → bool
Check if it's adding new item or not
no setter
isDeleting → bool
Check if it's removing an item or not
no setter
isEmpty → bool
Get status of data. Return true if data == null.
no setter
isEnd → bool
Check if it is the end of the list
no setter
isError → bool
Get current error status
no setter
isLoading → bool
Get loading status
no setter
isUpdating → bool
Check if it's updating a item or not
no setter
items → List<T>
Get value data
no setter
lastPage → int
Get last page
no setter
page → int
Get current page
no setter
pageSize → int
Get current page size
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
Get current search value
no setter
sortOptions → List<SortOption>?
Get current sort options
no setter
totalItem → int
Get total available items
no setter

Methods

add(T newItem, {bool isQuiet = false, bool addToTheStart = false}) → Future<void>
Add a new item to the end of data list.
addListener(VoidCallback listener) → void
Register a closure to be called when the object changes.
inherited
dispose() → void
Discards any resources used by the object. After this is called, the object is not in a usable state and should be discarded (calls to addListener will throw after the object is disposed).
override
fetch({bool isQuiet = false}) → Future<void>
Fetch data by calling onFetch Set isQuiet = true to avoid rendering loading state, default false.
loadMore() → void
Call nextPage to load more data, meaningful in infinity mode
nextPage({bool noRefresh = false}) → void
Go next page and refresh data
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
notifyListeners() → void
Call all the registered listeners.
inherited
onCreate(T newItem) → Future<T>
Called when trying to add a new item, Must return the added item, or throw an error if it's failed to add.
onCreateCompleted(T newItem) → Future<void>
onCreateFailed(dynamic error) → Future<void>
onDelete(T item) → Future<bool>
Called when trying to delete the data. Must return a boolean (true mean deleted), or throw and error when it's failed.
onDeleteCompleted(bool result) → Future<void>
onDeleteFailed(dynamic error) → Future<void>
onFetch() → Future<RemoteList<T>>
Called when trying to fetch data for initial or on refreshing. Must return a list of data as the result, or throw an error when it's failed to fetch.
onFetchCompleted(RemoteList<T> data) → Future<void>
onFetchFailed(dynamic error) → Future<void>
onUpdate(T newData) → Future<T>
Called when trying to update the data. Must return the new data, or throw and error when it's failed to update.
onUpdateCompleted(T newData) → Future<void>
onUpdateFailed(dynamic error) → Future<void>
prevPage({bool noRefresh = false}) → void
Go previous page and refresh data
refresh({bool isQuiet = false}) → Future<void>
Refresh value of data by recall fetch. Set isQuiet = true to avoid rendering loading state, default false.
removeAt(int index, {bool isQuiet = false}) → Future<void>
Remove the item at index. Set isQuiet = true to avoid rendering loading state, default false.
removeListener(VoidCallback listener) → void
Remove a previously registered closure from the list of closures that are notified when the object changes.
inherited
setPage(int val, {bool noRefresh = false}) → void
Set new page and refresh data
setPageSize(int val, {bool noRefresh = false}) → void
Set new page size and refresh data
setSearch(String val, {bool noRefresh = false, int debounceMs = 500}) → void
Set search value and refresh data
setSortOptions(List<SortOption> val, {bool noRefresh = false}) → void
Set new sorts and refresh data
toString() → String
A string representation of this object.
inherited
updateAt(int index, T newData, {bool isQuiet = false}) → Future<void>
Update data by newData. Set isQuiet = true to avoid rendering loading state, default false.

Operators

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