Class StringField<T>

Public

Type Parameters

T extends void | null = void

Hierarchy (View Summary)

AbstractField<T extends void ? string : string | null>
- StringField

Constructors

constructor

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

Properties

`Protected`allowNull

allowNull: boolean

`Protected`descriptorConfig

descriptorConfig: undefined | BaseOptions

`Protected`dirty

dirty: boolean

`Protected`observabilitySet

observabilitySet: Set<ReactiveProp>

`Protected`originalValue

originalValue: T extends void ? string : null | string

persist

persist: boolean

validationResult

validationResult: string[]

`Protected`value

value: IObservableValue<T extends void ? string : null | string>

Accessors

isPrimaryKey

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

Methods

addValidator

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

bind

bind(field: AbstractField<T extends void ? string : null | string>): void
Parameters
- field: AbstractField<T extends void ? string : null | string>
Returns void
Inherited from AbstractField.bind
- Defined in app-sdk/index.d.ts:566

`Protected`castValue

castValue(value: any): any
Parameters
- value: any
Returns any
Overrides AbstractField.castValue
- Defined in app-sdk/index.d.ts:19306

clearValidationResult

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

commit

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

compare

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

getDirty

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

getErrorMessage

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

getLabel

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

getOriginalValue

getOriginalValue(): T extends void ? string : null | string
Returns T extends void ? string : null | string
Inherited from AbstractField.getOriginalValue
- Defined in app-sdk/index.d.ts:543

getValidationResult

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

getValidators

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

getValue

getValue(): T extends void ? string : null | string
Returns T extends void ? string : null | string
Inherited from AbstractField.getValue
- Defined in app-sdk/index.d.ts:542

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:564

isEqual

isEqual(b: T extends void ? string : null | string): boolean
Parameters
- b: T extends void ? string : null | string
Returns boolean
Inherited from AbstractField.isEqual
- Defined in app-sdk/index.d.ts:548

`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:547

revert

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

serialize

serialize(): T extends void ? string : null | string
Returns T extends void ? string : null | string
Inherited from AbstractField.serialize
- Defined in app-sdk/index.d.ts:538

setOriginalValue

setOriginalValue(value: T extends void ? string : null | string): void
Parameters
- value: T extends void ? string : null | string
Returns void
Inherited from AbstractField.setOriginalValue
- Defined in app-sdk/index.d.ts:541

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:3585

setValue

setValue(value: T extends void ? string : null | string, silent?: boolean): void
Parameters
- value: T extends void ? string : null | string
- Optionalsilent: boolean
Returns void
Inherited from AbstractField.setValue
- Defined in app-sdk/index.d.ts:540

updateDirty

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

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:552