ProcessorProvider<EP extends EventToStateProcessor> class

Takes a CreateEventStateProcessorFun that is responsible for creating the EventToStateProcessor and a child which will have access to the EventToStateProcessor via BlocProvider.of(context). It is used as a dependency injection (DI) widget so that a single instance of a EventToStateProcessor can be provided to multiple widgets within a subtree.

Automatically handles closing the EventToStateProcessor when used with EventToStateProcessor and lazily creates the provided EventToStateProcessor unless lazy is set to false.

ProcessorProvider(
  create: (BuildContext context) => EventToStateProcessorA(),
  child: ChildA(),
);

Inheritance

Object
DiagnosticableTree
Widget
StatelessWidget
SingleChildStatelessWidget
BlocProvider<EP>
ProcessorProvider

Constructors

ProcessorProvider({Key? key, required CreateEventStateProcessorFun<EP> create, Widget? child, bool lazy = true}): const
ProcessorProvider.value({Key? key, required EP value, Widget? child}): Takes a EventToStateProcessor and a child which will have access to the EventToStateProcessor via BlocProvider.of(context). When BlocProvider.value is used, the EventToStateProcessor will not be automatically closed. As a result, BlocProvider.value should mainly be used for providing existing EventToStateProcessors to new routes.

Properties

child → Widget?: Widget which will have access to the Bloc or Cubit.
finalinherited
hashCode → int: The hash code for this object.
no setterinherited
key → Key?: Controls how one widget replaces another widget in the tree.
finalinherited
lazy → bool: Whether the Bloc or Cubit should be created lazily. Defaults to true.
finalinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited

Methods

build(BuildContext context) → Widget: Describes the part of the user interface represented by this widget.
inherited
buildWithChild(BuildContext context, Widget? child) → Widget: A build method that receives an extra child parameter.
inherited
createElement() → SingleChildStatelessElement: Creates a StatelessElement to manage this widget's location in the tree.
inherited
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

Static Methods

of<T extends EventToStateProcessor>(BuildContext context) → T: Method that allows widgets to access a EventToStateProcessor instance as long as their BuildContext contains a ProcessorProvider instance.
override