aem-forms-af-runtime

Class: Fieldset

Defines a field set class which extends from container

Hierarchy

• Container<FieldsetJson>

  ↳ Fieldset

Implements

• FieldsetModel

Table of contents

Accessors

• :type
• activeChild
• dataRef
• description
• enabled
• fieldType
• form
• fragment
• id
• index
• isContainer
• isFragment
• items
• label
• lang
• maxItems
• minItems
• name
• parent
• properties
• qualifiedName
• readOnly
• repeatable
• ruleEngine
• screenReaderText
• type
• uniqueItems
• value
• visible

Methods

• _canHaveRepeatingChildren
• change
• executeAction
• executeExpression
• focus
• getDependents
• getNonTransparentParent
• getPropertiesManager
• getRules
• getState
• hasDynamicItems
• importData
• indexOf
• isTransparent
• notifyChildren
• validate

Properties

• _eventSource

Accessors

:type

• get :type(): string

Custom widget type show to the user for capturing the data.

Returns

string

Implementation of

FieldsetModel.:type

Inherited from

Container.:type

---

activeChild

• get activeChild(): null | BaseModel

Returns

null | BaseModel

Implementation of

FieldsetModel.activeChild

Inherited from

Container.activeChild

• set activeChild(c): void

Parameters

Name	Type
c	null | BaseModel

Returns

void

Implementation of

FieldsetModel.activeChild

Inherited from

Container.activeChild

---

dataRef

• get dataRef(): undefined | null | string

To map the field’s value to a property in the data model.

Returns

undefined | null | string

Implementation of

FieldsetModel.dataRef

Inherited from

Container.dataRef

---

description

• get description(): undefined | string

Extra description to be shown to the user to aid in form filling experience. It can be rich text.

Returns

undefined | string

Implementation of

FieldsetModel.description

Inherited from

Container.description

• set description(d): void

Extra description to be shown to the user to aid in form filling experience. It can be rich text.

Parameters

Name	Type
d	undefined | string

Returns

void

Implementation of

FieldsetModel.description

Inherited from

Container.description

---

enabled

• get enabled(): undefined | boolean

Whether the field is enabled and takes part in rules, events etc.

Returns

undefined | boolean

Implementation of

FieldsetModel.enabled

Inherited from

Container.enabled

• set enabled(e): void

Whether the field is enabled and takes part in rules, events etc.

Parameters

Name	Type
e	undefined | boolean

Returns

void

Implementation of

FieldsetModel.enabled

Inherited from

Container.enabled

---

fieldType

• get fieldType(): string

Type of field to capture the user data.

Returns

string

Implementation of

FieldsetModel.fieldType

Overrides

Container.fieldType

---

form

• get form(): FormModel

Returns

FormModel

Inherited from

Container.form

---

fragment

• get fragment(): string

Returns

string

Implementation of

FieldsetModel.fragment

Inherited from

Container.fragment

---

id

• get id(): string

Unique id of the form field.

Returns

string

Implementation of

FieldsetModel.id

Inherited from

Container.id

---

index

• get index(): number

The index of the Field within its parent.

Returns

number

Implementation of

FieldsetModel.index

Inherited from

Container.index

---

isContainer

• get isContainer(): boolean

Whether the form field is container or not

Returns

boolean

Implementation of

FieldsetModel.isContainer

Inherited from

Container.isContainer

---

isFragment

• get isFragment(): any

Returns

any

Implementation of

FieldsetModel.isFragment

Inherited from

Container.isFragment

---

items

• get items(): (FieldModel | FieldsetModel)[]

Defines the children/items of the container

Returns

(FieldModel | FieldsetModel)[]

Implementation of

FieldsetModel.items

Overrides

Container.items

---

label

• get label(): undefined | Label

Label to be used for the field.

Returns

undefined | Label

Implementation of

FieldsetModel.label

Inherited from

Container.label

• set label(l): void

Label to be used for the field.

Parameters

Name	Type
l	undefined | Label

Returns

void

Implementation of

FieldsetModel.label

Inherited from

Container.label

---

lang

• get lang(): undefined | string

language of the field

Returns

undefined | string

Implementation of

FieldsetModel.lang

Inherited from

Container.lang

---

maxItems

• get maxItems(): number

Returns

number

Implementation of

FieldsetModel.maxItems

Inherited from

Container.maxItems

• set maxItems(m): void

Parameters

Name	Type
m	number

Returns

void

Implementation of

FieldsetModel.maxItems

Inherited from

Container.maxItems

---

minItems

• get minItems(): number

Returns

number

Implementation of

FieldsetModel.minItems

Inherited from

Container.minItems

• set minItems(m): void

Parameters

Name	Type
m	number

Returns

void

Implementation of

FieldsetModel.minItems

Inherited from

Container.minItems

---

name

• get name(): undefined | string

Name of the form field.

Returns

undefined | string

Implementation of

FieldsetModel.name

Inherited from

Container.name

---

parent

• get parent(): ContainerModel

Defines the parent of the container

Returns

ContainerModel

Implementation of

FieldsetModel.parent

Inherited from

Container.parent

---

properties

• get properties(): Object

Custom properties of the form field.

Returns

Object

Implementation of

FieldsetModel.properties

Inherited from

Container.properties

• set properties(p): void

Custom properties of the form field.

Parameters

Name	Type
p	Object

Returns

void

Implementation of

FieldsetModel.properties

Inherited from

Container.properties

---

qualifiedName

• get qualifiedName(): any

Returns

any

Implementation of

FieldsetModel.qualifiedName

Inherited from

Container.qualifiedName

---

readOnly

• get readOnly(): any

Whether the field should be readOnly to end user or not.

Returns

any

Implementation of

FieldsetModel.readOnly

Inherited from

Container.readOnly

• set readOnly(e): void

Whether the field should be readOnly to end user or not.

Parameters

Name	Type
e	any

Returns

void

Implementation of

FieldsetModel.readOnly

Inherited from

Container.readOnly

---

repeatable

• get repeatable(): any

Field is repeatable or not

Returns

any

Implementation of

FieldsetModel.repeatable

Inherited from

Container.repeatable

---

ruleEngine

• get ruleEngine(): RuleEngine

Returns

RuleEngine

Implementation of

FieldsetModel.ruleEngine

Inherited from

Container.ruleEngine

---

screenReaderText

• get screenReaderText(): undefined | string

Returns

undefined | string

Inherited from

Container.screenReaderText

---

type

• get type(): undefined | "array" | "object"

Returns

undefined | "array" | "object"

Implementation of

FieldsetModel.type

Overrides

Container.type

---

uniqueItems

• get uniqueItems(): undefined | boolean

Returns

undefined | boolean

Implementation of

FieldsetModel.uniqueItems

Inherited from

Container.uniqueItems

---

value

• get value(): any

The current value of the Field. The property is serialized in the Data Model.

Returns

any

Implementation of

FieldsetModel.value

Overrides

Container.value

---

visible

• get visible(): undefined | boolean

Whether the field should be visible to author or not.

Returns

undefined | boolean

Implementation of

FieldsetModel.visible

Inherited from

Container.visible

• set visible(v): void

Whether the field should be visible to author or not.

Parameters

Name	Type
v	undefined | boolean

Returns

void

Implementation of

FieldsetModel.visible

Inherited from

Container.visible

Methods

_canHaveRepeatingChildren

▸ _canHaveRepeatingChildren(mode?): boolean

Parameters

Name	Type	Default value
mode	FormCreationMode	'create'

Returns

boolean

Inherited from

Container._canHaveRepeatingChildren

---

change

▸ change(event, context): void

Parameters

Name	Type
event	Action
context	any

Returns

void

Inherited from

Container.change

---

executeAction

▸ executeAction(action): void

Executes the given action

Parameters

Name	Type	Description
action	Action	event object

Returns

void

Inherited from

Container.executeAction

---

executeExpression

▸ executeExpression(expr): any

Parameters

Name	Type
expr	string

Returns

any

Inherited from

Container.executeExpression

---

focus

▸ focus(): void

Returns

void

Inherited from

Container.focus

---

getDependents

▸ getDependents(): { id: string = x.node.id; propertyName: undefined | string = x.propertyName }[]

Returns

{ id: string = x.node.id; propertyName: undefined | string = x.propertyName }[]

Inherited from

Container.getDependents

---

getNonTransparentParent

▸ getNonTransparentParent(): ContainerModel

Returns

ContainerModel

Inherited from

Container.getNonTransparentParent

---

getPropertiesManager

▸ getPropertiesManager(): PropertiesManager

Get the PropertiesManager instance for use in setVariable

Returns

PropertiesManager

Inherited from

Container.getPropertiesManager

---

getRules

▸ getRules(): Items<string>

Returns

Items<string>

Inherited from

Container.getRules

---

getState

▸ getState(isRepeatableChild?, forRestore?): TranslationBaseJson & RulesJson & TranslationConstraintsJson & { accept?: string[] ; enforceEnum?: boolean ; exclusiveMaximum?: string | number ; exclusiveMinimum?: string | number ; format?: string ; maxFileSize?: string | number ; maxItems?: number ; maxLength?: number ; maxOccur?: number ; maximum?: string | number ; minItems?: number ; minLength?: number ; minOccur?: number ; minimum?: string | 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)[] } & { readOnly?: boolean ; type?: "object" | "array" } & { :items: undefined = undefined; :itemsOrder: undefined = undefined; :type: string ; _dependents: undefined | { id: string = x.node.id; propertyName: undefined | string = x.propertyName }[] ; _itemTemplate: undefined | { :type?: string ; accept?: string[] ; altText?: string ; appliedCssClassNames?: string ; buttonType?: string ; checked?: boolean ; constraintMessages?: ConstraintsMessages ; dataRef?: null | string ; default?: any ; description?: string ; displayFormat?: string ; displayValue?: string ; displayValueExpression?: string ; editFormat?: string ; editValue?: string ; emptyValue?: "" | "undefined" | "null" ; enabled?: boolean ; enforceEnum?: boolean ; enum?: any[] ; enumNames?: string[] ; errorMessage?: string ; events?: Items<undefined | string | string[]> ; exclusiveMaximum?: string | number ; exclusiveMinimum?: string | number ; fieldType?: string ; format?: string ; label?: Label ; lang?: string ; maxFileSize?: string | number ; maxItems?: number ; maxLength?: number ; maxOccur?: number ; maximum?: string | number ; minItems?: number ; minLength?: number ; minOccur?: number ; minimum?: string | number ; name?: string ; pattern?: string ; placeholder?: string ; properties?: { [key: string]: any; } ; readOnly?: boolean ; repeatable?: boolean ; required?: boolean ; rules?: Items<string> ; screenReaderText?: string ; step?: number ; tooltip?: string ; type?: string ; uniqueItems?: boolean ; valid?: boolean ; validationExpression?: string ; validationMessage?: string ; validity?: any ; value?: any ; viewType?: string ; visible?: boolean } | { :type?: string ; accept?: string[] ; activeChild?: string ; altText?: string ; appliedCssClassNames?: string ; buttonType?: string ; constraintMessages?: ConstraintsMessages ; dataRef?: null | string ; description?: string ; enabled?: boolean ; enforceEnum?: boolean ; enum?: any[] ; enumNames?: string[] ; errorMessage?: string ; events?: Items<undefined | string | string[]> ; exclusiveMaximum?: string | number ; exclusiveMinimum?: string | number ; fieldType?: string ; format?: string ; initialItems?: number ; items: (FieldJson | ContainerJson)[] ; label?: Label ; lang?: string ; maxFileSize?: string | number ; maxItems?: number ; maxLength?: number ; maxOccur?: number ; maximum?: string | number ; minItems?: number ; minLength?: number ; minOccur?: number ; minimum?: string | number ; name?: string ; pattern?: string ; properties?: { [key: string]: any; } ; readOnly?: boolean ; repeatable?: boolean ; required?: boolean ; rules?: Items<string> ; screenReaderText?: string ; step?: number ; tooltip?: string ; type?: "object" | "array" ; uniqueItems?: boolean ; validationExpression?: string ; viewType?: string ; visible?: boolean } ; 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

Parameters

Name	Type	Default value
isRepeatableChild	boolean	false
forRestore	boolean	false

Returns

TranslationBaseJson & RulesJson & TranslationConstraintsJson & { accept?: string[] ; enforceEnum?: boolean ; exclusiveMaximum?: string | number ; exclusiveMinimum?: string | number ; format?: string ; maxFileSize?: string | number ; maxItems?: number ; maxLength?: number ; maxOccur?: number ; maximum?: string | number ; minItems?: number ; minLength?: number ; minOccur?: number ; minimum?: string | 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)[] } & { readOnly?: boolean ; type?: "object" | "array" } & { :items: undefined = undefined; :itemsOrder: undefined = undefined; :type: string ; _dependents: undefined | { id: string = x.node.id; propertyName: undefined | string = x.propertyName }[] ; _itemTemplate: undefined | { :type?: string ; accept?: string[] ; altText?: string ; appliedCssClassNames?: string ; buttonType?: string ; checked?: boolean ; constraintMessages?: ConstraintsMessages ; dataRef?: null | string ; default?: any ; description?: string ; displayFormat?: string ; displayValue?: string ; displayValueExpression?: string ; editFormat?: string ; editValue?: string ; emptyValue?: "" | "undefined" | "null" ; enabled?: boolean ; enforceEnum?: boolean ; enum?: any[] ; enumNames?: string[] ; errorMessage?: string ; events?: Items<undefined | string | string[]> ; exclusiveMaximum?: string | number ; exclusiveMinimum?: string | number ; fieldType?: string ; format?: string ; label?: Label ; lang?: string ; maxFileSize?: string | number ; maxItems?: number ; maxLength?: number ; maxOccur?: number ; maximum?: string | number ; minItems?: number ; minLength?: number ; minOccur?: number ; minimum?: string | number ; name?: string ; pattern?: string ; placeholder?: string ; properties?: { [key: string]: any; } ; readOnly?: boolean ; repeatable?: boolean ; required?: boolean ; rules?: Items<string> ; screenReaderText?: string ; step?: number ; tooltip?: string ; type?: string ; uniqueItems?: boolean ; valid?: boolean ; validationExpression?: string ; validationMessage?: string ; validity?: any ; value?: any ; viewType?: string ; visible?: boolean } | { :type?: string ; accept?: string[] ; activeChild?: string ; altText?: string ; appliedCssClassNames?: string ; buttonType?: string ; constraintMessages?: ConstraintsMessages ; dataRef?: null | string ; description?: string ; enabled?: boolean ; enforceEnum?: boolean ; enum?: any[] ; enumNames?: string[] ; errorMessage?: string ; events?: Items<undefined | string | string[]> ; exclusiveMaximum?: string | number ; exclusiveMinimum?: string | number ; fieldType?: string ; format?: string ; initialItems?: number ; items: (FieldJson | ContainerJson)[] ; label?: Label ; lang?: string ; maxFileSize?: string | number ; maxItems?: number ; maxLength?: number ; maxOccur?: number ; maximum?: string | number ; minItems?: number ; minLength?: number ; minOccur?: number ; minimum?: string | number ; name?: string ; pattern?: string ; properties?: { [key: string]: any; } ; readOnly?: boolean ; repeatable?: boolean ; required?: boolean ; rules?: Items<string> ; screenReaderText?: string ; step?: number ; tooltip?: string ; type?: "object" | "array" ; uniqueItems?: boolean ; validationExpression?: string ; viewType?: string ; visible?: boolean } ; 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 }

Implementation of

FieldsetModel.getState

Inherited from

Container.getState

---

hasDynamicItems

▸ hasDynamicItems(): boolean

returns whether the items in the Panel can repeat or not

Returns

boolean

Inherited from

Container.hasDynamicItems

---

importData

▸ importData(dataModel): void

Imports the given form data

Parameters

Name	Type
dataModel	any

Returns

void

Implementation of

FieldsetModel.importData

Inherited from

Container.importData

---

indexOf

▸ indexOf(f): number

Returns the index of the child item or the child container

Parameters

Name	Type
f	FieldModel | FieldsetModel

Returns

number

Implementation of

FieldsetModel.indexOf

Inherited from

Container.indexOf

---

isTransparent

▸ isTransparent(): boolean

Transparent form fields are meant only for creation of view. They are also not part of data

Returns

boolean

Implementation of

FieldsetModel.isTransparent

Inherited from

Container.isTransparent

---

notifyChildren

▸ notifyChildren(action): void

Parameters

Name	Type
action	Action

Returns

void

Inherited from

Container.notifyChildren

---

validate

▸ validate(): ValidationError[]

Validates the given form field

Returns

ValidationError[]

Implementation of

FieldsetModel.validate

Inherited from

Container.validate

Properties

_eventSource

• _eventSource: EventSource = EventSource.CODE

Implementation of

FieldsetModel._eventSource

Inherited from

Container._eventSource

This site is open source. Improve this page.