BlocBuilderBase<B extends StateStreamable<S> , S> class
abstract
Base class for widgets that build themselves based on interaction with a specified bloc.
A BlocBuilderBase is stateful and maintains the state of the interaction so far. The type of the state and how it is updated with each interaction is defined by sub-classes.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- BlocBuilderBase
- Available extensions
Constructors
-
BlocBuilderBase({Key? key, B? bloc, BlocBuilderCondition<
S> ? buildWhen}) -
Base class for widgets that build themselves based on interaction with
a specified bloc.
const
Properties
- bloc → B?
-
The bloc that the BlocBuilderBase will interact with.
If omitted, BlocBuilderBase will automatically perform a lookup using
BlocProvider and the current
BuildContext
.final -
buildWhen
→ BlocBuilderCondition<
S> ? -
An optional buildWhen can be implemented for more granular control over
how often BlocBuilder rebuilds.
buildWhen should only be used for performance optimizations as it
provides no security about the state passed to the
builder
function. buildWhen will be invoked on each blocstate
change. buildWhen takes the previousstate
and currentstate
and must return a bool which determines whether or not thebuilder
function will be invoked. The previousstate
will be initialized to thestate
of the bloc when the BlocBuilder is initialized. buildWhen is optional and if omitted, it will default totrue
.final - center → Widget
-
Available on Widget, provided by the WidgetX extension
no setter - hashCode → int
-
The hash code for this object.
no setterinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
align(
Alignment alignment) → Widget -
build(
BuildContext context, S state) → Widget -
Returns a widget based on the
BuildContext
and currentstate
. -
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< BlocBuilderBase< 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.
override
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
pad(
double pad) → Widget -
pOnly(
{double left = 0, double top = 0, double right = 0, double bottom = 0}) → Widget -
pxy(
{double x = 0, double y = 0}) → Widget -
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, int wrapWidth = 65}) → 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
-
visible(
{required bool isVisible, Widget replacer = const SizedBox.shrink()}) → Widget
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited