Paso 1: Operativa - Crear una Etiqueta y su correspondiente Tag Handler (Manejador de Etiquetas)

Creación tradicional de Etiquetas Personalizadas
Paso 1: Operativa

Crear una Etiqueta y su correspondiente Tag Handler (Manejador de Etiquetas)

Un Manejador de Etiquetas es una Clase Java que ejecuta la acción de una Etiqueta Personalizada implementando una serie de métodos predefinidos para que el Contenedor Web los invoque.

El Manejador de Etiquetas de nuestro ejemplo se llama paqtaghandler.FechaActual.java. Al igual que un Servlet o un JavaBean, el fichero FechaActual.class se aloja en el directorio ../WEB-INF/classes/paqtaghandler de nuestra aplicación Web.

Para crear el Manejador de Etiquetas en cuestión tenemos que seguir los siguientes pasos:

Nos situamos en la ventana Projects y con el botón derecho del ratón seleccionamos el proyecto protaghandler. Entonces elegimos new | Other...

en el cuadro de diálogo New File elgimos Web | Tag Handler y hacemos clic sobre el botón

NetBeans 6 - Nuevo Manejador de Etiquetas - New File | Web | Tag Handler

en el cuadro de diálogo New Tag Handler introducimos el nombre del Manejador de Etiquetas FechaActual en el campo de texto Class Name: e indicamos que esta Clase pertenece al paquete paqtaghandler en el campo de texto Package:.

El nuevo Manejador de Etiquetas puede heredar de la Clase javax.servlet.jsp.tagext.SimpleTagSupport o de la Clase javax.servlet.jsp.tagext.BodyTagSupport . Si hereda de esta segunda Clase se pueden controlar las acciones dependiendo de si el Contenedor Web está entrando en la etiqueta de principio o está saliendo de la etiqueta de fin. En este ejemplo sólo queremos que el Contenedor Web muestre la fecha actual cuando se encuentre con la etiqueta personalizada <libreria1:fechaActual/>. Así pues, elegiremos el radiobotón Simple TagSupport (J2EE 1.4). De todas formas hay que tener en cuenta que la Clase javax.servlet.jsp.tagext.SimpleTagSupport ha aparecido en la versión J2EE 1.4 y la versión JSP 2.0. Por tanto las versiones anteriores no soportan esta Clase. Seguidamente hacemos clic sobre el botón

NetBeans 6 - Nuevo Manejador de Etiquetas - New Tag Handler | Name and Location | Class name: FechaActual | Package: paqtaghandler

en el cuadro de diálogo New File vamos a cambiar el nombre a nuestra Etiqueta Personalizada FechaActual por fechaActual y también vamos a incluir la Etiqueta Personalizada en el Descriptor de la Librería de Etiquetas.

NetBeans 6 - Nuevo Manejador de Etiquetas - New Files | TLD Information | Add Corresponding Tag to the Tag Library Descriptor

para incluir la Etiqueta Personalizada en el Descriptor de la Librería de Etiquetas mantenemos seleccionada la casilla de verificación Add Corresponding Tag to the Tag Library Descriptor y seguidamente hacemos clic sobre el botón . entonces navegamos hasta encontrar el Descriptor de la Librería de Etiquetas libreria1.tld. Una vez hemos seleccionado la Librería de etiquetas en cuestión hacemos clic sobre el botón

ahora en el campo de texto Tag Name: cambiamos el nombre de la etiqueta a fechaActual y también seleccionamos el radiobotón empty.

empty
- la etiqueta no puede contener cuerpo (body)
scriptless
- el cuerpo (body) de la etiqueta permite albergar contenido JSP pero no puede contener elementos de código (scriptlets)
tagdependent
- el cuerpo (body) de la etiqueta puede contener cualquier tipo de contendio
- si heredamos de la Clase SimpleTagSuport no podemos incluir elementos de código (scriptlets)
JSP
- el cuerpo (body) de la etiqueta puede ser procesado por la etiqueta
- el Contenedor Web evaluará código JSP que esté contenido en el cuerpo de la etiqueta
- se puede utiliar JSP sólo por razones de compatibilidad con versiones anteriores a la 2.0 de la especificación de las páginas JSP
  - si heredamos de la Clase SimpleTagSuport el valor JSP no está permitido

Para salir de este cuadro de diálogo hacemos clic sobre el botón

NetBeans 6 - Nuevo Manejador de Etiquetas - New Files | TLD Information | Tag Name: fechaActual

El asistente ha ampliado el fichero libreria1.tld añadiendo un subelemento llamado <tag> al elemento raíz.

<?xml version="1.0" encoding="UTF-8"?>

<tlib-version>1.0</tlib-version>
<short-name>biblioteca1</short-name>
<uri>/WEB-INF/tlds/descriptorEtiquetas</uri>
<tag>
  <name>fechaActual</name>
  <tag-class>paqtaghandler.FechaActual</tag-class>
  <body-content>empty</body-content>
</tag>
</taglib>

<tag>
- <name>fechaActual</name>
  - aquí se indica el nombre de la Etiqueta Personalizada que será utilizada desde una página JSP
- <tag-class>paqtaghandler.FechaActual</tag-class>
  - aquí se indica la Clase que ejecuta la acción de la Etiqueta Personalizada
- <body-content>empty</body-content>
  - en este caso la Etiqueta Personalizada no tiene contenido

Este es el código del Manejador de Etiquetas FechaActual

package paqtaghandler;

import javax.servlet.jsp.tagext.SimpleTagSupport;
import javax.servlet.jsp.tagext.JspFragment;
import javax.servlet.jsp.JspWriter;
import javax.servlet.jsp.JspException;

public class FechaActual extends SimpleTagSupport {
public void doTag() throws JspException {
  JspWriter out = getJspContext().getOut();

  try {
   JspFragment f = getJspBody();
   if (f != null) {
    f.invoke(out);
   }
  } catch (java.io.IOException ex) {
   throw new JspException(ex.getMessage());
  }
}
}

public void doTag() throws JspException {
- este método es invocado por el Contenedor Web cuando éste lee la etiqueta personalizada situada en la página JSP invocada.
public class FechaActual extends SimpleTagSupport {
- la Clase FechaActual hereda de la Clase SimpleTagSupport.
  - en vez de heredar de esta Clase podriamos haber implementado las intefaces SimpleTag y JspTag que también se encuentran en el paquete javax.servlet.jsp.tagext.
    - pero es más cómodo heredar directamente de la Clase de conveniencia SimpleTagSupport e implementar sólo el método doTag()
JspWriter out = getJspContext().getOut();
- el Manejador de Etiquetas tiene acceso al Objeto response a través de pageContext

Ignasi Pérez Valls
fundador-director Infosintesis Solutions Group
asesor-formador independiente
ignasiperez[ARROBA]javadabbadoo[PUNTO]org
Junio 2009

JavaDabbaDoo.org
Tu comunidad Java parlante. Cursos abiertos, tutoriales y mucho mucho más ...


	Custom Tags
Inicio \| Cursos infosintesis.net liberados \| Java EE \| Creación tradicional de Etiquetas Personalizadas