FormControlCollection<T> class abstract

The base class form FormGroup and FormArray. Its provides methods for get a control by name and a Listenable that emits events each time you add or remove a control to the collection.

Inheritance
Implementers
Available Extensions

Constructors

FormControlCollection({List<Validator> validators = const [], List<AsyncValidator> asyncValidators = const [], int asyncValidatorsDebounceTime = 250, bool disabled = false})

Properties

asyncValidators → List<AsyncValidator>
The list of async functions that determines the validity of this control.
no setterinherited
collectionChanges → Stream<List<AbstractControl<Object?>>>
Emits when a control is added or removed from collection.
no setter
dirty → bool
A control is dirty if the user has changed the value in the UI.
no setterinherited
disabled → bool
A control is disabled when its status is ControlStatus.disabled.
no setterinherited
enabled → bool
A control is enabled as long as its status is not ControlStatus.disabled.
no setterinherited
errors → Map<String, Object>
An object containing any errors generated by failing validation, or empty Map if there are no errors.
no setterinherited
hasErrors → bool
True whether the control has validation errors.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
invalid → bool
A control is invalid when its status is ControlStatus.invalid.
no setterinherited
parent ↔ AbstractControl<Object>?
The parent control.
getter/setter pairinherited
pending → bool
A control is pending when its status is ControlStatus.pending.
no setterinherited
pristine → bool
A control is pristine if the user has not yet changed the value in the UI.
no setterinherited
rawValue → T
Gets the value of the control, including any disabled control.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
status → ControlStatus
The validation status of the control.
no setterinherited
statusChanged → Stream<ControlStatus>
A Stream that emits the status every time it changes.
no setterinherited
touchChanges → Stream<bool>
A Stream that emits an event every time the control is touched or untouched.
no setterinherited
touched → bool
Gets if the control is touched or not.
no setterinherited
valid → bool
A control is valid when its status is ControlStatus.valid.
no setterinherited
validators → List<Validator>
The list of functions that determines the validity of this control.
no setterinherited
value ↔ T?
The current value of the control.
getter/setter pairinherited
valueChanges → Stream<T?>
A Stream that emits the value of the control every time it changes.
no setterinherited

Methods

allControlsDisabled() → bool
Returns true if all children disabled, otherwise returns false.
inherited
anyControls(bool condition(AbstractControl)) → bool
inherited
anyControlsHaveStatus(ControlStatus status) → bool
Returns true if all children has the specified status, otherwise returns false.
inherited
clearAsyncValidators() → void
Empties out the async validator list.
inherited
clearValidators() → void
Empties out the sync validator list.
inherited
closeCollectionEvents() → void
Close stream that emit collection change events
contains(String name) → bool
Checks if collection contains a control by a given name.
control(String name) → AbstractControl
Retrieves a child control given the control's name or path.
dispose() → void
Disposes the control
inherited
emitsCollectionChanged(List<AbstractControl<Object?>> controls) → void
Notify to listeners that the collection changed.
findControl(String path) → AbstractControl?
inherited
findControlInCollection(List<String> path) → AbstractControl?
Walks the path to find the matching control.
focus() → void
inherited
forEachChild(void callback(AbstractControl)) → void
inherited
getError(String errorCode, [String? path]) → Object?
Returns the error data for the control with the given errorCode in the given path.
inherited
hasError(String errorCode, [String? path]) → bool
Reports whether the control with the given path has the specified errorCode.
inherited
markAllAsTouched({bool updateParent = true, bool emitEvent = true}) → void
Marks the control and all its descendant controls as touched.
inherited
markAsDirty({bool updateParent = true, bool emitEvent = true}) → void
Marks the control as dirty.
inherited
markAsDisabled({bool updateParent = true, bool emitEvent = true}) → void
Disables the control.
inherited
markAsEnabled({bool updateParent = true, bool emitEvent = true}) → void
Enables the control. This means the control is included in validation checks and the aggregate value of its parent. Its status recalculates based on its value and its validators.
inherited
markAsPending({bool updateParent = true, bool emitEvent = true}) → void
Marks the control as pending.
inherited
markAsPristine({bool updateParent = true}) → void
Marks the control as pristine.
inherited
markAsTouched({bool updateParent = true, bool emitEvent = true}) → void
Marks the control as touched.
inherited
markAsUntouched({bool updateParent = true, bool emitEvent = true}) → void
Marks the control as untouched.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
patchValue(T? value, {bool updateParent = true, bool emitEvent = true}) → void
Patches the value of the control.
inherited
reduceValue() → T?
inherited
removeError(String key, {bool markAsDirty = false}) → void
Removes an error given the error key.
inherited
reset({T? value, bool updateParent = true, bool emitEvent = true, bool removeFocus = false, bool? disabled}) → void
Resets the control, marking it as untouched, pristine and setting the value to null.
inherited
setAsyncValidators(List<AsyncValidator> validators, {bool autoValidate = false, bool updateParent = true, bool emitEvent = true}) → void
Sets the async validators that are active on this control. Calling this overwrites any existing async validators.
inherited
setErrors(Map<String, dynamic> errors, {bool markAsDirty = true}) → void
Sets errors on a form control when running validations manually, rather than automatically.
inherited
setValidators(List<Validator> validators, {bool autoValidate = false, bool updateParent = true, bool emitEvent = true}) → void
Sets the synchronous validators that are active on this control. Calling this overwrites any existing sync validators.
inherited
toString() → String
A string representation of this object.
inherited
unfocus({bool touched = true}) → void
Remove the focus from the UI widget without the interaction of the user.
inherited
updatePristine({bool updateParent = true}) → void
inherited
updateTouched({bool updateParent = true}) → void
inherited
updateValue(T? value, {bool updateParent = true, bool emitEvent = true}) → void
Sets the value of the control.
inherited
updateValueAndValidity({bool updateParent = true, bool emitEvent = true}) → void
Recalculates the value and validation status of the control.
inherited

Operators

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