CarpenterDataCollectionControllerBase<T, TFilter, TSort> class

A reusable controller adapter for domain-owned collection loading.

Inheritance
Implemented types

Constructors

CarpenterDataCollectionControllerBase({required CarpenterCollectionQuery<TFilter, TSort> query, required Future<CarpenterCollectionState<T>> loadRequest(CarpenterCollectionQuery<TFilter, TSort> query, CarpenterCollectionLoadRequest request), Future<CarpenterCollectionState<T>> loadNext(CarpenterCollectionQuery<TFilter, TSort> query, CarpenterCollectionState<T> current)?, CarpenterSelectionController<T>? selection, CarpenterCollectionState<T>? initialState, CarpenterCollectionQuery<TFilter, TSort> queryForSearch(CarpenterCollectionQuery<TFilter, TSort> query, String search)?, CarpenterCollectionQuery<TFilter, TSort> queryForPage(CarpenterCollectionQuery<TFilter, TSort> query, int page)?, Duration searchDebounce = const Duration(milliseconds: 350), String errorMessage(Object error)?})

Properties

errorMessage String Function(Object error)?
final
hashCode int
The hash code for this object.
no setterinherited
hasListeners bool
Whether any listeners are currently registered.
no setterinherited
query CarpenterCollectionQuery<TFilter, TSort>
getter/setter pairoverride-getter
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
searchDebounce Duration
final
selection CarpenterSelectionController<T>?
final
value CarpenterCollectionState<T>
The current value stored in this notifier.
getter/setter pairinherited

Methods

addListener(VoidCallback listener) → void
Register a closure to be called when the object changes.
inherited
didLoad(CarpenterCollectionState<T> state) → void
Hook for application controllers that keep derived summaries or groups.
dispose() → void
Discards any resources used by the object.
override
goToPage(int page) Future<void>
override
initialize() Future<void>
loadNext() Future<void>
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
notifyListeners() → void
Call all the registered listeners.
inherited
refresh() Future<void>
override
removeListener(VoidCallback listener) → void
Remove a previously registered closure from the list of closures that are notified when the object changes.
inherited
toString() String
A string representation of this object.
inherited
updateQuery(CarpenterCollectionQuery<TFilter, TSort> next, {bool load = true}) → void
updateSearch(String value) → void
override

Operators

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