Expresiones de formulario adaptables

Los formularios adaptables proporcionan una experiencia de cumplimentación de formularios optimizada y simplificada para los usuarios finales con funciones de secuencias de comandos dinámicas. Permite escribir expresiones para añadir varios comportamientos, como mostrar u ocultar campos y paneles dinámicos. También permite agregar campos calculados, hacer campos de solo lectura, agregar lógica de validación y muchos más. El comportamiento dinámico se basa en los datos introducidos por el usuario o rellenados previamente.

JavaScript es el lenguaje de expresión de los formularios adaptables. Todas las expresiones son expresiones de JavaScript válidas y utilizan API de modelos de secuencias de comandos de formularios adaptables. Estas expresiones devuelven valores de ciertos tipos. Para obtener la lista completa de clases de formularios adaptables, eventos, objetos y API públicas, consulte Referencia de la API de la biblioteca JavaScript para formularios adaptables.

Prácticas recomendadas para escribir expresiones

• Al escribir expresiones, para acceder a campos y paneles, puede utilizar el nombre del campo o panel. Para acceder al valor de un campo, utilice la propiedad value . Por ejemplo, field1.value
• Utilice nombres únicos para campos y paneles de todo el formulario. Ayuda a evitar posibles conflictos con los nombres de campo utilizados al escribir expresiones.
• Cuando escriba expresiones de varias líneas, utilice un punto y coma para finalizar una instrucción.

Prácticas recomendadas para expresiones que implican panel de repetición

Los paneles de repetición son instancias de un panel que se añaden o eliminan dinámicamente mediante API de secuencias de comandos o datos rellenados previamente. Para obtener información detallada sobre el uso del panel de repetición, consulte creación de formularios con secciones repetibles.

• Para crear un panel de repetición, en el cuadro de diálogo del panel, abra la configuración y establezca el valor del campo de recuento máximo en más de 1.

• El valor de recuento mínimo de la configuración de repetición del panel puede ser uno o más, pero no puede ser superior al valor de recuento máximo.

• Cuando una expresión hace referencia a un campo de panel de repetición, los nombres de campo de la expresión se resuelven en el elemento de repetición más cercano.

• Los formularios adaptables proporcionan algunas funciones especiales para simplificar el cálculo de paneles repetibles, como suma, recuento, mínimo, máximo, filtro y muchas más. Para obtener la lista completa de las funciones, consulte Referencia de la API de la biblioteca JavaScript para formularios adaptables

• Las API para manipular instancias de panel repetitivo son:

  • Para añadir una instancia de panel: panel1.instanceManager.addInstance()
  • Para obtener un índice de repetición de panel: panel1.instanceIndex
  • Para obtener el instanceManager de un panel: _panel1 or panel1.instanceManager
  • Para quitar una instancia de un panel: _panel1.removeInstance(panel1.instanceIndex)

Tipos de expresión

En los formularios adaptables, puede escribir expresiones para añadir comportamientos como mostrar u ocultar campos y paneles dinámicos. También puede escribir expresiones para agregar campos calculados, convertir campos en de solo lectura, lógica de validación y muchos más. Los formularios adaptables admiten las expresiones siguientes:

• Expresiones de acceso: para activar o desactivar un campo.

• Calcular expresiones: para calcular automáticamente el valor de un campo.

• Expresión de clic: para controlar las acciones al hacer clic en un botón.

• Secuencia de comandos de inicialización: realice una acción sobre la inicialización de un campo.

• Expresión de opciones: para rellenar dinámicamente una lista desplegable.

• Expresión de resumen: para calcular dinámicamente el título de un acordeón.

• Validar expresiones: para validar un campo.

• Secuencia de comandos de confirmación de valores: para cambiar los componentes de un formulario después de cambiar el valor de un campo.

• Expresión de visibilidad: para controlar la visibilidad de un campo y un panel.

• Expresión de finalización de paso: para evitar que un usuario vaya al siguiente paso de un asistente.

Expresión de acceso (expresión de habilitación)

Puede utilizar la expresión access para habilitar o deshabilitar un campo. Si la expresión utiliza el valor de un campo, cada vez que cambie el valor del campo, se recuperará la expresión.

Se aplica a: campos

Tipo de devolución: La expresión devuelve un valor booleano, que representa si el campo está habilitado o deshabilitado. ​​realmente representa que el campo está habilitado y ​​falserrepresenta que el campo está deshabilitado.

Ejemplo: Para habilitar un campo únicamente cuando el valor de field1 está establecido en X, la expresión de acceso es: field1.value == "X"

Calcular expresión

La expresión calculate se utiliza para calcular automáticamente el valor de un campo mediante una expresión. Normalmente, esta expresión utiliza la propiedad value de otros campos. Por ejemplo, field2.value + field3.value. Siempre que cambia el valor de field2o field3, se recupera la expresión y se vuelve a calcular el valor.

Se aplica a: campos

Tipo de devolución: La expresión devuelve un valor compatible con el campo en el que se muestra el resultado de la expresión (por ejemplo, decimal).

Ejemplo: La expresión calculate para mostrar la suma de dos campos en field1 es:
field2.value + field3.value

Haga clic en Expresión

La expresión click gestiona las acciones realizadas en el suceso click de un botón. De serie, GuideBridge proporciona API para realizar diversas funciones, como enviar y validar, que se utilizan junto con la expresión de clic. Para obtener una lista completa de las API, consulte GuideBridge APIs.

Se aplica a: Campos de botón

Tipo de devolución: La expresión click no devuelve ningún valor. Si alguna expresión devuelve un valor, se ignora el valor.

Ejemplo: Para rellenar un cuadro de texto de cuadro de texto1 en la acción de clic de un botón con el valor AEM Forms, la expresión de clic del botón es textbox1.value="AEM Forms" "

Script de inicialización

La secuencia de comandos de inicialización se activa cuando se inicializa un formulario adaptable. Según los escenarios, la secuencia de comandos de inicialización se comporta de la siguiente manera:

• Cuando se procesa un formulario adaptable sin un relleno previo de datos, la secuencia de comandos de inicialización se ejecuta después de que se inicialice el formulario.
• Cuando se procesa un formulario adaptable con un relleno previo de datos, la secuencia de comandos se ejecuta una vez finalizada la operación de rellenado previo.
• Cuando se activa la revalidación del lado del servidor de un formulario adaptable, se ejecuta la secuencia de comandos de inicialización.

Se aplica a: campos y panel

Tipo de devolución: la expresión de secuencia de comandos de inicialización no devuelve ningún valor. Si alguna expresión devuelve un valor, se ignora el valor.

Ejemplo: en un escenario de rellenado previo de datos, para rellenar campos con un valor predeterminado 'Adaptive Forms' cuando su valor se guarda como nulo, la expresión de la secuencia de comandos de inicialización es:
if(this.value==null) this.value='Adaptive Forms';

Expresión de opciones

La expresión options se utiliza para rellenar dinámicamente las opciones de un campo de lista desplegable.

Se aplica a: campos de lista desplegable

Tipo de devolución: La expresión options devuelve una matriz de valores de cadena. Cada valor puede ser una cadena simple, como Hombre, o en un formato de par clave=valor, como 1=Hombre

Ejemplo: Para rellenar el valor de un campo, en función del valor de otro campo, proporcione una expresión de opciones simple. Por ejemplo, para rellenar un campo, Number of Kids , según el Marital Status expresado en otro campo, la expresión es:

marital_status.value == "married" ? ["1=One", "2=two"] : ["0=Zero"].

Siempre que cambia el valor del campo marital_status, se recupera la expresión. También puede rellenar el menú desplegable desde un servicio REST. Para obtener información detallada, consulte Rellenado dinámico de desplegables.

Expresión de resumen

La expresión Resumen calcula dinámicamente el título de un panel secundario de un panel de diseño de acordeón. Puede especificar la expresión Resumen en una regla, que utiliza un campo de formulario o una lógica personalizada para evaluar el título. La expresión se ejecuta cuando se inicializa el formulario. Si va a incluir un formulario como prefijo, la expresión se ejecuta después de que los datos se hayan rellenado previamente o cuando cambie el valor de los campos dependientes utilizados en la expresión.

La expresión Resumen se utiliza generalmente para repetir elementos secundarios de un panel de diseño de acordeón para proporcionar un título significativo a cada panel secundario.

Se aplica a: paneles que son secundarios directos de un panel cuyo diseño está configurado como acordeón.

Tipo de devolución: la expresión devuelve un valor de tipo String que se convierte en el título del acordeón.

Ejemplo: "Número de cuenta : "+ textbox1.value

Validar expresión

La expresión validate se utiliza para validar los campos utilizando la expresión dada. Normalmente, estas expresiones utilizan expresiones regulares junto con el valor del campo para validar un campo. La expresión se recupera y el estado de validación del campo se vuelve a calcular en cualquier cambio en el valor de un campo.

Se aplica a: campos

Tipo de devolución: La expresión devuelve un valor booleano, que representa el estado de validación del campo. El valor false representa que el campo no es válido y true representa que el campo es válido.

Ejemplo: Para un campo que representa el código postal del Reino Unido, la expresión de validación es:

(this.value && this.value.match(/^(GIR 0AA|[A-Z]{1,2}\d[A-Z0-9]? ?[0-9][A-Z]{2}\s*)$/i) == null) ? false : true)

En el ejemplo anterior, si el valor no vacío no coincide con el patrón, la expresión devuelve false para indicar que el campo no es válido.

Script de implementación de valor

La secuencia de comandos de confirmación de valores se activa cuando:

• Un usuario cambia el valor de un campo de la IU.
• El valor de un campo cambia programáticamente debido a cambios en otro campo.

Se aplica a: campos

Tipo de devolución: el valor de la expresión de secuencia de comandos de confirmación no devuelve ningún valor. Si alguna expresión devuelve un valor, se ignora el valor.

Ejemplo: para convertir las mayúsculas y minúsculas de los alfabetos introducidos en el campo a mayúsculas en la confirmación, el valor de la expresión de confirmación es:
this.value=this.value.toUpperCase()

Expresión de visibilidad

La expresión Visibilidad se utiliza para controlar la visibilidad del campo o panel. Normalmente, la expresión visibility utiliza la propiedad value de un campo y se recupera cada vez que cambia ese valor.

Se aplica a: campos y panel

Tipo de devolución: Expression devuelve un valor booleano, que representa el campo/panel visible o no. ​​presenta que el campo o panel no está visible y que el valor "True" representa que el campo o panel está visible.

Ejemplo: Para un panel que se vuelve visible solo si el valor de field1 está establecido en Masculino, la expresión de visibilidad es: field1.value == "Male"

Expresión de finalización de paso

La expresión de finalización de paso se utiliza para evitar que un usuario vaya al siguiente paso de un diseño de asistente. Estas expresiones se utilizan cuando los paneles tienen una presentación de asistente (formularios de varios pasos que muestran un paso a la vez). El usuario puede pasar al siguiente paso, panel o subsección solo si todos los valores requeridos de la sección actual están rellenados y son válidos.

Se aplica a: Paneles con diseño de elemento definido en asistente.

Tipo de devolución: Expression devuelve un valor booleano, que representa que el panel actual es válido o no. ​​Verdaderamente representa que el panel actual es válido y el usuario puede navegar al panel siguiente.

Ejemplo: En un formulario organizado en varios paneles, antes de navegar al panel siguiente, se valida el panel actual. En estos casos, se utilizan las expresiones de finalización de paso. Por lo general, estas expresiones utilizan la API de validación de GuideBridge. Un ejemplo de expresión de finalización de paso es:
window.guideBridge.validate([],this.panel.navigationContext.currentItem.somExpression)

Validaciones en formato adaptable

Existen varios métodos para agregar la validación de campos a un formulario adaptable. Si se agrega una comprobación de validación en un campo, True representa que el valor introducido en el campo es válido. ​​Muestra que el valor no es válido. Si inserta y sale de un campo, no se genera el mensaje de error.

Los métodos para agregar validaciones en un campo son:

Requerido

Para hacer que un componente sea obligatorio, en el cuadro de diálogo Editar del componente, puede seleccionar la opción Título y texto > Requerido. También puede agregar el mensaje necesario (opcional) apropiado. .

Patrones de validación

Hay varios patrones de validación predeterminados disponibles para un campo. Para seleccionar un patrón de validación, en el cuadro de diálogo Editar del componente, busque la sección Patrones y seleccione patrones. Puede crear su propio patrón de validación personalizado en un cuadro de texto Pattern. El estado de validación se devuelve True solo si los datos rellenados cumplen el patrón de validación, de lo contrario se devuelve False. Para escribir su propio patrón de validación personalizado, consulte Compatibilidad de cláusula de imagen para formularios HTML5.

Expresiones de validación

La validación de un campo también se puede calcular mediante expresiones en diferentes campos. Estas expresiones se escriben dentro del campo Validation Script de la pestaña Script del cuadro de diálogo Edit del componente. El estado de validación de un campo depende del valor que devuelva la expresión. Para obtener información sobre cómo escribir estas expresiones, consulte Validar expresión.

Información adicional

Uso del formato de visualización de campo

El formato de visualización puede utilizarse para mostrar los datos en distintos formatos. Por ejemplo, puede utilizar el formato de visualización para mostrar un número de teléfono con guiones, aplicar formato a código postal o un selector de fechas. Estos patrones de visualización se pueden seleccionar desde la sección Patrones del cuadro de diálogo Editar de un componente. Puede escribir patrones de visualización personalizados similares a los patrones de validación mencionados anteriormente.

GuideBridge: API y eventos

GuideBridge es una colección de API que se pueden utilizar para interactuar con formularios adaptables en el modelo de memoria en un explorador. Para obtener una introducción detallada a la API de puente de guía, los métodos de clase y los eventos expuestos, consulte Referencia de la API de biblioteca JavaScript para formularios adaptables.

Uso de GuideBridge en varias expresiones

• Para restablecer los campos del formulario, puede almacenar en déclencheur la API guideBridge.reset() al hacer clic en la expresión de un botón. Del mismo modo, existe una API de envío a la que se puede llamar como expresión de clic guideBridge.submit().

• Puede utilizar la API setFocus() para definir el enfoque en varios campos o paneles (para que el enfoque del panel se establezca automáticamente en el primer campo). setFocus()proporciona una amplia gama de opciones para navegar, como la navegación entre paneles, la travesía anterior/siguiente, la definición del enfoque en un campo concreto y muchas más. Por ejemplo, para desplazarse al panel siguiente, puede utilizar: guideBridge.setFocus(this.panel.somExpression, 'nextItem').

• Para validar un formulario adaptable o sus paneles específicos, utilice guideBridge.validate(errorList, somExpression).

Uso de GuideBridge fuera de las expresiones 

También puede utilizar las API de GuideBridge fuera de las expresiones. Por ejemplo, puede utilizar la API de GuideBridge para establecer la comunicación entre el HTML de la página que aloja el formulario adaptable y el Modelo de formulario. Además, puede establecer el valor que proviene del elemento principal de Iframe que aloja el formulario.

Para utilizar la API de GuideBridge para el ejemplo mencionado anteriormente, capture una instancia de GuideBridge. Para capturar la instancia, escuche el evento bridgeInitializeStartde un objeto window:

window.addEventListener("bridgeInitializeStart", function(evnt) {

     // get hold of the guideBridge object

     var gb = evnt.detail.guideBridge;

     //wait for the completion of AF

     gb.connect(function (){

        //this function will be called after Adaptive Form is initialized

     })

})

Para utilizar GuideBridge después de inicializar el formulario (se envía el evento bridgeInitializeComplete ), obtenga la instancia de GuideBridge mediante window.guideBridge. Puede comprobar el estado de inicialización de GuideBridge mediante la API guideBride.isConnected.

Eventos GuideBridge

GuideBridge también proporciona ciertos eventos para secuencias de comandos externas en la página de alojamiento. Los scripts externos pueden escuchar estos eventos y realizar diversas operaciones. Por ejemplo, cada vez que cambia el nombre de usuario en un formulario, también cambia el nombre que se muestra en el encabezado de la página. Para obtener más información sobre estos eventos, consulte Referencia de la API de la biblioteca JavaScript para formularios adaptables.

Utilice el siguiente código para registrar los controladores:

guideBridge.on("elementValueChanged", function (event, data)  {

      // execute some logic when value of a field is changed  

});

Creación de patrones personalizados para un campo

Como se ha mencionado anteriormente, los formularios adaptables permiten al autor proporcionar patrones para los formatos de validación o visualización. Además de utilizar patrones predeterminados, puede definir patrones personalizados reutilizables para un componente de formulario adaptable. Por ejemplo, puede definir un campo de texto o un campo numérico. Una vez definidos, se pueden utilizar estos patrones en todos los formularios para un tipo de componente específico. Por ejemplo, puede crear un patrón personalizado para un campo de texto y utilizarlo en los campos de texto de sus formularios adaptables. Puede seleccionar el patrón personalizado accediendo a la sección Patrón del cuadro de diálogo de edición de un componente. Para obtener más información sobre la definición o el formato del patrón, consulte Compatibilidad de cláusula de imagen para formularios HTML5.

Realice los siguientes pasos para crear un patrón personalizado para un tipo de campo específico y reutilizarlo para otros campos del mismo tipo:

1. Vaya al CRXDE Lite de la instancia de creación.

2. Cree una carpeta para mantener los patrones personalizados. En el directorio /apps, cree un nodo de tipo sling:folder. Por ejemplo, cree un nodo con el nombre customPatterns. Bajo este nodo, cree otro nodo de tipo nt:unstructed y asígnele el nombre textboxpatterns. Este nodo contiene los distintos patrones personalizados que desea agregar.

3. Abra la pestaña Propiedades del nodo creado. Por ejemplo, abra la pestaña Propiedades de textboxpatterns. Agregue la propiedad guideComponentType a este nodo y establezca su valor en fd/af/components/formatter/guideTextBox.

4. El valor de esta propiedad varía según el campo para el que desee definir los patrones. En el caso de los campos numéricos, el valor de la propiedad guideComponentType es fd/af/components/formatter/guideNumericBox. El valor del campo Marcador de datos es fd/af/components/formatter/guideDatepicker.

5. Puede añadir un patrón personalizado asignando una propiedad al nodo textboxpatterns. Agregue una propiedad con un nombre (por ejemplo pattern1) y establezca su valor en el patrón que desee agregar. Por ejemplo, agregue una propiedad pattern1 con el valor Fax=text{99-999-9999999}. El patrón está disponible para todos los cuadros de texto que utilice en Forms adaptable.

   
   Figura: Creación de patrones personalizados