MetaForm class

Renders a form for a IMSchemaDefinition (based on ref)

The form is backed by a FormController, which is usually a MModel/IFact wrapped in a MModelForm

To override the behavior of the form, provide MetaFormOverrides through MetaFormContext.overrides

Inheritance
Available Extensions

Constructors

MetaForm({required String name, required FutureOr<MetaFormContext> metaFormContext, BuildContext? context, MSchemaRef? ref, Future<Result> overrideHandler(BuildContext context, FormController form, FormSubmitResult result)?, MetaFormBuilderFn? builder, SubmitHook? submitHook, FormValidator? validator, bool inheritForm = false, FormController? parentForm, FormControllerCreator? formCreator, bool attachForm = true, bool? skipIfUnmodified, List<MetaFormSection> sections = const []})
MetaForm.ofMModel(BuildContext context, {String? id, JsonPath? embedPath, required MBaseModel? model, MSchemaRef? ref, MetadataOverrides? overrides, IMSchemaDefinition? schema, bool saveModel = true, FormController? parentForm, SubmitHook? submitHook, FormValidator? validator, Future<Result> overrideHandler(BuildContext context, FormController form, FormSubmitResult result)?, bool attachForm = true, bool inheritForm = false, Set? ignoredPaths, bool? skipIfUnmodified, List<MetaFormSection> sections = const [], MetaFormBuilderFn? builder, List<MetaPropertyHandler> extraHandlers = const [], Map<String, dynamic>? scope})

Properties

attachForm bool
Whether this form should be attached as a subform to any parent form that exists in scope, either parentForm or a provided Provider form that's in scope. Attaching to the parent form means that this form will validate and submit when the parent form submits.
final
builder MetaFormBuilderFn?
final
formCreator FormControllerCreator?
final
hashCode int
The hash code for this object.
no setterinherited
inheritForm bool
If inheritForm is true, then this MetaForm will bind directly to the parent form, instead of creating a new subform that's nested inside the parent form
final
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
metaFormContext FutureOr<MetaFormContext>
final
name String
final
overrideHandler → (Future<Result> Function(BuildContext context, FormController form, FormSubmitResult result)?)
final
parentForm FormController?
final
ref → MSchemaRef?
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
sections List<MetaFormSection>
final
skipIfUnmodified bool?
final
submitHook SubmitHook?
final
validator FormValidator?
final

Methods

createElement() StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() State<StatefulWidget>
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