Forms服务可以渲染基于您使用设计器创建的片段的表单。 片段是表单的可重用部分,将其保存为可插入到多个表单设计中的单独XDP文件。 例如,片段可以包括地址块或合法文本。
使用片段可简化和加快大量表单的创建和维护。 创建新表单时,插入对所需片段的引用,该片段将显示在表单中。 片段引用包含指向物理XDP文件的子表单。 有关根据片段创建表单设计的信息,请参阅Forms设计器
片段可以包括多个子表单,这些子表单打包在所选子表单集中。 选择子表单集基于来自数据连接的数据流控制子表单的显示。 您可以使用条件语句确定集合中的哪些子表单显示在已提交的表单中。 例如,集合中的每个子表单可以包括特定地理位置的信息,并且所显示的子表单可以基于用户的位置来确定。
脚本片段包含可重用的JavaScript函数或值,这些函数或值与任何特定对象(如日期分析器或Web服务调用)分开存储。 这些片段包含一个脚本对象,它在“层次结构”调色板中显示为变量的子对象。 不能从其他对象的属性(如验证、计算或初始化等事件脚本)的脚本创建片段。
以下是使用片段的优势:
您可以组合一个表单设计,以基于多个片段传递给Forms服务。 要组合多个片段,请使用Assembler服务。 要查看使用Assemble服务创建供其他Forms服务(Output服务)使用的表单设计的示例,请参阅使用片段创建PDF文档。 您可以使用Forms服务执行相同的工作流,而不是使用输出服务。
使用Assembler服务时,您正在传递一个使用片段组合的表单设计。 创建的表单设计不引用其他片段。 与此相反,本主题讨论如何通过引用其他片段到Forms服务的表单设计。 但是,表单设计不是由Assembler组合的。 它是在Designer中创建的。
有关Forms服务的详细信息,请参见AEM Forms服务参考。
有关创建基于Web的应用程序以基于片段呈现表单的信息,请参见创建用于呈现Forms的Web 应用程序。
要渲染基于片段的表单,请执行以下任务:
包括项目文件
将必要的文件包含在您的开发项目中。 如果您使用Java创建客户端应用程序,请包含必要的JAR文件。 如果您使用Web服务,请确保包含代理文件。
创建Forms客户端API对象
在以编程方式执行Forms服务客户端API操作之前,必须创建Forms服务客户端。
指定URI值
要成功呈现基于片段的表单,必须确保Forms服务能够找到表单设计引用的表单和片段(XDP文件)。 例如,假定表单名为PO.xdp,并且此表单使用两个名为FooterUS.xdp和FooterCanada.xdp的片段。 在这种情况下,Forms服务必须能够找到所有三个XDP文件。
您可以将表单及其片段放在一个位置,将片段放在另一个位置,或将所有XDP文件放在同一位置。 就本节而言,假定所有XDP文件都位于AEM Forms存储库中。 有关将XDP文件放入AEM Forms存储库的信息,请参阅编写资源。
在基于片段渲染表单时,您只能引用表单本身,而不能引用片段。 例如,必须引用PO.xdp,而不是FooterUS.xdp或FooterCanada.xdp。 确保将片段放在Forms服务可以找到它们的位置。
渲染表单
基于片段的表单可以与非碎片表单相同的方式呈现。 即,您可以以PDF、HTML或表单指南(已弃用)形式呈现表单。 本节中的示例将基于片段的表单渲染为交互式PDF表单。 (请参阅渲染交互式PDF forms。)
将表单数据流写入客户端Web浏览器
当Forms服务呈现表单时,它会返回一个表单数据流,您必须将该数据流写入客户端Web浏览器。 写入客户端Web浏览器时,用户可以看到表单。
另请参阅
使用FormsAPI(Java)渲染基于片段的表单:
包括项目文件
在Java项目的类路径中包含客户端JAR文件,如adobe-forms-client.jar。
创建Forms客户端API对象
ServiceClientFactory
对象。FormsServiceClient
对象的构造函数创建ServiceClientFactory
对象。指定URI值
URLSpec
对象,它使用其构造函数存储URI值。URLSpec
对象的setApplicationWebRoot
方法并传递一个字符串值,它表示应用程序的Web根目录。URLSpec
对象的setContentRootURI
方法并传递一个指定内容根URI值的字符串值。 确保表单设计和片段位于内容根URI中。 如果没有,Forms服务会引发异常。 要引用存储库,请指定repository://
。URLSpec
对象的setTargetURL
方法并传递一个字符串值,该字符串值指定将表单目标发布到的位置。 如果在表单设计中定义目标URL,则可以传递一个空字符串。 您还可以指定将表单发送到的URL以执行计算。渲染表单
调用FormsServiceClient
对象的renderPDFForm
方法并传递以下值:
Applications/FormsApplication/1.0/FormsFolder/Loan.xdp
。com.adobe.idp.Document
对象,其中包含要与表单合并的数据。 如果不想合并数据,请传递一个空com.adobe.idp.Document
对象。PDFFormRenderSpec
对象。URLSpec
对象,它包含Forms服务需要的URI值,以根据片段呈现表单。java.util.HashMap
对象。 这是可选参数,如果不想将文件附加到表单,可以指定null
。renderPDFForm
方法返回一个FormsResult
对象,该对象包含一个必须写入客户端Web浏览器的表单数据流。
将表单数据流写入客户端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
方法。另请参阅
快速开始(SOAP模式):使用Java API渲染基于片段的表单
使用FormsAPI(Web服务)渲染基于片段的表单:
包括项目文件
创建Forms客户端API对象
创建FormsService
对象并设置身份验证值。
指定URI值
URLSpec
对象。URLSpec
对象的setApplicationWebRoot
方法并传递一个字符串值,它表示应用程序的Web根目录。URLSpec
对象的setContentRootURI
方法并传递一个指定内容根URI值的字符串值。 确保表单设计位于内容根URI中。 如果没有,Forms服务会引发异常。 要引用存储库,请指定repository://
。URLSpec
对象的setTargetURL
方法并传递一个字符串值,该字符串值指定将表单目标发布到的位置。 如果在表单设计中定义目标URL,则可以传递一个空字符串。 您还可以指定将表单发送到的URL以执行计算。渲染表单
调用FormsService
对象的renderPDFForm
方法并传递以下值:
Applications/FormsApplication/1.0/FormsFolder/Loan.xdp
。BLOB
对象,其中包含要与表单合并的数据。 如果不想合并数据,请传递null
。PDFFormRenderSpec
对象。 请注意,如果输入文档是PDF文档,则无法设置加标签的PDF选项。 如果输入文件是XDP文件,则可以设置加标签的PDF选项。URLSpec
对象,包含Forms服务所需的URI值。java.util.HashMap
对象。 这是可选参数,如果不想将文件附加到表单,可以指定null
。com.adobe.idp.services.holders.BLOBHolder
对象。 此参数用于存储呈现的表单。javax.xml.rpc.holders.LongHolder
对象。 此参数将存储表单中的页数。javax.xml.rpc.holders.StringHolder
对象。 此参数将存储区域设置值。com.adobe.idp.services.holders.FormsResultHolder
对象。renderPDFForm
方法使用必须写入客户端Web浏览器的表单数据流填充作为最后一个参数值传递的com.adobe.idp.services.holders.FormsResultHolder
对象。
将表单数据流写入客户端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
方法。另请参阅