PagedListBloc<T> class
A list BLoC with pagination but without filtering.
Designed to collaborate with ViewStateBuilder for displaying data.
Call loadFirstPage to fetch first page of data. Call loadNextPage to fetch next page of data.
T - the type of list items.
- Inheritance
-
- Object
- PagedListFilterBloc<
T, void> - PagedListBloc
Constructors
-
PagedListBloc(PagedListRepository<
T> repository)
Properties
- filter → void
-
no setterinherited
- 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
Blocof a neweventwhich triggers all correspondingEventHandlerinstances.inherited -
addError(
Object error, [StackTrace? stackTrace]) → void -
Reports an
errorwhich triggersonErrorwith an optional StackTrace.inherited -
close(
) → Future< void> -
Closes the
eventandstateStreams. This method should be called when aBlocis no longer needed. Oncecloseis called,eventsthat areadded will not be processed. In addition, ifcloseis called whileeventsare still being processed, theBlocwill finish processing the pendingevents.inherited -
emit(
ViewState< PagedList< state) → voidT> > -
emitis only for internal use and should never be called directly outside of tests. TheEmitterinstance provided to eachEventHandlershould be used instead.inherited -
loadFirstPage(
{int pageSize = defaultPageSize, void filter}) → void -
Loads items using the given
filterandpageSize. When no size is given_defaultPageSizeis used.inherited -
loadNextPage(
) → void -
Loads next page. When no page has been loaded before the first one is
loaded with the default page size
_defaultPageSize.inherited -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
on<
E extends Event> (EventHandler< E, ViewState< handler, {EventTransformer<PagedList< >T> >E> ? transformer}) → void -
Register event handler for an event of type
E. There should only ever be one event handler per event typeE.inherited -
onChange(
Change< ViewState< change) → voidPagedList< >T> > -
Called whenever a
changeoccurs with the givenchange. Achangeoccurs when a newstateis emitted.onChangeis called before thestateof thecubitis updated.onChangeis a great spot to add logging/analytics for a specificcubit.inherited -
onError(
Object error, StackTrace stackTrace) → void -
Called whenever an
erroroccurs and notifiesBlocObserver.onError.inherited -
onEvent(
PagedListEvent event) → void -
Called whenever an
eventisadded to theBloc. A great spot to add logging/analytics at the individualBloclevel.inherited -
onTransition(
Transition< PagedListEvent, ViewState< transition) → voidPagedList< >T> > -
Called whenever a
transitionoccurs with the giventransition. Atransitionoccurs when a neweventis added and a new state isemittedfrom a correspondingEventHandler.inherited -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited