在客户端渲染表单

在客户端渲染表单

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

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

注意

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

步骤摘要

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

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

包括项目文件

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

创建Forms Client API对象

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

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

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

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

您可以使用设计器创建简单的动态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,它不包含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服务

创建呈现表单的Web 应用程序

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

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

  1. 包括项目文件

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

  2. 创建Forms Client API对象

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

    • 使用对 PDFFormRenderSpec 象的构造函数创建对象。
    • 通过 RenderAtClient 调用对象的方法并传递enum值 PDFFormRenderSpec 来设置 setRenderAtClient 运行时选项 RenderAtClient.Yes
  4. 在客户端渲染表单

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

    • 一个字符串值,它指定表单设计名称,包括文件扩展名。 如果引用的表单设计是AEM Forms应用程序的一部分,请确保指定完整路径,如 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浏览器的表单数据流。

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

    • 通过 com.adobe.idp.Document 调用对象的方 FormsResult 法创建对 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 Client API对象

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

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

    • 使用对 PDFFormRenderSpec 象的构造函数创建对象。
    • 通过 RenderAtClient 调用对象的方法并传递字符串 PDFFormRenderSpec 值来设置 setRenderAtClient 运行时选项 RenderAtClient.Yes
  4. 在客户端渲染表单

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

    • 一个字符串值,它指定表单设计名称,包括文件扩展名。 如果引用的表单设计是表单应用程序的一部分,请确保指定完整路径,如 Applications/FormsApplication/1.0/FormsFolder/Loan.xdp
    • 包含 BLOB 要与表单合并的数据的对象。 如果您不想合并数据,请传递 null。 (请参阅 使用可流式布局预填充表单。)
    • 存储 PDFFormRenderSpec 在客户端渲染表单所需的运行时选项的对象。
    • URLSpec 含Forms服务所需的URI值的对象。
    • 存储 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 方法。

另请参阅

在客户端渲染表单

使用Base64编码调用AEM Forms

在此页面上