ControlGroup class
Defines a part of a form, of fixed length, that can contain other controls.
A ControlGroup aggregates the values of each Control in the group.
The status of a ControlGroup depends on the status of its children.
If one of the controls in a group is invalid, the entire group is invalid.
Similarly, if a control changes its value, the entire group changes as well.
ControlGroup is one of the three fundamental building blocks used to
define forms in Angular, along with Control and ControlArray.
ControlArray can also contain other controls, but is of variable length.
- Inheritance
-
- Object
- AbstractControl<
Map< String?, dynamic> > - AbstractControlGroup<
Map< String?, dynamic> > - ControlGroup
Constructors
-
ControlGroup(Map<
String?, AbstractControl> controls, [ValidatorFn? validator])
Properties
-
controls
→ Map<
String?, AbstractControl> -
finalinherited
- dirty → bool
-
no setterinherited
- disabled → bool
-
no setterinherited
-
disabledChanges
→ Stream<
bool> -
no setterinherited
- enabled → bool
-
no setterinherited
-
errors
→ Map<
String, dynamic> ? -
Returns the errors of this control.
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- invalid → bool
-
no setterinherited
- pending → bool
-
no setterinherited
- pristine → bool
-
no setterinherited
- root → AbstractControl
-
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- status → String?
-
The validation status of the control.
no setterinherited
-
statusChanges
→ Stream<
String> -
no setterinherited
- touched → bool
-
no setterinherited
- untouched → bool
-
no setterinherited
- valid → bool
-
no setterinherited
- validator ↔ ValidatorFn?
-
getter/setter pairinherited
-
value
→ Map<
String?, dynamic> ? -
no setterinherited
-
valueChanges
→ Stream<
Map< String?, dynamic> ?> -
no setterinherited
Methods
-
addControl(
String? name, AbstractControl control) → void -
Add a control to this group.
inherited
-
contains(
String? controlName) → bool -
Check whether there is a control with the given name in the group.
inherited
-
find(
String? path) → AbstractControl? -
Walks the path supplied to find matching control.
inherited
-
findPath(
List< String?> ? path) → AbstractControl? -
Walks the path to find the matching control.
inherited
-
getError(
String errorCode, [List< String> ? path]) → dynamic -
inherited
-
hasError(
String errorCode, [List< String> ? path]) → bool -
inherited
-
included(
String? controlName) → bool -
inherited
-
markAsDirty(
{bool? onlySelf, bool emitEvent = true}) → void -
Mark the control as
dirty.inherited -
markAsDisabled(
{bool updateParent = true, bool emitEvent = true}) → void -
Disables the control. This means the control will be exempt from
validation checks and excluded from the aggregate value of any
parent. Its status is
DISABLED.inherited -
markAsEnabled(
{bool updateParent = true, bool emitEvent = true}) → void -
Enables the control. This means the control will be included in
validation checks and the aggregate value of its parent. Its
status is re-calculated based on its value and its validators.
inherited
-
markAsPending(
{bool onlySelf = false}) → void -
inherited
-
markAsPristine(
{bool updateParent = true}) → void -
Marks the control as
pristine.inherited -
markAsTouched(
{bool updateParent = true}) → void -
Marks the control as
touched.inherited -
markAsUntouched(
{bool updateParent = true}) → void -
Marks the control as
untouched.inherited -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
onUpdate(
) → void -
Callback when control is asked to update its value.
override
-
removeControl(
String? name) → void -
Remove a control from this group.
inherited
-
reset(
{Map< String?, dynamic> ? value, bool? isDisabled, bool? updateParent, bool? emitEvent}) → void -
Resets the form control.
inherited
-
setErrors(
Map< String, dynamic> errors, {bool emitEvent = true}) → void -
Sets errors on a control.
inherited
-
setParent(
AbstractControl parent) → void -
inherited
-
toString(
) → String -
A string representation of this object.
inherited
-
updateValue(
Map< String?, dynamic> ? value, {bool? onlySelf, bool? emitEvent, bool? emitModelToViewChange, String? rawValue}) → void -
Set the value of the AbstractControl to
value.override -
updateValueAndValidity(
{bool? onlySelf, bool? emitEvent}) → void -
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited