Defines a generic container class which any form container should extend from.
| Name | Type | Description |
|---|---|---|
T |
extends ContainerJson & RulesJson |
type of the node which extends ContainerJson and RulesJson |
Scriptable<T>
↳ Container
↳↳ Form
↳↳ Fieldset
• get :type(): string
Custom widget type show to the user for capturing the data.
string
Scriptable.:type
• get activeChild(): null | BaseModel
null | BaseModel
• set activeChild(c): void
| Name | Type |
|---|---|
c |
null | BaseModel |
void
• get dataRef(): undefined | null | string
To map the field’s value to a property in the data model.
undefined | null | string
Scriptable.dataRef
• 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
Scriptable.description
• 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
Scriptable.description
• get enabled(): undefined | boolean
Whether the field is enabled and takes part in rules, events etc.
undefined | boolean
• set enabled(e): void
Whether the field is enabled and takes part in rules, events etc.
| Name | Type |
|---|---|
e |
undefined | boolean |
void
• get fieldType(): string
Type of field to capture the user data.
string
Scriptable.fieldType
• get form(): FormModel
Scriptable.form
• get fragment(): string
string
Scriptable.fragment
• get id(): string
Unique id of the form field.
string
Scriptable.id
• get index(): number
The index of the Field within its parent.
number
Scriptable.index
• get isContainer(): boolean
Whether the form field is container or not
boolean
Scriptable.isContainer
• get isFragment(): any
any
• get items(): (FieldModel | FieldsetModel)[]
Defines the children/items of the container
(FieldModel | FieldsetModel)[]
• get label(): undefined | Label
Label to be used for the field.
undefined | Label
Scriptable.label
• set label(l): void
Label to be used for the field.
| Name | Type |
|---|---|
l |
undefined | Label |
void
Scriptable.label
• get lang(): undefined | string
language of the field
undefined | string
Scriptable.lang
• get maxItems(): number
number
• set maxItems(m): void
| Name | Type |
|---|---|
m |
number |
void
• get minItems(): number
number
• set minItems(m): void
| Name | Type |
|---|---|
m |
number |
void
• get name(): undefined | string
Name of the form field.
undefined | string
Scriptable.name
• get parent(): ContainerModel
Defines the parent of the container
Scriptable.parent
• get properties(): Object
Custom properties of the form field.
Object
Scriptable.properties
• set properties(p): void
Custom properties of the form field.
| Name | Type |
|---|---|
p |
Object |
void
Scriptable.properties
• get qualifiedName(): any
any
Scriptable.qualifiedName
• get readOnly(): any
Whether the field should be readOnly to end user or not.
any
• set readOnly(e): void
Whether the field should be readOnly to end user or not.
| Name | Type |
|---|---|
e |
any |
void
• get repeatable(): any
Field is repeatable or not
any
Scriptable.repeatable
• get ruleEngine(): RuleEngine
RuleEngine
ContainerModel.ruleEngine
Scriptable.ruleEngine
• get screenReaderText(): undefined | string
undefined | string
Scriptable.screenReaderText
• get type(): undefined | string
undefined | string
Scriptable.type
• get uniqueItems(): undefined | boolean
undefined | boolean
Scriptable.uniqueItems
• get visible(): undefined | boolean
Whether the field should be visible to author or not.
undefined | boolean
Scriptable.visible
• set visible(v): void
Whether the field should be visible to author or not.
| Name | Type |
|---|---|
v |
undefined | boolean |
void
Scriptable.visible
▸ _canHaveRepeatingChildren(mode?): boolean
| Name | Type | Default value |
|---|---|---|
mode |
FormCreationMode |
'create' |
boolean
▸ change(event, context): void
| Name | Type |
|---|---|
event |
Action |
context |
any |
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
Scriptable.getNonTransparentParent
▸ getRules(): Items<string>
Items<string>
▸ getState(isRepeatableChild?, forRestore?): T & { :items: undefined = undefined; :itemsOrder: undefined = undefined; :type: string ; _dependents: undefined | string[] ; allowedComponents: undefined = undefined; columnClassNames: undefined = undefined; columnCount: undefined = undefined; enabled: undefined | boolean ; gridClassNames: undefined = undefined; id: string ; index: number ; items: any[] ; maxOccur: undefined | number ; minOccur: undefined | number ; parent: undefined = undefined; properties: { [key: string]: any; } ; qualifiedName: any ; readOnly: any ; repeatable: undefined | boolean = true }
Returns the current container state
| Name | Type | Default value |
|---|---|---|
isRepeatableChild |
boolean |
false |
forRestore |
boolean |
false |
T & { :items: undefined = undefined; :itemsOrder: undefined = undefined; :type: string ; _dependents: undefined | string[] ; allowedComponents: undefined = undefined; columnClassNames: undefined = undefined; columnCount: undefined = undefined; enabled: undefined | boolean ; gridClassNames: undefined = undefined; id: string ; index: number ; items: any[] ; maxOccur: undefined | number ; minOccur: undefined | number ; parent: undefined = undefined; properties: { [key: string]: any; } ; qualifiedName: any ; readOnly: any ; repeatable: undefined | boolean = true }
▸ hasDynamicItems(): boolean
returns whether the items in the Panel can repeat or not
boolean
▸ importData(dataModel): void
Imports the given form data
| Name | Type |
|---|---|
dataModel |
any |
void
▸ indexOf(f): number
Returns the index of the child item or the child container
| Name | Type |
|---|---|
f |
FieldModel | FieldsetModel |
number
▸ isTransparent(): boolean
Transparent form fields are meant only for creation of view. They are also not part of data
boolean
▸ notifyChildren(action): void
| Name | Type |
|---|---|
action |
Action |
void
▸ validate(): ValidationError[]
Validates the given form field
• _eventSource: EventSource = EventSource.CODE
• Abstract value: Primitives
The current value of the Field. The property is serialized in the Data Model.
• new Container<T>(json, _options)
| Name | Type |
|---|---|
T |
extends TranslationBaseJson & RulesJson & TranslationConstraintsJson & { accept?: string[] ; enforceEnum?: boolean ; exclusiveMaximum?: number ; exclusiveMinimum?: number ; format?: string ; maxFileSize?: string | number ; maxItems?: number ; maxLength?: number ; maxOccur?: number ; maximum?: number ; minItems?: number ; minLength?: number ; minOccur?: number ; minimum?: number ; pattern?: string ; required?: boolean ; step?: number ; type?: string ; uniqueItems?: boolean ; validationExpression?: string } & { :type?: string ; altText?: string ; appliedCssClassNames?: string ; buttonType?: string ; constraintMessages?: ConstraintsMessages ; dataRef?: null | string ; enabled?: boolean ; errorMessage?: string ; fieldType?: string ; label?: Label ; lang?: string ; name?: string ; properties?: { [key: string]: any; } ; repeatable?: boolean ; screenReaderText?: string ; tooltip?: string ; viewType?: string ; visible?: boolean } & { activeChild?: string ; initialItems?: number ; items: (FieldJson | ContainerJson)[] } |
| Name | Type |
|---|---|
json |
T |
_options |
Object |
_options.fieldFactory |
IFormFieldFactory |
_options.form |
FormModel |
_options.mode? |
"create" | "restore" |
_options.parent |
ContainerModel |
Scriptable<T\>.constructor