Como usar archivos XML en Flash

Cuando nos encontramos con proyectos donde el cliente debe cargar datos de tipo dinámicos o datos que son sensibles a nuevos cambios la mejor manera de afrontar esos proyectos es usando XML, el potencia que tiene un XML es la posibilidad de manipular grande cantidades de información de una manera organizada y estructurada y simple de modificar, sin la necesidad de tocar nuestro SWF.

Para aquellos que quieran saber cómo construir un archivo de tipo XML o quieran saber cómo es su estructura les vendrá bien leer el siguiente artículo: http://www.leobaraldi.com.ar/2008/03/09/que-es-un-archivo-xml-y-escribir-archivos-xml
En este artículo veremos cómo cargar y gestionar un archivo XML para una galería de imágenes que el mismo roten con un intervalo de tiempo mas los controles habituales e información para cada imagen. En este caso también vamos a hacer uso de AS 2.0 recuerden que todos estos tutoriales vamos a ir pasándolos a AS 3.0 a medida que el tiempo surja.
Para utilizar XML flash cuenta con una clase nativa para ello, la cual nos permite manipular XML, nodos, métodos y parámetros de todo tipo. Como toda clase simplemente para comenzar a utilizarla debemos crear un nuevo objeto de tipo XML de la siguiente manera:
var miXML:XML = new XML();

Los siguientes pasos seria comenzar a levantar la información de nuestro XML y guardarla en el objeto XML que creamos (miXML), para ello usaremos el siguiente método load y el controlador onLoad para saber que sucede con nuestros datos. Ahora en mas la explicaciones van dentro del código cosa que vamos ir viendo paso a paso como trabajar el objeto XML.
Antes que todo vamos a necesitar por supuesto tener nuestro XML con su estructura y datos ya conformados, en este caso particular lo vamos a diseñar de la siguiente manera.

Importante: Nunca olvidarse de los cierre de cada nodo, sea padre o hijos!!!

Una vez que ya tenemos nuestro archivo XML con su estructura definida ya podemos pasar a nuestro AS, no es necesario por ahora que nuestro XML tenga todos los datos cargados, simplemente con que ya tengamos su estructura es suficiente para comenzar, después a su momento editaremos el XML con la información real requerida.

ActionScript
< view plain text >
  1. //System.useCodepage = true //esto va en caso de que su cabecera no este en UTF 8
  2. var urlXML:String = "xmlgaleria.xml";//nombre del archivo xml
  3. var miXML:XML = new XML();//creamos un objeto XML para almacenarle adentro la información necesaria
  4. miXML.ignoreWhite = true;//Que ignore las líneas en blanco que puedan existir entre nodos y nodos
  5.  
  6. //El siguiente paso sería cargar nuestro archivo XML atreves de un controlador (onLoad)
  7. miXML.onLoad = function(ok) {//función encargada de evaluar si se cargo o no el XML
  8. if (ok) {//si la carga fue exitosa ejecutamos lo siguiente
  9. trace("carga exitosa!!!")
  10. } else {//si la carga no se realizo ejecutamos lo siguiente
  11. trace("error al cargar XML");
  12. }
  13. };
  14. miXML.load(urlXML);//iniamos la carga de nuestro XML, la función superior se encargara
  15. //de detectar si se realizo con éxito o no

Hasta aquí lo único que se realizo fue la carga a nuestro SWF del XML, posteriormente ahora trabajaremos en el uso del mismo. El paso más importante a continuación es guardar todos los nodos hijos (foto) y su información en un Array, ser como que cada uno de los nodos con todos sus datos lo pusiéramos en una carpeta individual para cada nodo y todas estas carpetas dentro de un archivador que ser nuestro Array.

ActionScript
< view plain text >
  1. //System.useCodepage = true //esto va en caso de que su cabecera no este en UTF 8
  2. var urlXML:String = "xmlgaleria.xml";//nombre del archivo xml
  3. var id:Number = 0;//esta variable de tipo numérica es para indicar que hijo queremos llamar, ya que
  4. //los Array funcionan como un casillero diferenciados por numero
  5. var miXML:XML = new XML();//creamos un objeto XML para almacenarle adentro la información necesaria
  6. miXML.ignoreWhite = true;//Que ignore las líneas en blanco que puedan existir entre nodos y nodos
  7.  
  8. //El siguiente paso sería cargar nuestro archivo XML atreves de un controlador (onLoad)
  9. miXML.onLoad = function(ok) {//función encargada de evaluar si se cargo o no el XML
  10. if (ok) {//si la carga fue exitosa ejecutamos lo siguiente
  11. misNodos_Array = this.firstChild.childNodes;//creamos una variable de tipo array donde almacenamos
  12. //cada uno de los nodos. La partícula this hace referencia a miXML, firstChild es el nodo principal
  13. //de nuestro XML y childNodes son los nodos que están dentro del nodo principal
  14. //en definitiva le indicamos que solo guarde TODOS los nodos después del nodo principal.
  15. //si después de esta línea pusiéramos trace(misNodos_Array) el panel de salida nos muestra los
  16. //nodos almacenados en nuestro Array
  17. mcLoader.loadClip(misNodos_Array[id].attributes.url,contenedor_mc); //cargamos el primer nodo
  18. //misNodos_Array[id] &lt; ----este es el nodo que llamamos, entre [ ] va el numero referencia a la posición
  19. //que ocupa en el array, en este caso (0) - .attributes.url &lt; --- con la partícula attributes indicamos
  20. //que atributo queremos cargar, en este caso la url que le corresponde al nodo 0
  21. comenzarIntervalo();//inicializamos el temporizador
  22. } else {//si la carga no se realizo ejecutamos lo siguiente
  23. trace("error al cargar XML");
  24. }
  25. };
  26. miXML.load(urlXML);//iniciamos la carga de nuestro XML, la función superior se encargara
  27. //de detectar si se realizo con éxito o no
  28. //FUNCION ENCARGADA DE CARGAR LAS FOTOS
  29. function loadImagen() {
  30. if (id //ultima foto que regrese a la primera y asi perpetuamente
  31. id++;//incremento el valor de id, este es la referencia a la posición del array
  32. } else {
  33. id = 0;//si llegue al final del array comienzo de nuevo el recorrido
  34. }
  35. mcLoader.loadClip(misNodos_Array[id].attributes.url,contenedor_mc);//cargamos la imagen
  36. }
  37. //OTROS ELEMENTOS NECESARIOS
  38. this.createEmptyMovieClip("contenedor_mc",this.getNextHighestDepth());//creamos un contenedor donde enviar
  39. //nuestras imágenes
  40.  
  41. //ACCION DE CARGA POR INTERVALOS DE TIEMPO
  42. var intervalId:Number;
  43. var duracion:Number = 10000;//tiempo de espera entre foto y foto en milisegundos 1000=1 segundo
  44. function comenzarIntervalo():Void {
  45. if (intervalId != null) {
  46. clearInterval(intervalId);
  47. }
  48. intervalId = setInterval(this, "loadImagen", duracion);
  49. }
  50.  
  51. //GESTOR DE CARGA DE IMAGENES
  52. var mcLoader:MovieClipLoader = new MovieClipLoader();
  53. var escuchar:Object = new Object();
  54. escuchar.onLoadProgress = function(target:MovieClip, bytesLoaded:Number, bytesTotal:Number) {//porcentaje de carga de la imagen
  55. var persoTotal = bytesTotal;
  56. var cargados = bytesLoaded;
  57. var porcentaje = Math.round(cargados*100/persoTotal);
  58. var miFormat:TextFormat = new TextFormat();//formateo el campo de texto %
  59. miFormat.size = 40;
  60. miFormat.color = 0xFFFFFF;
  61. miFormat.font = "arial";
  62. porcentaje_txt.text = porcentaje+"%";
  63. porcentaje_txt.setTextFormat(miFormat);
  64. };
  65. escuchar.onLoadInit = function(target:MovieClip) {
  66. };
  67. escuchar.onLoadStart = function(target:MovieClip) {
  68. //creo el campo de texto para porcentaje
  69. target._parent.createTextField("porcentaje_txt",target._parent.getNextHighestDepth(),10,10,1,1);
  70. porcentaje_txt.autoSize = true;
  71. porcentaje_txt.background = true;
  72. porcentaje_txt.backgroundColor = 0x000000;
  73. descripcion_txt.text = "";
  74. descripcion_txt.removeTextField();
  75. };
  76. escuchar.onLoadComplete = function(target:MovieClip, httpStatus:Number) {
  77. porcentaje_txt.removeTextField();
  78. //creo el campo de texto para la descripcion
  79. target._parent.createTextField("descripcion_txt",target._parent.getNextHighestDepth(),0,Stage.height-40,Stage.width,35);
  80. descripcion_txt.autoSize = false;
  81. descripcion_txt.textColor = 0xFFFFFF;
  82. descripcion_txt.background = true;
  83. descripcion_txt.backgroundColor = 0x000000;
  84. descripcion_txt.text = " "+misNodos_Array[id].attributes.titulo+" "+newline;
  85. descripcion_txt.text += " "+misNodos_Array[id].firstChild+" ";
  86. efectoBlur();
  87. };
  88. mcLoader.addListener(escuchar);
  89.  
  90. //EFECTO BLUR PARA CADA IMAGEN CARGADA
  91. function efectoBlur() {
  92. import flash.filters.BlurFilter;
  93. var blurX:Number = 30;
  94. var blurY:Number = 30;
  95. var quality:Number = 3;
  96. var filterArray:Array = new Array();
  97.  
  98. this.onEnterFrame = function() {
  99. var filter:BlurFilter = new BlurFilter(blurX, blurY, quality);
  100. filterArray.push(filter);
  101. contenedor_mc.filters = filterArray;
  102. blurX--;
  103. blurY--;
  104. filterArray = [];
  105. if (blurX&lt; =0 || blurY&lt;=0) {
  106. delete this.onEnterFrame;
  107. }
  108. };
  109. }

En el siguiente grafico pueden darse cuenta cómo funciona la estructura del XML y como flash la interpreta según este caso particular, pero el principio general es el mismo en todos los casos

En conclusión como pueden observar simplemente con pocas líneas de AS y un archivo XML hemos logrado una pequeña y simple galería que solo pesa 2kb y es totalmente actualizable desde afuera del SWF con solo modificar el XML . Estar de mas decir e imaginar las virtudes y posibilidades que dan el uso de archivos XML.

Que es un archivo XML y como crear archivos XML

Sin dudas la mejor definición de XML nos la da el mata burros de wikipedia que dice así:

La tecnología XML busca dar solución al problema de expresar información estructurada de la manera más abstracta y reutilizable posible. Que la información sea estructurada quiere decir que se compone de partes bien definidas, y que esas partes se componen a su vez de otras partes. Entonces se tiene un árbol de pedazos de información. Ejemplos son un tema musical, que se compone de compases, que están formados a su vez con notas. Estas partes se llaman elementos, y se las señala mediante etiquetas.

Una etiqueta consiste en una marca hecha en el documento, que señala una porción de este como un elemento. Un pedazo de información con un sentido claro y definido.
Teniendo en cuenta esta definición podremos definir un XML para una lista de temas musicales de esta manera: Tanto MUSICA como tema son ambas etiquetas!

  1. <MUSICA>
  2. <tema titulo="Mi musica" />
  3. </MUSICA>

Como pueden observar la información está fragmentada pero a su vez está organizada de manera secuencial y en un orden jerárquico, digamos que MUSICA es el padre de tema porque cada uno de los tema que son nodos se encuentra dentro de la etiqueta MUSICA que agrupa todos los hijos o nodos tema.
Pero para que un archivo realmente cumpla con las normas de XML no solo debe respetar esta estructura jerárquica sino también debe incluir elementos obligatorios como es el tipo de codificación de lenguaje o prólogo.

  1. <?xml version="1.0" encoding="utf-8"?>
  2. <MUSICA>
  3.     <tema titulo="Mi musica" />
  4. </MUSICA>

Como pueden observar se agrego una nueva línea en la parte superior del XML que cumple con la función de indicar el tipo de versión 1.0 y el tipo de codificación de lenguaje utf-8 que en este caso es para poder nosotros usar alfabeto español dentro de la estructura del XML.

Otro elemento importante de un XML son sus atributos y estos son elementos que están indicado dentro de una etiqueta y anteponiéndose al signo igual (=), estos atributos nos son de gran utilidad si es que queremos incluir información extenza, si observan en el ejemplo verán que titulo=”la dormida” es un atributo y su contenido es la dormida. La manera correcta de escribir un atributo es no usar letras como ñ o acentuadas como nombre de atributo. Posterior al signo igual (=) entre comillas ya sean dobles o simples indicamos el valor del atributo la dormida.

El valor del atributo si puede tener espacios, ñ o acentos lo que si deben tener cuidado con el uso de las comillas, si para encerrar el valor del atributo usando comillas dobles y necesitamos volver a utilizar comillas, en este caso dentro del valor pondremos comillas simple, o viceversa.

Los atributos son usados en la mayoría de los casos para representar información corta, por ejemplo duración del tema, nombre del tema, autor pero si quisiéramos almacenar una descripción sea del tema o del disco ya no es para nada aconsejable usar un atributo para dicho fin, en ese caso nos haremos uso de una nueva etiqueta llamada CDATA.

CDATA nos permite dentro de ella colocar todo el texto que queramos y el XML ignorara todos los caracteres internos de este, cosa que ninguna palabra que este allí sea confundida por una etiqueta.

  1. <?xml version="1.0" encoding="utf-8"?>
  2. <MUSICA>
  3.     <tema titulo="Mi musica">
  4.         <![CDATA[aqui el texto]]>
  5.     </tema>
  6. </MUSICA>

Como pueden observar las etiquetas CDATA están dentro del cuerpo de cada por lo tanto seguimos respetando el orden jerárquico de orden de padres a hijos. También es importante respetar la sintaxis de escritura del CDATA de la siguiente manera:

  1. <![CDATA[aqui el texto]]>

Conclusion, indispensable nunca olvidarse:
1º Prólogo:

  1. <?xml version="1.0" encoding="utf-8"?>

Siempre al principio de nuestro XML y solo lo indicamos 1 vez

2º Cuerpo:

  1. <MUSICA></MUSICA>

Es la etiqueta superior que abarcara todas las sub etiquetas y no abra ni existirá ninguna fuera de ella, esta se declara y se cierra una sola vez.

3º Nodos:

  1. <tema titulo="Mi musica" />

Pueden existir cuanta cantidad de nodos necesiten pero siempre cuando se abre uno “<" se deben cerrar en alguna parte “/>”, estos nodos pueden tener el mismo nombre de nodo y cada uno será interpretado como elementos diferentes.

4º Atributos: nombre=”Kevin Chuca”
Los atributos deben ir dentro del nodo y utilizar un nombre lo mas descriptivo posible y corto, su contenido se escribe a continuación del signo = y entre comillas sean simples o dobles. Si usan comillas dobles deberán usar dobles para el resto de sus atributos o viceversa.

5º CDATA:

  1. <![CDATA[aqui el texto]]>

Por cada nodo puede existir un CDATA

XML según Wikipedia:
XML según w3schools

XML finalizado:

  1. <?xml version="1.0" encoding="utf-8"?>
  2. <MUSICA>
  3.     <tema titulo="Mi musica1">
  4.         <![CDATA[aqui el texto]]>
  5.     </tema>
  6.     <tema titulo="Mi musica2">
  7.         <![CDATA[aqui el texto]]>
  8.     </tema>
  9.     <tema titulo="Mi musica3">
  10.         <![CDATA[aqui el texto]]>
  11.     </tema>
  12. </MUSICA>