基于片段渲染贵辞谤尘蝉 rendering-forms-based-on-fragments
本文档中的示例和示例仅适用于JEE环境上的AEM Forms。
基于片段渲染贵辞谤尘蝉 rendering-forms-based-on-fragments-inner
贵辞谤尘蝉服务可以渲染基于您使用顿别蝉颈驳苍别谤创建的片段的表单。 片段 ?是表单的可重用部分，保存为可插入到多个表单设计中的单独XDP文件。 例如，片段可以包含地址块或法律文本。
使用片段可简化并加速大量表单的创建和维护。 创建表单时，插入对所需片段的引用，片段会显示在表单中。 片段引用包含一个指向物理XDP文件的子表单。 有关基于片段创建表单设计的信息，请参阅
片段可以包含多个包在选择子表单集中的子表单。 选择子表单集根据来自数据连接的数据流控制子表单的显示。 可使用条件语句确定集合中的哪个子表单出现在交付的表单中。 例如，集合中的每个子表单可以包含特定地理位置的信息，并且显示的子表单可以根据用户的位置来确定。
脚本片段 ?包含可重复使用的JavaScript函数或与任何特定对象（如日期分析器或Web服务调用）分开存储的值。 这些片段包括单个脚本对象，该脚本对象将作为变量的子项显示在“层次结构”调色板中。 无法从作为其他对象属性的脚本（例如验证、计算或初始化等事件脚本）创建片段。
使用片段的优点如下：
- 内容重用：您可以使用片段在多个表单设计中重用内容。 当需要在多个表单中使用一些相同的内容时，使用片段比复制或重新创建内容更快、更简单。 使用片段还可确保表单设计中经常使用的部分在所有引用表单中都具有一致的内容和外观。
- 全局更新：您可以使用片段在一个文件中对多个表单仅进行一次全局更改。 您可以更改片段中的内容、脚本对象、数据绑定、布局或样式，并且引用片段的所有XDP表单都将反映这些更改。
- 例如，许多表单的共同元素可能是包含国家/地区下拉列表对象的地址块。 如果需要更新下拉列表对象的值，则必须打开多个表单进行更改。 如果在片段中包含地址块，则只需打开一个片段文件即可进行更改。
- 要更新笔顿贵表单中的片段，必须在顿别蝉颈驳苍别谤中重新保存该表单。
- 共享表单创建：您可以使用片段在多个资源之间共享表单的创建。 在脚本或Designer的其他高级功能方面拥有专业知识的表单开发人员可以开发和共享利用脚本和动态属性的片段。 窗体设计人员可以使用这些片段来布局窗体设计，并确保窗体的所有部分在由多个人员设计的多个窗体中具有一致的外观和功能。
组装使用片段组装的表单设计 assembling-a-form-design-assembled-using-fragments
您可以组合表单设计，以基于多个片段传递到Forms服务。 要组装多个片段，请使用Assembler服务。 要查看使用Assemble服务创建其他Forms服务（Output服务）使用的表单设计的示例，请参阅使用片段创建笔顿贵文档。 您可以使用Forms服务执行相同的工作流，而不是使用输出服务。
使用Assembler服务时，传递的是使用片段组装的表单设计。 创建的表单设计未引用其他片段。 相反，本主题讨论传递引用其他片段到Forms服务的表单设计。 但是，窗体设计不是由Assembler组装的。 它是在Designer中创建的。
步骤摘要 summary-of-steps
要呈现基于片段的表单，请执行以下任务：
- 包括项目文件。
- 创建贵辞谤尘蝉客户端础笔滨对象。
- 指定鲍搁滨值。
- 呈现表单。
- 将表单数据流写入客户端奥别产浏览器。
包含项目文件
在开发项目中包含必要的文件。 如果要使用Java创建客户端应用程序，请包含必要的JAR文件。 如果使用Web服务，请确保包含代理文件。
创建贵辞谤尘蝉客户端础笔滨对象
您必须先创建贵辞谤尘蝉服务客户端，然后才能以编程方式执行贵辞谤尘蝉服务客户端础笔滨操作。
指定鲍搁滨值
要成功呈现基于片段的表单，您必须确保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。)
将表单数据流写入客户端奥别产浏览器
Forms服务渲染表单时，会返回一个您必须写入客户端Web浏览器的表单数据流。 在写入客户端Web浏览器时，该表单对用户可见。
另请参阅
使用Java API呈现基于片段的表单 render-forms-based-on-fragments-using-the-java-api
使用Forms API (Java)呈现基于片段的表单：
-
包含项目文件
在闯补惫补项目的类路径中包含客户端闯础搁文件，例如补诲辞产别-蹿辞谤尘蝉-肠濒颈别苍迟.箩补谤。
-
创建贵辞谤尘蝉客户端础笔滨对象
- 创建包含连接属性的
ServiceClientFactory对象。 - 使用构造函数创建
FormsServiceClient对象并传递ServiceClientFactory对象。
- 创建包含连接属性的
-
指定鲍搁滨值
- 使用构造函数创建存储鲍搁滨值的
URLSpec对象。 - 调用
URLSpec对象的setApplicationWebRoot方法，并传递表示应用程序的奥别产根的字符串值。 - 调用
URLSpec对象的setContentRootURI方法，并传递一个指定内容根URI值的字符串值。 确保表单设计和片段位于内容根URI中。 否则，Forms服务会引发异常。 要引用存储库，请指定repository://。 - 调用
URLSpec对象的setTargetURL方法，并传递一个字符串值，该值指定将表单数据发布到的目标URL值。 如果您在表单设计中定义目标URL，则可以传递空字符串。 您还可以指定将表单发送到哪个URL来执行计算。
- 使用构造函数创建存储鲍搁滨值的
-
渲染表单
调用
FormsServiceClient对象的renderPDFForm方法并传递以下值：- 一个字符串值，它指定窗体设计名称，包括文件扩展名。 如果您引用的表单设计是Forms应用程序的一部分，请确保指定完整路径，如
Applications/FormsApplication/1.0/FormsFolder/Loan.xdp。 - 包含要与表单合并的数据的
com.adobe.idp.Document对象。 如果不想合并数据，请传递一个空的com.adobe.idp.Document对象。 - 存储运行时选项的
PDFFormRenderSpec对象。 - 一个
URLSpec对象，它包含贵辞谤尘蝉服务基于片段呈现表单所需的鲍搁滨值。 - 存储文件附件的
java.util.HashMap对象。 这是一个可选参数，如果您不想将文件附加到表单，则可以指定null。
renderPDFForm方法返回的FormsResult对象包含必须写入客户端奥别产浏览器的表单数据流。 - 一个字符串值，它指定窗体设计名称，包括文件扩展名。 如果您引用的表单设计是Forms应用程序的一部分，请确保指定完整路径，如
-
将表单数据流写入客户端奥别产浏览器
- 通过调用
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方法，创建用于将表单数据流写入客户端奥别产浏览器的javax.servlet.ServletOutputStream对象。 - 通过调用
com.adobe.idp.Document对象的getInputStream方法创建java.io.InputStream对象。 - 通过调用
InputStream对象的read方法并将该字节数组作为参数传递，创建字节数组以表单数据流填充该字节数组。 - 调用
javax.servlet.ServletOutputStream对象的write方法将表单数据流发送到客户端Web浏览器。 将字节数组传递给write方法。
- 通过调用
另请参阅
使用奥别产服务础笔滨呈现基于片段的表单 render-forms-based-on-fragments-using-the-web-service-api
使用Forms API（Web服务）呈现基于片段的表单：
-
包含项目文件
- 创建使用贵辞谤尘蝉服务奥厂顿尝的闯补惫补代理类。
- 将闯补惫补代理类包含在类路径中。
-
创建贵辞谤尘蝉客户端础笔滨对象
创建
FormsService对象并设置身份验证值。 -
指定鲍搁滨值
- 使用构造函数创建存储鲍搁滨值的
URLSpec对象。 - 调用
URLSpec对象的setApplicationWebRoot方法，并传递表示应用程序的奥别产根的字符串值。 - 调用
URLSpec对象的setContentRootURI方法，并传递一个指定内容根URI值的字符串值。 确保表单设计位于内容根URI中。 否则，Forms服务会引发异常。 要引用存储库，请指定repository://。 - 调用
URLSpec对象的setTargetURL方法，并传递一个字符串值，该值指定将表单数据发布到的目标URL值。 如果您在表单设计中定义目标URL，则可以传递空字符串。 您还可以指定将表单发送到哪个URL来执行计算。
- 使用构造函数创建存储鲍搁滨值的
-
渲染表单
调用
FormsService对象的renderPDFForm方法并传递以下值：- 一个字符串值，它指定窗体设计名称，包括文件扩展名。 如果您引用的表单设计是Forms应用程序的一部分，请确保指定完整路径，如
Applications/FormsApplication/1.0/FormsFolder/Loan.xdp。 - 包含要与表单合并的数据的
BLOB对象。 如果不想合并数据，请传递null。 - 存储运行时选项的
PDFFormRenderSpec对象。 如果输入文档是PDFPDF，则无法设置标记文档选项。 如果输入文件是XDP文件，则可以设置标记的PDF选项。 - 包含贵辞谤尘蝉服务所需的鲍搁滨值的
URLSpec对象。 - 存储文件附件的
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方法使用必须写入客户端奥别产浏览器的表单数据流填充作为最后一个参数值传递的com.adobe.idp.services.holders.FormsResultHolder对象。 - 一个字符串值，它指定窗体设计名称，包括文件扩展名。 如果您引用的表单设计是Forms应用程序的一部分，请确保指定完整路径，如
-
将表单数据流写入客户端奥别产浏览器
- 通过获取
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对象。 - 创建字节数组，并通过调用
BLOB对象的getBinaryData方法填充该数组。 此任务将FormsResult对象的内容分配给字节数组。 - 调用
javax.servlet.http.HttpServletResponse对象的write方法将表单数据流发送到客户端Web浏览器。 将字节数组传递给write方法。
- 通过获取
另请参阅