Saltar al contenido principal

Elements

Abrir en ChatGPT
23.06
Java API

Los desarrolladores de webforJ tienen la opción de elegir no solo entre la rica biblioteca de componentes proporcionados, sino también de integrar componentes de otros lugares. Para facilitar esto, se puede usar el componente Element para simplificar la integración de cualquier cosa, desde elementos HTML simples hasta componentes web personalizados más complejos.

important

El componente Element no se puede extender y no es el componente base para todos los componentes dentro de webforJ. Para leer más acerca de la jerarquía de componentes de webforJ, lee este artículo.

Mostrar Código

Agregando eventos​

Para utilizar eventos que pueden venir con tu elemento, puedes usar los métodos addEventListener del componente Element. Agregar un evento requiere al menos el tipo/nombre del evento que el componente espera y un listener que se añadirá al evento.

También hay opciones adicionales para personalizar aún más los eventos mediante la configuración de Opciones de Evento.

Mostrar Código

Interacción de componentes​

El componente Element actúa como un contenedor para otros componentes. Proporciona una forma de organizar y recuperar información para componentes secundarios y ofrece un conjunto claro de funciones para agregar o eliminar estos componentes secundarios según sea necesario.

Agregando componentes secundarios​

El componente Element admite la composición de componentes secundarios. Los desarrolladores pueden organizar y gestionar estructuras complejas de UI agregando componentes como hijos al Element. Existen tres métodos para establecer contenido dentro de un Element:

  1. add(Component... components): Este método permite que uno o varios componentes se agreguen a un String opcional que designa un slot específico cuando se usa con un Componente Web. Omitir el slot agregará el componente entre las etiquetas HTML.

  2. setHtml(String html): Este método toma el String pasado al método e inyecta como HTML dentro del componente. Dependiendo del Element, esto puede representarse de diferentes maneras.

  3. setText(String text): Este método se comporta de manera similar al método setHtml(), pero inyecta texto literal dentro del Element.

Mostrar Código

sugerencia

Llamar a setHtml() o setText() reemplazará el contenido actualmente contenido entre las etiquetas de apertura y cierre del elemento.

Eliminando componentes​

Además de agregar componentes a un Element, se implementan los siguientes métodos para la eliminación de varios componentes secundarios:

  1. remove(Component... components): Este método toma uno o más componentes y los eliminará como componentes secundarios.

  2. removeAll(): Este método eliminará todos los componentes secundarios del Element.

Accediendo a componentes​

Para acceder a los diversos componentes secundarios presentes dentro de un Element, o información sobre estos componentes, están disponibles los siguientes métodos:

  1. getComponents(): Este método devuelve una lista de Java List de todos los hijos del Element.

  2. getComponents(String id): Este método es similar al anterior, pero tomará la ID del lado del servidor de un componente específico y la devolverá cuando se encuentre.

  3. getComponentCount(): Devuelve el número de componentes secundarios presentes dentro del Element.

Llamando funciones JavaScript​

El componente Element proporciona dos métodos API que permiten llamar a funciones JavaScript en elementos HTML.

  1. callJsFunction(String functionName, Object... arguments): Este método toma un nombre de función como una cadena y opcionalmente toma uno o más Objetos como parámetros para la función. Este método se ejecuta de manera síncrona, lo que significa que el hilo en ejecución está bloqueado hasta que el método JS retorna, dando como resultado una llamada de ida y vuelta. Los resultados de la función se devuelven como un Object, que puede ser convertido y utilizado en Java.

  2. callJsFunctionAsync(String functionName, Object... arguments): Al igual que con el método anterior, se puede pasar un nombre de función y argumentos opcionales para la función. Este método se ejecuta de manera asincrónica y no bloquea el hilo en ejecución. Devuelve un PendingResult, que permite una interacción adicional con la función y su carga útil.

Pasando parámetros​

Los argumentos que se pasan a estos métodos que se utilizan en la ejecución de funciones JS se serializan como un arreglo JSON. Hay dos tipos de argumentos notables que se manejan de la siguiente manera:

  • this: Usar la palabra clave this le dará al método una referencia a la versión del componente del lado del cliente que invoca la función.
  • Component: Cualquier instancia de componente Java pasada a uno de los métodos JsFunction se reemplazará con la versión del lado del cliente del componente.
info

Tanto la llamada a funciones síncronas como asincrónicas esperarán para llamar a un método hasta que el Element haya sido agregado al DOM antes de ejecutar una función, pero callJsFunction() no esperará a que se adjunten los argumentos component, lo que puede resultar en fallos. Por el contrario, invocar callJsFunctionAsync() puede no completarse nunca si un argumento de componente nunca se adjunta.

En la demostración a continuación, se agrega un evento a un Button HTML. Este evento se dispara programáticamente llamando al método callJsFunctionAsync(). El resultado de PendingResult se utiliza para crear otro cuadro de mensaje una vez que la función asíncrona se ha completado.

Mostrar Código

Ejecutando JavaScript​

Además de ejecutar JavaScript desde el nivel de la aplicación, también es posible ejecutar JavaScript desde el nivel de Element. Realizar esta ejecución a nivel de Element permite que el contexto del elemento HTML se incluya en la ejecución. Esta es una herramienta poderosa que actúa como un conducto para que el desarrollador acceda a capacidades interactivas con entornos del lado del cliente.

Al igual que la ejecución de funciones, la ejecución de JavaScript se puede realizar de manera síncrona o asincrónica con los siguientes métodos:

  1. executeJs(String script): Este método toma un String, que se ejecutará como código JavaScript en el cliente. Este script se ejecuta de manera síncrona, lo que significa que el hilo en ejecución está bloqueado hasta que la ejecución de JS retorna y resulta en una llamada de ida y vuelta. Los resultados de la función se devuelven como un Object, que puede ser convertido y utilizado en Java.

  2. executeJsAsync(String script): Al igual que con el método anterior, se pasará un parámetro de tipo String que se ejecutará como código JavaScript en el cliente. Este método se ejecuta de manera asincrónica y no bloquea el hilo en ejecución. Devuelve un PendingResult, que permite una interacción adicional con la función y su carga útil.

sugerencia

Estos métodos tienen acceso a la palabra clave component, que le da al código JavaScript acceso a la instancia del lado del cliente del componente que ejecuta el JavaScript.