AbstractFormDirective — Angular

Абстрактный класс для директив форм верхнего уровня (FormArrayDirective, FormGroupDirective), которые привязывают существующую Form к элементу DOM.

API

abstract class AbstractFormDirective extends ControlContainer implements Form ,OnChanges ,OnDestroy {
  constructor(validators: (ValidatorFn | Validator)[], asyncValidators: (AsyncValidatorFn | AsyncValidator)[], callSetDisabledState?: SetDisabledStateOption | undefined): AbstractFormDirective;
  readonly submitted: boolean;
  directives: FormControlName[];
  abstract form: AbstractControl<any, any, any>;
  abstract ngSubmit: EventEmitter<any>;
  protected onChanges(changes: { [propName: string]: SimpleChange<any>; }): void;
  protected onDestroy(): void;
  readonly formDirective: Form;
  abstract readonly control: AbstractControl<any, any, any>;
  readonly path: string[];
  addControl(dir: FormControlName): FormControl<any>;
  getControl(dir: FormControlName): FormControl<any>;
  removeControl(dir: FormControlName): void;
  addFormGroup(dir: FormGroupName): void;
  removeFormGroup(dir: FormGroupName): void;
  getFormGroup(dir: FormGroupName): FormGroup<any>;
  getFormArray(dir: FormArrayName): FormArray<any>;
  addFormArray(dir: FormArrayName): void;
  removeFormArray(dir: FormArrayName): void;
  updateModel(dir: FormControlName, value: any): void;
  onReset(): void;
  resetForm(value?: any, options?: { onlySelf?: boolean | undefined; emitEvent?: boolean | undefined; }): void;
  onSubmit($event: Event): boolean;
  override name: string | number | null;
  override readonly value: any;
  override readonly valid: boolean | null;
  override readonly invalid: boolean | null;
  override readonly pending: boolean | null;
  override readonly disabled: boolean | null;
  override readonly enabled: boolean | null;
  override readonly errors: ValidationErrors | null;
  override readonly pristine: boolean | null;
  override readonly dirty: boolean | null;
  override readonly touched: boolean | null;
  override readonly status: string | null;
  override readonly untouched: boolean | null;
  override readonly statusChanges: any;
  override readonly valueChanges: any;
  override readonly validator: ValidatorFn | null;
  override readonly asyncValidator: AsyncValidatorFn | null;
  override reset(value?: any): void;
  override hasError(errorCode: string, path?: string | (string | number)[] | undefined): boolean;
  override getError(errorCode: string, path?: string | (string | number)[] | undefined): any;
}

constructor

AbstractFormDirective

@paramvalidators(ValidatorFn | Validator)[]

@paramasyncValidators(AsyncValidatorFn | AsyncValidator)[]

@paramcallSetDisabledStateSetDisabledStateOption | undefined

@returnsAbstractFormDirective

submitted

boolean

Сообщает, была ли отправлена форма.

directives

FormControlName[]

Отслеживает список добавленных экземпляров FormControlName

form

AbstractControl<any, any, any>

Отслеживает форму, привязанную к этой директиве.

ngSubmit

EventEmitter<any>

Создает событие при отправке формы.

ngOnChanges

void

@paramchanges{ [propName: string]: SimpleChange<any>; }

@returnsvoid

ngOnDestroy

void

@returnsvoid

onChanges

void

@paramchanges{ [propName: string]: SimpleChange<any>; }

@returnsvoid

onDestroy

void

@returnsvoid

formDirective

Form

Возвращает экземпляр этой директивы.

control

AbstractControl<any, any, any>

Возвращает форму, привязанную к этой директиве.

path

string[]

Возвращает массив, представляющий путь к этой группе. Поскольку эта директива всегда находится на верхнем уровне формы, она всегда возвращает пустой массив.

addControl

FormControl<any>

Метод, который настраивает директиву управления в этой группе, повторно вычисляет ее значение и валидность, а также добавляет экземпляр во внутренний список директив.

@paramdirFormControlName

Экземпляр директивы FormControlName.

@returnsFormControl<any>

getControl

FormControl<any>

Получает экземпляр FormControl из указанной директивы FormControlName

@paramdirFormControlName

Экземпляр директивы FormControlName.

@returnsFormControl<any>

removeControl

void

Удаляет экземпляр FormControlName из внутреннего списка директив

@paramdirFormControlName

Экземпляр директивы FormControlName.

@returnsvoid

addFormGroup

void

Добавляет в форму новый экземпляр директивы FormGroupName.

@paramdirFormGroupName

Экземпляр директивы FormGroupName.

@returnsvoid

removeFormGroup

void

Выполняет необходимую очистку при удалении экземпляра директивы FormGroupName из представления.

@paramdirFormGroupName

Экземпляр директивы FormGroupName.

@returnsvoid

getFormGroup

FormGroup<any>

Получает экземпляр FormGroup для указанного экземпляра директивы FormGroupName

@paramdirFormGroupName

Экземпляр директивы FormGroupName.

@returnsFormGroup<any>

getFormArray

FormArray<any>

Получает экземпляр FormArray для указанного экземпляра директивы FormArrayName.

@paramdirFormArrayName

Экземпляр директивы FormArrayName.

@returnsFormArray<any>

addFormArray

void

Выполняет необходимую настройку при добавлении экземпляра директивы FormArrayName в представление.

@paramdirFormArrayName

Экземпляр директивы FormArrayName.

@returnsvoid

removeFormArray

void

Выполняет необходимую очистку при удалении экземпляра директивы FormArrayName из представления.

@paramdirFormArrayName

Экземпляр директивы FormArrayName.

@returnsvoid

updateModel

void

Задает новое значение для указанной директивы FormControlName.

@paramdirFormControlName

Экземпляр директивы FormControlName.

@paramvalueany

Новое значение элемента управления директивы.

@returnsvoid

onReset

void

Метод, вызываемый при возникновении события "reset" для формы.

@returnsvoid

resetForm

void

Сбрасывает форму до исходного значения и сбрасывает ее статус отправки.

@paramvalueany

Новое значение формы.

@paramoptions{ onlySelf?: boolean | undefined; emitEvent?: boolean | undefined; }

@returnsvoid

onSubmit

boolean

Метод, вызываемый при возникновении события "submit" для формы. Вызывает эмиттер ngSubmit для создания события "submit" с соответствующим объектом события в качестве данных.

@param$eventEvent

Объект события "submit"

@returnsboolean

name

string | number | null

Имя элемента управления

value

any

Сообщает значение элемента управления, если он существует, иначе возвращает null.

valid

boolean | null

Сообщает, является ли элемент управления валидным. Элемент управления считается валидным, если для текущего значения нет ошибок валидации. Если элемент управления отсутствует, возвращается null.

invalid

boolean | null

Сообщает, является ли элемент управления невалидным, то есть содержит ли введенное значение ошибку. Если элемент управления отсутствует, возвращается null.

pending

boolean | null

Сообщает, находится ли элемент управления в состоянии ожидания: выполняется асинхронная валидация, и ошибки для введенного значения еще недоступны. Если элемент управления отсутствует, возвращается null.

disabled

boolean | null

Сообщает, отключен ли элемент управления: он отключен в пользовательском интерфейсе, не участвует в проверках валидации и исключается из агрегированных значений родительских элементов управления. Если элемент управления отсутствует, возвращается null.

enabled

boolean | null

Сообщает, включен ли элемент управления, то есть учитывается ли он при вычислении валидности или значения родительских элементов управления. Если элемент управления отсутствует, возвращается null.

errors

ValidationErrors | null

Сообщает об ошибках валидации элемента управления. Если элемент управления отсутствует, возвращается null.

pristine

boolean | null

Сообщает, является ли элемент управления нетронутым, то есть изменял ли пользователь его значение в пользовательском интерфейсе. Если элемент управления отсутствует, возвращается null.

dirty

boolean | null

Сообщает, изменен ли элемент управления, то есть менял ли пользователь его значение в пользовательском интерфейсе. Если элемент управления отсутствует, возвращается null.

touched

boolean | null

Сообщает, был ли затронут элемент управления, то есть вызвал ли пользователь для него событие blur. Если элемент управления отсутствует, возвращается null.

status

string | null

Сообщает статус валидации элемента управления. Возможные значения: 'VALID', 'INVALID', 'DISABLED' и 'PENDING'. Если элемент управления отсутствует, возвращается null.

untouched

boolean | null

Сообщает, не был ли затронут элемент управления, то есть вызывал ли пользователь для него событие blur. Если элемент управления отсутствует, возвращается null.

statusChanges

any

Возвращает мультикастовый observable, который выдает статус валидации при каждом его вычислении для элемента управления. Если элемент управления отсутствует, возвращается null.

valueChanges

any

Возвращает мультикастовый observable изменений значения элемента управления, который выдает новое значение каждый раз, когда оно меняется в пользовательском интерфейсе или программно. Если элемент управления отсутствует, возвращается null.

validator

ValidatorFn | null

Функция синхронной валидации, объединяющая все синхронные валидаторы, зарегистрированные в этой директиве.

asyncValidator

AsyncValidatorFn | null

Функция асинхронной валидации, объединяющая все асинхронные валидаторы, зарегистрированные в этой директиве.

reset

void

Сбрасывает элемент управления до указанного значения, если он существует.

@paramvalueany

@returnsvoid

hasError

boolean

Сообщает, есть ли у элемента управления по указанному пути заданная ошибка.

@paramerrorCodestring

Код проверяемой ошибки

@parampathstring | (string | number)[] | undefined

Список имен элементов управления, указывающий путь от текущего элемента управления к элементу управления, ошибки которого нужно проверить.

@returnsboolean

наличие указанной ошибки у элемента управления по указанному пути.

Если элемент управления отсутствует, возвращается false.

Примечания по использованию

Например, для следующей FormGroup:

form = new FormGroup({
  address: new FormGroup({ street: new FormControl() })
});

Путь от корневой формы к элементу управления 'street' будет таким: 'address' -> 'street'.

Его можно передать этому методу в одном из двух форматов:

Массив строк с именами элементов управления, например ['address', 'street']
Строка со списком имен элементов управления, разделенных точками, например 'address.street'

Если путь не указан, этот метод проверяет наличие ошибки у текущего элемента управления.

getError

any

Возвращает данные об ошибке для элемента управления по указанному пути.

@paramerrorCodestring

Код проверяемой ошибки

@parampathstring | (string | number)[] | undefined

@returnsany

данные об указанной ошибке. Если элемент управления или ошибка отсутствуют, возвращается null.

Примечания по использованию

Например, для следующей FormGroup:

form = new FormGroup({
  address: new FormGroup({ street: new FormControl() })
});

Путь от корневой формы к элементу управления 'street' будет таким: 'address' -> 'street'.

Его можно передать этому методу в одном из двух форматов:

Массив строк с именами элементов управления, например ['address', 'street']
Строка со списком имен элементов управления, разделенных точками, например 'address.street'