Representación de HTML Forms con barras de herramientas personalizadas

Los ejemplos y ejemplos de este documento son solo para AEM Forms en un entorno JEE.

Representación de HTML Forms con barras de herramientas personalizadas

El servicio Forms permite personalizar una barra de herramientas que se procesa con un formulario HTML. Se puede personalizar una barra de herramientas para modificar su aspecto anulando los estilos CSS predeterminados y para añadir un comportamiento dinámico anulando los scripts Java. Una barra de herramientas se personaliza utilizando un archivo XML llamado fscmenu.xml. De forma predeterminada, el servicio Forms recupera este archivo desde una ubicación URI especificada internamente.

NOTA

Esta ubicación URI se encuentra en el archivo adobe-forms-core.jar , que se encuentra en el archivo adobe-forms-dsc.jar . El archivo adobe-forms-dsc.jar se encuentra en C:\Adobe\Adobe_Experience_Manager_forms\ folder (C:\ is the installation directory). Puede utilizar una herramienta de extracción de archivos, como Win RAR, para abrir el adobe.

Puede copiar el archivo fscmenu.xml desde esta ubicación, modificarlo para satisfacer sus necesidades y, a continuación, colocarlo en una ubicación URI personalizada. A continuación, con la API de servicio de Forms, establezca las opciones en tiempo de ejecución que resulten en que el servicio de Forms use su archivo fscmenu.xml desde la ubicación especificada. Estas acciones resultan en que el servicio Forms procese un formulario HTML que tiene una barra de herramientas personalizada.

Además del archivo fscmenu.xml, también debe obtener los siguientes archivos:

  • fscmenu.js
  • fscattachments.js
  • fscmenu.css
  • fscmenu-v.css
  • fscmenu-ie.css
  • fscdialog.css

fscJS es la secuencia de comandos Java asociada a cada nodo. Es necesario suministrar uno para el nodo div#fscmenu y, opcionalmente, para los nodos ul#fscmenuItem. Los archivos JS implementan la funcionalidad principal de la barra de herramientas y los archivos predeterminados funcionan.

fscCSS es una hoja de estilos asociada a un nodo en particular. Los estilos de los archivos CSS especifican el aspecto de la barra de herramientas. fscVCSSes una hoja de estilo para una barra de herramientas vertical que se muestra a la izquierda del formulario HTML procesado. fscIECSS es una hoja de estilos que se utiliza para los formularios HTML procesados en Internet Explorer.

Asegúrese de que todos los archivos anteriores están referenciados en el archivo fscmenu.xml. Es decir, en el archivo fscmenu.xml, especifique las ubicaciones de URI que apunten a estos archivos para que el servicio de Forms pueda localizarlos. De forma predeterminada, estos archivos están disponibles en ubicaciones de URI que comienzan por palabras clave internas FSWebRoot o ApplicationWebRoot.

Para personalizar la barra de herramientas, reemplace las palabras clave utilizando la palabra clave externa FSToolBarURI. Esta palabra clave representa el URI que se pasa al servicio de Forms en tiempo de ejecución (este método se muestra más adelante en esta sección).

También puede especificar las ubicaciones absolutas de estos archivos JS y CSS, como https://www.mycompany.com/scripts/misc/fscmenu.js. En este caso, no es necesario utilizar la palabra clave FSToolBarURI.

NOTA

No se recomienda mezclar las formas en que se hace referencia a estos archivos. Es decir, se debe hacer referencia a todos los URI utilizando la palabra clave FSToolBarURI o una ubicación absoluta.

Puede obtener los archivos JS y CSS abriendo el archivo adobe-forms-<appserver>.ear . En este archivo, abra adobe-forms-res.war. Todos estos archivos se encuentran en el archivo WAR. El archivo adobe-forms-<appserver>.ear se encuentra en la carpeta de instalación de AEM forms (C:\ is the installation directory). Puede abrir adobe-forms-<appserver>.ear con una herramienta de extracción de archivos como WinRAR.

La siguiente sintaxis XML muestra un archivo fscmenu.xml de ejemplo.

 <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>
NOTA

El texto en negrita representa los URI de los archivos CSS y JS a los que se debe hacer referencia.

Los siguientes elementos describen cómo se puede personalizar una barra de herramientas:

  • Cambie los valores de los atributos fscJS, fscCSS, fscVCSS, fscIECSS (en el archivo fscmenu.xml) para que reflejen las ubicaciones personalizadas de los archivos a los que se hace referencia utilizando uno de los métodos descritos en esta sección (por ejemplo, fscJS="FSToolBarURI/scripts/fscmenu.js").
  • Se deben especificar todos los archivos CSS y JS. Si no se modifica ninguno de los archivos, proporcione el predeterminado en la ubicación personalizada. Puede obtener los archivos predeterminados abriendo varios archivos como se describe en esta sección.
  • Se permite proporcionar una referencia absoluta (por ejemplo, https://www.example.com/scripts/custom-vertical-fscmenu.css) para cualquier archivo.
  • Los archivos JS y CSS que requiere el nodo div#fscmenu son esenciales para la funcionalidad de la barra de herramientas. Los nodos individuales ul#fscmenuItem pueden admitir o no archivos JS o CSS.

Modificación del valor local

Como parte de la personalización de una barra de herramientas, puede cambiar el valor de configuración regional de la barra de herramientas. Es decir, puede mostrarlo en otro idioma. La siguiente ilustración muestra una barra de herramientas personalizada que se muestra en francés.

NOTA

No es posible crear una barra de herramientas personalizada en más de un idioma. Las barras de herramientas no pueden utilizar diferentes archivos XML basados en la configuración regional.

Para cambiar el valor de configuración regional de una barra de herramientas, asegúrese de que el archivo fscmenu.xml contenga el idioma que desea mostrar. La siguiente sintaxis XML muestra el archivo fscmenu.xml que se utiliza para mostrar una barra de herramientas en francés.

 <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>
NOTA

Los Quick Starts asociados a esta sección utilizan este archivo XML para mostrar una barra de herramientas personalizada en francés, como se muestra en la ilustración anterior.

Además, especifique un valor de configuración regional válido invocando el método HTMLRenderSpec del objeto setLocale y pasando un valor de cadena que especifica el valor de configuración regional. Por ejemplo, pase fr_FR para especificar el francés. El servicio Forms está empaquetado con barras de herramientas localizadas.

NOTA

Antes de procesar un formulario HTML que utilice una barra de herramientas personalizada, debe saber cómo se procesan los formularios HTML. (Consulte Representación de Forms como HTML).

Para obtener más información sobre el servicio Forms, consulte Referencia de servicios para AEM Forms.

Resumen de los pasos

Para procesar un formulario HTML que contenga una barra de herramientas personalizada, realice estas tareas:

  1. Incluir archivos de proyecto.
  2. Cree un objeto de API Java de Forms.
  3. Haga referencia a un archivo XML de fscmenu personalizado.
  4. Representar un formulario HTML.
  5. Escriba el flujo de datos del formulario en el explorador web del cliente.

Incluir archivos de proyecto

Incluya los archivos necesarios en el proyecto de desarrollo. Si está creando una aplicación cliente mediante Java, incluya los archivos JAR necesarios. Si utiliza servicios web, incluya los archivos proxy.

Creación de un objeto de API Java de Forms

Para poder realizar mediante programación una operación que admita el servicio Forms, debe crear un objeto cliente Forms.

Hacer referencia a un archivo XML de fscmenu personalizado

Para procesar un formulario HTML que contenga una barra de herramientas personalizada, haga referencia a un archivo XML fscmenu que describe la barra de herramientas. (Esta sección proporciona dos ejemplos de archivo XML fscmenu). Además, asegúrese de que el archivo fscmenu.xml especifica las ubicaciones de todos los archivos a los que se hace referencia correctamente. Como se mencionó anteriormente en esta sección, asegúrese de que la palabra clave FSToolBarURI o sus ubicaciones absolutas hagan referencia a todos los archivos.

Representar un formulario HTML

Para procesar un formulario HTML, especifique un diseño de formulario que se haya creado en Designer y guardado como archivo XDP. Seleccione también un tipo de transformación HTML. Por ejemplo, puede especificar el tipo de transformación HTML que procesa un HTML dinámico para Internet Explorer 5.0 o posterior.

La renderización de un formulario HTML también requiere valores, como valores de URI, para procesar otros tipos de formulario.

Escribir el flujo de datos del formulario en el explorador web del cliente

Cuando el servicio Forms procesa un formulario HTML, devuelve un flujo de datos de formulario que debe escribir en el explorador web del cliente para que el formulario HTML sea visible para los usuarios.

Consulte también

Representar un formulario HTML con una barra de herramientas personalizada mediante la API de Java

Representación de un formulario HTML con una barra de herramientas personalizada mediante la API de servicio web

Inclusión de archivos de biblioteca Java de AEM Forms

Configuración de las propiedades de conexión

Inicio rápido de la API del servicio de Forms

Renderización de PDF forms interactivos

Representación de Forms como HTML

Creación de aplicaciones web que procesen Forms

Representar un formulario HTML con una barra de herramientas personalizada mediante la API de Java

Representar un formulario HTML que contenga una barra de herramientas personalizada mediante la API de servicio de Forms (Java):

  1. Incluir archivos de proyecto

    Incluya archivos JAR del cliente, como adobe-forms-client.jar, en la ruta de clase de su proyecto Java.

  2. Creación de un objeto de API Java de Forms

    • Cree un objeto ServiceClientFactory que contenga propiedades de conexión.
    • Cree un objeto FormsServiceClient utilizando su constructor y pasando el objeto ServiceClientFactory.
  3. Hacer referencia a un archivo XML de fscmenu personalizado

    • Cree un objeto HTMLRenderSpec utilizando su constructor.
    • Para procesar un formulario HTML con una barra de herramientas, invoque el método HTMLRenderSpec del objeto setHTMLToolbar y pase un valor de enumeración HTMLToolbar. Por ejemplo, para mostrar una barra de herramientas vertical HTML, pase HTMLToolbar.Vertical.
    • Especifique la ubicación del archivo XML fscmenu invocando el método HTMLRenderSpec del objeto setToolbarURI y pasando un valor de cadena que especifica la ubicación URI del archivo XML.
    • Si corresponde, establezca el valor de configuración regional invocando el método HTMLRenderSpec del objeto setLocale y pasando un valor de cadena que especifica el valor de configuración regional. El valor predeterminado es inglés.
    NOTA

    El inicio rápido asociado con esta sección establece este valor en fr_FR.

  4. Representar un formulario HTML

    Invoque el método FormsServiceClient del objeto renderHTMLForm y pase los siguientes valores:

    • Un valor de cadena que especifica el nombre del diseño de formulario, incluida la extensión del nombre de archivo. Si hace referencia a un diseño de formulario que forma parte de una aplicación de Forms, asegúrese de especificar la ruta completa, como Applications/FormsApplication/1.0/FormsFolder/Loan.xdp.
    • Un valor de enumeración TransformTo que especifica el tipo de preferencia HTML. Por ejemplo, para procesar un formulario HTML compatible con HTML dinámico para Internet Explorer 5.0 o posterior, especifique TransformTo.MSDHTML.
    • Un objeto com.adobe.idp.Document que contiene datos para combinar con el formulario. Si no desea combinar datos, pase un objeto com.adobe.idp.Document vacío.
    • El objeto HTMLRenderSpec que almacena las opciones de tiempo de ejecución HTML.
    • Un valor de cadena que especifica el valor del encabezado HTTP_USER_AGENT, como Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1; .NET CLR 1.1.4322).
    • Un objeto URLSpec que almacena valores de URI necesarios para procesar un formulario HTML.
    • Un objeto java.util.HashMap que almacena archivos adjuntos. Se trata de un parámetro opcional y puede especificar null si no desea adjuntar archivos al formulario.

    El método renderHTMLForm devuelve un objeto FormsResult que contiene un flujo de datos de formulario que debe escribirse en el explorador web del cliente.

  5. Escribir el flujo de datos del formulario en el explorador web del cliente

    • Cree un objeto com.adobe.idp.Document invocando el método FormsResult del objeto ‘s getOutputContent.
    • Obtenga el tipo de contenido del objeto com.adobe.idp.Document invocando su método getContentType.
    • Establezca el tipo de contenido del objeto javax.servlet.http.HttpServletResponse invocando su método setContentType y pasando el tipo de contenido del objeto com.adobe.idp.Document.
    • Cree un objeto javax.servlet.ServletOutputStream que se utilice para escribir el flujo de datos del formulario en el explorador web del cliente invocando el método javax.servlet.http.HttpServletResponse del objeto getOutputStream.
    • Cree un objeto java.io.InputStream invocando el método com.adobe.idp.Document del objeto getInputStream.
    • Cree una matriz de bytes y rellénela con la secuencia de datos del formulario invocando el método InputStream del objeto read y pasando la matriz de bytes como argumento.
    • Invoque el método javax.servlet.ServletOutputStream del objeto write para enviar la secuencia de datos del formulario al explorador web del cliente. Pase la matriz de bytes al método write.

Consulte también

Inicio rápido (modo SOAP): Representación de un formulario HTML con una barra de herramientas personalizada mediante la API de Java

Inclusión de archivos de biblioteca Java de AEM Forms

Configuración de las propiedades de conexión

Representación de un formulario HTML con una barra de herramientas personalizada mediante la API de servicio web

Representar un formulario HTML que contenga una barra de herramientas personalizada mediante la API del servicio Forms (servicio web):

  1. Incluir archivos de proyecto

    • Cree clases de proxy Java que consuman el WSDL del servicio Forms.
    • Incluya las clases proxy de Java en la ruta de clase.
  2. Creación de un objeto de API Java de Forms

    Cree un objeto FormsService y establezca valores de autenticación.

  3. Hacer referencia a un archivo XML de fscmenu personalizado

    • Cree un objeto HTMLRenderSpec utilizando su constructor.
    • Para procesar un formulario HTML con una barra de herramientas, invoque el método HTMLRenderSpec del objeto setHTMLToolbar y pase un valor de enumeración HTMLToolbar. Por ejemplo, para mostrar una barra de herramientas vertical HTML, pase HTMLToolbar.Vertical.
    • Especifique la ubicación del archivo XML fscmenu invocando el método HTMLRenderSpec del objeto setToolbarURI y pasando un valor de cadena que especifica la ubicación URI del archivo XML.
    • Si corresponde, establezca el valor de configuración regional invocando el método HTMLRenderSpec del objeto setLocale y pasando un valor de cadena que especifica el valor de configuración regional. El valor predeterminado es inglés.
    NOTA

    El inicio rápido asociado con esta sección establece este valor en fr_FR.

  4. Representar un formulario HTML

    Invoque el método FormsService del objeto renderHTMLForm y pase los siguientes valores:

    • Un valor de cadena que especifica el nombre del diseño de formulario, incluida la extensión del nombre de archivo. Si hace referencia a un diseño de formulario que forma parte de una aplicación de Forms, asegúrese de especificar la ruta completa, como Applications/FormsApplication/1.0/FormsFolder/Loan.xdp.
    • Un valor de enumeración TransformTo que especifica el tipo de preferencia HTML. Por ejemplo, para procesar un formulario HTML compatible con HTML dinámico para Internet Explorer 5.0 o posterior, especifique TransformTo.MSDHTML.
    • Un objeto BLOB que contiene datos para combinar con el formulario. Si no desea combinar datos, pase null.
    • El objeto HTMLRenderSpec que almacena las opciones de tiempo de ejecución HTML.
    • Un valor de cadena que especifica el valor del encabezado HTTP_USER_AGENT, como Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1; .NET CLR 1.1.4322). Puede pasar una cadena vacía si no desea establecer este valor.
    • Un objeto URLSpec que almacena valores de URI necesarios para procesar un formulario HTML.
    • Un objeto java.util.HashMap que almacena archivos adjuntos. Este parámetro es opcional y puede especificar null si no desea adjuntar archivos al formulario.
    • Un objeto com.adobe.idp.services.holders.BLOBHolder vacío que se rellena con el método renderHTMLForm. Este valor de parámetro almacena el formulario procesado.
    • Un objeto com.adobe.idp.services.holders.BLOBHolder vacío que se rellena con el método renderHTMLForm. Este parámetro almacena los datos XML de salida.
    • Un objeto javax.xml.rpc.holders.LongHolder vacío que se rellena con el método renderHTMLForm. Este argumento almacena el número de páginas del formulario.
    • Un objeto javax.xml.rpc.holders.StringHolder vacío que se rellena con el método renderHTMLForm. Este argumento almacena el valor de configuración regional.
    • Un objeto javax.xml.rpc.holders.StringHolder vacío que se rellena con el método renderHTMLForm. Este argumento almacena el valor de renderización HTML que se utiliza.
    • Un objeto com.adobe.idp.services.holders.FormsResultHolder vacío que contendrá los resultados de esta operación.

    El método renderHTMLForm rellena el objeto com.adobe.idp.services.holders.FormsResultHolder que se pasa como el último valor de argumento con un flujo de datos de formulario que debe escribirse en el explorador web del cliente.

  5. Escribir el flujo de datos del formulario en el explorador web del cliente

    • Cree un objeto FormResult obteniendo el valor del miembro de datos com.adobe.idp.services.holders.FormsResultHolder del objeto value.
    • Cree un objeto BLOB que contenga datos de formulario invocando el método FormsResult del objeto getOutputContent.
    • Obtenga el tipo de contenido del objeto BLOB invocando su método getContentType.
    • Establezca el tipo de contenido del objeto javax.servlet.http.HttpServletResponse invocando su método setContentType y pasando el tipo de contenido del objeto BLOB.
    • Cree un objeto javax.servlet.ServletOutputStream que se utilice para escribir el flujo de datos del formulario en el explorador web del cliente invocando el método javax.servlet.http.HttpServletResponse del objeto getOutputStream.
    • Cree una matriz de bytes y rellénela invocando el método BLOB del objeto getBinaryData. Esta tarea asigna el contenido del objeto FormsResult a la matriz de bytes.
    • Invoque el método javax.servlet.http.HttpServletResponse del objeto write para enviar la secuencia de datos del formulario al explorador web del cliente. Pase la matriz de bytes al método write.

Consulte también

Invocación de AEM Forms mediante la codificación Base64

En esta página