Defines a generic base class which all objects of form runtime model should extend from.
| Name | Type | Description |
|---|---|---|
T |
extends BaseJson |
type of the form object which extends from base type |
BaseNode
• get :type(): string
Custom widget type show to the user for capturing the data.
string
• get dataRef(): undefined | null | string
To map the field’s value to a property in the data model.
undefined | null | string
• get description(): undefined | string
Extra description to be shown to the user to aid in form filling experience. It can be rich text.
undefined | string
• set description(d): void
Extra description to be shown to the user to aid in form filling experience. It can be rich text.
| Name | Type |
|---|---|
d |
undefined | string |
void
• get fieldType(): string
Type of field to capture the user data.
string
• get form(): FormModel
• get fragment(): string
string
• get id(): string
Unique id of the form field.
string
• get index(): number
The index of the Field within its parent.
number
• get isContainer(): boolean
Whether the form field is container or not
boolean
• get label(): undefined | Label
Label to be used for the field.
undefined | Label
• set label(l): void
Label to be used for the field.
| Name | Type |
|---|---|
l |
undefined | Label |
void
• get lang(): undefined | string
language of the field
undefined | string
• get name(): undefined | string
Name of the form field.
undefined | string
• get parent(): ContainerModel
The Parent Panel of the Field/Panel.
• get properties(): Object
Custom properties of the form field.
Object
• set properties(p): void
Custom properties of the form field.
| Name | Type |
|---|---|
p |
Object |
void
• get qualifiedName(): any
any
• get repeatable(): any
Field is repeatable or not
any
• get ruleEngine(): RuleEngine
RuleEngine
• get screenReaderText(): undefined | string
undefined | string
• get type(): undefined | string
undefined | string
• get uniqueItems(): undefined | boolean
undefined | boolean
• get visible(): undefined | boolean
Whether the field should be visible to author or not.
undefined | boolean
• set visible(v): void
Whether the field should be visible to author or not.
| Name | Type |
|---|---|
v |
undefined | boolean |
void
• _eventSource: EventSource = EventSource.CODE
• Abstract value: Primitives
The current value of the Field. The property is serialized in the Data Model.
▸ Abstract defaultDataModel(name): undefined | default
| Name | Type |
|---|---|
name |
string | number |
undefined | default
▸ dispatch(action): void
| Name | Type |
|---|---|
action |
Action |
void
BaseModel.dispatch
▸ Abstract executeAction(action): any
| Name | Type |
|---|---|
action |
Action |
any
▸ focus(): void
void
▸ getDependents(): string[]
string[]
▸ getNonTransparentParent(): ContainerModel
▸ getState(forRestore?): T & { :type: string ; _dependents: undefined | string[] ; allowedComponents: undefined = undefined; columnClassNames: undefined = undefined; columnCount: undefined = undefined; gridClassNames: undefined = undefined; id: string ; index: number ; maxOccur: undefined | number ; minOccur: undefined | number ; parent: undefined = undefined; properties: { [key: string]: any; } ; qualifiedName: any ; repeatable: undefined | boolean = true }
| Name | Type | Default value |
|---|---|---|
forRestore |
boolean |
false |
T & { :type: string ; _dependents: undefined | string[] ; allowedComponents: undefined = undefined; columnClassNames: undefined = undefined; columnCount: undefined = undefined; gridClassNames: undefined = undefined; id: string ; index: number ; maxOccur: undefined | number ; minOccur: undefined | number ; parent: undefined = undefined; properties: { [key: string]: any; } ; qualifiedName: any ; repeatable: undefined | boolean = true }
▸ isTransparent(): boolean
Transparent form fields are meant only for creation of view. They are also not part of data
boolean
▸ Abstract reset(): any
Resets the form model
any
▸ Abstract syncDataAndFormModel(a?): any
| Name | Type |
|---|---|
a? |
default | default |
any
BaseModel.syncDataAndFormModel
▸ Abstract validate(): ValidationError[]
Validates the given form field