ATLAS MANUAL DE USUARIO COMPONENTE CODIGO DE BARRAS

Transcripción

1 ATLAS MANUAL DE USUARIO COMPONENTE CODIGO DE BARRAS Versión 1.0 Área de Integración y Arquitectura de Aplicaciones

2 Hoja de Control Título Documento de Referencia Responsable Manual de Usuario Componente Código de barras lcm Versión 1.0 Fecha Versión 11/05/2010 Registro de Cambios Versión Causa del Cambio Responsable del Cambio Fecha del Cambio 1.0 Versión inicial del documento ICM 11/05/2010 barras 13/05/2010 Página 2 de 10

3 Índice 1. INTRODUCCIÓN AUDIENCIA OBJETIVO CONOCIMIENTOS PREVIOS DESCRIPCIÓN INSTALACIÓN Y CONFIGURACIÓN INSTALACIÓN CONFIGURACIÓN Paso 1: Modificación del fichero web.xml Paso 2: Modificación de los textos de los mensajes del componente USO PASO 1: DEFINICIÓN DEL ESPACIO DE NOMBRES DE ETIQUETAS DE ATLAS PASO 2: INSERCIÓN EN LA PÁGINA DE LA ETIQUETA DE ATLAS RECOMENDACIONES Y BUENAS PRÁCTICAS EJEMPLO DE USO PREGUNTAS MÁS FRECUENTES ENLACES RELACIONADOS barras 13/05/2010 Página 3 de 10

4 Contenido 1. INTRODUCCIÓN Este documento contiene el manual de uso del componente visual Código de barras del framework Atlas. En él se incluye información sobre cómo utilizar dicho componente en una aplicación web, así como información acerca de la configuración de los parámetros fundamentales del componente AUDIENCIA OBJETIVO Este documento está orientado a toda aquella persona que esté desarrollando una aplicación Web basada en el Framework Atlas y necesite utilizar componentes de presentación en su aplicación Web CONOCIMIENTOS PREVIOS Para un completo entendimiento del documento, el lector deberá tener conocimientos previos sobre las siguientes tecnologías: Java Server Faces (JSF) Facelets Spring Framework Hibernate Para saber más sobre dichas tecnologías, consultar el apartado de este documento, Enlaces Relacionados. 2. DESCRIPCIÓN El componente Barcode es capaz de genera una imagen con un código de barras. Sus características principales son: Crea ficheros de imagen en varios formatos, conteniendo códigos de barras (1D) y puntos (2D). Puede integrarse con aplicaciones Swing/AWT. Lanza procesos de impresión conteniendo los códigos de barras. Permite mostrar códigos en aplicaciones Web. Soporta los siguientes Standard: barras 13/05/2010 Página 4 de 10

5 o Code128, Code128A, Code128B, Code128C, EAN128, USPS, ShipmentIdentificationNumber, SSCC18, SCCC14ShippingCode, GlobalTradeItemNumber, UCC128, PDF417, Code39, 3of9, USD3, Codabar, USD4, NW7, Monarch, 2of7. Internamente, el componente utiliza la librería de código abierto Barbacue. Esta librería permite visualizar e imprimir códigos de barra. A continuación se muestra el ejemplo de la aplicación de demostración de componentes del Framework Atlas 2.0: barras 13/05/2010 Página 5 de 10

6 3. INSTALACIÓN Y CONFIGURACIÓN En este apartado se incluye información sobre la instalación y la configuración del componente Barcode INSTALACIÓN El componente del código de barras ya viene instalado en el arquetipo Web, incluido con el módulo de componentes visuales. Por este motivo no es necesaria una instalación adicional si se parte del arquetipo, sólo es necesario realizar los pasos indicados en el siguiente apartado, configuración CONFIGURACIÓN Una vez instalado el componente, se debe proceder a su configuración. La configuración del componente afecta a los siguientes ficheros: - web.xml: Fichero de configuración de la aplicación web en el que se incluirá el Servlet que responde al comportamiento del componente. - messages.properties: Fichero con los mensajes de texto mostrados al usuario por el componente. Es opcional ya que por defecto existe un bundle determinado. Para la configuración del componente deben realizarse los pasos descritos en los siguientes apartados: Paso 1: Modificación del fichero web.xml Nota: En el fichero web.xml del arquetipo web ya se encuentran estas líneas para habilitar el servlet, por lo que en principio este paso puede omitirse. Hay que añadir la referencia al Servlet necesario para el funcionamiento del componente, modificando el fichero web.xml de la aplicación (directorio src\main\webapp\web-inf) según el siguiente ejemplo: web.xml <?xml version="1.0" encoding="utf-8"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" " <servlet> <servlet-name>barcode</servlet-name> <servlet-class>atlas.faces.servlet.barcodeservlet</servletclass> </servlet> <servlet-mapping> <servlet-name>barcode</servlet-name> <url-pattern>/barcode</url-pattern> </servlet-mapping> barras 13/05/2010 Página 6 de 10

7 Paso 2: Modificación de los textos de los mensajes del componente Opcionalmente, es posible modificar los textos de los mensajes que afectan al componente. Para ello pueden añadirse los textos de los mensajes en el fichero messages_es.properties situado en el directorio web/src/main/resources/msg del arquetipo. Los mensajes a configurar son: barcode.txt1=ean128 \: barcode.txt2=pdf417 \: barcode.txt3=c\u00f3digo barras Estas etiquetas definen los mensajes que puede mostrar el componente, y pueden modificarse para mostrar cualquier otro texto. 4. USO Una vez instalado el módulo de componentes puede procederse a su utilización. Para ello deben realizarse los pasos indicados en los siguientes apartados: 4.1. Paso 1: Definición del espacio de nombres de etiquetas de Atlas Es necesario crear un fichero xhtml y establecer la definición del espacio de nombres para las etiquetas de componentes de Atlas. Un ejemplo de cabecera de fichero xhtml es la siguiente: Ejemplo.xhtlm <?xml version="1.0" encoding="utf-8"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" " <html xmlns=" xml:lang="es" xmlns:ui=" xmlns:h=" xmlns:f=" xmlns:atlas=" Paso 2: Inserción en la página de la etiqueta de Atlas Se incluirá una etiqueta atlas:barcode que es lo que define la imagen del código de barras en la página. A continuación se detalla dicha invocación. Ejemplo.xhtml <atlas:barcode barcodetype="ean128" barcodedata=" " barcodeheight="50" barcodewidth="1" alt="#{bundle['barcode.txt3']}" /> barras 13/05/2010 Página 7 de 10

8 Los atributos del componente son los siguientes: Nombre atributo Obligatorio Descripción alt NO Titulo emergente informativo. barcodeappid NO Identificador del componente. barcodechecksum NO True para incluir el checksum calculado, false para omitirlo (solo para Code39 y sus derivados). Su valor por defecto es false. barcodedata SI Datos a codificar. barcodedrawtext NO true para dibujar el texto (solo si headless = false) barcodeheadless NO True para headless mode (valor por defecto). barcodeheight NO Altura en píxel del código de barras. barcoderesolution NO Resolución expresada en DPI. barcodetype NO Tipo de formato de código de barras. Hay varios formatos soportados. Los principales son: EAN128 y PDF417. El valor por defecto es EAN128. barcodewidth NO Anchura en píxel de la barra más pequeña del código. rendered NO Valor true/false para seleccionar si este componente se va a mostrar. Por defecto es true Recomendaciones y buenas prácticas Se recomienda no aumentar demasiado las cantidades de anchura y altura para la buena visualización del componente Ejemplo de Uso Se puede ver un ejemplo de dicho componente en la aplicación de demostración de componentes, bajo la siguiente secuencia de navegación: Inicio > Barcode barras 13/05/2010 Página 8 de 10

9 5. PREGUNTAS MÁS FRECUENTES En este apartado se incluyen una lista de preguntas más frecuentes sobre el componente. Pregunta: Dónde puedo encontrar información general sobre los componentes? Respuesta: En la aplicación de demostración de los componentes del Framework Atlas Pregunta: Cómo puedo averiguar todas las funcionalidades disponibles en el componente Barbecue? Respuesta: Accediendo a la página Web del componente que se indica en la sección de Enlaces Relacionados. Pregunta: Cómo se ha implementado el componente en su capa de presentación? Respuesta: El componente captcha se implementó como un Custom Component de Faces, que da respuesta a una etiqueta mediante un objeto que hereda de UIGraphic del API de Faces. barras 13/05/2010 Página 9 de 10

10 6. ENLACES RELACIONADOS Producto URL Versión Ajax4JSF GA Barbecue d Commons BeanUtils commons.apache.org/beanutils/ Commons Configurations Facelets Hibernate ga Hibernate Annotations ga JAXB Jcaptcha jcaptcha.sourceforge.net/ 1.0-RC5 JPA JSF JSFUnit Beta3 Log4J MyFaces Core RichFaces GA Spring Spring Security Tomahawk Velocity barras 13/05/2010 Página 10 de 10