PagedListFilterBloc<T, F> class

A list BLoC with pagination and filtering.

Designed to collaborate with ViewStateBuilder for displaying data.

Call loadFirstPage to fetch first page of data. This is where filter value can be set as well as the page size and these values cannot be changed when loading the next page. Call loadNextPage to fetch next page of data.

T - the type of list items. F - the type of filter.

Implementers

Constructors

PagedListFilterBloc(PagedListFilterRepository<T, F> repository)

Properties

filter → F?
no setter
hashCode → int
The hash code for this object.
no setterinherited
isClosed → bool
Whether the bloc is closed.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
state → ViewState<PagedList<T>>
The current state.
no setterinherited
stream → Stream<ViewState<PagedList<T>>>
The current stream of states.
no setterinherited

Methods

add(PagedListEvent event) → void
Notifies the Bloc of a new event which triggers all corresponding EventHandler instances.
inherited
addError(Object error, [StackTrace? stackTrace]) → void
Reports an error which triggers onError with an optional StackTrace.
inherited
close() → Future<void>
Closes the event and state Streams. This method should be called when a Bloc is no longer needed. Once close is called, events that are added will not be processed. In addition, if close is called while events are still being processed, the Bloc will finish processing the pending events.
inherited
emit(ViewState<PagedList<T>> state) → void
emit is only for internal use and should never be called directly outside of tests. The Emitter instance provided to each EventHandler should be used instead.
inherited
loadFirstPage({int pageSize = defaultPageSize, F? filter}) → void
Loads items using the given filter and pageSize. When no size is given _defaultPageSize is used.
loadNextPage() → void
Loads next page. When no page has been loaded before the first one is loaded with the default page size _defaultPageSize.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
on<E extends Event>(EventHandler<E, ViewState<PagedList<T>>> handler, {EventTransformer<E>? transformer}) → void
Register event handler for an event of type E. There should only ever be one event handler per event type E.
inherited
onChange(Change<ViewState<PagedList<T>>> change) → void
Called whenever a change occurs with the given change. A change occurs when a new state is emitted. onChange is called before the state of the cubit is updated. onChange is a great spot to add logging/analytics for a specific cubit.
inherited
onError(Object error, StackTrace stackTrace) → void
Called whenever an error occurs and notifies BlocObserver.onError.
inherited
onEvent(PagedListEvent event) → void
Called whenever an event is added to the Bloc. A great spot to add logging/analytics at the individual Bloc level.
inherited
onTransition(Transition<PagedListEvent, ViewState<PagedList<T>>> transition) → void
Called whenever a transition occurs with the given transition. A transition occurs when a new event is added and a new state is emitted from a corresponding EventHandler.
inherited
toString() → String
A string representation of this object.
inherited

Operators

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

Constants

defaultPageSize → const int