Class EnumField<M, N>

Public

Type Parameters

M
N extends void | null = void

Hierarchy (View Summary)

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

Constructors

constructor

new EnumField<M, N extends null | void = void>(
    value: N extends void ? OptionValueType<M> : null | OptionValueType<M>,
    onChangeDirty?: ModelDirtyChangeHandler,
    descriptorConfig?: IEnumFieldMainDescriptorConfig<M, void>,
    onValidation?: (validationResult: string[]) => void,
): EnumField<M, N>
Type Parameters
- M
- N extends null | void = void
Parameters
- value: N extends void ? OptionValueType<M> : null | OptionValueType<M>
- OptionalonChangeDirty: ModelDirtyChangeHandler
- OptionaldescriptorConfig: IEnumFieldMainDescriptorConfig<M, void>
- OptionalonValidation: (validationResult: string[]) => void
Returns EnumField<M, N>
Inherited from AbstractField.constructor
- Defined in app-sdk/index.d.ts:490

Properties

`Protected`allowNull

allowNull: boolean

`Protected`descriptorConfig

descriptorConfig: undefined | IEnumFieldMainDescriptorConfig<M, void>

`Protected`dirty

dirty: boolean

`Protected`observabilitySet

observabilitySet: Set<ReactiveProp>

`Protected`originalValue

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

persist

persist: boolean

validationResult

validationResult: string[]

`Protected`value

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

Accessors

displayValue

get displayValue(): string
Returns string
- Defined in app-sdk/index.d.ts:6633

isPrimaryKey

get isPrimaryKey(): boolean
Returns boolean
Inherited from AbstractField.isPrimaryKey
- Defined in app-sdk/index.d.ts:524

options

get options(): { title: string; value: OptionValueType<M> }[]
Returns { title: string; value: OptionValueType<M> }[]
- Defined in app-sdk/index.d.ts:6629

selectedItem

get selectedItem(): undefined | ItemType<M>
Returns undefined | ItemType<M>
- Defined in app-sdk/index.d.ts:6634

Methods

addValidator

addValidator(validator: IFieldValidator): void
Parameters
- validator: IFieldValidator
Returns void
Inherited from AbstractField.addValidator
- Defined in app-sdk/index.d.ts:509

bind

bind(
    field: AbstractField<
        N extends void ? OptionValueType<M> : null | OptionValueType<M>,
    >,
): void
Parameters
- field: AbstractField<N extends void ? OptionValueType<M> : null | OptionValueType<M>>
Returns void
Inherited from AbstractField.bind
- Defined in app-sdk/index.d.ts:521

`Protected`castValue

castValue(
value: any,
): N extends void ? OptionValueType<M> : null | OptionValueType<M>
Parameters
- value: any
Returns N extends void ? OptionValueType<M> : null | OptionValueType<M>
Inherited from AbstractField.castValue
- Defined in app-sdk/index.d.ts:494

clearValidationResult

clearValidationResult(): void
Returns void
Inherited from AbstractField.clearValidationResult
- Defined in app-sdk/index.d.ts:508

commit

commit(): void
Returns void
Inherited from AbstractField.commit
- Defined in app-sdk/index.d.ts:515

compare

compare(
a: N extends void ? OptionValueType<M> : null | OptionValueType<M>,
b: N extends void ? OptionValueType<M> : null | OptionValueType<M>,
): number
Function for comparing elements of type T
Parameters
- a: N extends void ? OptionValueType<M> : null | OptionValueType<M>
- b: N extends void ? OptionValueType<M> : null | OptionValueType<M>
Returns number
Inherited from AbstractField.compare
- Defined in app-sdk/index.d.ts:514

getDirty

getDirty(): boolean
Returns boolean
Inherited from AbstractField.getDirty
- Defined in app-sdk/index.d.ts:518

getErrorMessage

getErrorMessage(): string
Returns string
Inherited from AbstractField.getErrorMessage
- Defined in app-sdk/index.d.ts:522

getLabel

getLabel(): string
Returns string
Inherited from AbstractField.getLabel
- Defined in app-sdk/index.d.ts:523

getOriginalValue

getOriginalValue(): N extends void
? OptionValueType<M>
: null | OptionValueType<M>
Returns N extends void ? OptionValueType<M> : null | OptionValueType<M>
Inherited from AbstractField.getOriginalValue
- Defined in app-sdk/index.d.ts:498

getValidationResult

getValidationResult(): string[]
Returns string[]
Inherited from AbstractField.getValidationResult
- Defined in app-sdk/index.d.ts:520

getValidators

getValidators(): IFieldValidator<AbstractModel<any>>[]
Returns IFieldValidator<AbstractModel<any>>[]
Inherited from AbstractField.getValidators
- Defined in app-sdk/index.d.ts:510

getValue

getValue(): N extends void ? OptionValueType<M> : null | OptionValueType<M>
Returns N extends void ? OptionValueType<M> : null | OptionValueType<M>
Inherited from AbstractField.getValue
- Defined in app-sdk/index.d.ts:497

hasValidator

hasValidator(validator: ClassCtor<IFieldValidator<AbstractModel<any>>>): boolean
Parameters
- validator: ClassCtor<IFieldValidator<AbstractModel<any>>>
Returns boolean
Inherited from AbstractField.hasValidator
- Defined in app-sdk/index.d.ts:519

isEqual

isEqual(
b: N extends void ? OptionValueType<M> : null | OptionValueType<M>,
): boolean
Parameters
- b: N extends void ? OptionValueType<M> : null | OptionValueType<M>
Returns boolean
Inherited from AbstractField.isEqual
- Defined in app-sdk/index.d.ts:503

`Protected`isModified

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

Returns boolean
Inherited from AbstractField.isModified
- Defined in app-sdk/index.d.ts:502

revert

revert(): void
Returns void
Inherited from AbstractField.revert
- Defined in app-sdk/index.d.ts:516

serialize

serialize(): N extends void ? OptionValueType<M> : null | OptionValueType<M>
Returns N extends void ? OptionValueType<M> : null | OptionValueType<M>
Inherited from AbstractField.serialize
- Defined in app-sdk/index.d.ts:493

setOriginalValue

setOriginalValue(
value: N extends void ? OptionValueType<M> : null | OptionValueType<M>,
): void
Parameters
- value: N extends void ? OptionValueType<M> : null | OptionValueType<M>
Returns void
Inherited from AbstractField.setOriginalValue
- Defined in app-sdk/index.d.ts:496

setReactive

setReactive(props: ReactiveProp[]): void
Make some of the system properties reactive in the current model
Parameters
- props: ReactiveProp[]
  list of system properties
Returns void
Inherited from AbstractField.setReactive
- Defined in app-sdk/index.d.ts:3225

setValue

setValue(
value: N extends void ? OptionValueType<M> : null | OptionValueType<M>,
silent?: boolean,
): void
Parameters
- value: N extends void ? OptionValueType<M> : null | OptionValueType<M>
- Optionalsilent: boolean
Returns void
Inherited from AbstractField.setValue
- Defined in app-sdk/index.d.ts:495

updateDirty

updateDirty(): void
Returns void
Inherited from AbstractField.updateDirty
- Defined in app-sdk/index.d.ts:517

validate

validate(disablePropagation?: boolean): string[]
Parameters
- OptionaldisablePropagation: boolean
  Parent cmp notification flag about validation
Returns string[]
Inherited from AbstractField.validate
- Defined in app-sdk/index.d.ts:507

Class EnumField<M, N>

Public

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns EnumField<M, N>

Properties

ProtectedallowNull

ProtecteddescriptorConfig

Protecteddirty

ProtectedobservabilitySet

ProtectedoriginalValue

persist

validationResult

Protectedvalue

Accessors

displayValue

Returns string

isPrimaryKey

Returns boolean

options

Returns { title: string; value: OptionValueType<M> }[]

selectedItem

Returns undefined | ItemType<M>

Methods

addValidator

Parameters

Returns void

bind

Parameters

Returns void

ProtectedcastValue

Parameters

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

clearValidationResult

Returns void

commit

Returns void

compare

Parameters

Returns number

getDirty

Returns boolean

getErrorMessage

Returns string

getLabel

Returns string

getOriginalValue

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

getValidationResult

Returns string[]

getValidators

Returns IFieldValidator<AbstractModel<any>>[]

getValue

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

hasValidator

Parameters

Returns boolean

isEqual

Parameters

Returns boolean

ProtectedisModified

Returns boolean

revert

Returns void

serialize

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

setOriginalValue

Parameters

Returns void

setReactive

Parameters

`Protected`allowNull

`Protected`descriptorConfig

`Protected`dirty

`Protected`observabilitySet

`Protected`originalValue

`Protected`value

`Protected`castValue

`Protected`isModified