在客户端渲染Forms

上次更新: 2023-05-04
  • 创建对象:
  • Developer
注意

AEM 6.4已结束扩展支持,本文档将不再更新。 有关更多详细信息,请参阅 技术支助期. 查找支持的版本 此处.

在客户端渲染Forms

您可以使用Acrobat或Adobe Reader的客户端渲染功能,优化PDF内容的交付,并提高Forms服务处理网络负载的能力。 此过程称为在客户端渲染表单。 要在客户端渲染表单,客户端设备(通常为Web浏览器)必须使用Acrobat 7.0或Adobe Reader 7.0或更高版本。

服务器端脚本执行对表单所做的更改不会反映在呈现在客户端的表单中,除非根子表单包含 restoreState 设置为 auto. 有关此属性的更多信息,请参阅 Forms设计师。

注意

有关Forms服务的更多信息,请参阅 AEM Forms服务参考.

步骤摘要

要在客户端渲染表单,请执行以下任务:

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

包含项目文件

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

创建Forms客户端API对象

您必须先创建Forms服务客户端,然后才能以编程方式执行Forms服务客户端API操作。 如果您使用的是Java API,请创建 FormsServiceClient 对象。 如果您使用的是Forms Web服务API,请创建 FormsService 对象。

设置客户端渲染运行时选项

您必须设置客户端渲染运行时选项,以通过设置 RenderAtClient 运行时选项 true. 这会导致表单被传送到呈现表单的客户端设备。 如果 RenderAtClient is auto (默认值),表单设计会确定表单是否呈现在客户端。 表单设计必须是具有可流动布局的表单设计。

您可以设置的可选运行时选项是 SeedPDF 选项。 的 SeedPDF 选项将PDF容器(种子PDF文档)与表单设计和XML数据结合使用。 表单设计和XML数据都会交付到Acrobat或Adobe Reader,表单会在其中呈现。 的 SeedPDF 当客户端计算机没有表单中使用的字体时,可以使用选项,例如,如果最终用户未获得使用表单所有者有权使用的字体的许可,则可以使用选项。

您可以使用Designer创建简单的动态PDF文件,以用作种子PDF文件。 执行此任务需要执行以下步骤:

  1. 确定是否需要在种子PDF文件中嵌入任何字体。 种子PDF文件需要包含正在呈现的表单所需的其他字体。 在将字体嵌入种子PDF文件时,请确保您未违反任何字体许可协议。 在Designer中,您可以确定是否可以合法嵌入字体。 在保存时,如果表单中存在无法嵌入的字体,则Designer会显示一条消息,其中列出了您无法嵌入的字体。 对于静态PDF文档,此消息未显示在Designer中。
  2. 如果要在Designer中创建种子PDF文件,建议至少添加一个包含消息的文本字段。 该消息应针对早期版本的Adobe Reader的用户,这些用户声明他们需要Acrobat 7.0或更高版本,或者Adobe Reader 7.0或更高版本才能查看文档。
  3. 将种子PDF文件另存为具有PDF文件扩展名的动态PDF文件。
注意

您无需定义种子PDF运行时选项即可在客户端上呈现表单。 如果未指定种子PDF,Forms服务将创建一个外壳pdf,该外壳pdf将不包含COS对象,但将包含一个PDF包装器,其中实际嵌入了XDP内容。 本节中的步骤未设置种子PDF运行时选项。 有关COS对象的信息,请参阅《Adobe PDF参考指南》。

在客户端渲染表单

要在客户端渲染表单,必须确保在渲染表单的应用程序逻辑中包含客户端渲染运行时选项。

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

Forms服务会创建一个必须写入客户端Web浏览器的表单数据流。 将表单写入客户端Web浏览器后,表单将由Acrobat 7.0或Adobe Reader 7.0或更高版本呈现,并且对用户可见。

另请参阅

使用Java API在客户端渲染表单

使用Web服务API在客户端渲染表单

包括AEM Forms Java库文件

设置连接属性

Forms Service API快速入门

将文档传递到Forms服务

创建可渲染Forms的Web应用程序

使用Java API在客户端渲染表单

使用Forms API(Java)在客户端渲染表单:

  1. 包含项目文件

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

  2. 创建Forms客户端API对象

    • 创建 ServiceClientFactory 包含连接属性的对象。
    • 创建 FormsServiceClient 对象,并使用其构造函数进行传递 ServiceClientFactory 对象。
  3. 设置客户端渲染运行时选项

    • 创建 PDFFormRenderSpec 对象。
    • 设置 RenderAtClient 通过调用 PDFFormRenderSpec 对象 setRenderAtClient 方法和传递枚举值 RenderAtClient.Yes.
  4. 在客户端渲染表单

    调用 FormsServiceClient 对象 renderPDFForm 方法并传递以下值:

    • 指定表单设计名称(包括文件扩展名)的字符串值。 如果您引用的表单设计是AEM Forms应用程序的一部分,请确保指定完整路径,例如 Applications/FormsApplication/1.0/FormsFolder/Loan.xdp.
    • A com.adobe.idp.Document 包含要与表单合并的数据的对象。 如果不想合并数据,请传递一个空 com.adobe.idp.Document 对象。
    • A PDFFormRenderSpec 用于存储在客户端呈现表单所需的运行时选项的对象。
    • A URLSpec 包含Forms服务渲染表单所需URI值的对象。
    • A java.util.HashMap 用于存储文件附件的对象。 这是一个可选参数,您可以指定 null 如果您不想将文件附加到表单。

    renderPDFForm 方法返回 FormsResult 包含必须写入客户端web浏览器的表单数据流的对象。

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

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

另请参阅

快速入门(SOAP模式):使用Java API在客户端渲染表单

包括AEM Forms Java库文件

设置连接属性

使用Web服务API在客户端渲染表单

使用Forms API(Web服务)在客户端渲染表单:

  1. 包含项目文件

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

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

  3. 设置客户端渲染运行时选项

    • 创建 PDFFormRenderSpec 对象。
    • 设置 RenderAtClient 通过调用 PDFFormRenderSpec 对象 setRenderAtClient 方法和传递字符串值 RenderAtClient.Yes.
  4. 在客户端渲染表单

    调用 FormsService 对象 renderPDFForm 方法并传递以下值:

    • 指定表单设计名称(包括文件扩展名)的字符串值。 如果您引用的表单设计是Forms应用程序的一部分,请确保指定完整路径,例如 Applications/FormsApplication/1.0/FormsFolder/Loan.xdp.
    • A BLOB 包含要与表单合并的数据的对象。 如果不想合并数据,请传递 null. (请参阅 使用可流动布局预填充Forms.)
    • A PDFFormRenderSpec 用于存储在客户端呈现表单所需的运行时选项的对象。
    • A URLSpec 包含Forms服务所需URI值的对象。
    • A java.util.HashMap 用于存储文件附件的对象。 这是一个可选参数,您可以指定 null 如果您不想将文件附加到表单。
    • com.adobe.idp.services.holders.BLOBHolder 由方法填充的对象。 此参数用于存储呈现的PDF表单。
    • javax.xml.rpc.holders.LongHolder 由方法填充的对象。 (此参数将以表单存储页数)。
    • javax.xml.rpc.holders.StringHolder 由方法填充的对象。 (此参数将存储区域设置值)。
    • com.adobe.idp.services.holders.FormsResultHolder 包含此操作结果的对象。

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

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

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

另请参阅

在客户端渲染Forms

使用Base64编码调用AEM Forms

在此页面上