自适应表单表达式

自适应表单借助动态脚本功能为最终用户提供优化和简化的表单填写体验。 它允许您编写表达式来添加各种行为,如动态显示/隐藏字段和面板。 它还允许您添加计算字段、使字段为只读、添加验证逻辑等。 动态行为基于用户输入或预填数据。

JavaScript是自适应表单的表达式语言。 所有表达式都是有效的JavaScript表达式,并使用自适应表单脚本模型API。 这些表达式返回某些类型的值。 有关自适应表单类、事件、对象和公共API的完整列表,请参阅自适应表单的JavaScript库API参考

编写表达式的最佳实践

  • 在编写表达式时,要访问字段和面板,可以使用字段或面板的名称。 要访问字段的值,请使用value属性。 例如,field1.value
  • 在表单中为字段和面板使用唯一名称。 它有助于避免与编写表达式时使用的字段名称发生任何可能的冲突。
  • 编写多行表达式时,使用分号来终止语句。

涉及重复面板的表达式的最佳实践

重复面板是使用脚本API或预填充数据动态添加或删除面板的实例。 有关使用重复面板的详细信息,请参阅创建具有可重复部分的表单

  • 要创建重复面板,请在面板对话框中打开设置,并将最大计数字段的值设置为大于1。

  • 面板重复设置的最小计数值可以是一个或多个,但不能大于最大计数值。

  • 当表达式引用重复面板的字段时,表达式中的字段名称解析为最接近的重复元素。

  • 自适应表单提供了一些特殊函数来简化可重复面板的计算,如和、计数、最小、最大、过滤器等。 有关函数的完整列表,请参阅自适应表单的JavaScript库API参考

  • 用于处理重复面板实例的API有:

    • 要添加面板实例,请执行以下操作:panel1.instanceManager.addInstance()
    • 要获取面板重复索引,请执行以下操作:panel1.instanceIndex
    • 要获取面板的instanceManager,请执行以下操作:_panel1 or panel1.instanceManager
    • 删除面板实例:_panel1.removeInstance(panel1.instanceIndex)

表达式类型

在自适应表单中,您可以编写表达式来添加动态显示/隐藏字段和面板等行为。 您还可以编写表达式来添加计算字段、使字段为只读、验证逻辑等。 自适应表单支持以下表达式:

访问表达式(启用表达式)

您可以使用访问表达式启用或禁用字段。 如果表达式使用字段的值,则每当字段的值发生更改时,都会触发表达式。

适用于:字段

返回类型:表达式返回布尔值,表示字段是启用还是禁用。true 表示字段已启用, ​而false表示字段已禁用。

示例:要仅在字段1的值设置为 X 时启用 字段,访问表达式为: field1.value == "X"

计算表达式

计算表达式用于使用表达式自动计算字段的值。 通常,此类表达式使用其他字段的值属性。 例如,field2.value + field3.value。 只要field2field3的值发生变化,就会重新触发表达式并重新计算值。

适用于:字段

返回类型:表达式返回与显示表达式结果的字段(例如,小数)兼容的值。

示例:显示字段1中两个字段总和的计算 表达式 是:
field2.value + field3.value

单击表达式

单击表达式处理对按钮的单击事件执行的操作。 开箱即用的GuideBridge提供API以执行各种功能,如提交、验证以及单击表达式。 有关API的完整列表,请参阅GuideBridge API

适用于:按钮字段

返回类型:单击表达式不返回任何值。如果任何表达式返回值,则忽略该值。

示例:要在按钮的单 击操 作中填充一个文本框1,其值 AEM Forms textbox1.value="AEM Forms" ,按钮的单击表达式为"

初始化脚本

初始化脚本在自适应表单被初始化时触发。 初始化脚本的行为方式取决于情况:

  • 当在没有数据预填的情况下渲染自适应表单时,初始化脚本在表单初始化后运行。
  • 当使用数据预填渲染自适应表单时,该脚本在预填操作完成后运行。
  • 当触发自适应表单的服务器侧重验证时,执行初始化脚本。

适用于:字 段和面板

返回类型: 初始化脚本表达式不返回任何值。如果任何表达式返回值,则忽略该值。

示例: 在数据预填方案中,要在将字段值保存为null 'Adaptive Forms' 时用默认值填充字段,初始化脚本表达式为:
if(this.value==null) this.value='Adaptive Forms';

选项表达式

选项表达式用于动态填充下拉列表字段的选项。

适用于:下拉列表字段

返回类型:选项表达式返回字符串值的数组。每个值可以是简单字符串,如​Male,或者是键=值对格式,如​1=Male

示例:要根据其他字段的值填充字段的值,请提供一个简单的选项表达式。例如,要填充一个字段​子数,根据另一个字段中表示的​婚姻状态,表达式为:

marital_status.value == "married" ? ["1=One", "2=two"] : ["0=Zero"].

只要​frine_status​字段的值发生变化,就会重新触发表达式。 您还可以从REST服务填充下拉列表。 有关详细信息,请参阅动态填充下拉列表

摘要表达式

“摘要”表达式会动态计算折叠布局面板的子面板的标题。 您可以在规则中指定摘要表达式,该规则使用表单字段或自定义逻辑来评估标题。 表达式在表单初始化时执行。 如果要预填表单,则在预填数据或表达式中使用的从属字段值发生更改后,表达式会执行。

“摘要”表达式通常用于重复折叠布局面板的子项,为每个子面板提供有意义的标题。

适用于: 其布局配置为Accordion的面板的直接子面板。

返回类 型:表达式返回一个字符串,它成为accordion的标题。

示例: "帐号:"+ textbox1.value

验证表达式

验证表达式用于使用给定表达式验证字段。 通常,此类表达式使用常规表达式和字段值来验证字段。 该表达式被触发,并且该字段的验证状态在字段值的任何变化时被重新计算。

适用于:字段

返回类型:表达式返回一个布尔值,表示字段的验证状态。值​false​表示字段无效,而​true​表示字段有效。

示例:对于表示英国邮政编码的字段,验证表达式为:

(this.value && this.value.match(/^(GIR 0AA|[A-Z]{1,2}\d[A-Z0-9]? ?[0-9][A-Z]{2}\s*)$/i) == null) ? false : true

在上例中,如果非空值与模式不匹配,表达式将返回​false​以指示字段无效。

注意

如果为非强制或强制字段编写验证表达式,则无论该字段的可见性状态如何,都将评估该表达式。 要停止对隐藏字段的验证,请将“初始化”或“值提交脚本”中的validationsDisabled属性设置为true。 例如,this.validationsDisabled=true

值提交脚本

值提交脚本在以下情况下触发:

  • 用户从UI更改字段的值。
  • 字段的值因其他字段的更改而以编程方式更改。

应用于:字

返回类型: 值提交脚本表达式不返回任何值。如果任何表达式返回值,则忽略该值。

示例: 要在提交时将字段中输入的字母大小写转换为大写,值提交表达式为:
this.value=this.value.toUpperCase()

注意

以编程方式更改字段值时,可以禁用执行值提交脚本。 要这样做,请转到https://[server]:[port]/system/console/configMgr and change 兼容性自适应Forms版​至​AEM Forms6.1。 此后,仅当用户从UI更改字段值时,才执行值提交脚本。

可见性表达式

可见性表达式用于控制字段/面板的可见性。 通常,可见性表达式使用字段的value属性,并且只要该值发生更改,就会重新触发。

适用于:字段和面板

返回类型:表达式返回布尔值,表示字段/面板是否可见。false 表示字段或面板不可见,true表示字段或面板可见。

示例:对于仅当field1的值设置为Male时才 会显 示的面 板,​可见性表达式为: field1.value == "Male"

步骤完成表达式

步骤完成表达式用于阻止用户进入向导布局的下一步。 这些表达式在面板具有向导布局时使用(多步表单,一次显示一个步骤)。 仅当当前部分中的所有必需值都已填写并且有效时,用户才可移至下一步、面板或子节。

适用于:将项目布局设置为向导的面板。

返回类型:表达式返回布尔值,表示当前面板是否有效。True 表示当前面板有效,用户可以导航到下一个面板。

示例:在以各种面板组织的表单中,在导航到下一个面板之前,将验证当前面板。在这种情况下,使用步骤完成表达式。 通常,这些表达式使用GuideBridge验证API。 步骤完成表达式的示例为:
window.guideBridge.validate([],this.panel.navigationContext.currentItem.somExpression)

自适应表单中的验证

有多种方法可向自适应表单添加字段验证。 如果在字段上添加了验证检查,True​表示在字段中输入的值有效。 ​False表示值无效。如果在字段中切入和切出,则不会生成错误消息。

对字段添加验证的方法有:

必填

要强制使用组件,请在组件的​编辑​对话框中,选择选项​标题和文本>必需。 您还可以添加相应的​必需消息(可选)。.

验证模式

有多个可用于字段的现成验证模式。 要选择验证模式,请在组件的​编辑​对话框中,找到​模式​部分,然后选择​模式。 您可以在​模式​文本框中创建您自己的自定义验证模式。 仅当所填充的数据符合验证模式时,才返回验证状态​True,否则返回​False。 要编写您自己的自定义验证模式,请参阅HTML5表单的图片子句支持

验证表达式

也可使用不同字段上的表达式计算字段的验证。 这些表达式写入到组件​编辑​对话框的​脚本​选项卡的​验证脚本​字段中。 字段的验证状态取决于表达式返回的值。 有关如何编写此类表达式的信息,请参见验证表达式

附加信息

使用字段显示格式

“显示格式”可用于以不同格式显示数据。 例如,可以使用显示格式显示带连字符的电话号码、设置ZIP代码格式或日期选取器格式。 这些显示模式可以从组件的​编辑​对话框的​模式​部分中选择。 您可以编写与上述验证模式类似的自定义显示模式。

GuideBridge - API和事件

GuideBridge是API的集合,可用于在浏览器中与内存模型中的自适应表单进行交互。 有关指南Bridge API、类方法和公开的事件的详细介绍,请参阅自适应表单的JavaScript库API参考

注意

建议不要在表达式中使用GuideBridge事件监听器。

各种表达式中的GuideBridge使用

  • 要重置表单字段,可以在单击按钮表达式触发guideBridge.reset() API。 同样,还有一个提交API,它可以作为单击表达式​guideBridge.submit()调用。

  • 您可以使用setFocus() API在不同字段或面板之间设置焦点(面板焦点自动设置为第一个字段)。 setFocus()提供了各种导航选项,如跨面板导航、上一遍/下一遍历、将焦点设置到特定字段等。例如,要移到下一个面板,您可以使用:guideBridge.setFocus(this.panel.somExpression, 'nextItem').

  • 要验证自适应表单或其特定面板,请使用guideBridge.validate(errorList, somExpression).

在表达式外使用GuideBridge 

您还可以在表达式之外使用GuideBridge API。 例如,可以使用GuideBridge API设置承载自适应表单的页面HTML与表单模型之间的通信。 此外,还可以设置来自承载表单的Iframe父代的值。

要对上述示例使用GuideBridge API,请捕获GuideBridge的一个实例。 要捕获该实例,请侦听window对象的bridgeInitializeStart事件:

window.addEventListener("bridgeInitializeStart", function(evnt) {

     // get hold of the guideBridge object

     var gb = evnt.detail.guideBridge;

     //wait for the completion of AF

     gb.connect(function (){

        //this function will be called after Adaptive Form is initialized

     })

})
注意

在AEM中,最好在clientLib中编写代码并将其包含在页面(页面的header.jsp或footer.jsp)中

要在初始化表单后使用GuideBridge(调度bridgeInitializeComplete事件),请使用window.guideBridge获取GuideBridge实例。 可以使用guideBride.isConnected API检查GuideBridge初始化状态。

GuideBridge事件

GuideBridge还为托管页面上的外部脚本提供某些事件。 外部脚本可以侦听这些事件并执行各种操作。 例如,每当表单中的用户名发生更改时,页面标题中显示的名称也会发生更改。 有关此类事件的详细信息,请参阅自适应表单的JavaScript库API参考

使用以下代码注册处理程序:

guideBridge.on("elementValueChanged", function (event, data)  {

      // execute some logic when value of a field is changed  

});

为字段创建自定义模式

如上所述,自适应表单允许作者提供验证或显示格式的模式。 除了使用现成的模式外,您还可以为自适应表单组件定义可重用的自定义模式。 例如,您可以定义文本字段或数字字段。 定义后,您可以在所有表单中为指定类型的组件使用这些模式。 例如,您可以为文本字段创建自定义模式,并在其自适应表单的文本字段中使用它。 通过访问组件的编辑对话框中的图案部分,可以选择自定义图案。 有关模式定义或格式的详细信息,请参阅HTML5表单的图片子句支持

请执行以下步骤,为特定字段类型创建自定义模式,并将其重复用于相同类型的其他字段:

  1. 导航到创作实例上的CRXDE Lite。

  2. 创建一个文件夹以维护您的自定义模式。 在/apps目录下,创建sling:folder类型的节点。 例如,创建名为customPatterns的节点。 在此节点下,创建另一个类型为nt:unstructed的节点,并将其命名为textboxpatterns。 此节点包含要添加的各种自定义模式。

  3. 打开创建的节点的“属性”选项卡。 例如,打开textboxpatterns的“属性”选项卡。 将guideComponentType属性添加到此节点并将其值设置为​fd/af/components/formatter/guideTextBox

  4. 此属性的值因要定义模式的字段而异。 对于数字字段,guideComponentType属性的值为​fd/af/components/formatter/guideNumericBox。 “日期选取器”字段的值为​fd/af/components/formatter/guideDatepicker

  5. 可以通过为textboxpatterns节点分配属性来添加自定义模式。 添加一个名为(例如pattern1)的属性,并将其值设置为要添加的模式。 例如,添加一个值为Fax=text{99-999-999999}的属性pattern1。 该模式适用于您在自适应Forms中使用的所有文本框。

    为CrxDe中的字段创建自定义模式
    图:创 建自定义图案

在此页面上