ControlWidget class abstract
A flexible CoreWidget that can manage multiple ControlModels.
This is a general-purpose widget for building UI that depends on one or more
ControlModels. Dependencies are initialized in initControls and can be
accessed within the build method via context.get<T>().
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- CoreWidget
- ControlWidget
- Implementers
Constructors
- ControlWidget({Key? key, Map initArgs = const {}})
-
const
Properties
- autoMountControls → bool
-
If
true, all ControlModels found in the widget's arguments will be automatically initialized and mounted. Defaults tofalse.no setterinherited - hashCode → int
-
The hash code for this object.
no setterinherited
- initArgs → Map
-
A map of initial arguments to be passed to the CoreContext.
finalinherited
- 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
-
build(
BuildContext context) → Widget - Builds the widget's UI.
-
createElement(
) → CoreContext -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → ControlState< _ControlWidgetBase> -
Creates the mutable state for this widget at a given 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
-
init(
CoreContext context) → void -
A preliminary initialization method called by the CoreContext.
This is a good place for mixins to hook into the initialization process.
inherited
-
initControls(
CoreContext context) → List< ControlModel> -
Returns a list of ControlModels to be initialized and managed by this widget.
This method is called once during state initialization.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
onChangeState(
ControlState< _ControlWidgetBase> state, dynamic value) → void -
Called when the state is notified of a change from one of its notifiers.
inherited
-
onDependencyChanged(
CoreContext context) → void -
Called when a dependency of this widget changes.
See State.didChangeDependencies for more information.
inherited
-
onDispose(
) → void -
Called when the widget is being disposed.
inherited
-
onInit(
Map args, CoreContext context) → void -
Called once when the state is fully initialized and the context is available.
inherited
-
onInitState(
ControlState< _ControlWidgetBase> state) → void -
Called after the state and all its controls have been initialized.
inherited
-
onUpdate(
CoreContext context, CoreWidget oldWidget) → void -
Called when the widget is updated with new configuration.
See State.didUpdateWidget for more information.
inherited
-
rebuild(
CoreContext context) → Widget - Abstract method for building the widget's UI. Implemented by subclasses like ControlWidget and SingleControlWidget.
-
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
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited