atlas manual de usuario arbol
Contents
1. 4 6 RECOMENDACIONES Y BUENAS PR CTICAS Para el buen funcionamiento del componente hay que seguir los pasos de instalaci n configuraci n de ficheros y implementaci n de clases tal y como se ha indicado en los anteriores puntos 4 7 EJEMPLO DE USO Se puede ver un ejemplo de dicho componente navegando en la aplicaci n componentes de la siguiente manera Inicio gt Otros componentes Atlas gt rbol kk RRK 13 de 15 gfh Agencia de o Framework Atlas Te Inform tica y Comunicaciones de la Comunidad de Madrid Componente rbol 5 PREGUNTAS M S FRECUENTES En este apartado se debe incluir una lista de preguntas m s frecuentes sobre el objetivo del documento as como las respuestas pertinentes 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 se ha implementado el componente en su capa de presentaci n Respuesta Mediante un componente de Facelets Hace uso adem s de un componente de rbol de RichFaces Pregunta C mo puedo modificar los estilos del componente Respuesta Mediante los atributos de estilo del componente Para m s informaci n consultar la tabla de atributos en la secci n de Uso del componente kk RRK 14 de 15 kk Ak Ak kkk Agencia de C Inform tica y Comunicaciones de la Comunidad de Madrid Framework Atlas Componente rbol2. 6 ENLACES RELACIONADOS Producto URL Ajax4JSF Barbecue Commons BeanUtils Commons Configurations Facelets Hibernate Hibernate Annotations JAXB Jcaptcha JPA JSF JSFUnit Log4J MyFaces Core RichFaces Spring Spring Security Tomahawk Velocity http www boss org jbossrichfaces http barbecue sourceforge net commons apache org beanutils http commons apache org configuration https facelets dev java net http www hibernate org http www hibernate org hib_docs annotations reference en html_single http java sun com webservices axb captcha sourceforge net http ava sun com developer technicalArticles J2EE pa http ava sun com javaee javaserverfaces http www boss org sfunit http logging apache orq log4j http myfaces apache org http www jboss org bossrichfaces http www springframework orqg htto www springframework orqg htto myfaces apache org tomahawk htto velocity apache org 15 de 15 kk Ak A A 1
3. Ak RRK 6 de 15 pi Agencia de o Framework Atlas Te Inform tica y Comunicaciones de la Comunidad de Madrid Componente rbol e Elementos de segundo nivel provincias de Espa a La restricci n con el nivel anterior consiste en que dado un nodo del primer nivel cuya clave consistir en una letra entonces los nodos hijos ser n las provincias cuya inicial coincida con el valor de esa letra e Elementos de tercer nivel municipios de Espa a La restricci n con el nivel anterior consiste en que dado un nodo del segundo nivel cuya clave consistir en un c digo de provincia entonces los nodos hijos ser n los municipios cuya clave for nea de provincia coincida con el valor de esa provincia Ejemplo applicationContext services xml lt bean 1d abecedarioNodesService class atlas samples service tree impl AbecedarioNodesservice gt lt bean 1id provincialetraNodessSservice class atlas samples service tree impl ProvincialetraNodesservice gt lt property name provinciasucaDAO gt lt ref bean provinciaSucaDAO gt lt property gt lt bean gt lt bean id municipioNodesSservice class atlas samples service tree impl MunicipioNodesservice gt lt property name provinciasucaDAO gt lt ref bean provinciaSucaDA0O gt lt property gt lt bean gt e Las referencias abcedarioNodesService provinciaLetraNodesService y municipioNodeService son los servicios creados para cada nivel Deben imp
4. del componente son los siguientes Nombre atributo Obligatorio Descripci n e _ Identificador del componente Debe ser nico dataModel EL Expression Language al bean que controla el funcionamiento del rbol El objeto devuelto debe ser de tipo atlas componentes bean AtlasTree services Lista con los identificadores en el contexto de Spring del servicio o servicios encargados de generar los diferentes niveles del rbol lazyMode NO Valor true false para indicar si el componente debe consultar los hijos de los nodos una vez abierto un nivel Si es false se har una b squeda en los nodos reci n abiertos para ver cu les tienen hijos y cu les son nodos hoja Si su valor es true la propiedad mostrarNumeroNodoshHijos no tiene efecto Su valor por defecto es false A p eee cada nodo Su valor por defecto es true davetnicial NO Clave inicial para el nodo raiz del rbol Clave inicial para el nodo ra z del rbol inicial para el nodo ra z del rbol ere O po COS a mostrar Por defecto es true 4 3 Carga de nodos y estado del rbol En este apartado se explica un poco m s el modo en que se obtienes los nodos de los diferentes niveles el n mero de llamadas a los servicios y qu informaci n guarda internamente el componente Para este caso dos propiedades de la tabla anterior son las encargadas de definir el modo en que se comporta el componente lazyMode y cacheMode Como se indica en la descripci n de ambas
5. la clave correspondiente del nodo pulsado y se mostrar n aquellos nodos que devuelva el servicio En el siguiente apartado se definen como deben ser estos nodos Se puede especificar un solo servicio para todos los niveles del rbol o uno diferente para cada nivel En el primer caso el componente no sabr a priori el n mero de niveles del rbol ya que har llamadas al mismo servicio cada vez que se expanda un nodo en el segundo caso se entiende que el rbol tiene tantos niveles como n mero de servicios Este detalle implica que si se definen varios servicios el componente no har llamadas una vez llegado al mayor nivel del rbol sin embargo si es un solo servicio seguir haciendo llamadas independientemente del nivel El modo de enlazar el componente con el servicio es mediante un atributo en la definici n en la p gina o directamente en el backing bean a trav s de la clase AtlasTree Para mostrar el funcionamiento de la configuraci n del componente rbol se va a mostrar un ejemplo con tres servicios para dar lugar a un tipo de rbol de tres niveles Comenzaremos definiendo el rbol y los niveles que lo forman y por tanto los servicios que necesitaremos e Elementos de primer nivel las letras del abecedario No tiene restricci n porque se trata de los elementos de primer nivel aunque el componente permite especificar una clave inicial que se utilizar para obtener el primer nivel de rbol del servicio correspondiente
6. n del componente rbol 3 1 INSTALACI N El componente rbol 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 3 2 CONFIGURACI N kk RRK 5de 15 pi Agencia de o Framework Atlas Te Inform tica y Comunicaciones de la Comunidad de Madrid Componente rbol Una vez instalado el componente se debe proceder a su configuraci n La configuraci n comienza con la definici n e inicializaci n en el backing bean de un objeto de la clase atlas componentes bean AtlasTree Este objeto se encarga de alimentar el rbol y gestionar los diferentes eventos generados y se enlaza con el componente mediante el atributo dataModel Posteriormente hay que crear los servicios para los diferentes niveles del rbol estos servicios deben cumplir una interfaz y devolver una lista de objetos que cumplan otra interfaz A continuaci n se describen ambas interfaces 3 2 1 Servicios Para que el componente obtenga la informaci n de los diferentes niveles del rbol es necesario definir uno o varios servicios Estos servicios deben estar definidos en el contexto de Spring y cumplir con la interfaz atlas componentes service tree NodesService Esta interfaz tiene un solo m todo List lt extends Node gt getNodes Object clave Cada vez que se expanda un nodo del rbol el componente har una llamada a este m todo con
7. sus valores por defecto son false y true respectivamente de modo que kk xk Rf ICM 10 de 15 gfh Agencia de o Framework Atlas Te Inform tica y Comunicaciones de la Comunidad de Madrid Componente rbol el rbol inicialmente obtendr los hijos de un nodo y har una llamada al servicio del siguiente nivel para cada nodo hijo mostrando estos nodos como nodos hoja o no seg n corresponda y en caso en que as se configure mostrar tambi n el n mero de hijos de cada nodo Adem s cuando se contraiga un nodo y vuelva a expandirse no se volver a llamar al servicio para obtener los hijos sino que se mostrar n los hijos ya obtenidos previamente y en el mismo estado en que estuviera el sub rbol cuando se cerr el nodo Estos comportamientos se pueden modificar con ambas propiedades Si se desea minimizar el n mero de consultas se puede establecer la propiedad lazyMode a true en este caso s lo se har una consulta al servicio del nodo expandido para obtener el listado de hijos sin consultar si los hijos son nodo hoja o no visualmente se traducir en que todos los nodos del nivel abierto se mostrar n como nodos con hijos hasta que se expanda cada uno de ellos momento en el que se abrir el nivel o se cambiar el icono a nodo hoja si no hubiera hijos que mostrar Esto ocurrir salvo en el caso en que se especifique un n mero determinado de niveles en este caso cuando se llegue al ltimo nivel se mostrar n todos lo
8. un texto con el nombre del nodo pero mediante el tag de facelets define con el nombre nodo se puede sustituir este texto por cualquier otro o incluir cualquier otro componente En el siguiente ejemplo se sustituye el nodo por un commandLink con el nombre como texto Fichero xhtml lt atlas arbol id arbol dataModel provinciasFormBean atlasArbol services abecedarioNodesservices provincialetraNodesService municipioNodesService gt lt ul define name nodo gt lt a43 commandLink actionListener provinciasFormBean selectNode value item data nombre execute dthis render panelNodo gt lt f param name nodoSeleccionado value f item data nombre gt lt a43 commandLink gt lt fui define gt atlas arbol gt Para acceder a la informaci n b sica de un nodo clave nombre y n mero de hijos en caso de usar esta funcionalidad se deben usar con los siguientes identificadores tem data clave item data nombre XK kk xk xk 12 de 15 gfh Agencia de o Framework Atlas Te Inform tica y Comunicaciones de la Comunidad de Madrid Componente rbol item data numeroHijos respectivamente Tambi n se puede hacer referencia a cualquier otra propiedad de la clase que representa el nodo aunque no forme parte de las interfaces Node y NodeCount Para acceder a la clase se debe usar al igual que en el caso anterior tem data esto da acceso al nodo a partir de ah se puede acceder a cualquier propiedad
9. ATLAS MANUAL DE USUARIO ARBOL Versi n 1 3 rea de Aplicaciones Especiales y Arquitectura de Software PPRT gt e imm Agencia de Inform tica y Comunicaciones de la Comunidad de Madrid pido AS kk xk Agencia de Te Inform tica y Comunicaciones de la Comunidad de Madrid Framework Atlas Componente rbol Hoja de Control T tulo Manual de Usuario del componente rbol NORMATIVA ATLAS rea de Aplicaciones Especiales y Arquitectura de Software 01 03 2013 Documento de Referencia Responsable Versi n Registro de Cambios Causa del Cambio Responsable del Cambio Fecha del Cambio rea de Integraci n y Arquitectura de Versi n inicial del documento E 12 11 2010 Aplicaciones rea de Aplicaciones Especiales y Se modifica el nombre del Area 27 09 2011 Arquitectura de Software Versi n Ampliada la informaci n sobre la carga de nodos y estado del rbol Nuevo atributo cacheMode Nuevo apartado 4 4 Interacci n con el rbol Modificaci n general del 12 documento debido a la creaci n de un nuevo componente para Atlas 1 2 2 rea de Aplicaciones Especiales y Arquitectura de Software rea de Aplicaciones Especiales y Arquitectura de Software 2 de 15 24 08 2012 13 02 2013 us Aida Agencia de Framework Atlas Te Inform tica y Comunicaciones i de la Comunidad de Madrid Componente Arbol ndice 1 INTRODUCCI N ti 4 1 1 AMEN ELABORA ac
10. DCCD S7 WWW W3 0 9 TR xntemil DTD nctal1 trRa sitional dtd gt lt html xmlns http www w3 org 1999 xhtml xml lang es xmlns ui http java sun com 3sf facelets mins h htettp Java su com 73st htiml mins f http Jav sun com 7 sE core xmlns atlas http atlas core componentes 3sf gt 4 2 Paso 2 Inserci n de la etiqueta en la p gina Para invocar al componente hay que crear una p gina XHTML donde se inserte la etiqueta de este componente Es importante que el componente est incluido dentro de un formulario si no lo est no funcionar correctamente En la propiedad dataModel del componente es necesario establecer una EL Expression Language que indica el m todo del backing bean que devuelve el bean de tipo atlas componentes bean AtlasTree Fichero xhtml lt atlas arbol id arbol dataModel provinciasFormBean atlasArbol services abecedarioNodesServices provincialetraNodesService municipioNodesService gt Un ejemplo para este m todo de la clase de backing bean ProvinciasFormBean podr a ser ProvinciasFormBean java public class ProvinciasFormBean extends BaseBean private AtlasTree arbol new AtlasTree public AtlasTree getArbol Return arbol public void setArbol AtlasTree arbol this arbal arbol u a 9 de 15 pana Agencia de Framework Atlas Te Inform tica y Comunicaciones de la Comunidad de Madrid Componente rbol Los atributos
11. amentales del componente 1 1 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 1 2 CONOCIMIENTOS PREVIOS Para un completo entendimiento del documento el lector deber tener conocimientos previos sobre las siguientes tecnolog as e Java Server Faces JSF e Facelets e Richfaces e Spring Framework e Hibernate Para saber m s sobre dichas tecnolog as consultar el apartado de este documento Enlaces Relacionados kk RRK 4de 15 ptr Agencia de o Framework Atlas Te Inform tica y Comunicaciones de la Comunidad de Madrid Componente Arbol 2 DESCRIPCI N Este componente sirve para mostrar al usuario un conjunto de datos organizados jer rquicamente en forma de rbol Los nodos de este rbol se pueden desplegar o replegar para mejorar la presentaci n de los datos al usuario En caso de desplegar un nodo su contenido ser obtenido mediante una petici n tipo AJAX La implementaci n de este componente se basa en los componentes de RichFaces rich tree y rich treeNode El aspecto visual del componente es el siguiente tHg F i i M m d EES l Tarragona 185 k y A l Aiguam rcia Albinyana Albiol L my g y O Alcanar 3 INSTALACI N Y CONFIGURACI N En este apartado se incluye informaci n sobre la instalaci n y la configuraci
12. e otro modo no tiene efecto e expandirNodoRuta List lt Object gt listaClaves expande un nodo y los niveles previos si no han sido abiertos e cambiarClavelnicial Object clave modifica la clave inicial del rbol e cerrarNodos cierra todos los nodos de primer nivel abiertos Si la propiedad cacheMode es false el resultado es igual a la funci n cerrarNodosRecursivo e cerrarNodosRecursivo cierra todos los nodos abiertos en el rbol e cerrarNodo List lt Object gt listaClaves Cierra un nodo e cerrarNodoRecursivo List lt Object gt listaClaves Cierra todos los nodos abiertos a partir de uno e expandirNodolnicial List lt Object gt listaClaves Se a ade el nodo a una lista de los que deben mostrarse al inicializar el rbol en ese momento es cuando se consulta la lista Esta funci n puede ser llamada varias veces y est pensada para ejecutarse al cargar el componente por primera vez de modo que se pueda establecer un estado inicial en el que algunos nodos aparezcan abiertos al cargar la p gina El comportamiento a la hora de abrir los nodos es el de la funci n expandirNodoRuta de modo que abre el nodo indicado y los niveles previos hasta l Si el componente que ejecuta la acci n es ajax hay que especificar el id del componente rbol en la propiedad render para que se actualice correctamente 4 5 Personalizaci n de los nodos El componente permite personalizar los nodos del rbol Por defecto se muestra
13. lementar la interfaz atlas componentes service tree NodesService e Estos objetos deben de proveerse de clases de acceso a datos DAO para obtener sus datos De esta manera se mantiene una arquitectura de tres capas Estas clases tienen que tener los m todos necesarios para que los servicios abcedarioNodesService provinciaLetraNodesService y municipioNodeService devuelvan en sus m todos de la interfaz NodesService los elementos correspondientes a cada nivel e La lista devuelta por los servicios debe contener elementos que implementen la interfaz atlas componentes service tree Node A continuaci n se describe dicha interfaz Ak RRK 7 de 15 pi Agencia de o Framework Atlas Te Inform tica y Comunicaciones de la Comunidad de Madrid Componente Arbol 3 2 2 Nodos Los servicios deben devolver una lista de elementos que cumplan unos requisitos en forma de interfaz Hay dos interfaces definidas debiendo implementar una u otra en funci n del modo de uso del rbol e atlas componentes service tree Node Es la interfaz b sica de un nodo e incluye los m todos o String getNombre debe devolver la etiqueta del nodo que se mostrar en el rbol o Object getClave debe devolver el identificador del nodo que utilizar el servicio para obtener los hijos una vez el usuario lo expanda Estos m todos son suficientes para que la clase controladora pueda gestionar el rbol pero mediante una propiedad es posible indicarle al compone
14. nte que muestre despu s de cada nodo el n mero de hijos en caso de usar esta funcionalidad la interfaz que el nodo debe implementar es e atlas componentes service tree NodeCount Esta interfaz hereda de Node y por tanto tambi n se debe cumplir pero adem s incluye los siguientes m todos o Integer getNumerohHijos o void setNumerohHijos Integer numeroHijos Para que el rbol funcione correctamente ambos m todos deben actualizar una variable de tipo Integer La librer a de componente incluye implementaci n b sica de NodeCount la clase atlas componentes service tree mpl Nodelmpl M s adelante veremos c mo el componente permite ampliar la informaci n que se muestra de modo que se pueda mostrar informaci n diferente al nombre del nodo 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 Fichero xhtml Ak RRK 8 de 15 a Agencia de o Framework Atlas Te Inform tica y Comunicaciones de la Comunidad de Madrid Componente rbol lt xml version 1 0 encoding UTF 8 gt lt I DOCTYPE html PUBLIC W30 DID XHTML 1 0 Transitional EN
15. s nodos como nodos hoja ag A aja e ajo E F aja A ll H e o Por otro lado en casos en que la estructura del rbol pueda cambiar es necesario que siempre que se expanda un nodo se obtengan del servicio sus hijos independientemente de si este nodo ya ha sido visitado o no esto se puede hacer especificando la propiedad cacheMode a false Para este caso hay que aclarar que cada vez que se expanda un nodo la estructura ser con todos los nodos hijos cerrados es decir se pierde la estructura que tuviera cuando se cerr el nodo 4 4 Interacci n con el rbol Relacionado con el apartado anterior es posible interactuar con el rbol desde otros componentes de la p gina o desde un backing bean Para esto se ha definido un API de operaci n en la clase AtlasTree estos m todos se deben ejecutar en el backing bean al ejecutar una acci n Los m todos son los siguientes e recargar recarga las informaci n del rbol volviendo al estado inicial e recargarNodo List lt Object gt listaClaves recarga la informaci n de un nodo Para especificar el nodo se debe pasar como par metro una lista con las claves hasta llegar al nodo kk Ra A Vio 11 de 15 pi Agencia de o Framework Atlas Te Inform tica y Comunicaciones de la Comunidad de Madrid Componente rbol e expandirNodo List lt Object gt listaClaves expande un nodo Los nodos de niveles superiores deben estar ya abierto d
16. uc 4 1 2 CONOCINTENTOS PREVIO a o 4 A ME ON aos es 5 3 INSTALACI N Y CONFIGURACI N seesesesoesesesoesesosoesesosoesesosossesosoesesoseesososesosoesesosossesosoesesosossesosoesososeesososeesosossesosos 5 BA MNSTALA CD N es 5 2 CON EIGURACI N e 5 3 2 1 EN 6 3 2 2 o SSA 8 4 IUE E PEI OSEE ANAI EEE A EE A A ONAA OEA AE SANER E NEES TT 8 4 1 PASO 1 DEFINICI N DEL ESPACIO DE NOMBRES DE ETIQUETAS DE ATLAS ccooocccnnnocnnonoccnnonocnnnnnoncnonnncnnonrcnnonarononnorononaness 8 4 2 PASO 2 INSERCI N DE LA ETIQUETA EN LA P GINA ccooooooononncnnnnnnnnnnnnnonnnnnnnnnnnnn nr rr nn nn nn nn nono nn nn nn n nn enn n rra nnnnnnnnnnnnnnnnnnrernnss 9 4 3 CARGADE NODOS Y ESTADO DEL ARBOL darias 10 Ad INTERACCI N CONTAR O cios 11 AS PERSONALIZACI N DELOS NODOS ii cios 12 4 6 RECOMENDACIONES Y BUENAS PR CTICAS anne neones 13 14 IA e II 13 3 PREGUNTAS M S FRECUENTES o occocoonconncoonconnnnonnnnnnnnnnnonanonononnnonnnconnnonnnnonncnnnnonnnnnnnnnnncnnnconnnnonncnnncona nana nonncnnnncanacnacos 14 0 ENLACES RELACIONADOS iia 15 kk kk xk kx k 3de 15 effa Agencia de o Framework Atlas Te Inform tica y Comunicaciones de la Comunidad de Madrid Componente rbol 1 INTRODUCCI N Este documento contiene el manual de uso del componente visual rbol 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 fund
Download Pdf Manuals
Related Search