new GuideCompositeField()
JavaScript class to represent the adaptive forms GuideCompositeField Component. This class provides common functionality to Fields that output two values like File Upload (Comments and File).
- Since:
-
- 6.0
Extends
Members
-
<readonly> items :Array.<GuideNode>
returns a list of children inside the component.
-
Type:
- Array.<GuideNode>
- Since:
-
- 6.0
- Inherited From:
-
<readonly, nullable> shortDescription :String
The short description defined in the Scriptable object.
-
In AF, one can define short Description for the Fields. This API returns the short Description set on the Field. It is non null only for Field objects
Type:
- String
- Since:
-
- 6.0
- Inherited From:
-
<readonly, nullable> longDescription :String
Specifies the long description present in the Scriptable object
-
In AF, one can define long Description for the Objects. This API returns the long Description set on the Objects.
Type:
- String
- Since:
-
- 6.0
- Inherited From:
-
visible :boolean
Visiblity of the Node. True if it's visible otherwise false.
-
Type:
- boolean
- Since:
-
- 6.0
- Inherited From:
- See:
-
enabled :boolean
Specify whether the component is enabled or not.
-
Type:
- boolean
- Since:
-
- 6.0
- Inherited From:
- See:
-
<readonly, non-null> name :string
Name of the node
-
Type:
- string
- Since:
-
- 6.0
- Inherited From:
-
<readonly, non-null> somExpression :string
SOM Expression of the Node.
-
In Adaptive Forms SOM is a model to access fields and Panels. The SOM Expression provides easy access to the Fields and Objects through a straightforward syntax
Type:
- string
- Since:
-
- 6.0
- Inherited From:
Example
Considering the heirarchy, -- guide -- panel1 ---- field2 ---- panel2 ------ field3 the som Expression of field3 will be guide[0].panel1[0].panel2[0].field3[0]. The 0 here represents the same name sibling index of that particular item in its parent. If panel2 has an additional child field3 as ---- panel2 ------- field3 ------- field3 The second field3 would have the somExpression guide[0].panel1[0].panel2[0].field3[1]
-
<readonly, nullable> title :string
Title of the element, localized as per the locale of the form.
-
Returns the localized version of the title. In case of Fields it is the Caption of the Field.
Type:
- string
- Since:
-
- 6.0
- Inherited From:
-
<readonly, nullable> nonLocalizedTitle :string
Non Localized Title of the element.
-
Type:
- string
- Since:
-
- 6.0
- Inherited From:
-
<readonly, non-null> panel :Panel
Parent panel in which the Node is inserted
-
Type:
- Since:
-
- 6.0
- Inherited From:
-
<readonly, non-null> index :number
Index of the Node among its siblings having the same name as itself
-
Every node in the Adaptive Form field has an index depending on the number of same named siblings that the node has before it. If the element has no same named sibling its index will always be 0.
Type:
- number
- Since:
-
- 6.0
- Inherited From:
-
dorExclusion :boolean
Whether the object is excluded from DOR or not
-
The property specifies the exclusion of the field from document of record. If the value is true, then the field is excluded otherwise included in DoR. If excludeFromDoRIfHidden property is set at guide container, the value of dorExclusion is derived from visibility of field dynamically.
Type:
- boolean
- Since:
-
- 6.1-FP1
- Inherited From:
-
<readonly> bindRef :String
Binding specified for the object
-
In AF, components can be bound to XML Schema or XFA elements. This API returns that binding. In case of XFA elements, it returns the SOM Expression of that element otherwise the XPATH of the element.
Type:
- String
- Since:
-
- 6.2
- Inherited From:
-
<readonly> isXsd :boolean
Whether the element is bound to XSD element or not
-
In AF, components can be bound to Schema(XML/JSON) or XFA elements. This API returns true if the component is bound to XML Schema false otherwise
Type:
- boolean
- Since:
-
- 6.2
- Inherited From:
-
stateOverrides :map
overridden state of object
-
The property specifies overridden state in field
Type:
- map
- Since:
-
- 6.5
- Inherited From:
Methods
-
validate(errorList)
Runs the validations of all its descendants and return its results.
-
The API iterates over all its and calls their validate API.
Parameters:
Name Type Description errorList
Array.<Field~ValidationError> The array will be filled with the ValidationError object if the validations on the field fail.
- Since:
-
- 6.0
- Inherited From:
- See:
Returns:
true if all the validations of all its descendant passes, false otherwise
- Type
- boolean
-
resetData()
reset the data of all the Fields present inside this container
-
- Since:
-
- 6.0
- Inherited From:
-
visit(callback, context)
Executes a callback on the element and its children.
-
The callback is called for the element and all its children.
Parameters:
Name Type Description callback
GuideNode~VisitorCallback context
Object this parameter to be used
- Since:
-
- 6.0
- Inherited From: