将Forms渲染为HTML

Forms服务响应来自Web浏览器的HTTP请求,将表单呈现为HTML。 将表单渲染为HTML的好处是客户端Web浏览器所在的计算机不需要Adobe Reader、Acrobat或Flash Player(对于表单指南(已弃用))。

要将表单渲染为HTML,必须将表单设计另存为XDP文件。 保存为PDF文件的表单设计无法呈现为HTML。 在设计器中开发将呈现为HTML的表单设计时,请考虑以下条件:

  • 请勿使用对象的边框属性在表单上绘制线条、框或网格。 某些浏览器可能无法像在预览中显示的那样排列边框。 对象可能呈分层状,也可能将其他对象推离其预期位置。
  • 可以使用线条、矩形和圆定义背景。
  • 绘制的文本略大于容纳文本所需的文本。 某些Web浏览器无法清晰显示文本。
注意

当使用FormServiceClient对象的(Deprecated) renderHTMLFormrenderHTMLForm2方法呈现包含TIFF图像的表单时,在Internet Explorer或Mozilla Firefox浏览器中显示的呈现的HTML表单中不显示TIFF图像。 这些浏览器不提供对TIFF图像的本机支持。

HTML页

当表单设计呈现为HTML表单时,每个二级子表单都呈现为HTML页面(面板)。 您可以在设计器中视图子表单的层次结构。 属于根子表单的子子表单(根子表单的默认名称为form1)是面板子表单。 以下示例展示了表单设计的子表单。

     form1 
         Master Pages 
         PanelSubform1 
             NestedDynamicSubform 
                 TextEdit1 
         PanelSubform2 
             TextEdit1 
         PanelSubform3 
             TextEdit1 
         PanelSubform4 
             TextEdit1

当表单设计呈现为HTML表单时,面板不会限制为任何特定页面大小。 如果您有动态子表单,它们应嵌套在面板子表单中。 动态子表单能够扩展到无限数量的HTML页。

当表单呈现为HTML表单时,页面大小(将表单呈现为PDF时需要分页)毫无意义。 由于具有可流动布局的表单可以扩展到无限数量的HTML页面,因此避免主控页面上的页脚很重要。 在主控页面的内容区域下方的页脚可覆盖流经页面边界的HTML内容。

必须使用xfa.host.pageUpxfa.host.pageDown方法在面板之间显式移动。 您可以通过向Forms服务发送表单并让Forms服务将表单呈现回客户端设备(通常是Web浏览器)来更改页面。

注意

向Forms服务发送表单,然后让Forms服务将表单呈现回客户端设备的过程称为向服务器发送往返数据。

注意

如果要自定义HTML表单上“HTML数字签名”按钮的外观,则必须更改fscdigsig.css文件(在adobe-forms-ds.ear > adobe-forms-ds.war文件中)中的以下属性:

.fsc-ds-ssb:此样式表适用于空白符号字段。

.fsc-ds-ssv:此样式表适用于有效符号字段的情况。

.fsc-ds-ssc:此样式表适用于有效签名字段但数据已更改的情况。

.fsc-ds-ssi:此样式表在签名字段无效时适用。

.fsc-ds-popup-bg:不使用此样式表属性。

.fsc-ds-popup-btn:不使用此样式表属性。

运行脚本

表单作者指定脚本是在服务器上还是在客户端上执行。 Forms服务创建分布式的事件处理环境,用于执行表单智能,该表单智能可通过使用runAt属性在客户端和服务器之间分发。 有关此属性或在表单设计中创建脚本的信息,请参见Forms设计器

Forms服务可以在呈现表单时执行脚本。 因此,您可以通过连接到数据库或客户端上可能不可用的Web服务,用数据预填充表单。 您还可以设置按钮的Click事件以在服务器上运行,以便客户端将数据往返到服务器。 这允许客户端在用户与表单交互时运行可能需要服务器资源(如企业数据库)的脚本。 对于HTML表单,只能在服务器上执行formcalc脚本。 因此,必须将这些脚本标记为在serverboth运行。

可以通过调用xfa.host.pageUpxfa.host.pageDown方法设计在页面(面板)之间移动的表单。 此脚本位于按钮的Click事件中,runAt属性设置为Both。 您选择Both的原因在于,Adobe Reader或Acrobat(对于呈现为PDF的表单)可以更改页面而不转到服务器,而HTML表单可以通过将数据往返到服务器来更改页面。 即,表单将发送到Forms服务,并且表单将以HTML形式呈现,并显示新页面。

建议不要为脚本变量和表单字段赋予与项目等名称相同的名称。 某些Web浏览器(如Internet Explorer)可能无法初始化与表单字段同名的变量,该变量会导致脚本错误。 最好为表单字段和脚本变量指定不同的名称。

在呈现同时包含页面导航功能和表单脚本的HTML表单时(例如,假定每次呈现表单时脚本都从数据库检索字段数据),请确保表单脚本位于form:calculate事件中,而不是form:readyevent中。

位于表单:就绪事件中的表单脚本在表单的初始呈现期间仅执行一次,而不对后续页面检索执行。 相反,将对呈现表单的每个页面导航执行表单:计算事件。

注意

在多页表单上,如果移动到其他页面,则JavaScript对页面所做的更改不会保留。

您可以在提交表单之前调用自定义脚本。 此功能适用于所有可用的浏览器。 但是,仅当用户呈现其Output Type属性设置为Form Body的HTML表单时,才可使用它。 当Output TypeFull HTML时,它将不工作。 有关配置此功能的步骤,请参阅管理帮助中的配置表单。

必须首先定义在提交表单之前调用的回调函数,其中函数的名称为_user_onsubmit。 假定该函数不会引发任何异常,或如果它引发异常,则将忽略该异常。 建议将JavaScript函数放在html的head部分;但是,可以在包含xfasubset.js的脚本标记结束前的任何位置声明它。

当formserver呈现包含下拉列表的XDP时,除了创建下拉列表外,它还会创建两个隐藏的文本字段。 这些文本字段存储下拉列表的数据(一个存储选项的显示名称,另一个存储选项的值)。 因此,每次用户提交表单时,都会提交下拉列表的整个数据。 如果您不想每次提交这么多数据,可以编写一个自定义脚本来禁用它。 例如:下拉列表的名称为drpOrderedByStateProv,并包含在子表单标题下。 HTML输入元素的名称将为header[0].drpOrderedByStateProv[0]。 存储并提交下拉列表数据的隐藏字段的名称具有以下名称:header[0].drpOrderedByStateProv_DISPLAYITEMS_[0] header[0].drpOrderedByStateProv_VALUEITEMS_[0]

如果不想发布数据,可以通过以下方式禁用这些输入元素。var __CUSTOM_SCRIPTS_VERSION = 1; //enabling the feature function _user_onsubmit() { var elems = document.getElementsByName("header[0].drpOrderedByStateProv_DISPLAYITEMS_[0]"); elems[0].disabled = true; elems = document.getElementsByName("header[0].drpOrderedByStateProv_VALUEITEMS_[0]"); elems[0].disabled = true; }

header[0].drpOrderedByStateProv_DISPLAYITEMS_[0] header[0].drpOrderedByStateProv_VALUEITEMS_[0]
var __CUSTOM_SCRIPTS_VERSION = 1; //enabling the feature 
    function _user_onsubmit() { 
    var elems = document.getElementsByName("header[0].drpOrderedByStateProv_DISPLAYITEMS_[0]"); 
    elems[0].disabled = true; 
    elems = document.getElementsByName("header[0].drpOrderedByStateProv_VALUEITEMS_[0]"); 
    elems[0].disabled = true; 
    }

XFA子集

创建表单设计以呈现为HTML时,必须将脚本限制为javascript语言脚本的XFA子集。

在客户端上运行或同时在客户端和服务器上运行的脚本必须写入XFA子集中。 在服务器上运行的脚本可以使用完整的XFA脚本模型,也可以使用FormCalc。 有关使用JavaScript的信息,请参见Forms设计器

在客户端上运行脚本时,只有当前显示的面板才能使用脚本;例如,当显示面板B时,您无法对位于面板A中的字段进行脚本编写。 在服务器上运行脚本时,可以访问所有面板。

在客户端上运行的脚本中使用脚本对象模型(SOM)表达式时,您也必须小心。 在客户端上运行的脚本只支持SOM表达式的简化子集。

事件时间

XFA子集定义映射到HTML事件的XFA事件。 在计算和验证事件的定时上,行为略有差异。 在Web浏览器中,当您退出字段时,将执行完全计算事件。 当您更改字段值时,不会自动执行计算事件。 可以通过调用xfa.form.execCalculate方法强制计算事件。

在Web浏览器中,仅当退出字段或提交表单时才执行验证事件。 可以使用xfa.form.execValidate方法强制验证事件。

Forms在Web浏览器中显示(与Adobe Reader或Acrobat相对),符合必填字段的XFA空测试(错误或警告)。

  • 如果空测试产生错误,并且您退出字段而未指定值,则会显示一个消息框,单击“确定”后您将重新定位到该字段。
  • 如果空测试生成警告,而您退出字段时未指定值,则系统将提示您单击“确定”或“取消”,这样您就可以选择继续操作而不指定值,或者返回字段以输入值。

有关空测试的详细信息,请参阅Forms设计器

表单按钮

单击提交按钮将表单数据发送到Forms服务并表示表单处理结束。 preSubmit事件可以设置为在客户端或服务器上运行。 如果preSubmit事件配置为在客户端上运行,则它会在表单提交之前运行。 否则,在提交表单期间,preSubmit事件在服务器上运行。 有关preSubmit事件的详细信息,请参阅Forms设计器

如果按钮没有与其关联的客户端脚本,则数据会提交到服务器,在服务器上执行计算,并重新生成HTML表单。 如果按钮包含客户端脚本,则数据不会发送到服务器,客户端脚本在Web浏览器中执行。

HTML 4.0 Web浏览器

仅支持HTML 4.0的Web浏览器不支持XFA子集客户端脚本模型。 创建表单设计以在HTML 4.0和MSDHTML或CSS2HTML中工作时,标记为在客户端运行的脚本将实际在服务器上运行。 例如,假定用户单击位于HTML 4.0 Web浏览器中显示的表单上的按钮。 在这种情况下,表单数据将发送到执行客户端脚本的服务器。

建议将表单逻辑放置在计算事件中,该逻辑在HTML 4.0的服务器上运行,在MSDHTML或CSS2HTML的客户端上运行。

维护演示文稿更改

在HTML页面(面板)之间移动时,只保留数据的状态。 不保留背景颜色或必填字段设置等设置(如果不同于初始设置)。 要保持演示状态,必须创建表示字段演示状态的字段(通常为隐藏字段)。 如果向字段的Calculate事件添加一个脚本,该脚本根据隐藏字段值更改演示文稿,则在HTML页面(面板)之间来回移动时,可以保留演示文稿状态。

以下脚本根据hiddenField的值维护字段的fillColor。 假定此脚本位于字段的Calculate事件中。

     If (hiddenField.rawValue == 1) 
         this.fillColor = "255,0,0" 
     else 
         this.fillColor = "0,255,0"
注意

嵌套在表单元格中时,静态对象不会显示在呈现的HTML表单中。 例如,嵌套在表单元格中的圆和矩形不会在渲染HTML表单中显示。 但是,当位于表之外时,这些相同的静态对象会正确显示。

对HTML表单进行数字签名

如果表单呈现为以下HTML转换之一,则不能对包含数字签名字段的HTML表单进行签名:

  • AHTML
  • HTML4
  • 静态HTML
  • NoScriptXHTML

有关对文档进行数字签名的信息,请参见文档进行数字签名和认证

呈现符合辅助功能指导原则的XHTML表单

您可以呈现符合辅助工具指导原则的完整HTML表单。 即,表单在完整HTML标记中呈现,而不是在正文标记(不是完整的HTML页面)中呈现的HTML表单。

正在验证表单数据

建议在将表单渲染为HTML表单时限制对表单字段的验证规则的使用。 HTML表单可能不支持某些验证规则。 例如,当MM-DD-YYYY的验证模式应用于Date/Time字段(该字段位于以HTML表单呈现的表单设计中)时,即使日期键入正确,它也无法正常工作。 但是,此验证模式适用于呈现为PDF的表单。

注意

有关Forms服务的详细信息,请参见AEM Forms服务参考

步骤的摘要

要渲染HTML表单,请执行以下步骤:

  1. 包括项目文件。
  2. 创建一个Forms客户端API对象。
  3. 设置HTML运行时选项。
  4. 渲染HTML表单。
  5. 将表单数据流写入客户端Web浏览器。

包括项目文件

将必要的文件包含在您的开发项目中。 如果您使用Java创建客户端应用程序,请包含必要的JAR文件。 如果您使用Web服务,请确保包含代理文件。

创建Forms客户端API对象

在以编程方式将数据导入PDF formClient API之前,必须创建Form Data Integration服务客户端。 在创建服务客户端时,您定义调用服务所需的连接设置。

设置HTML运行时选项

在渲染HTML表单时设置HTML运行时选项。 例如,可以向HTML表单添加工具栏,使用户能够选择位于客户端计算机上的文件附件或检索用HTML表单呈现的文件附件。 默认情况下,HTML工具栏处于禁用状态。 要向HTML表单添加工具栏,必须以编程方式设置运行时选项。 默认情况下,HTML工具栏包含以下按钮:

  • Home:提供指向应用程序Web根目录的链接。
  • Upload:提供一个用户界面,用于选择要附加到当前表单的文件。
  • Download:提供用于显示附加文件的用户界面。

当HTML表单上显示HTML工具栏时,用户最多可以选择十个文件以及表单数据一起提交。 提交文件后,Forms服务可以检索文件。

将表单渲染为HTML时,可指定用户代理值。 用户代理值提供浏览器和系统信息。 这是可选值,您可以传递空字符串值。 使用Java API快速开始渲染HTML表单演示如何获取用户代理值并使用它以HTML形式渲染表单。

可以通过使用Forms服务客户端API设置目标URL来指定发布表单数据的HTTP URL,也可以在XDP表单设计中包含的“提交”按钮中指定。 如果在表单设计中指定了目标URL,则不要使用Forms服务客户端API设置值。

注意

使用工具栏渲染HTML表单是可选的。

注意

如果您渲染AHTML表单,建议您不要向表单添加工具栏。

渲染HTML表单

要渲染HTML表单,必须指定在Designer中创建并另存为XDP文件的表单设计。 还必须选择HTML转换类型。 例如,可指定用于为Internet Explorer 5.0或更高版本渲染动态HTML的HTML转换类型。

呈现HTML表单还需要一些值,如呈现其他表单类型所需的URI值。

将表单数据流写入客户端Web浏览器

当Forms服务呈现HTML表单时,它返回一个表单数据流,您必须将该数据流写入客户端Web浏览器。 写入客户端Web浏览器时,用户可以看到HTML表单。

另请参阅

使用Java API将表单渲染为HTML

使用Web服务API将表单渲染为HTML

包括AEM FormsJava库文件

设置连接属性

Forms服务API快速开始

渲染交互式PDF forms

使用自定义工具栏渲染HTMLForms

创建呈现Forms的Web 应用程序

使用Java API将表单渲染为HTML

使用FormsAPI(Java)渲染HTML表单:

  1. 包括项目文件

    在Java项目的类路径中包含客户端JAR文件,如adobe-forms-client.jar。

  2. 创建Forms客户端API对象

    • 创建包含连接属性的ServiceClientFactory对象。
    • 使用FormsServiceClient对象的构造函数创建ServiceClientFactory对象。
  3. 设置HTML运行时选项

    • 使用HTMLRenderSpec对象的构造函数创建<a0/>对象。
    • 要呈现带有工具栏的HTML表单,请调用HTMLRenderSpec对象的setHTMLToolbar方法并传递HTMLToolbar枚举值。 例如,要显示垂直HTML工具栏,请传递HTMLToolbar.Vertical
    • 要设置HTML表单的区域设置值,请调用HTMLRenderSpec对象的setLocale方法并传递一个指定区域设置值的字符串值。 (这是可选设置。)
    • 要在完整HTML标记中呈现HTML表单,请调用HTMLRenderSpec对象的setOutputType方法并传递OutputType.FullHTMLTags。 (这是可选设置。)
    注意

    StandAlone选项为trueApplicationWebRoot引用承载AEM Forms的J2EE应用程序服务器以外的服务器时,HTML中无法成功呈现Forms(ApplicationWebRoot值是使用传递给FormsServiceClient对象的(Deprecated) renderHTMLForm方法的URLSpec对象指定的)。 当ApplicationWebRoot是承载AEM Forms的另一台服务器时,管理控制台中web根URI的值需要设置为表单的web应用程序URI值。 这可以通过登录到管理控制台,单击“服务”>“Forms”,然后将Web根URI设置为https://server-name:port/FormServer来完成。 然后,保存设置。

  4. 渲染HTML表单

    调用FormsServiceClient对象的(Deprecated) renderHTMLForm方法并传递以下值:

    • 一个字符串值,它指定表单设计名称,包括文件扩展名。 如果您引用的表单设计是Forms应用程序的一部分,请确保指定完整路径,如Applications/FormsApplication/1.0/FormsFolder/Loan.xdp
    • 一个TransformTo枚举值,它指定HTML首选项类型。 例如,要渲染与Internet Explorer 5.0或更高版本的动态HTML兼容的HTML表单,请指定TransformTo.MSDHTML
    • com.adobe.idp.Document对象,其中包含要与表单合并的数据。 如果不想合并数据,请传递一个空com.adobe.idp.Document对象。
    • 存储HTML运行时选项的HTMLRenderSpec对象。
    • 指定HTTP_USER_AGENT头值的字符串值;例如,Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1; .NET CLR 1.1.4322)
    • 一个URLSpec对象,用于存储呈现HTML表单所需的URI值。
    • 存储文件附件的java.util.HashMap对象。 这是可选参数,如果不想将文件附加到表单,可以指定null

    (Deprecated) renderHTMLForm方法返回一个FormsResult对象,该对象包含一个可写入客户端Web浏览器的表单数据流。

  5. 将表单数据流写入客户端Web浏览器

    • 通过调用FormsResult对象“s getOutputContent方法创建com.adobe.idp.Document对象。
    • 通过调用getContentType方法获取com.adobe.idp.Document对象的内容类型。
    • 通过调用setContentType方法并传递com.adobe.idp.Document对象的内容类型,设置javax.servlet.http.HttpServletResponse对象的内容类型。
    • 通过调用javax.servlet.http.HttpServletResponse对象的getOutputStream方法,创建一个javax.servlet.ServletOutputStream对象,用于将表单数据流写入客户端Web浏览器。
    • 通过调用com.adobe.idp.Document对象的getInputStream方法创建java.io.InputStream对象。
    • 通过调用InputStream对象的read方法并将字节数组作为参数进行传递,创建一个字节数组并将其填充为表单数据流。
    • 调用javax.servlet.ServletOutputStream对象的write方法,将表单数据流发送到客户端Web浏览器。 将字节数组传递给write方法。

另请参阅

将Forms渲染为HTML

快速开始(SOAP模式):使用Java API渲染HTML表单

包括AEM FormsJava库文件

设置连接属性

使用Web服务API将表单渲染为HTML

使用FormsAPI(Web服务)渲染HTML表单:

  1. 包括项目文件

    • 创建使用Forms服务WSDL的Java代理类。
    • 将Java代理类包含到类路径中。
  2. 创建Forms客户端API对象

    创建FormsService对象并设置身份验证值。

  3. 设置HTML运行时选项

    • 使用HTMLRenderSpec对象的构造函数创建<a0/>对象。
    • 要呈现带有工具栏的HTML表单,请调用HTMLRenderSpec对象的setHTMLToolbar方法并传递HTMLToolbar枚举值。 例如,要显示垂直HTML工具栏,请传递HTMLToolbar.Vertical
    • 要设置HTML表单的区域设置值,请调用HTMLRenderSpec对象的setLocale方法并传递一个指定区域设置值的字符串值。 有关详细信息,请参阅AEM FormsAPI参考
    • 要在完整HTML标记中呈现HTML表单,请调用HTMLRenderSpec对象的setOutputType方法并传递OutputType.FullHTMLTags
    注意

    StandAlone选项为trueApplicationWebRoot引用承载AEM Forms的J2EE应用程序服务器以外的服务器时,HTML中无法成功呈现Forms(ApplicationWebRoot值是使用传递给FormsServiceClient对象的(Deprecated) renderHTMLForm方法的URLSpec对象指定的)。 当ApplicationWebRoot是承载AEM Forms的另一台服务器时,管理控制台中web根URI的值需要设置为表单的web应用程序URI值。 这可以通过登录到管理控制台,单击“服务”>“Forms”,然后将Web根URI设置为https://server-name:port/FormServer来完成。 然后,保存设置。

  4. 渲染HTML表单

    调用FormsService对象的(Deprecated) renderHTMLForm方法并传递以下值:

    • 一个字符串值,它指定表单设计名称,包括文件扩展名。 如果您引用的表单设计是Forms应用程序的一部分,请确保指定完整路径,如Applications/FormsApplication/1.0/FormsFolder/Loan.xdp
    • 一个TransformTo枚举值,它指定HTML首选项类型。 例如,要渲染与Internet Explorer 5.0或更高版本的动态HTML兼容的HTML表单,请指定TransformTo.MSDHTML
    • BLOB对象,其中包含要与表单合并的数据。 如果不想合并数据,请传递null。 (请参阅使用可流动布局预填充Forms。)
    • 存储HTML运行时选项的HTMLRenderSpec对象。
    • 指定HTTP_USER_AGENT头值的字符串值;例如,Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1; .NET CLR 1.1.4322)。 如果不想设置此值,可以传递空字符串。
    • 一个URLSpec对象,用于存储呈现HTML表单所需的URI值。 (请参阅指定URI值。)
    • 存储文件附件的java.util.HashMap对象。 这是可选参数,如果不想将文件附加到表单,可以指定null。 (请参阅将文件附加到表单。)
    • 由方法填充的空com.adobe.idp.services.holders.BLOBHolder对象。 此参数值存储呈现的表单。
    • 由方法填充的空com.adobe.idp.services.holders.BLOBHolder对象。 此参数将存储输出XML数据。
    • 由方法填充的空javax.xml.rpc.holders.LongHolder对象。 此参数将存储表单中的页数。
    • 由方法填充的空javax.xml.rpc.holders.StringHolder对象。 此参数将存储区域设置值。
    • 由方法填充的空javax.xml.rpc.holders.StringHolder对象。 此参数将存储所使用的HTML呈现值。
    • 将包含此操作结果的空com.adobe.idp.services.holders.FormsResultHolder对象。

    (Deprecated) renderHTMLForm方法使用必须写入客户端Web浏览器的表单数据流填充作为最后一个参数值传递的com.adobe.idp.services.holders.FormsResultHolder对象。

  5. 将表单数据流写入客户端Web浏览器

    • 通过获取com.adobe.idp.services.holders.FormsResultHolder对象的value数据成员的值,创建FormResult对象。
    • 通过调用FormsResult对象的getOutputContent方法,创建包含表单数据的BLOB对象。
    • 通过调用getContentType方法获取BLOB对象的内容类型。
    • 通过调用setContentType方法并传递BLOB对象的内容类型,设置javax.servlet.http.HttpServletResponse对象的内容类型。
    • 通过调用javax.servlet.http.HttpServletResponse对象的getOutputStream方法,创建一个javax.servlet.ServletOutputStream对象,用于将表单数据流写入客户端Web浏览器。
    • 创建一个字节数组,并通过调用BLOB对象的getBinaryData方法填充它。 此任务将FormsResult对象的内容分配给字节数组。
    • 调用javax.servlet.http.HttpServletResponse对象的write方法,将表单数据流发送到客户端Web浏览器。 将字节数组传递给write方法。

另请参阅

将Forms渲染为HTML

使用Base64编码调用AEM Forms

在此页面上