RxBlocListenerBase<B extends RxBlocTypeBase, S> class abstract

Base class for widgets that listen to state changes in a specified bloc.

A RxBlocListenerBase is stateful and maintains the state subscription. The type of the state and what happens with each state change is defined by sub-classes.

Inheritance
Implementers

Constructors

RxBlocListenerBase({required RxBlocWidgetListener<S> listener, required Stream<S> state(B), Key? key, B? bloc, Widget? child, RxBlocListenerCondition<S>? condition, S? initialValue, void onError(BuildContext, Object, StackTrace)?, dynamic onComplete(BuildContext)?, dynamic onWaiting(BuildContext, S?)?})
Base class for widgets that listen to state changes in a specified bloc.
const

Properties

bloc → B?
The bloc whose state will be listened to. Whenever the bloc's state changes, listener will be invoked.
final
child → Widget?
The widget which will be rendered as a descendant of the RxBlocListenerBase.
final
condition → RxBlocListenerCondition<S>?
The RxBlocListenerCondition that the RxBlocListenerBase will invoke. The condition function will be invoked on each bloc state change. The condition takes the previous state and current state and must return a bool which determines whether or not the listener function will be invoked. The previous state will be initialized to state when the RxBlocListenerBase is initialized. condition is optional and if it isn't implemented, it will default to true.
final
hashCode → int
The hash code for this object.
no setterinherited
initialValue → S?
Initial value used in the onWaiting callback.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
listener → RxBlocWidgetListener<S>
The RxBlocWidgetListener which will be called on every state change. This listener should be used for any code which needs to execute in response to a state change (Transition). The state will be the nextState for the most recent Transition.
final
onComplete → (dynamic Function(BuildContext)?)
Callback executed once the listened state stops emitting values.
final
onError → (void Function(BuildContext, Object, StackTrace)?)
Callback triggered once any error happens on the listened stream.
final
onWaiting → (dynamic Function(BuildContext, S?)?)
Callback triggered once the widget has subscribed to the stream but the stream hasn't emitted any values yet. If initialValue has been specified it will be available as the second argument of the callback.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
state → Stream<S> Function(B)
Stream representing the state which will be listened to for changes
final

Methods

createElement() → SingleChildStatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → SingleChildState<RxBlocListenerBase<B, S>>
Creates the mutable state for this widget at a given location in the tree.
override
debugDescribeChildren() → List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String
A string representation of this object.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a one-line detailed description of the object.
inherited
toStringShort() → String
A short, textual description of this widget.
inherited

Operators

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