Класс EnumField<M, N>

Поле для хранения значение перечисления.

Параметры типа

M
N extends void | null = void

Иерархия (Просмотр сводки)

AbstractField<
N extends void ? OptionValueType<M> : OptionValueType<M> | null,
IEnumFieldMainDescriptorConfig<M>,
>
- EnumField

Индекс

Конструкторы

constructor

new EnumField<M, N extends void | null = void>(
    value: N extends void ? OptionValueType<M> : OptionValueType<M> | null,
    onChangeDirty?: ModelDirtyChangeHandler,
    descriptorConfig?: IEnumFieldMainDescriptorConfig<M, void>,
    onValidation?: (validationResult: string[]) => void,
): EnumField<M, N>
Параметры типа
- M
- N extends void | null = void
Параметры
- value: N extends void ? OptionValueType<M> : OptionValueType<M> | null
- OptionalonChangeDirty: ModelDirtyChangeHandler
- OptionaldescriptorConfig: IEnumFieldMainDescriptorConfig<M, void>
- OptionalonValidation: (validationResult: string[]) => void
Возвращает EnumField<M, N>
Наследуется от AbstractField.constructor

Свойства

`Protected`allowNull

allowNull: boolean

`Protected`descriptorConfig

descriptorConfig: IEnumFieldMainDescriptorConfig<M, void> | undefined

`Protected`dirty

dirty: boolean

`Protected`observabilitySet

observabilitySet: Set<ReactiveProp>

`Protected`originalValue

originalValue: N extends void ? OptionValueType<M> : OptionValueType<M> | null

persist

persist: boolean

Флаг, указывающий на сохранение поля при сериализации.

validationResult

validationResult: string[]

Список сообщений валидации поля.

`Protected`value

value: IObservableValue<
N extends void ? OptionValueType<M> : OptionValueType<M> | null,
>

Акцессоры

displayValue

get displayValue(): string
Геттер отображаемого значения

Возвращает string

isPrimaryKey

get isPrimaryKey(): boolean
Возвращает true, если поле является первичным ключом.

Возвращает boolean
Наследуется от AbstractField.isPrimaryKey

options

get options(): { title: string; value: OptionValueType<M> }[]
Возвращает набор опций.

Возвращает { title: string; value: OptionValueType<M> }[]

selectedItem

get selectedItem(): ItemType<M> | undefined
Возвращает выбранный элемент

Возвращает ItemType<M> | undefined

Методы

addValidator

addValidator(validator: IFieldValidator): void
Добавляет валидатор поля.
Параметры
- validator: IFieldValidator
  Экземпляр валидатора.
Возвращает void
Наследуется от AbstractField.addValidator

bind

bind(
    field: AbstractField<
        N extends void ? OptionValueType<M> : OptionValueType<M> | null,
    >,
): void
Привязывает другое поле к текущему для синхронизации значений.
Параметры
- field: AbstractField<N extends void ? OptionValueType<M> : OptionValueType<M> | null>
  Поле для привязки.
Возвращает void
Наследуется от AbstractField.bind

`Protected`castValue

castValue(
value: any,
): N extends void ? OptionValueType<M> : OptionValueType<M> | null
Параметры
- value: any
Возвращает N extends void ? OptionValueType<M> : OptionValueType<M> | null
Наследуется от AbstractField.castValue

clearValidationResult

clearValidationResult(): void
Очищает текущее состояние валидации поля.

Возвращает void
Наследуется от AbstractField.clearValidationResult

commit

commit(): void
Записывает новое значение

Возвращает void
Наследуется от AbstractField.commit

compare

compare(
a: N extends void ? OptionValueType<M> : OptionValueType<M> | null,
b: N extends void ? OptionValueType<M> : OptionValueType<M> | null,
): number
Сравнивает элементы типа T.
Параметры
- a: N extends void ? OptionValueType<M> : OptionValueType<M> | null
  Первый элемент.
- b: N extends void ? OptionValueType<M> : OptionValueType<M> | null
  Второй элемент.
Возвращает number
Наследуется от AbstractField.compare

getDirty

getDirty(): boolean
Возвращает флаг изменено ли значение

Возвращает boolean
Наследуется от AbstractField.getDirty

getErrorMessage

getErrorMessage(): string
Возвращает сообщение об ошибке.

Возвращает string
Наследуется от AbstractField.getErrorMessage

getLabel

getLabel(): string
Возвращает метку поля.

Возвращает string
Наследуется от AbstractField.getLabel

getOriginalValue

getOriginalValue(): N extends void
? OptionValueType<M>
: OptionValueType<M> | null
Возвращает исходное значение поля.

Возвращает N extends void ? OptionValueType<M> : OptionValueType<M> | null
Наследуется от AbstractField.getOriginalValue

getValidationResult

getValidationResult(): string[]
Возвращает копию результата валидации.

Возвращает string[]
Наследуется от AbstractField.getValidationResult

getValidators

getValidators(): IFieldValidator<AbstractModel<any>>[]
Возвращает список валидаторов поля.

Возвращает IFieldValidator<AbstractModel<any>>[]
Наследуется от AbstractField.getValidators

getValue

getValue(): N extends void ? OptionValueType<M> : OptionValueType<M> | null
Возвращает текущее значение поля.

Возвращает N extends void ? OptionValueType<M> : OptionValueType<M> | null
Наследуется от AbstractField.getValue

hasValidator

hasValidator(validator: ClassCtor<IFieldValidator<AbstractModel<any>>>): boolean
Проверяет наличие валидатора указанного типа.
Параметры
- validator: ClassCtor<IFieldValidator<AbstractModel<any>>>
  Класс валидатора.
Возвращает boolean
Наследуется от AbstractField.hasValidator

isEqual

isEqual(
b: N extends void ? OptionValueType<M> : OptionValueType<M> | null,
): boolean
Проверяет равенство текущего значения и переданного.
Параметры
- b: N extends void ? OptionValueType<M> : OptionValueType<M> | null
  Значение для сравнения.
Возвращает boolean
Наследуется от AbstractField.isEqual

`Protected`isModified

isModified(): boolean
Returns true if the current value is different from the original value

Возвращает boolean
Наследуется от AbstractField.isModified

revert

revert(): void
Восстанавливает исходное значение поля.

Возвращает void
Наследуется от AbstractField.revert

serialize

serialize(): N extends void ? OptionValueType<M> : OptionValueType<M> | null
Сериализует значение поля в JavaScript-объект.

Возвращает N extends void ? OptionValueType<M> : OptionValueType<M> | null
Наследуется от AbstractField.serialize

setOriginalValue

setOriginalValue(
value: N extends void ? OptionValueType<M> : OptionValueType<M> | null,
): void
Устанавливает исходное значение поля.
Параметры
- value: N extends void ? OptionValueType<M> : OptionValueType<M> | null
  Исходное значение.
Возвращает void
Наследуется от AbstractField.setOriginalValue

setReactive

setReactive(props: ReactiveProp[]): void
Делает некоторые системные свойства реактивными в текущей модели.
Параметры
- props: ReactiveProp[]
  Список системных свойств.
Возвращает void
Наследуется от AbstractField.setReactive

setValue

setValue(
value: N extends void ? OptionValueType<M> : OptionValueType<M> | null,
silent?: boolean,
): void
Устанавливает новое значение поля.
Параметры
- value: N extends void ? OptionValueType<M> : OptionValueType<M> | null
  Новое значение.
- Optionalsilent: boolean
  Флаг тихой установки
Возвращает void
Наследуется от AbstractField.setValue

updateDirty

updateDirty(): void
Обновляет флаг изменилось ли поле.

Возвращает void
Наследуется от AbstractField.updateDirty

validate

validate(disablePropagation?: boolean): string[]
Валидирует поле.
Параметры
- OptionaldisablePropagation: boolean
  Флаг отключения передачи результата родителю
Возвращает string[]
Наследуется от AbstractField.validate

Класс EnumField<M, N>

Параметры типа

Иерархия (Просмотр сводки)

Индекс

Конструкторы

Свойства

Акцессоры

Методы

Конструкторы

constructor

Параметры типа

Параметры

Возвращает EnumField<M, N>

Свойства

ProtectedallowNull

ProtecteddescriptorConfig

Protecteddirty

ProtectedobservabilitySet

ProtectedoriginalValue

persist

validationResult

Protectedvalue

Акцессоры

displayValue

Возвращает string

isPrimaryKey

Возвращает boolean

options

Возвращает { title: string; value: OptionValueType<M> }[]

selectedItem

Возвращает ItemType<M> | undefined

Методы

addValidator

Параметры

Возвращает void

bind

Параметры

Возвращает void

ProtectedcastValue

Параметры

Возвращает N extends void ? OptionValueType<M> : OptionValueType<M> | null

clearValidationResult

Возвращает void

commit

Возвращает void

compare

Параметры

Возвращает number

getDirty

Возвращает boolean

getErrorMessage

Возвращает string

getLabel

Возвращает string

getOriginalValue

Возвращает N extends void ? OptionValueType<M> : OptionValueType<M> | null

getValidationResult

Возвращает string[]

getValidators

Возвращает IFieldValidator<AbstractModel<any>>[]

getValue

Возвращает N extends void ? OptionValueType<M> : OptionValueType<M> | null

hasValidator

Параметры

Возвращает boolean

isEqual

Параметры

Возвращает boolean

ProtectedisModified

Возвращает boolean

revert

Возвращает void

serialize

Возвращает N extends void ? OptionValueType<M> : OptionValueType<M> | null

setOriginalValue

Параметры

Возвращает void

setReactive

Параметры

Возвращает void

`Protected`allowNull

`Protected`descriptorConfig

`Protected`dirty

`Protected`observabilitySet

`Protected`originalValue

`Protected`value

`Protected`castValue

`Protected`isModified