利用Forms服务,可自定义使用HTML表单呈现的工具栏。 可以通过覆盖默认CSS样式来自定义工具栏以更改其外观,并通过覆盖Java脚本来添加动态行为。 使用名为fscmenu.xml的XML文件自定义工具栏。 默认情况下,Forms服务会从内部指定的URI位置检索此文件。
此URI位置位于adobe-forms-core.jar文件中,该文件位于adobe-forms-dsc.jar文件中。 adobe-forms-dsc.jar文件位于C:\Adobe\Adobe_Experience_Manager_forms\ folder (C:\ is the installation directory)中。 您可以使用文件提取工具(如Win RAR)打开Adobe。
您可以从此位置复制fscmenu.xml,修改它以满足您的要求,然后将其放在自定义URI位置。 接下来,使用Forms服务API,设置运行时选项,以使用您从指定位置获取的fscmenu.xml文件生成Forms服务。 这些操作会导致Forms服务渲染具有自定义工具栏的HTML表单。
除了fscmenu.xml文件之外,您还需要获取以下文件:
fscJS是与每个节点关联的Java脚本。 必须为div#fscmenu
节点提供一个,并且可选地为ul#fscmenuItem
节点提供一个。 JS文件实施了核心工具栏功能,并且默认文件有效。
fscCSS是与特定节点关联的样式表。 CSS文件中的样式指定工具栏外观。 fscVCSS是垂直工具栏的样式表,显示在呈现的HTML表单的左侧。 fscIECSS是在Internet Explorer中呈现的HTML表单的样式表。
请确保上述所有文件均在fscmenu.xml文件中引用。 也就是说,在fscmenu.xml文件中,指定指向这些文件的URI位置,以便Forms服务能够找到这些文件。 默认情况下,这些文件位于以内部关键字FSWebRoot
或ApplicationWebRoot
开头的URI位置。
要自定义工具栏,请使用外部关键词FSToolBarURI
替换关键词。 此关键字表示在运行时传递到Forms服务的URI(此方法将在此部分稍后显示)。
您还可以指定这些JS和CSS文件的绝对位置,如https://www.mycompany.com/scripts/misc/fscmenu.js。 在这种情况下,您无需使用FSToolBarURI
关键字。
不建议将引用这些文件的方式混合使用。 也就是说,所有URI都应使用FSToolBarURI
关键字或绝对位置来引用。
您可以通过打开adobe-forms-<appserver>.ear文件来获取JS和CSS文件。 在此文件中,打开adobe-forms-res.war。 所有这些文件都位于WAR文件中。 adobe-forms-<appserver>.ear文件位于AEM Forms安装文件夹(C:\ is the installation directory)中。 您可以使用文件提取工具(如WinRAR)打开adobe-forms-<appserver>.ear。
以下XML语法显示了一个fscmenu.xml文件示例。
<div id="fscmenu" fscJS="FSToolBarURI/scripts/fscmenu.js" fscCSS="FSToolBarURI/fscmenu.css" fscVCSS="FSToolBarURI/fscmenu-v.css" fscIECSS="FSToolBarURI/fscmenu-ie.css">
<ul class="fscmenuItem" id="Home">
<li>
<a href="#" fscTarget="_top" tabindex="1">Home</a>
</li>
</ul>
<ul class="fscmenuItem" id="Upload" fscJS="FSToolBarURI/scripts/fscattachments.js" fscCSS="FSToolBarURI/fscdialog.css">
<li>
<a tabindex="2">Upload Attachments</a>
<ul class="fscmenuPopup" id="fscUploadAttachments">
<li>
<a href="javascript:doUploadDialog();" tabindex="3">Add ...</a>
</li>
<li>
<a href="javascript:doDeleteDialog();" tabindex="4">Delete ...</a>
</li>
</ul>
</li>
</ul>
<ul class="fscmenuItem" id="Download">
<li>
<a tabindex="100">Download Attachments</a>
<ul class="fscmenuPopup">
<li>
<a tabindex="101">None available</a>
</li>
</ul>
</li>
</ul>
</div>
粗体文本表示必须引用的CSS和JS文件的URI。
以下项目介绍了如何自定义工具栏:
fscJS
、fscCSS
、fscVCSS
、fscIECSS
属性的值(在fscmenu.xml文件中),以使用本节中描述的方法之一(例如fscJS="FSToolBarURI/scripts/fscmenu.js"
)来反映引用文件的自定义位置。div#fscmenu
节点需要的JS和CSS文件对于工具栏功能至关重要。 单个ul#fscmenuItem
节点可能或可能没有支持的JS或CSS文件。更改本地值
在自定义工具栏时,您可以更改工具栏的区域设置值。 也就是说,你可以用其他语言来显示它。 下图显示了一个以法语显示的自定义工具栏。
无法使用多种语言创建自定义工具栏。 工具栏无法根据区域设置使用不同的XML文件。
要更改工具栏的区域设置值,请确保fscmenu.xml文件包含要显示的语言。 以下XML语法显示fscmenu.xml文件,该文件用于显示法语工具栏。
<div id="fscmenu" fscJS="FSToolBarURI/scripts/fscmenu.js" fscCSS="FSToolBarURI/fscmenu.css" fscVCSS="FSToolBarURI/fscmenu-v.css" fscIECSS="FSToolBarURI/fscmenu-ie.css">
<ul class="fscmenuItem" id="Home">
<li>
<a href="#" fscTarget="_top" tabindex="1">Accueil</a>
</li>
</ul>
<ul class="fscmenuItem" id="Upload" fscJS="FSToolBarURI/scripts/fscattachments.js" fscCSS="FSToolBarURI/fscdialog.css">
<li>
<a tabindex="2">Télécharger les pièces jointes</a>
<ul class="fscmenuPopup" id="fscUploadAttachments">
<li>
<a href="javascript:doUploadDialog();" tabindex="3">Ajouter...</a>
</li>
<li>
<a href="javascript:doDeleteDialog();" tabindex="4">Supprimer...</a>
</li>
</ul>
</li>
</ul>
<ul class="fscmenuItem" id="Download">
<li>
<a tabindex="100">Télécharger les pièces jointes</a>
<ul class="fscmenuPopup">
<li>
<a tabindex="101">Aucune disponible</a>
</li>
</ul>
</li>
</ul>
</div>
与此部分关联的快速入门使用此XML文件来显示法语自定义工具栏,如上图所示。
此外,通过调用HTMLRenderSpec
对象的setLocale
方法并传递指定区域设置值的字符串值来指定有效的区域设置值。 例如,传递fr_FR
以指定法语。 Forms服务与本地化的工具栏捆绑在一起。
在渲染使用自定义工具栏的HTML表单之前,您必须了解HTML表单的渲染方式。 (请参阅将Forms渲染为HTML。)
有关Forms服务的更多信息,请参阅AEM Forms的服务参考。
要渲染包含自定义工具栏的HTML表单,请执行以下任务:
包含项目文件
在开发项目中包含必需的文件。 如果您使用Java创建客户端应用程序,请包含必需的JAR文件。 如果您使用的是Web服务,请包含代理文件。
创建Forms Java API对象
在以编程方式执行Forms服务支持的操作之前,必须先创建Forms客户端对象。
引用自定义fscmenu XML文件
要渲染包含自定义工具栏的HTML表单,请引用描述该工具栏的fscmenu XML文件。 (本节提供了fscmenu XML文件的两个示例。) 此外,请确保fscmenu.xml文件正确指定所有引用文件的位置。 如本节前面所述,请确保FSToolBarURI
关键字或其绝对位置引用所有文件。
渲染HTML表单
要渲染HTML表单,请指定在Designer中创建并另存为XDP文件的表单设计。 另请选择HTML转换类型。 例如,您可以指定为Internet Explorer 5.0或更高版本渲染动态HTML的HTML转换类型。
渲染HTML表单还需要值,例如用于渲染其他表单类型的URI值。
将表单数据流写入客户端Web浏览器
当Forms服务呈现HTML表单时,它会返回一个表单数据流,您必须将该数据流写入客户端Web浏览器,以使用户能够看到HTML表单。
另请参阅
使用Forms服务API(Java)渲染包含自定义工具栏的HTML表单:
包含项目文件
在Java项目的类路径中包含客户端JAR文件,如adobe-forms-client.jar。
创建Forms Java API对象
ServiceClientFactory
对象。FormsServiceClient
对象,并传递ServiceClientFactory
对象。引用自定义fscmenu XML文件
HTMLRenderSpec
对象的构造函数创建对象。HTMLRenderSpec
对象的setHTMLToolbar
方法并传递HTMLToolbar
枚举值。 例如,要显示垂直HTML工具栏,请传递HTMLToolbar.Vertical
。HTMLRenderSpec
对象的setToolbarURI
方法并传递指定XML文件URI位置的字符串值,指定fscmenu XML文件的位置。HTMLRenderSpec
对象的setLocale
方法并传递指定区域设置值的字符串值来设置区域设置值。 默认值为英语。与此部分关联的快速入门会将此值设置为fr_FR
。
渲染HTML表单
调用FormsServiceClient
对象的renderHTMLForm
方法并传递以下值:
Applications/FormsApplication/1.0/FormsFolder/Loan.xdp
。TransformTo
枚举值。 例如,要渲染与Internet Explorer 5.0或更高版本的动态HTML兼容的HTML表单,请指定TransformTo.MSDHTML
。com.adobe.idp.Document
对象,其中包含要与表单合并的数据。 如果不想合并数据,请传递一个空的com.adobe.idp.Document
对象。HTMLRenderSpec
对象。HTTP_USER_AGENT
标头值的字符串值,如Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1; .NET CLR 1.1.4322)
。URLSpec
对象,用于存储呈现HTML表单所需的URI值。java.util.HashMap
对象。 这是一个可选参数,如果您不想将文件附加到表单,可以指定null
。renderHTMLForm
方法返回一个FormsResult
对象,该对象包含必须写入客户端Web浏览器的表单数据流。
将表单数据流写入客户端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呈现带有自定义工具栏的HTML表单
使用Forms服务API(Web服务)渲染包含自定义工具栏的HTML表单:
包含项目文件
创建Forms Java API对象
创建FormsService
对象并设置身份验证值。
引用自定义fscmenu XML文件
HTMLRenderSpec
对象的构造函数创建对象。HTMLRenderSpec
对象的setHTMLToolbar
方法并传递HTMLToolbar
枚举值。 例如,要显示垂直HTML工具栏,请传递HTMLToolbar.Vertical
。HTMLRenderSpec
对象的setToolbarURI
方法并传递指定XML文件URI位置的字符串值,指定fscmenu XML文件的位置。HTMLRenderSpec
对象的setLocale
方法并传递指定区域设置值的字符串值来设置区域设置值。 默认值为英语。与此部分关联的快速入门会将此值设置为fr_FR
。
渲染HTML表单
调用FormsService
对象的renderHTMLForm
方法并传递以下值:
Applications/FormsApplication/1.0/FormsFolder/Loan.xdp
。TransformTo
枚举值。 例如,要渲染与Internet Explorer 5.0或更高版本的动态HTML兼容的HTML表单,请指定TransformTo.MSDHTML
。BLOB
对象,其中包含要与表单合并的数据。 如果不想合并数据,请传递null
。HTMLRenderSpec
对象。HTTP_USER_AGENT
标头值(如Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1; .NET CLR 1.1.4322
)的字符串值。 如果不想设置此值,可以传递空字符串。URLSpec
对象,用于存储呈现HTML表单所需的URI值。java.util.HashMap
对象。 此参数是可选的,如果您不打算将文件附加到表单,则可以指定null
。renderHTMLForm
方法填充的空com.adobe.idp.services.holders.BLOBHolder
对象。 此参数值存储呈现的表单。renderHTMLForm
方法填充的空com.adobe.idp.services.holders.BLOBHolder
对象。 此参数存储输出XML数据。renderHTMLForm
方法填充的空javax.xml.rpc.holders.LongHolder
对象。 此参数以表单形式存储页数。renderHTMLForm
方法填充的空javax.xml.rpc.holders.StringHolder
对象。 此参数存储区域设置值。renderHTMLForm
方法填充的空javax.xml.rpc.holders.StringHolder
对象。 此参数存储所用的HTML呈现值。com.adobe.idp.services.holders.FormsResultHolder
对象。renderHTMLForm
方法使用必须写入客户端Web浏览器的表单数据流填充作为最后一个参数值传递的com.adobe.idp.services.holders.FormsResultHolder
对象。
将表单数据流写入客户端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
方法。另请参阅