ReaderBloc class

Constructors

ReaderBloc({required String sectionFileName, required String highlightFileName, required String bookFolder})

Properties

allText ↔ String
getter/setter pair
baseScaleFactor ↔ double
getter/setter pair
bookFolder → String
final
currentSelectedHighlight ↔ Highlight?
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
highlightFileName → String
final
highlights ↔ List<Highlight>
getter/setter pair
isClosed → bool
Whether the bloc is closed.
no setterinherited
isScrolling ↔ bool
getter/setter pair
lastSavedLocation ↔ double
getter/setter pair
lugat ↔ List?
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scaleFactor ↔ double
getter/setter pair
scrollController → ScrollController
final
scrollSpeedFactor ↔ double
getter/setter pair
sectionFileName → String
final
state → ReaderState
The current state.
no setterinherited
stream → Stream<ReaderState>
The current state stream.
no setterinherited

Methods

add(ReaderEvent event) → void
Notifies the Bloc of a new event which triggers all corresponding EventHandler instances. If close has already been called, any subsequent calls to add will be ignored and will not result in any subsequent state changes.
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(ReaderState state) → void
emit should never be used outside of tests.
inherited
getHighlights(String fileName) → List<Highlight>
gotoLastLocation() → void
listen(void onData(ReaderState)?, {Function? onError, void onDone()?, bool? cancelOnError}) → StreamSubscription<ReaderState>
Adds a subscription to the Stream<State>. Returns a StreamSubscription which handles events from the Stream<State> using the provided onData, onError and onDone handlers.
inherited
loadSectionText() → void
loadSectionTextAndHighlights() → Future<void>
mapEventToState(ReaderEvent event) → Stream<ReaderState>
@Deprecated - Use on
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
on<E extends Event>(EventHandler<E, ReaderState> 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<ReaderState> 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(ReaderEvent 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<ReaderEvent, ReaderState> 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. executed. onTransition is called before a Bloc's state has been updated. A great spot to add logging/analytics at the individual Bloc level.
inherited
saveHighlights() → void
scrollSpeedChanged(dynamic newValue) → dynamic
toggleAutoScroll() → Future<void>
toString() → String
A string representation of this object.
inherited
transformEvents(Stream<ReaderEvent> events, TransitionFunction<ReaderEvent, ReaderState> transitionFn) → Stream<Transition<ReaderEvent, ReaderState>>
@Deprecated - Use on<Event> with an EventTransformer instead. Will be removed in v8.0.0
inherited
transformTransitions(Stream<Transition<ReaderEvent, ReaderState>> transitions) → Stream<Transition<ReaderEvent, ReaderState>>
@Deprecated - Override Stream<State> get stream instead. Will be removed in v8.0.0
inherited

Operators

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

Static Properties

booksAssetsFolder ↔ String
getter/setter pair