Defines scriptable aspects (ie rules, events) of form runtime model. Any form runtime object which requires execution of rules/events should extend from this class.
Name | Type |
---|---|
T |
extends RulesJson |
• get
:type(): string
string
BaseNode.:type
• get
dataRef(): undefined
| null
| string
undefined
| null
| string
BaseNode.dataRef
• get
description(): undefined
| string
undefined
| string
BaseNode.description
• set
description(d
): void
Name | Type |
---|---|
d |
undefined | string |
void
BaseNode.description
• get
fieldType(): string
string
BaseNode.fieldType
• get
form(): FormModel
BaseNode.form
• get
fragment(): string
string
BaseNode.fragment
• get
id(): string
string
BaseNode.id
• get
index(): number
number
BaseNode.index
• get
isContainer(): boolean
boolean
BaseNode.isContainer
• get
label(): undefined
| Label
undefined
| Label
BaseNode.label
• set
label(l
): void
Name | Type |
---|---|
l |
undefined | Label |
void
BaseNode.label
• get
lang(): undefined
| string
undefined
| string
BaseNode.lang
• get
name(): undefined
| string
undefined
| string
BaseNode.name
• get
parent(): ContainerModel
BaseNode.parent
• get
properties(): Object
Object
BaseNode.properties
• set
properties(p
): void
Name | Type |
---|---|
p |
Object |
void
BaseNode.properties
• get
qualifiedName(): any
any
BaseNode.qualifiedName
• get
repeatable(): any
any
BaseNode.repeatable
• get
ruleEngine(): RuleEngine
RuleEngine
ScriptableField.ruleEngine
BaseNode.ruleEngine
• get
screenReaderText(): undefined
| string
undefined
| string
BaseNode.screenReaderText
• get
type(): undefined
| string
undefined
| string
BaseNode.type
• get
uniqueItems(): undefined
| boolean
undefined
| boolean
BaseNode.uniqueItems
• get
visible(): undefined
| boolean
undefined
| boolean
BaseNode.visible
• set
visible(v
): void
Name | Type |
---|---|
v |
undefined | boolean |
void
BaseNode.visible
• _eventSource: EventSource
= EventSource.CODE
• Abstract
value: Primitives
The current value of the Field. The property is serialized in the Data Model.
▸ change(event
, context
): void
Name | Type |
---|---|
event |
Action |
context |
any |
void
▸ Abstract
defaultDataModel(name
): undefined
| default
Name | Type |
---|---|
name |
string | number |
undefined
| default
▸ dispatch(action
): void
Name | Type |
---|---|
action |
Action |
void
▸ executeAction(action
): void
Executes the given action
Name | Type | Description |
---|---|---|
action |
Action |
event object |
void
▸ executeExpression(expr
): any
Name | Type |
---|---|
expr |
string |
any
▸ focus(): void
void
▸ getDependents(): string
[]
string
[]
▸ getNonTransparentParent(): ContainerModel
BaseNode.getNonTransparentParent
▸ getRules(): Items
<string
>
Items
<string
>
▸ 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
▸ Abstract
validate(): ValidationError
[]
Validates the given form field