在客户端渲染Forms

最近更新： 2024年7月15日
  • 适用对象：
  • Experience Manager 6.5
  • 主题：

创建对象：

  • 开发人员

本文档中的示例和示例仅适用于JEE环境上的AEM Forms。

在客户端渲染Forms

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

除非根子表单包含设置为auto的restoreState属性，否则由服务器端脚本执行产生的对表单的更改不会反映在客户端渲染的表单中。 有关此属性的更多信息，请参阅Forms Designer。

注意
有关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为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服务将创建一个shell pdf，其中将不包含COS对象，但将包含嵌入了实际XDPPDF的内容包装器。 本节中的步骤不设置种子PDF运行时选项。 有关COS对象的信息，请参阅《Adobe PDF参考指南》。

在客户端渲染表单

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

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

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

另请参阅

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

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

包括AEM Forms Java库文件

设置连接属性

Forms服务API快速启动

将文档传递到Forms服务

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

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

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

  1. 包含项目文件

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

  2. 创建Forms客户端API对象

    • 创建包含连接属性的ServiceClientFactory对象。
    • 使用构造函数创建FormsServiceClient对象并传递ServiceClientFactory对象。

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

    • 使用构造函数创建PDFFormRenderSpec对象。
    • 通过调用PDFFormRenderSpec对象的setRenderAtClient方法并传递枚举值RenderAtClient.Yes来设置RenderAtClient运行时选项。

  4. 在客户端渲染表单

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

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

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

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

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

另请参阅

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

包括AEM Forms Java库文件

设置连接属性