在客户端上呈现Forms

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

在客户端上呈现Forms

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

服务器端脚本执行对表单所做的更改不会反映在呈现在客户端的表单中,除非根子表单包含设置为autorestoreState属性。 有关此属性的更多信息,请参阅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。 这会导致表单被传送到呈现表单的客户端设备。 如果RenderAtClientauto(默认值),则表单设计将确定表单是否在客户端呈现。 表单设计必须是具有可流动布局的表单设计。

可设置的可选运行时选项是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对象的构造函数创建对象。
    • 通过调用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对象,用于存储在客户端渲染表单所需的运行时选项。
    • URLSpec对象,其中包含Forms服务渲染表单所需的URI值。
    • 用于存储文件附件的java.util.HashMap对象。 这是一个可选参数,如果您不想将文件附加到表单,可以指定null

    renderPDFForm方法返回一个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方法。

另请参阅

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

包括AEM Forms Java库文件

设置连接属性

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

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

  1. 包含项目文件

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

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

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

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

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

    • 指定表单设计名称(包括文件扩展名)的字符串值。 如果您引用的表单设计是Forms应用程序的一部分,请确保指定完整路径,如Applications/FormsApplication/1.0/FormsFolder/Loan.xdp
    • BLOB对象,其中包含要与表单合并的数据。 如果不想合并数据,请传递null。 (请参阅使用可流动布局预填充Forms。)
    • 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方法使用必须写入客户端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

使用Base64编码调用AEM Forms

在此页面上