Professional Documents
Culture Documents
ACTIONSCRIPT 3.0
Avisos legales
Avisos legales
Para ver los avisos legales, consulte http://help.adobe.com/es_ES/legalnotices/index.html.
iii
Contenido
Captulo 1: Trabajo con fechas y horas Administracin de fechas de calendario y horas Control de intervalos de tiempo ........................................................................ 1 .................................................................... 6 ....................................................................................... 4
Ejemplo de fecha y hora: Un sencillo reloj analgico Captulo 2: Trabajo con cadenas Fundamentos de la utilizacin de cadenas Creacin de cadenas La propiedad length
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Obtencin de representaciones de cadena de otros objetos Bsqueda de subcadenas y patrones en cadenas Ejemplo de cadenas: Arte ASCII
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Captulo 3: Trabajo con conjuntos Fundamentos de la utilizacin de conjuntos Conjuntos indexados Conjuntos asociativos Clonacin de conjuntos
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Captulo 4: Gestin de errores Fundamentos de la gestin de errores Tipos de errores Gestin de errores en ActionScript 3.0
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Trabajo con las versiones de depuracin de los motores de ejecucin de Flash Gestin de errores sincrnicos en una aplicacin Creacin de clases de error personalizadas Respuesta al estado y a los eventos de error Comparacin de las clases Error
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Ejemplo de gestin de errores: Aplicacin CustomErrors Captulo 5: Uso de expresiones regulares Fundamentos de la utilizacin de expresiones regulares Sintaxis de las expresiones regulares Mtodos para utilizar expresiones regulares con cadenas Ejemplo de expresiones regulares: Analizador Wiki
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
iv
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
Construccin y transformacin de objetos XML Uso de espacios de nombres XML Conversin de tipo XML
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
Ejemplo de XML en ActionScript: Carga de datos RSS desde Internet Captulo 7: Gestin de eventos Fundamentos de la gestin de eventos Flujo de eventos Objetos de evento
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
Detectores de eventos
Ejemplo de gestin de eventos: Reloj con alarma Captulo 8: Trabajo con dominios de aplicacin
Captulo 9: Programacin de la visualizacin Fundamentos de la programacin de la visualizacin Clases principales de visualizacin Trabajo con objetos de visualizacin Animacin de objetos Ventajas de la utilizacin de la lista de visualizacin Manipulacin de objetos de visualizacin Orientacin del escenario
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
Captulo 10: Trabajo con la geometra Fundamentos de geometra . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207 Uso de objetos Point Uso de objetos Matrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210 . . . . . . . . . . . . . . . . . . . . . . . 215 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213 Uso de objetos Rectangle
Captulo 11: Uso de la API de dibujo Aspectos bsicos de la API de dibujo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219 Clase Graphics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228 Dibujo de lneas y curvas
Dibujo de formas mediante los mtodos incorporados Creacin de lneas y rellenos degradados Uso de la clase Math con los mtodos de dibujo
Ejemplo de API de dibujo: Generador visual algortmico Utilizacin avanzada de la API de dibujo
Captulo 12: Trabajo con mapas de bits Fundamentos de la utilizacin de mapas de bits Las clases Bitmap y BitmapData Manipulacin de pxeles Copia de datos de mapas de bits Desplazamiento por mapas de bits
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245
Captulo 13: Aplicacin de filtros a objetos de visualizacin Fundamentos de la aplicacin de filtros a los objetos de visualizacin Creacin y aplicacin de filtros Filtros de visualizacin disponibles
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
Captulo 14: Trabajo con sombreados de Pixel Bender Fundamentos de los sombreados de Pixel Bender . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302 Carga e incorporacin de un sombreado Acceso a los metadatos de sombreado Uso de un sombreado . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312
Captulo 15: Trabajo con clips de pelcula Fundamentos de la utilizacin de pelcula . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325 Trabajo con objetos MovieClip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 334 Control de la reproduccin de clips de pelcula Creacin de objetos MovieClip con ActionScript Carga de un archivo SWF externo
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332
Captulo 16: Trabajo con interpolaciones de movimiento Fundamentos de interpolaciones de movimiento . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 338 Incorporacin de scripts de interpolacin de movimiento Descripcin de la animacin Aadir filtros . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 340 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342
Captulo 17: Trabajo con cinemtica inversa Fundamentos de cinemtica inversa . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 346 Informacin general sobre animacin de esqueletos IK Obtener informacin sobre un esqueleto IK . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349
vi
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 350
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 351 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 351
Captulo 18: Trabajo en tres dimensiones (3D) Fundamentos del concepto 3D . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353 Aspectos bsicos de las funciones 3D de Flash Player y el tiempo de ejecucin de AIR Creacin y movimiento de objetos 3D Ejemplo: Proyeccin en perspectiva Transformaciones 3D complejas Uso de tringulos para efectos 3D Proyeccin de objetos 3D en una vista bidimensional . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 362
Captulo 19: Fundamentos de la utilizacin de texto Captulo 20: Uso de la clase TextField Visualizacin de texto . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375 Seleccin y manipulacin de texto Captura de entradas de texto Formato de texto Restriccin de entradas de texto Representacin avanzada de texto Trabajo con texto esttico . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 379 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 382 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 387 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 391 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 381
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 383 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 389
Captulo 21: Uso de Flash Text Engine Creacin y visualizacin de texto . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 400 Gestin de eventos en FTE Formato de texto Trabajo con fuentes Control del texto . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 405 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 408 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 413 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 415 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 421
Captulo 22: Uso de Text Layout Framework Informacin general sobre Text Layout Framework Uso de Text Layout Framework Estructuracin del texto con TLF Formato de texto con TLF
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 430
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 440
Activacin de las operaciones para deshacer, editar y seleccin de texto con TLF Posicionamiento de imgenes en el texto Captulo 23: Trabajo con sonido Fundamentos de la utilizacin de sonido Carga de archivos de sonido externos
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 443 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 444
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 445 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 446
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448
vii
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 459
Consideraciones de seguridad al cargar y reproducir sonidos Control de desplazamiento y volumen de sonido Trabajo con metadatos de sonido Captura de entradas de sonido Acceso a datos de sonido sin formato Ejemplo de sonido: Podcast Player
Captulo 24: Trabajo con vdeo Fundamentos de la utilizacin de vdeo Aspectos bsicos de la clase Video Carga de archivos de vdeo Control de la reproduccin de vdeo Transmisin de archivos de vdeo
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 478 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 479
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 483
Reproduccin de vdeo en modo de pantalla completa Aspectos bsicos de los puntos de referencia Uso de puntos de referencia y metadatos Control de la actividad de NetStream Temas avanzados para archivos FLV Ejemplo de vdeo: Video Jukebox
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 497
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 507 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 510
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 512 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 518
Uso de la clase StageVideo para la presentacin con aceleracin por hardware Captulo 25: Trabajo con cmaras Aspectos bsicos de la clase Camera Diseo de la aplicacin de cmara Conexin a la cmara de un usuario
Comprobacin de que las cmaras estn instaladas Deteccin de permisos para el acceso a una cmara Aumento de la calidad de vdeo de la cmara Supervisin del estado de la cmara
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 532
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 533
Captulo 26: Uso de la administracin de derechos digitales Aspectos bsicos del flujo de trabajo de contenido protegido . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 536 Eventos y miembros relacionados con DRM de la clase NetStream Uso de la clase DRMStatusEvent Uso de la clase DRMErrorEvent Uso de la clase DRMManager Uso de la clase DRMContentData Uso de la clase DRMAuthenticateEvent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 542 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 543 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 544 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 548 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 548 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 550 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 550
viii
Captulo 27: Cmo aadir contenido PDF en AIR Deteccin de la capacidad de PDF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 552 Carga de contenido PDF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 553 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 553 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 555 Uso de scripts con el contenido PDF
Captulo 28: Aspectos bsicos de la interaccin con el usuario Captura de entradas del usuario . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 557 Administracin de la seleccin Deteccin de tipos de entrada . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 558 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 559
Captulo 29: Entradas de teclado Captura de entradas de teclado . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 561 Uso de la clase IME Teclados virtuales . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 563 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 568
Captulo 30: Entradas de ratn Captura de entradas de ratn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 576 Ejemplo de entrada de ratn: WordSearch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 578
Captulo 31: Entrada tctil, multitctil y de gestos Fundamentos de la entrada tctil . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 583 Deteccin con soporte tctil Gestin de eventos tctiles Tocar y arrastrar Gestin de eventos de gestos Solucin de problemas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 585 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 586 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 591
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 589 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 594
Captulo 32: Copiar y pegar Aspectos bsicos de la operacin de copiar y pegar Lectura y escritura en el portapapeles del sistema Operaciones de pegar y copiar HTML en AIR Formatos de datos para Clipboard
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 597 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 598
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 598
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 600
Captulo 33: Entrada de acelermetro Comprobacin de la compatibilidad del acelermetro Deteccin de cambios del acelermetro
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 606
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 607
Captulo 34: Operacin de arrastrar y colocar en AIR Aspectos bsicos de la operacin de arrastrar y colocar en AIR Compatibilidad con el gesto de arrastrar hacia fuera Compatibilidad con el gesto de arrastrar hacia dentro Operacin de arrastrar y colocar en HTML Arrastrar datos hacia fuera de un elemento en HTML Arrastrar datos dentro de un elemento HTML
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 609
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 617 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 621
Ejemplo: Supresin del comportamiento predeterminado de arrastrar hacia dentro en HTML Gestin de la colocacin de archivos en entornos limitados de HTML ajenos a la aplicacin Colocacin de promesas de archivo
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 625
ix
Captulo 35: Trabajo con mens Men: conceptos bsicos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 634 Creacin de mens nativos (AIR) Mens contextuales en HTML (AIR) Gestin de eventos de men . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 641 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 643 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 644 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 646
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 645
Captulo 36: Iconos de la barra de tareas en AIR Iconos de la barra de tareas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 650 Iconos del Dock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 651 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 651 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 653 Iconos de la bandeja del sistema
Captulo 37: Trabajo con el sistema de archivos Uso de la clase FileReference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 655 Uso de la API del sistema de archivos de AIR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 670
Captulo 38: Almacenamiento de datos locales Objetos compartidos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 706 Almacenamiento local cifrado . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 715
Captulo 39: Trabajo con bases de datos SQL locales en AIR Bases de datos SQL locales . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 719 Creacin y modificacin de una base de datos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 724 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 731 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 760 Manipulacin de los datos de una base de datos SQL Uso del cifrado con bases de datos SQL
Uso de operaciones sincrnicas y asncronas de base de datos Estrategias para la utilizacin de bases de datos SQL
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 765 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 782
Captulo 40: Trabajo con conjuntos de bytes Lectura y escritura de un ByteArray . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 785 Ejemplo de ByteArray: Lectura de un archivo .zip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 791
Captulo 41: Fundamentos de redes y comunicacin Interfaces de red . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 798 Cambios de conectividad de la red . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 799 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 802 Registros del sistema de nombres de dominio (DNS)
Captulo 42: Sockets Sockets TCP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 804 Sockets UDP (AIR) Direcciones IPv6 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 815 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 817
Captulo 43: Comunicaciones HTTP Carga de datos externos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 819 Peticiones de servicios web . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 828 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 836 Apertura de una URL en otra aplicacin
Captulo 44: Conexin con otras instancias de Flash Player y AIR Informacin sobre la clase LocalConnection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 838 Envo de mensajes entre dos aplicaciones . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 840 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 842 Conexin al contenido en diferentes dominios y a otras aplicaciones de AIR Captulo 45: Comunicacin con procesos nativos en AIR Informacin general sobre las comunicaciones de proceso nativo Inicio y cierre de un proceso nativo Comunicacin con un proceso nativo
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 845
Seguridad en la comunicacin del proceso nativo Captulo 46: Uso de la API externa Fundamentos de la utilizacin de la API externa Requisitos y ventajas de la API externa Uso de la clase ExternalInterface
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 851
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 854
Ejemplo de API externa: Comunicacin entre ActionScript y una aplicacin de escritorio que utiliza el control ActiveX
Captulo 47: Validacin de la firma XML en AIR Aspectos bsicos de la validacin de firmas XML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 870 Firmas XML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 875 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 877 Implementacin de la interfaz IURIDereferencer Captulo 48: Entorno del sistema del cliente Fundamentos del entorno del sistema del cliente Uso de la clase System Uso de la clase Capabilities
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 885
Captulo 49: Cierre e invocacin de una aplicacin de AIR Invocacin de aplicaciones . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 892 Captura de argumentos de la lnea de comandos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 894 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 897 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 898 Invocacin de una aplicacin de AIR en el inicio de sesin de usuario Invocacin de una aplicacin de AIR desde el navegador Cierre de una aplicacin
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 900
Captulo 50: Trabajo con informacin sobre el motor de ejecucin de AIR y el sistema operativo Gestin de asociaciones con archivos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 902 Obtencin de la versin y el nivel de revisin del motor de ejecucin Deteccin de las capacidades de AIR Seguimiento de la presencia de usuarios . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 903 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 903 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 904
Captulo 51: Trabajo con ventanas nativas de AIR Aspectos bsicos de las ventanas nativas en AIR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 905 Creacin de ventanas Gestin de ventanas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 913 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 922 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 932 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 933
xi
Captulo 52: Pantallas en AIR Aspectos bsicos de las pantallas en AIR Enumeracin de las pantallas Captulo 53: Impresin Fundamentos de impresin Impresin de una pgina
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 935
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 936
Interfaz de impresin del sistema y tareas del motor de ejecucin de Flash Configuracin del tamao, la escala y la orientacin Tcnicas de impresin avanzada Ejemplo de impresin: Impresin de varias pginas
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 946
Ejemplo de impresin: Configuracin de pgina y opciones de impresin Captulo 54: Localizacin geogrfica Deteccin de cambios de geolocalizacin
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 955
Captulo 55: Internacionalizacin de aplicaciones Conceptos bsicos de internacionalizacin de aplicaciones Informacin general sobre el paquete flash.globalization Determinacin de la configuracin regional Formato de nmeros Formato de valores de divisa Formato de fechas y horas Conversin tipogrfica
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 958 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 959
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 961
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 970
Captulo 56: Localizacin de aplicaciones Eleccin de una configuracin regional . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 976 Localizacin de contenido de Flex Localizacin de contenido de Flash Localizacin de aplicaciones de AIR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 977 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 977 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 977 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 978
Captulo 57: Entorno HTML Informacin general sobre el entorno HTML AIR y WebKit
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 980
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 983
Captulo 58: Programacin con HTML y JavaScript en AIR Informacin sobre la clase HTMLLoader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 999 Cmo evitar errores de JavaScript relacionados con la seguridad Acceso a las clases de API de AIR desde JavaScript Informacin sobre URL en AIR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1001 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1006 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1009 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1010 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1014
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1008
Acceso a objetos JavaScript y DOM HTML desde ActionScript Uso de las bibliotecas de ActionScript en una pgina HTML
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1012
xii
Captulo 59: Uso de scripts en el contenedor HTML de AIR Propiedades de visualizacin de objetos HTMLLoader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1023 Desplazamiento de contenido HTML Acceso a la lista del historial HTML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1026 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1027 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1028 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1028 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1029
Configuracin del agente de usuario que se utiliza al cargar contenido HTML Definicin de interfaces de usuario del navegador para el contenido HTML Creacin de subclases de la clase HTMLLoader
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1040
Captulo 60: Gestin de eventos relacionados con HTML en AIR Eventos HTMLLoader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1042 Gestin de eventos DOM con ActionScript . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1043 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1043 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1045 Respuesta a excepciones en JavaScript sin capturar
Captulo 61: Visualizacin de contenido HTML en aplicaciones mviles Objetos StageWebView . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1048 Contenido Historial Seleccin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1049 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1051 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1051 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1052 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1054 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1056 Eventos de navegacin
Captulo 62: Seguridad Informacin general sobre la seguridad de la plataforma Flash Entornos limitados de seguridad Controles de permiso Restriccin de las API de red Carga de contenido Reutilizacin de scripts Carga de datos
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1059
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1061
Carga de contenido incorporado de archivos SWF importados en un dominio de seguridad Trabajo con contenido heredado Control del acceso URL saliente Objetos compartidos Seguridad en AIR Configuracin de permisos de LocalConnection
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1093
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1095
xiii
Captulo 63: Cmo utilizar ejemplos de ActionScript Tipos de ejemplos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1117 Ejecucin de ejemplos de ActionScript 3.0 en Flash Professional Ejecucin de ejemplos de ActionScript 3.0 en Flash Builder Ejecucin de ejemplos de ActionScript 3.0 en dispositivos mviles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1118 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1121 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1120
Captulo 64: Compatibilidad de SQL en bases de datos locales Sintaxis SQL admitida . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1126 Compatibilidad de tipos de datos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1148
Ms temas de ayuda
Date flash.utils.Timer
En segundo lugar, si se proporciona un solo parmetro numrico, el constructor Date() trata dicho parmetro como el nmero de milisegundos transcurridos desde el 1 de enero de 1970 y devuelve un objeto Date correspondiente. Hay que tener en cuenta que el valor de milisegundos que se pasa se trata como milisegundos desde el 1 de enero de 1970, en UTC. Sin embargo, el objeto Date muestra los valores en la zona horaria local, a menos que se utilicen mtodos especficos de UTC para recuperarlos y mostrarlos. Si se crea un nuevo objeto Date con un solo parmetro de milisegundos, hay tener en cuenta la diferencia de zona horaria entre la hora local y la hora universal UTC. Las siguientes sentencias crean un objeto Date establecido en la medianoche del da 1 de enero de 1970, en UTC:
var millisecondsPerDay:int = 1000 * 60 * 60 * 24; // gets a Date one day after the start date of 1/1/1970 var startTime:Date = new Date(millisecondsPerDay);
En tercer lugar, se pueden pasar varios parmetros numricos al constructor Date(). Estos parmetros se tratan como el ao, mes, da, hora, minuto, segundo y milisegundo, respectivamente, y se devuelve un objeto Date correspondiente. Se supone que estos parmetros de entrada estn en hora local y no en UTC. Las siguientes sentencias obtienen un objeto Date establecido en la medianoche del inicio del da 1 de enero de 2000, en hora local:
var millenium:Date = new Date(2000, 0, 1, 0, 0, 0, 0);
En cuarto lugar, se puede pasar un solo parmetro de cadena al constructor Date(). ste intentar analizar dicha cadena en componentes de fecha u hora, y devolver a continuacin un objeto Date correspondiente. Si utiliza este enfoque, es una buena idea incluir el constructor Date() en un bloque try..catch para localizar cualquier error de anlisis. El constructor Date() acepta una serie de formatos de cadena diferentes (que se incluyen en Referencia de ActionScript 3.0 para la plataforma de Adobe Flash). La siguiente sentencia inicializa un nuevo objeto Date con un valor de cadena:
var nextDay:Date = new Date("Mon May 1 2006 11:30:00 AM");
Si el constructor Date() no puede analizar correctamente el parmetro de cadena, no emitir una excepcin. Sin embargo, el objeto Date resultante contendr un valor de fecha no vlido.
La propiedad fullYear La propiedad month, que tiene un formato numrico con un valor entre 0 (enero) y 11 (diciembre) La propiedad date, que es el nmero de calendario del da del mes, en el rango de 1 a 31 La propiedad day, que es el da de la semana en formato numrico, siendo 0 el valor correspondiente al domingo La propiedad hours, en el rango de 0 a 23 La propiedad minutes La propiedad seconds La propiedad milliseconds
De hecho, la clase Date proporciona varias formas de obtener cada uno de estos valores. Por ejemplo, se puede obtener el valor de mes de un objeto Date de cuatro formas distintas:
Ahora resulta sencillo realizar operaciones aritmticas de fecha con unidades de tiempo estndar. El cdigo siguiente establece un valor de fecha de una hora a partir de la hora actual, mediante los mtodos getTime() y setTime():
var oneHourFromNow:Date = new Date(); oneHourFromNow.setTime(oneHourFromNow.getTime() + millisecondsPerHour);
Otra forma de establecer un valor de fecha consiste en crear un nuevo objeto Date con un solo parmetro de milisegundos. Por ejemplo, el siguiente cdigo aade 30 das a una fecha para calcular otra:
// sets the invoice date to today's date var invoiceDate:Date = new Date(); // adds 30 days to get the due date var dueDate:Date = new Date(invoiceDate.getTime() + (30 * millisecondsPerDay));
A continuacin, se multiplica por 30 la constante millisecondsPerDay para representar un tiempo de 30 das y el resultado se aade al valor invoiceDate y se utiliza para establecer el valor dueDate.
En el siguiente ejemplo se utiliza el desplazamiento de zona horaria para convertir una fecha de la hora local a la hora universal UTC. Para realizar la conversin, primero se calcula el valor de zona horaria en milisegundos y luego se ajusta el valor de Date en dicha cantidad:
// creates a Date in local time var nextDay:Date = new Date("Mon May 1 2006 11:30:00 AM"); // converts the Date to UTC by adding or subtracting the time zone offset var offsetMilliseconds:Number = nextDay.getTimezoneOffset() * 60 * 1000; nextDay.setTime(nextDay.getTime() + offsetMilliseconds);
La clase Timer
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior La forma preferida de gestionar funciones de tiempo en ActionScript 3.0 consiste en utilizar la clase Timer (flash.utils.Timer) para distribuir eventos cuando se alcanza un intervalo. Para iniciar un temporizador, primero es necesario crear una instancia de la clase Timer e indicarle la frecuencia con la que debe generar un evento del temporizador y la cantidad de veces que debe hacerlo antes de detenerse. Por ejemplo, el cdigo siguiente crea una instancia de Timer que distribuye un evento cada segundo y se prolonga durante 60 segundos:
var oneMinuteTimer:Timer = new Timer(1000, 60);
El objeto Timer distribuye un objeto TimerEvent cada vez que se alcanza el intervalo especificado. El tipo de evento de un objeto TimerEvent es timer (definido por la constante TimerEvent.TIMER). Un objeto TimerEvent contiene las mismas propiedades que un objeto Event estndar.
Si la instancia de Timer se establece en un nmero fijo de intervalos, tambin distribuir un evento timerComplete (definido por la constante TimerEvent.TIMER_COMPLETE) cuando alcance el intervalo final. A continuacin se muestra una aplicacin de ejemplo donde se utiliza la clase Timer:
package { import flash.display.Sprite; import flash.events.TimerEvent; import flash.utils.Timer; public class ShortTimer extends Sprite { public function ShortTimer() { // creates a new five-second Timer var minuteTimer:Timer = new Timer(1000, 5); // designates listeners for the interval and completion events minuteTimer.addEventListener(TimerEvent.TIMER, onTick); minuteTimer.addEventListener(TimerEvent.TIMER_COMPLETE, onTimerComplete); // starts the timer ticking minuteTimer.start(); } public function onTick(event:TimerEvent):void { // displays the tick count so far // The target of this event is the Timer instance itself. trace("tick " + event.target.currentCount); } public function onTimerComplete(event:TimerEvent):void { trace("Time's Up!"); } } }
Al crear la clase ShortTimer, se crea una instancia de Timer que har tictac una vez por segundo durante cinco segundos. Posteriormente agrega dos detectores al temporizador: uno que detecta todos los tictac y otro que detecta el evento timerComplete . A continuacin, inicia el tictac del temporizador y, a partir de ese punto, el mtodo onTick() se ejecuta en intervalos de un segundo. El mtodo onTick() simplemente muestra el recuento de tictac actual. Despus de cinco segundos, se ejecuta el mtodo onTimerComplete(), que indica que se ha acabado el tiempo. Cuando se ejecuta este ejemplo, aparecen las siguientes lneas en la consola o ventana de traza a una velocidad de una lnea por segundo:
Descripcin Cancela una llamada a setInterval() especificada. Cancela una llamada setTimeout() especificada. Devuelve el nmero de milisegundos transcurridos desde que se inici Adobe Flash Player o Adobe AIR.
Ejecuta una funcin especificada tras una demora especificada (en milisegundos).
Estas funciones se conservan en ActionScript 3.0 para permitir la compatibilidad con versiones anteriores. Adobe no recomienda utilizarlas en nuevas aplicaciones de ActionScript 3.0. En general, resulta ms sencillo y eficaz utilizar la clase Timer en las aplicaciones.
Obtencin de la fecha y hora actuales, y extraccin de valores para las horas, minutos y segundos Uso de un objeto Timer para establecer el ritmo de una aplicacin
Para obtener los archivos de la aplicacin de este ejemplo, consulte www.adobe.com/go/learn_programmingAS3samples_flash_es. Los archivos de la aplicacin SimpleClock se encuentran en la carpeta Samples/SimpleClock. La aplicacin consta de los siguientes archivos:
El archivo de la aplicacin principal. Dibuja una esfera de reloj redonda y las manecillas de hora, minutos y segundos, en funcin de la hora.
La propiedad face, que es una instancia de la clase AnalogClockFace La propiedad ticker, que es una instancia de la clase Timer
La clase SimpleClock utiliza un constructor predeterminado. El mtodo initClock() realiza el trabajo de configuracin real, pues crea la esfera del reloj e inicia el tictac de la instancia de Timer.
/** * Sets up a SimpleClock instance. */ public function initClock(faceSize:Number = 200) { // creates the clock face and adds it to the display list face = new AnalogClockFace(Math.max(20, faceSize)); face.init(); addChild(face); // draws the initial clock display face.draw();
El tamao de la esfera puede pasarse al mtodo initClock(). Si no se pasa el valor faceSize, se utiliza un tamao predeterminado de 200 pxeles. A continuacin, la aplicacin inicializa la esfera y la aade a la lista de visualizacin a travs del mtodo addChild() heredado de la clase DisplayObjectContainer. Luego llama al mtodo AnalogClockFace.draw() para mostrar la esfera del reloj una vez, con la hora actual.
En primer lugar, este mtodo crea una instancia de Timer que distribuir un evento una vez por segundo (cada 1000 milisegundos). Como no se pasa ningn parmetro repeatCount al constructor Timer(), el objeto Timer se repetir indefinidamente. El mtodo SimpleClock.onTick() se ejecutar una vez por segundo cuando se reciba el evento timer:
public function onTick(event:TimerEvent):void { // updates the clock display face.draw(); }
Este mtodo guarda la hora actual en una variable, de forma que la hora no puede cambiar mientras se dibujan las manecillas del reloj. Luego llama al mtodo showTime() para mostrar las manecillas, como se muestra a continuacin:
/** * Displays the given Date/Time in that good old analog clock style. */ public function showTime(time:Date):void { // gets the time values var seconds:uint = time.getSeconds(); var minutes:uint = time.getMinutes(); var hours:uint = time.getHours(); // multiplies by 6 to get degrees this.secondHand.rotation = 180 + (seconds * 6); this.minuteHand.rotation = 180 + (minutes * 6); // Multiply by 30 to get basic degrees, then // add up to 29.5 degrees (59 * 0.5) // to account for the minutes. this.hourHand.rotation = 180 + (hours * 30) + (minutes * 0.5); }
En primer lugar, este mtodo extrae los valores de las horas, minutos y segundos de la hora actual. Luego utiliza estos valores para calcular el ngulo de cada manecilla. Como la manecilla de los segundos realiza una rotacin completa en 60 segundos, gira 6 grados cada segundo (360/60). La manecilla de los minutos gira en la misma medida cada minuto. La manecilla de las horas se actualiza tambin cada minuto, de forma que va progresando a medida que pasan los minutos. Gira 30 grados cada hora (360/12), pero tambin gira medio grado cada minuto (30 grados divididos entre 60 minutos).
10
Ms temas de ayuda
String RegExp parseFloat() parseInt()
Como se ilustra en este ejemplo, en ActionScript se puede denotar un valor de cadena escribiendo texto entre comillas dobles o simples. A continuacin se muestran varios ejemplos de cadenas:
"Hello" "555-7649" "http://www.adobe.com/"
Siempre que se manipule un fragmento de texto en ActionScript, se trabaja con un valor de cadena. La clase String de ActionScript es el tipo de datos que se utiliza para trabajar con valores de texto. Se suelen utilizar instancias de String para propiedades, parmetros de mtodos, etc. en muchas otras clases de ActionScript. Conceptos y trminos importantes La siguiente lista de referencia contiene trminos importantes utilizados:
ASCII Sistema para representar caracteres de texto y smbolos en programas informticos. El sistema ASCII incluye el
de cadena.
11
Cadena vaca Cadena que no contiene texto, espacio en blanco ni otros caracteres; se escribe como "". Un valor de cadena vaca no es lo mismo que una variable de tipo String con valor NULL. Una variable de tipo String con valor NULL es una variable que no tiene una instancia de String asignada, mientras que una cadena vaca tiene una instancia con un valor que no contiene ningn carcter. Cadena Valor de texto (secuencia de caracteres). Literal de cadena (o cadena literal) Literal de cadena (o "cadena literal"): valor de cadena escrito explcitamente en el cdigo como un valor de texto entre comillas dobles o simples. Subcadena Cadena que forma parte de otra cadena. Unicode Sistema estndar para representar caracteres de texto y smbolos en programas informticos. El sistema
Creacin de cadenas
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior La clase String se utiliza para representar datos de cadena (textuales) en ActionScript 3.0. Las cadenas de ActionScript admiten caracteres tanto ASCII como Unicode. La manera ms sencilla de crear una cadena es utilizar un literal de cadena. Para declarar un literal de cadena, hay que utilizar comilla dobles rectas (") o comillas simples ('). Por ejemplo, las dos cadenas siguientes son equivalentes:
var str1:String = "hello"; var str2:String = 'hello';
Tambin se puede declarar una cadena utilizando el operador new, de la manera siguiente:
var str1:String = new String("hello"); var str2:String = new String(str1); var str3:String = new String(); // str3 == ""
Para utilizar comillas simples (') dentro de un literal de cadena definido con comillas simples (') hay que utilizar el carcter de escape barra diagonal inversa (\). De manera similar, para utilizar comillas dobles (") dentro de un literal de cadena definido con comillas dobles (") hay que utilizar el carcter de escape barra diagonal inversa (\). Las dos cadenas siguientes son equivalentes:
var str1:String = "That's \"A-OK\""; var str2:String = 'That\'s "A-OK"';
Se puede elegir utilizar comillas simples o comillas dobles en funcin de las comillas simples o dobles que existan en un literal de cadena, como se muestra a continuacin:
var str1:String = "ActionScript <span class='heavy'>3.0</span>"; var str2:String = '<item id="155">banana</item>';
Hay que tener en cuenta que ActionScript distingue entre una comilla simple recta (') y una comilla simple izquierda o derecha (' o ' ). Lo mismo ocurre para las comillas dobles. Hay que utilizar comillas rectas para delimitar los literales de cadena. Al pegar texto de otro origen en ActionScript hay que asegurarse de utilizar los caracteres correctos.
12
Como se muestra en la tabla siguiente, se puede utilizar el carcter de escape de barra diagonal inversa (\) para definir otros caracteres en los literales de cadena:
Secuencia de escape
\b \f \n \r \t \unnnn
Carcter Retroceso Salto de pgina Nueva lnea Retorno de carro Tabulador Carcter Unicode con el cdigo de carcter especificado por el nmero hexadecimal nnnn; por ejemplo, \u263a es el carcter smiley. Carcter ASCII con el cdigo de carcter especificado por el nmero hexadecimal nn. Comilla simple Comilla doble Barra diagonal inversa simple
La propiedad length
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior Cada cadena tiene una propiedad length que es igual al nmero de caracteres de la cadena:
var str:String = "Adobe"; trace(str.length); // output: 5
Tanto la cadena vaca como la cadena NULL tienen longitud 0, como se muestra en el siguiente ejemplo:
var str1:String = new String(); trace(str1.length); // output: 0 str2:String = ''; trace(str2.length);
// output: 0
Se pueden examinar caracteres individuales en diversas posiciones de una cadena mediante los mtodos charAt() y charCodeAt(), como en este ejemplo:
13
var str:String = "hello world!"; for (var i:int = 0; i < str.length; i++) { trace(str.charAt(i), "-", str.charCodeAt(i)); }
Tambin se pueden utilizar cdigos de caracteres para definir una cadena con el mtodo fromCharCode(), como se muestra en el siguiente ejemplo:
var myStr:String = String.fromCharCode(104,101,108,108,111,32,119,111,114,108,100,33); // Sets myStr to "hello world!"
Comparacin de cadenas
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior Se pueden utilizar los siguientes operadores para comparar cadenas: <, <=, !=, ==, => y >. Estos operadores se pueden utilizar con sentencias condicionales, como if y while, como se indica en el siguiente ejemplo:
var str1:String = "Apple"; var str2:String = "apple"; if (str1 < str2) { trace("A < a, B < b, C < c, ..."); }
Al usar estos operadores con cadenas, ActionScript considera el valor del cdigo de carcter de cada carcter de la cadena, comparando los caracteres de izquierda a derecha, como se muestra a continuacin:
trace("A" < "B"); // true trace("A" < "a"); // true trace("Ab" < "az"); // true trace("abc" < "abza"); // true
Los operadores == y != se utilizan para comparar cadenas entre s y para comparar cadenas con otros tipos de objetos, como se muestra en el siguiente ejemplo:
14
var str1:String = "1"; var str1b:String = "1"; var str2:String = "2"; trace(str1 == str1b); // true trace(str1 == str2); // false var total:uint = 1; trace(str1 == total); // true
Al utilizar el operador de concatenacin + con una combinacin de objetos String y objetos que no son cadenas, no es necesario utilizar el mtodo toString(). Para ver ms detalles sobre la concatenacin, consulte la siguiente seccin. La funcin global String() devuelve el mismo valor para un objeto determinado como el valor devuelto por el objeto llamando al mtodo toString().
Concatenacin de cadenas
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior La concatenacin de cadenas consiste en la unin secuencial de dos cadenas en una sola. Por ejemplo, se puede utilizar el operador suma + para concatenar dos cadenas:
var str1:String = "green"; var str2:String = "ish"; var str3:String = str1 + str2; // str3 == "greenish"
Tambin se puede utilizar el operador += para producir el mismo resultado, como se indica en el siguiente ejemplo:
var str:String = "green"; str += "ish"; // str == "greenish"
Adems, la clase String incluye un mtodo concat(), que se puede utilizar como se muestra a continuacin:
var str1:String = "Bonjour"; var str2:String = "from"; var str3:String = "Paris"; var str4:String = str1.concat(" ", str2, " ", str3); // str4 == "Bonjour from Paris"
Si se utiliza el operador + (o el operador +=) con un objeto String y un objeto que no es una cadena, ActionScript convierte automticamente el objeto que no es una cadena en un objeto String para evaluar la expresin, como se indica en este ejemplo:
15
var str:String = "Area = "; var area:Number = Math.PI * Math.pow(3, 2); str = str + area; // str == "Area = 28.274333882308138"
No obstante, se pueden utilizar parntesis para agrupar con el fin de proporcionar contexto para el operador +, como se indica en el siguiente ejemplo:
trace("Total: $" + 4.55 + 1.45); // output: Total: $4.551.45 trace("Total: $" + (4.55 + 1.45)); // output: Total: $6
ActionScript incluye mtodos para buscar patrones en cadenas y para reemplazar las coincidencias por subcadenas. Estos mtodos se describen en las secciones siguientes. Las expresiones regulares permiten definir patrones complejos. Para obtener ms informacin, consulte Uso de expresiones regulares en la pgina 77.
El mtodo slice() funciona de forma similar al mtodo substring(). Cuando se le facilitan como parmetros dos enteros no negativos, funciona exactamente de la misma forma. No obstante, el mtodo slice() admite enteros negativos como parmetros, en cuyo caso la posicin del carcter se mide desde el final de la cadena, como se indica en el siguiente ejemplo:
16
var str:String = "Hello from Paris, trace(str.slice(11,15)); // output: trace(str.slice(-3,-1)); // output: trace(str.slice(-3,26)); // output: trace(str.slice(-3,str.length)); // trace(str.slice(-8,-3)); // output:
Se pueden combinar enteros positivos y negativos como parmetros del mtodo slice().
Hay que tener en cuenta que el mtodo indexOf() distingue maysculas de minsculas. Se puede especificar un segundo parmetro para indicar la posicin del ndice en la cadena desde la que se debe iniciar la bsqueda, de la manera siguiente:
var str:String = "The moon, the stars, the sea, the land" trace(str.indexOf("the", 11)); // output: 21
Si se incluye un segundo parmetro con el mtodo lastIndexOf(), la bsqueda se realiza desde esa posicin de ndice en la cadena hacia atrs (de derecha a izquierda):
var str:String = "The moon, the stars, the sea, the land" trace(str.lastIndexOf("the", 29)); // output: 21
El segundo parmetro del mtodo split(), que es opcional, define el tamao mximo del conjunto devuelto. Tambin se puede utilizar una expresin regular como carcter delimitador:
var str:String = "Give me\t5." var a:Array = str.split(/\s+/); // a == ["Give","me","5."]
Para obtener ms informacin, consulte Uso de expresiones regulares en la pgina 77 y Referencia de ActionScript 3.0 para la plataforma de Adobe Flash.
17
Los mtodos match() y search() se utilizan para localizar subcadenas que coincidan con un patrn. El mtodo replace() permite buscar subcadenas que coincidan con un patrn y sustituirlas por una subcadena
especificada. Estos mtodos se describen en las secciones siguientes. Se pueden utilizar cadenas o expresiones regulares para definir los patrones utilizados en estos mtodos. Para obtener ms informacin sobre las expresiones regulares, consulte Uso de expresiones regulares en la pgina 77. Bsqueda de subcadenas coincidentes El mtodo search() devuelve la posicin del ndice de la primera subcadena que coincide con un patrn determinado, como se indica en este ejemplo:
var str:String = "The more the merrier."; // (This search is case-sensitive.) trace(str.search("the")); // output: 9
Tambin se pueden utilizar expresiones regulares para definir el patrn que se debe buscar, como se indica en este ejemplo:
var pattern:RegExp = /the/i; var str:String = "The more the merrier."; trace(str.search(pattern)); // 0
La salida del mtodo trace() es 0 porque el primer carcter de la cadena es la posicin de ndice 0. La bsqueda no distingue maysculas de minsculas porque est establecido el indicador i en la expresin regular. El mtodo search() busca una sola coincidencia y devuelve su posicin de ndice inicial, aunque el indicador g (global) est establecido en la expresin regular. En el siguiente ejemplo se muestra una expresin regular ms compleja, que coincide con una cadena entre comillas dobles:
var pattern:RegExp = /"[^"]*"/; var str:String = "The \"more\" the merrier."; trace(str.search(pattern)); // output: 4 str = "The \"more the merrier."; trace(str.search(pattern)); // output: -1 // (Indicates no match, since there is no closing double quotation mark.)
El mtodo match() funciona de manera similar. Busca una subcadena coincidente. Sin embargo, al utilizar el indicador global en un patrn de expresin regular, como en el siguiente ejemplo, match() devuelve un conjunto de subcadenas coincidentes:
var str:String = "bob@example.com, omar@example.org"; var pattern:RegExp = /\w*@\w*\.[org|com]+/g; var results:Array = str.match(pattern);
Para obtener ms informacin sobre las expresiones regulares, consulte Uso de expresiones regulares en la pgina 77.
18
Sustitucin de subcadenas coincidentes Se puede utilizar el mtodo replace() para buscar un patrn especfico en una cadena y sustituir las coincidencias por la cadena de sustitucin especificada, como se indica en el siguiente ejemplo:
var str:String = "She sells seashells by the seashore."; var pattern:RegExp = /sh/gi; trace(str.replace(pattern, "sch")); //sche sells seaschells by the seaschore.
En este ejemplo se puede observar que las cadenas coincidentes no distinguen maysculas de minsculas porque est establecido el indicador i (ignoreCase) en la expresin regular y se sustituyen todas las coincidencias porque est establecido el indicador g (global). Para obtener ms informacin, consulte Uso de expresiones regulares en la pgina 77. Se pueden incluir los siguientes cdigos de sustitucin $en la cadena de sustitucin. El texto de sustitucin mostrado en la tabla siguiente se inserta en lugar del cdigo de sustitucin $:
Cdigo $
$$ $& $`
Texto de sustitucin $ La subcadena coincidente. La parte de la cadena que precede a la subcadena coincidente. Este cdigo utiliza el carcter de comilla simple recta izquierda (`), no la comilla simple recta (') ni la comilla simple curva izquierda (' ). La parte de la cadena que sigue a la subcadena coincidente. Este cdigo utiliza la comilla simple recta (' ). El n-simo grupo entre parntesis coincidente capturado, donde n es un nico dgito, 1-9, y $n no va seguido de un dgito decimal. La nn-sima coincidencia de grupo entre parntesis capturada, donde nn es un nmero decimal de dos dgitos, 01 99. Si la nn-sima captura no est definida, el texto de sustitucin ser una cadena vaca.
$' $n
$nn
Por ejemplo, a continuacin se muestra el uso de los cdigos de sustitucin $2 y $1, que representan el primer y el segundo grupo coincidente captado:
var str:String = "flip-flop"; var pattern:RegExp = /(\w+)-(\w+)/g; trace(str.replace(pattern, "$2-$1")); // flop-flip
Tambin se puede utilizar una funcin como segundo parmetro del mtodo replace(). El texto coincidente se sustituye por el valor devuelto por la funcin.
var str:String = "Now only $9.95!"; var price:RegExp = /\$([\d,]+.\d+)+/i; trace(str.replace(price, usdToEuro)); function usdToEuro(matchedSubstring:String, capturedMatch1:String, str:String):String { var usd:String = capturedMatch1; usd = usd.replace(",", ""); var exchangeRate:Number = 0.853690; var euro:Number = parseFloat(usd) * exchangeRate; const euroSymbol:String = String.fromCharCode(8364); return euro.toFixed(2) + " " + euroSymbol; } index:int,
19
Si se utiliza una funcin como segundo parmetro del mtodo replace(), se pasan los siguientes argumentos a la funcin:
La parte coincidente de la cadena. Las coincidencias de grupos de parntesis de captura. El nmero de argumentos pasados de esta forma vara en
funcin del nmero de grupos entre parntesis coincidentes. Se puede determinar el nmero de grupos entre parntesis coincidentes comprobando arguments.length - 3 dentro del cdigo de la funcin.
Tras ejecutar estos mtodos, la cadena original permanece intacta. Para transformar la cadena original, utilice el cdigo siguiente:
str = str.toUpperCase();
Se utiliza el mtodo split() de la clase String para extraer valores de una cadena delimitada por caracteres
(informacin de imagen en un archivo de texto delimitado por tabulaciones).
Se utilizan varias tcnicas de manipulacin de cadenas, como split(), la concatenacin y la extraccin de una
parte de la cadena mediante substring() y substr() para convertir a maysculas la primera letra de cada palabra de los ttulos de imagen.
El mtodo getCharAt() se utiliza para obtener un solo carcter de una cadena (a fin de determinar el carcter
ASCII correspondiente a un valor de mapa de bits de escala de grises).
Se utiliza la concatenacin de cadenas para generar carcter a carcter la representacin ASCII Art de una imagen.
20
El trmino ASCII Art (arte ASCII) designa representaciones textuales de una imagen, en las que representa la imagen en una cuadrcula de caracteres con fuente de espacio fijo, como los caracteres Courier New. La imagen siguiente muestra un ejemplo de arte ASCII producido por la aplicacin:
Para obtener los archivos de la aplicacin para esta muestra, consulte www.adobe.com/go/learn_programmingAS3samples_flash_es. Los archivos de la aplicacin ASCIIArt se encuentran en la carpeta Samples/AsciiArt. La aplicacin consta de los siguientes archivos:
Archivo AsciiArtApp.mxml o AsciiArtApp.fla com/example/programmingas3/asciiArt/AsciiArtBuilder.as La clase que proporciona la funcionalidad principal de la aplicacin, incluidas la extraccin de metadatos de imagen de un archivo de texto, la carga de imgenes y la administracin del proceso de conversin de imagen a texto. Una clase que proporciona el mtodo parseBitmapData() para convertir datos de imagen en una versin de tipo String. Una clase que representa una imagen de mapa de bits cargada. Una clase que representa metadatos de una imagen de arte ASCII (como el ttulo, el URL del archivo de imagen, etc.). Una carpeta que contiene imgenes utilizadas por la aplicacin. Un archivo de texto delimitado por tabulaciones, que contiene informacin sobre las imgenes que la aplicacin debe cargar. Descripcin El archivo de aplicacin principal en Flash (FLA) o Flex (MXML)
com/example/programmingas3/asciiArt/BitmapToAsciiConverter.as
com/example/programmingas3/asciiArt/Image.as
com/example/programmingas3/asciiArt/ImageInfo.as
image/
txt/ImageData.txt
21
El archivo utiliza un formato delimitado por tabulaciones especfico. La primera lnea (fila) es una fila de encabezado. Las restantes lneas contienen los siguientes datos para cada mapa de bits que se va a cargar:
El nombre de archivo del mapa de bits. El nombre para mostrar del mapa de bits. Los valores de los umbrales blanco y negro para los mapas de bits. Son valores hexadecimales por encima o por
debajo de los cuales, un pxel se considerar completamente blanco o completamente negro. En cuanto se inicia la aplicacin, la clase AsciiArtBuilder carga y analiza el contenido del archivo de texto para crear la "pila" de imgenes que se mostrar, utilizando el cdigo siguiente del mtodo parseImageInfo() de la clase AsciiArtBuilder:
var lines:Array = _imageInfoLoader.data.split("\n"); var numLines:uint = lines.length; for (var i:uint = 1; i < numLines; i++) { var imageInfoRaw:String = lines[i]; ... if (imageInfoRaw.length > 0) { // Create a new image info record and add it to the array of image info. var imageInfo:ImageInfo = new ImageInfo(); // Split the current line into values (separated by tab (\t) // characters) and extract the individual properties: var imageProperties:Array = imageInfoRaw.split("\t"); imageInfo.fileName = imageProperties[0]; imageInfo.title = normalizeTitle(imageProperties[1]); imageInfo.whiteThreshold = parseInt(imageProperties[2], 16); imageInfo.blackThreshold = parseInt(imageProperties[3], 16); result.push(imageInfo); } }
22
Todo el contenido del archivo de texto est en una sola instancia de String, la propiedad_imageInfoLoader.data. Si se utiliza el mtodo split() con el carcter de nueva lnea ("\n") como parmetro, la instancia de String se divide en un conjunto (lines) cuyos elementos son las lneas individuales del archivo de texto. A continuacin, el cdigo utiliza un bucle para trabajar con cada una de las lneas (salvo la primera, ya que contiene slo encabezados, no contenido real). Dentro del bucle, se vuelve a utilizar el mtodo split() para dividir el contenido de la lnea individual en un conjunto de valores (el objeto Array denominado imageProperties). El parmetro utilizado con el mtodo split() en este caso es el carcter de tabulacin ("\t"), ya que los valores de cada lnea estn delimitados por tabulaciones.
En ese cdigo, se aplica al ttulo de imagen del archivo de texto el mtodo normalizeTitle() antes de almacenarlo en el objeto ImageInfo:
private { var var for { } return words.join(" "); } function normalizeTitle(title:String):String words:Array = title.split(" "); len:uint = words.length; (var i:uint; i < len; i++) words[i] = capitalizeFirstLetter(words[i]);
Este mtodo utiliza el mtodo split() para dividir el ttulo en palabras individuales (separadas por el carcter espacio), aplica a cada palabra el mtodo capitalizeFirstLetter() y despus utiliza el mtodo join() de la clase Array para volver a combinar las palabras en una sola cadena. Como indica su nombre, el mtodo capitalizeFirstLetter() convierte a mayscula la primera letra de cada palabra:
23
/** * Capitalizes the first letter of a single word, unless it's one of * a set of words that are normally not capitalized in English. */ private function capitalizeFirstLetter(word:String):String { switch (word) { case "and": case "the": case "in": case "an": case "or": case "at": case "of": case "a": // Don't do anything to these words. break; default: // For any other word, capitalize the first character. var firstLetter:String = word.substr(0, 1); firstLetter = firstLetter.toUpperCase(); var otherLetters:String = word.substring(1); word = firstLetter + otherLetters; } return word; }
En ingls, el carcter inicial de cada una de las palabras de un ttulo no va en maysculas si es alguna de estas palabras: and, the, in, an, or, at, of, o a. (sta es una versin simplificada de las reglas.) Para ejecutar esta lgica, el cdigo utiliza primero una sentencia switch para comprobar si la palabra es una de las palabras que no se deben escribir en maysculas. Si es as, el cdigo simplemente sale de la sentencia switch. Por otra parte, si hubiera que escribir la palabra en maysculas, se har en varios pasos, como se indica a continuacin:
1 La primera letra de la palabra se extrae mediante substr(0, 1), que extrae una subcadena que empieza por el
carcter correspondiente al ndice 0 (la primera letra de la cadena, como indica el primer parmetro 0). La subcadena tendr una longitud de un carcter (como indica el segundo parmetro, 1).
2 El carcter se convierte a mayscula mediante el mtodo toUpperCase(). 3 Los caracteres restantes de la palabra original se extraen mediante substring(1), que extrae una subcadena que
empieza en el ndice 1 (la segunda letra) hasta el final de la cadena (lo que se indica omitiendo el segundo parmetro del mtodo substring()).
4 La ltima palabra se crea combinando la primera letra que se acaba de convertir en mayscula con las restantes
24
var result:String = ""; // Loop through the rows of pixels top to bottom: for (var y:uint = 0; y < _data.height; y += verticalResolution) { // Within each row, loop through pixels left to right: for (var x:uint = 0; x < _data.width; x += horizontalResolution) { ... // Convert the gray value in the 0-255 range to a value // in the 0-64 range (since that's the number of "shades of // gray" in the set of available characters): index = Math.floor(grayVal / 4); result += palette.charAt(index); } result += "\n"; } return result;
Este cdigo define primero una instancia de String denominada result que se utilizar para generar la versin de arte ASCII de la imagen de mapa de bits. A continuacin, recorre pxeles individuales de la imagen de mapa de bits original. Utiliza varias tcnicas de manipulacin de colores (que se omiten aqu por brevedad), convierte los valores de los colores rojo, verde y azul de un pxel individual en un solo valor de escala de grises (un nmero entre 0 y 255). A continuacin el cdigo divide ese valor por 4 (como se indica) para convertirlo en un valor en la escala 0-63, que se almacena en la variable index. (Se utiliza la escala 0-63 porque la "paleta" de caracteres ASCII disponibles que utiliza esta aplicacin contiene 64 valores.) La paleta de caracteres se define como una instancia de String en la clase BitmapToAsciiConverter:
// The characters are in order from darkest to lightest, so that their // position (index) in the string corresponds to a relative color value // (0 = black). private static const palette:String = "@#$%&8BMW*mwqpdbkhaoQ0OZXYUJCLtfjzxnuvcr[]{}1()|/?Il!i><+_~-;,. ";
Como la variable index define el carcter ASCII de la paleta que corresponde al pxel actual de la imagen de mapa de bits, ese carcter se recupera de la instancia String de la paleta mediante el mtodo charAt(). A continuacin se aade result a la instancia de tipo String mediante el operador de concatenacin y asignacin (+=). Adems, al final de cada fila de pxeles, un carcter de nueva lnea se concatena con el final de la cadenaresult, lo que fuerza un ajuste de lnea para crear una nueva fila de "pxeles" de caracteres.
25
Ms temas de ayuda
Array Vector
26
A menudo, se utiliza un conjunto indexado para guardar varios elementos del mismo tipo (objetos que son instancias de la misma clase). La clase Array no tiene capacidad para restringir el tipo de elementos que contiene. La clase Vector es un tipo de conjunto indexado en el que todos los elementos de un conjunto simple son del mismo tipo. Al utilizar una instancia de Vector en lugar de una instancia de Array, tambin se consiguen mejoras de rendimiento y otras ventajas. la clase Vector est disponible a partir de Flash Player 10 y Adobe AIR 1.5. Un uso especial de un conjunto indexado es un conjunto multidimensional. Un conjunto multidimensional es un conjunto indexado cuyos elementos son conjuntos indexados (que, a su vez, contienen otros elementos). Otro tipo de conjunto es el conjunto asociativo, que utiliza una clave de tipo String en lugar de un ndice numrico para identificar elementos individuales. Por ltimo, ActionScript 3.0 tambin contiene la clase Dictionary, que representa un diccionario. Un diccionario es un conjunto que permite utilizar cualquier tipo de objeto como clave para distinguir entre elementos. Conceptos y trminos importantes La siguiente lista de referencia contiene trminos importantes que aparecern al programar rutinas de administracin de vectores y conjuntos:
Conjunto Objeto que se utiliza como contenedor para agrupar varios objetos. Operador de acceso a conjunto ([]) Par de corchetes que rodean un ndice o una clave que identifica de forma exclusiva
a un elemento de conjunto. Esta sintaxis se utiliza despus de un nombre de variable de conjunto para especificar un solo elemento del conjunto, no el conjunto completo.
Conjunto asociativo Conjunto que utiliza claves de tipo cadena para identificar elementos individuales. Tipo base Tipo de datos que puede almacenar una instancia de Vector. Diccionario Conjunto cuyos elementos constan de un par de objetos, denominados clave y valor. Se utiliza la clave en
diccionario.
Conjunto multidimensional Conjunto que contiene elementos que son conjuntos en lugar de valores individuales. T Convencin estndar que se utiliza en esta documentacin para representar el tipo base de una instancia de Vector, independientemente del tipo base. La convencin T se utiliza para representar un nombre de clase, tal como se indica en la descripcin del parmetro Type. (T viene de tipo, como en tipo de datos.) Parmetro Type Sintaxis que se utiliza en el nombre de la clase Vector para especificar el tipo base del vector (tipo de datos de los objetos que almacena). La sintaxis est formada por un punto (.) seguido del nombre del tipo de datos encerrado entre parntesis angulares (<>). Todo junto, presenta el siguiente aspecto: Vector.<T>. En esta documentacin, la clase especificada en el parmetro Type se representa genricamente como T. Vector Tipo de conjunto cuyos elementos son todos instancias del mismo tipo de datos.
27
Conjuntos indexados
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior Los conjuntos indexados almacenan una serie de uno o varios valores organizados de forma que se pueda acceder a cada valor mediante un valor entero sin signo. El primer nmero de ndice siempre es 0 y aumenta una unidad por cada elemento que se aada al conjunto. En ActionScript 3.0, se utilizan dos clases como conjuntos indexados: la clase Array y la clase Vector. Los conjuntos indexados usan un entero de 32 bits sin signo como nmero de ndice. El tamao mximo de un conjunto indexado es 232 - 1 4.294.967.295. Si se intenta crear un conjunto de tamao superior al tamao mximo, se producir un error en tiempo de ejecucin. Para acceder a un elemento individual de un conjunto indexado, debe utilizarse el operador de acceso a conjunto ([]) para especificar la posicin del ndice del elemento al que se desee acceder. Por ejemplo, el siguiente cdigo representa el primer elemento (elemento en el ndice 0) de un conjunto indexado llamado songTitles:
songTitles[0]
La combinacin del nombre de la variable de conjunto seguido del ndice entre corchetes hace las veces de identificador nico. (Dicho de otro modo, se puede utilizar en cualquier situacin en la que se utilizara un nombre de variable). Es posible asignar un valor a un elemento de conjunto indexado utilizando el nombre y el ndice situados a la izquierda de la sentencia de asignacin:
songTitles[1] = "Symphony No. 5 in D minor";
Del mismo modo, se puede recuperar el valor de un elemento de conjunto indexado utilizando el nombre y el ndice situados a la derecha de una sentencia de asignacin:
var nextSong:String = songTitles[2];
Tambin se puede utilizar una variable entre corchetes, en vez de proporcionar un valor explcito. (La variable debe contener un valor entero no negativo, como un uint, un int positivo o una instancia positiva entera de Number). Esta tcnica suele utilizarse para recorrer en bucle los elementos de un conjunto indexado y llevar a cabo una operacin en uno o en todos los elementos. El siguiente cdigo muestra esta tcnica. El cdigo utiliza un bucle para acceder a cada valor de un objeto Array llamado oddNumbers. Utiliza la sentencia trace() para imprimir cada valor con la forma oddNumber[ndice] = valor:
var oddNumbers:Array = [1, 3, 5, 7, 9, 11]; var len:uint = oddNumbers.length; for (var i:uint = 0; i < len; i++) { trace("oddNumbers[" + i.toString() + "] = " + oddNumbers[i].toString()); }
Clase Array El primer tipo de conjunto indexado es la clase Array. Una instancia de Array puede contener un valor de cualquier tipo de datos. El mismo objeto Array puede contener objetos que sean de distinto tipo de datos. Por ejemplo, una sola instancia de Array puede tener un valor de String en el ndice 0, una instancia de Number en el ndice 1 y un objeto XML en el ndice 2. Clase Vector Otro tipo de conjunto indexado disponible en ActionScript 3.0 es la clase Vector. Una instancia de Vector es un conjunto de tipos, lo que significa que todos los elementos de una instancia de Vector siempre son del mismo tipo.
28
Nota: la clase Vector est disponible a partir de Flash Player 10 y Adobe AIR 1.5. Al declarar una variable Vector o crear una instancia de un objeto Vector, se especifica explcitamente el tipo de datos de los objetos que dicho vector puede contener. El tipo de datos especificado se conoce como tipo base del vector. En tiempo de ejecucin y de compilacin (en modo estricto), se comprueba cualquier cdigo que establezca el valor de un elemento Vector o que recupere un valor desde un vector. Si el tipo de datos del objeto que se aade o se recupera no coincide con el tipo base del vector, se produce un error. Adems de la restriccin del tipo de datos, la clase Vector tiene otras limitaciones que la distinguen de la clase Array:
Una vector es un conjunto denso. Un objeto Array puede tener valores en los ndices 0 y 7, incluso si no tiene
valores en las posiciones 1-6. Sin embargo, un vector debe tener un valor (o null) en todos los ndices.
Opcionalmente, un vector puede tener longitud fija. Esto significa que el nmero de elementos contenidos por el
vector no puede cambiar.
El acceso a los elementos de un vector est definido por sus lmites. Nunca se puede leer un valor de un ndice
superior a la (longitud - 1) del elemento final. Nunca se puede establecer un valor con un ndice superior al ndice final actual. Dicho de otro modo, slo se puede establecer un valor en un ndice existente o en una [longitud] de ndice. La consecuencia de estas restricciones hace que utilizar un vector presente tres ventajas principales frente a una instancia de Array cuyos elementos sean todos instancias de una sola clase:
Rendimiento: el acceso y la iteracin en los elementos de un conjunto son mucho ms rpidos si se utiliza una
instancia de Vector y no una de Array.
Seguridad de tipos: en modo estricto, el compilador puede identificar errores de tipos de datos. Algunos ejemplos
de este tipo de errores incluyen la asignacin de un valor del tipo de datos incorrecto a un vector, o esperar un tipo de datos incorrecto al leer un valor en un vector. En tiempo de ejecucin, los tipos de datos tambin se comprueban al aadir datos o leerlos en un objeto Vector. Tenga en cuenta, no obstante, que cuando se utiliza el mtodo push() o el mtodo unshift() para aadir valores a un vector, los tipos de datos de los argumentos no se comprueban en tiempo de compilacin. Cuando se utilizan estos mtodos, los valores se siguen comprobando en tiempo de ejecucin.
Fiabilidad: la comprobacin del rango del motor de ejecucin (o la comprobacin de la longitud fija) aumenta la
fiabilidad sobre los conjuntos en gran medida. Dejando a un lado las restricciones y ventajas adicionales, la clase Vector es muy similar a la clase Array. Las propiedades y los mtodos de un objeto Vector son similares (la mayora de las veces, idnticos) a las propiedades y mtodos de un objeto Array. En la mayor parte de las situaciones en las que utilizara un objeto Array con todos sus elementos del mismo tipo de datos, es preferible usar una instancia del objeto Vector.
Creacin de conjuntos
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior Se pueden utilizar diversas tcnicas para crear una instancia de Array o una instancia de Vector. No obstante, las tcnicas para crear cada tipo de conjunto son ligeramente distintas.
29
La funcin constructora de Array() se puede utilizar de tres maneras distintas. En primer lugar, si se llama al constructor sin argumentos, se obtiene un conjunto vaco. Se puede utilizar la propiedad length de la clase Array para comprobar que el conjunto no tiene elementos. Por ejemplo, el cdigo siguiente llama al constructor de Array() sin argumentos:
var names:Array = new Array(); trace(names.length); // output: 0
En segundo lugar, si se utiliza un nmero como nico parmetro del constructor de Array(), se crea un conjunto de esa longitud y se establece el valor de cada elemento en undefined. El argumento debe ser un entero sin signo entre 0 y 4.294.967.295. Por ejemplo, el cdigo siguiente llama al constructor de Array() con un solo argumento numrico:
var names:Array = new Array(3); trace(names.length); // output: 3 trace(names[0]); // output: undefined trace(names[1]); // output: undefined trace(names[2]); // output: undefined
En tercer lugar, si se llama al constructor y se le pasa una lista de elementos como parmetros, se crea un conjunto con elementos correspondientes a cada uno de los parmetros. El cdigo siguiente pasa tres argumentos al constructor de Array():
var names:Array = new Array("John", "Jane", "David"); trace(names.length); // output: 3 trace(names[0]); // output: John trace(names[1]); // output: Jane trace(names[2]); // output: David
Tambin es posible crear conjuntos con literales de conjunto. Un literal de conjunto se puede asignar directamente a una variable de tipo conjunto, como se indica en el siguiente ejemplo:
var names:Array = ["John", "Jane", "David"];
En la primera lnea del ejemplo, la variable v se declara como una instancia de Vector.<String>. Es decir, representa un conjunto indexado que slo puede contener instancias de String. La segunda lnea llama al constructor Vector() para crear una instancia del mismo tipo de vector (es decir, un vector cuyos elementos sean todos objetos String). Asigna el objeto a v.
30
Uso del constructor Vector.<T>() Si utiliza el constructor Vector.<T>() sin ningn argumento, crea una instancia vaca de Vector. Puede comprobar si un vector est vaco observando su propiedad length. Por ejemplo, el siguiente cdigo llama al constructor Vector.<T>() sin ningn argumento:
var names:Vector.<String> = new Vector.<String>(); trace(names.length); // output: 0
Si conoce con antelacin el nmero de elementos que necesita el vector inicialmente, puede predefinir el nmero de elementos contenidos en Vector. Para crear un vector con un determinado nmero de elementos, transfiera el nmero de elementos como primer parmetro (el parmetro length). Puesto que los elementos Vector no pueden estar vacos, se llenan con instancias del tipo base. Si el tipo base es un tipo de referencia que admite valores null, todos los elementos contendrn null. En caso contrario, todos los elementos contienen el valor predeterminado para la clase. Por ejemplo, una variable uint no puede ser null. En consecuencia, en el siguiente cdigo, el vector llamado ages se crea con siete elementos (cada uno con el valor 0):
var ages:Vector.<uint> = new Vector.<uint>(7); trace(ages); // output: 0,0,0,0,0,0,0
Finalmente, con el constructor Vector.<T>(), tambin es posible crear un vector de longitud fija si se transfiere true como segundo parmetro (el parmetro fixed). En ese caso, el vector se crea con el nmero especificado de elementos y este nmero no puede cambiar. Debe tenerse en cuenta, no obstante, que sigue siendo posible cambiar los valores de los elementos de un vector de longitud fija. Uso del constructor de sintaxis literal de Vector En Flash Professional CS5, Flash Builder 4, Flex 4 y versiones posteriores de estas aplicaciones, se puede transmitir una lista de valores al constructor Vector.<T>() para especificar los valores iniciales de Vector:
// var v:Vector.<T> = new <T>[E0, ..., En-1 ,]; // For example: var v:Vector.<int> = new <int>[0,1,2,];
La coma final es opcional. Los elementos vacos del conjunto no se admiten; una sentencia como, por ejemplo, var
<int>[0,,2,] genera un error del compilador. v:Vector.<int> = new
No se puede especificar una longitud predeterminada para la instancia de Vector. En cambio, la longitud es la
misma que el nmero de elementos en la lista de inicializacin.
No es posible especificar si la instancia de Vector presenta una longitud fija. En su lugar, utilice la propiedad fixed. Los errores o la prdida de datos se pueden producir si los elementos transmitidos como valores no coinciden con
el tipo especificado. Por ejemplo:
var v:Vector.<int> = new <int>[4.2]; // compiler error when running in strict mode trace(v[0]); //returns 4 when not running in strict mode
Uso de la funcin global Vector.<T>() Adems del constructor Vector.<T>() y los constructores de sintaxis literal de Vector, tambin se puede utilizar la funcin global Vector.<T>() para crear un objeto Vector. La funcin global Vector.<T>() es una funcin de conversin. Al llamar a la funcin global Vector.<T>(), se especifica el tipo base del vector devuelto por el mtodo. Se transfiere un conjunto indexado sencillo (instancia de Array o de Vector) como argumento. El mtodo devuelve un vector con el tipo base especificado y con los valores del argumento del conjunto original. El siguiente cdigo muestra la sintaxis para llamar a la funcin global Vector.<T>():
31
La funcin global Vector.<T>() lleva a cabo la conversin de tipos de datos en dos niveles. En primer lugar, cuando se transfiere una instancia de Array a la funcin, se devuelve una instancia de Vector. En segundo lugar, sea o no el conjunto original una instancia de Array o de Vector, la funcin intenta convertir los elementos del conjunto original en valores del tipo base. La conversin utilizar reglas de conversin estndar de tipos de datos de ActionScript. Por ejemplo, el siguiente cdigo convierte los valores de String del objeto Array original en enteros del vector resultante. La parte decimal del primer valor ("1.5") se corta y el tercer valor no numrico ("Waffles") se convierte a 0 en el resultado:
var numbers:Vector.<int> = Vector.<int>(["1.5", "17", "Waffles"]); trace(numbers); // output: 1,17,0
Si no es posible convertir alguno de los elementos originales, se produce un error. Cuando el cdigo llama a la funcin global Vector.<T>(), si un elemento del conjunto original es una instancia de una subclase del tipo base especificado, el elemento se aade al vector resultante (y no se produce ningn error). Utilizar la funcin global Vector.<T>() es el nico modo de convertir un vector con tipo base T en uno con un tipo base que sea una superclase de T.
Si el objeto Array o Vector no tiene an ningn elemento en ese ndice, ste se crea y se almacena el valor en l. Si ya existe un valor en el ndice, el nuevo valor sustituye al existente. Un objeto Array permite crear un elemento en cualquier ndice. Sin embargo, con un objeto Vector slo es posible asignar un valor a un ndice existente o al siguiente ndice disponible. El siguiente ndice disponible corresponde a la propiedad length del objeto Vector. El modo ms seguro de aadir un nuevo elemento a un objeto Vector es utilizar un cdigo como el siguiente:
myVector[myVector.length] = valueToAdd;
Tres de los mtodos de la clase Array y Vector (push(), unshift() y splice()) permiten insertar elementos en un conjunto indexado. El mtodo push() aade uno o varios elementos al final de un conjunto. Es decir, el ltimo elemento insertado en el conjunto mediante el mtodo push() tendr el nmero de ndice ms alto. El mtodo unshift() inserta uno o ms elementos al principio de un conjunto, que siempre tiene el nmero de ndice 0. El mtodo splice() insertar un nmero arbitrario de elementos en un ndice especificado del conjunto. En el ejemplo siguiente se ilustran los tres mtodos. Un conjunto denominado planets se crea para almacenar los nombres de los planetas en orden de proximidad al sol. En primer lugar, se llama al mtodo push() para agregar el elemento inicial, Mars. En segundo lugar, se llama al mtodo unshift() para insertar el elemento que debe estar al principio del conjunto, Mercury. Por ltimo, se llama al mtodo splice() para insertar los elementos Venus y Earth a continuacin de Mercury, pero antes de Mars. El primer argumento enviado a splice(), el entero 1, dirige la insercin para que se realice en el nmero de ndice 1. El segundo argumento enviado a splice(), el entero 0, indica que no se debe eliminar ningn elemento. Por ltimo, el tercer y el cuarto argumento enviados a splice(), Venus y Earth son los elementos que se van a insertar.
32
var planets:Array = new Array(); planets.push("Mars"); // array contents: Mars planets.unshift("Mercury"); // array contents: Mercury,Mars planets.splice(1, 0, "Venus", "Earth"); trace(planets); // array contents: Mercury,Venus,Earth,Mars
Los mtodos push() y unshift() devuelven un entero sin signo que representa la longitud del conjunto modificado. El mtodo splice() devuelve un conjunto vaco cuando se utiliza para insertar elementos, algo que puede parecer extrao, pero que tiene sentido si se tiene en cuenta la versatilidad que ofrece splice(). Se puede utilizar el mtodo splice() no slo para insertar elementos en un conjunto, sino tambin para eliminar elementos de un conjunto. Cuando se utiliza para eliminar elementos, el mtodo splice() devuelve un conjunto que contiene los elementos eliminados. Nota: si la propiedad fixed de un objeto Vector es true, el nmero total de elementos de dicho vector es invariable. Si intenta aadir un nuevo elemento a un vector de longitud fija con las tcnicas descritas anteriormente, se producir un error.
Se puede intentar recuperar un valor de un objeto Array o Vector utilizando un ndice en el que no exista ningn elemento. En ese caso, un objeto Array devuelve el valor undefined y un objeto Vector emite una excepcin RangeError. Tres mtodos de las clases Array y Vector (pop(), shift() y splice()) permiten eliminar elementos. El mtodo pop() elimina un elemento del final del conjunto. Es decir, elimina el elemento que tenga el nmero de ndice ms alto. El mtodo shift() elimina un elemento del principio del conjunto, lo que significa que siempre elimina el elemento con el nmero de ndice 0. El mtodo splice(), que tambin se puede utilizar para insertar elementos, elimina un nmero arbitrario de elementos empezando por el que tiene el nmero de ndice especificado por el primer argumento enviado al mtodo. En el ejemplo siguiente se utilizan los tres mtodos para eliminar elementos de una instancia de Array. Se crea un conjunto denominado oceans para almacenar los nombres de grandes masas de agua. Algunos de los nombres del conjunto son lagos, no ocanos, por lo que hay que eliminarlos. En primer lugar, se utiliza el mtodo splice() para eliminar los elementos Aral y Superior, e insertar los elementos Atlantic e Indian. El primer argumento enviado a splice(), el entero 2, indica que la operacin debe empezar por el tercer elemento de la lista, que tiene el ndice 2. El segundo argumento, 2, indica que hay que eliminar dos elementos. Los restantes argumentos, Atlantic e Indian, son valores que deben insertarse a partir del ndice 2. En segundo lugar, se utiliza el mtodo pop() para eliminar el ltimo elemento del conjunto, Huron. Y por ltimo, se utiliza el mtodo shift() para eliminar el primer elemento del conjunto, Victoria.
var oceans:Array = ["Victoria", "Pacific", "Aral", "Superior", "Indian", "Huron"]; oceans.splice(2, 2, "Arctic", "Atlantic"); // replaces Aral and Superior oceans.pop(); // removes Huron oceans.shift(); // removes Victoria trace(oceans);// output: Pacific,Arctic,Atlantic,Indian
33
Los mtodos pop() y shift() devuelven el elemento eliminado. En una instancia de Array, el tipo de datos del valor devuelto es Object, ya que los conjuntos pueden contener valores de cualquier tipo de datos. En una instancia de Vector, el tipo de datos del valor es el tipo base del vector. El mtodo splice() devuelve un objeto Array o Vector que contiene los valores eliminados. Se puede modificar el ejemplo del conjunto oceans de forma que la llamada a splice() asigne el conjunto devuelto a una nueva variable de Array, como se indica en el siguiente ejemplo:
var lakes:Array = oceans.splice(2, 2, "Arctic", "Atlantic"); trace(lakes); // output: Aral,Superior
Es posible encontrar cdigo que utilice el operador delete en un elemento del objeto Array. El operador delete establece el valor de un elemento de conjunto en undefined, pero no elimina el elemento del objeto Array. Por ejemplo, el cdigo siguiente utiliza el operador delete en el tercer elemento del conjunto oceans, pero la longitud del conjunto sigue siendo 5:
var oceans:Array = ["Arctic", "Pacific", "Victoria", "Indian", "Atlantic"]; delete oceans[2]; trace(oceans);// output: Arctic,Pacific,,Indian,Atlantic trace(oceans[2]); // output: undefined trace(oceans.length); // output: 5
Se puede utilizar la propiedad length de un conjunto para truncar un objeto Array o Vector. Si se establece la propiedad length de un conjunto indexado como una longitud inferior a la longitud actual del conjunto, ste se trunca y se eliminan todos los valores almacenados en los nmeros de ndice superiores al nuevo valor de length menos 1. Por ejemplo, si el conjunto oceans se ordena de modo que todas las entradas vlidas estn al principio del conjunto, se puede utilizar la propiedad length para eliminar las entradas situadas al final, tal como se indica en el siguiente cdigo:
var oceans:Array = ["Arctic", "Pacific", "Victoria", "Aral", "Superior"]; oceans.length = 2; trace(oceans); // output: Arctic,Pacific
Nota: si la propiedad fixed de un objeto Vector es true, el nmero total de elementos de dicho vector es invariable. Si intenta eliminar o truncar un elemento de un vector de longitud fija utilizando las tcnicas descritas anteriormente, se producir un error.
Ordenacin de un conjunto
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior Hay tres mtodos, reverse(), sort() y sortOn(), que permiten cambiar el orden de un conjunto indexado, ordenando o invirtiendo el orden. Todos estos mtodos modifican el conjunto existente. En la tabla siguiente se resumen estos mtodos y su comportamiento en los objetos Array y Vector:
Mtodo
reverse()
Comportamiento de Array Cambia el orden del conjunto de forma que el ltimo elemento se convierte en el primero, el penltimo elemento se convierte en el segundo, etc.
sort()
Permite ordenar los elementos del conjunto de diversas formas Ordena los elementos segn el algoritmo de predefinidas, por ejemplo, por orden alfabtico o numrico. Tambin es ordenacin personalizado especificado. posible especificar un algoritmo de ordenacin personalizado. Permite ordenar objetos con una o varias propiedades comunes y utilizar las propiedades como claves de ordenacin. No disponible en la clase Vector.
sortOn()
34
Mtodo reverse() El mtodo reverse() no admite parmetros y no devuelve un valor, pero permite alternar el orden del conjunto de su estado actual al orden inverso. El ejemplo siguiente invierte el orden de los ocanos que se muestra en el conjunto oceans:
var oceans:Array = ["Arctic", "Atlantic", "Indian", "Pacific"]; oceans.reverse(); trace(oceans); // output: Pacific,Indian,Atlantic,Arctic
Ordenacin bsica con el mtodo sort() (slo en la clase Array) En una instancia de Array, el mtodo sort() reorganiza los elementos de un conjunto con el orden de clasificacin predeterminado. El orden de clasificacin predeterminado tiene las siguientes caractersticas:
En la ordenacin se distinguen maysculas de minsculas, lo que significa que los caracteres en maysculas
preceden a los caracteres en minsculas. Por ejemplo, la letra D precede a la letra b.
La ordenacin es ascendente, lo que significa que los cdigos de caracteres inferiores (como A) preceden a los
cdigos de caracteres superiores (como B).
La ordenacin coloca juntos los valores idnticos, pero no usa un orden especfico. La ordenacin se basa en cadenas, lo que significa que los elementos se convierten en cadenas antes de ser
comparados (por ejemplo, 10 precede a 3 porque el cdigo de carcter de la cadena "1" es inferior al de la cadena "3"). A veces hay que ordenar el conjunto sin tener en cuenta maysculas o minsculas, o en orden descendente, o si el conjunto contiene nmeros hay que ordenar numricamente en lugar de alfabticamente. El mtodo sort() de la clase Array tiene un parmetro options que permite modificar todas las caractersticas del orden de clasificacin predeterminado. Las opciones se definen mediante un conjunto de constantes estticas de la clase Array, como se indica en la lista siguiente:
Array.CASEINSENSITIVE: esta opcin hace que no se tengan en cuenta las diferencias de maysculas y minsculas
En el ejemplo siguiente se ilustran algunas de estas opciones. Se crea un conjunto denominado poets que se ordena con varias opciones distintas.
var poets:Array = ["Blake", "cummings", "Angelou", "Dante"]; poets.sort(); // default sort trace(poets); // output: Angelou,Blake,Dante,cummings poets.sort(Array.CASEINSENSITIVE); trace(poets); // output: Angelou,Blake,cummings,Dante poets.sort(Array.DESCENDING); trace(poets); // output: cummings,Dante,Blake,Angelou poets.sort(Array.DESCENDING | Array.CASEINSENSITIVE); // use two options trace(poets); // output: Dante,cummings,Blake,Angelou
35
Ordenacin personalizada con el mtodo sort() (clases Array y Vector) Adems de la ordenacin bsica disponible en los objetos Array, tambin es posible definir una regla de ordenacin personalizada. Esta tcnica es la nica forma del mtodo sort() disponible para la clase Vector. Para definir una ordenacin personalizada, debe escribir una funcin de ordenacin personalizada y transferirla como argumento al mtodo sort(). Por ejemplo, si se tiene una lista de nombres en la que cada elemento de la lista contiene el nombre completo de una persona, pero se desea ordenar la lista por apellido, hay que utilizar una funcin de ordenacin personalizada que analice cada elemento y use el apellido en la funcin de ordenacin. El cdigo siguiente muestra cmo se puede hacer esto con una funcin personalizada que se utiliza como parmetro del mtodo Array.sort():
var names:Array = new Array("John Q. Smith", "Jane Doe", "Mike Jones"); function orderLastName(a, b):int { var lastName:RegExp = /\b\S+$/; var name1 = a.match(lastName); var name2 = b.match(lastName); if (name1 < name2) { return -1; } else if (name1 > name2) { return 1; } else { return 0; } } trace(names); // output: John Q. Smith,Jane Doe,Mike Jones names.sort(orderLastName); trace(names); // output: Jane Doe,Mike Jones,John Q. Smith
La funcin de ordenacin personalizada orderLastName() utiliza una expresin regular para extraer el apellido de cada elemento que se va a utilizar para la operacin de comparacin. Se utiliza el identificador de la funcin orderLastName como nico parmetro al llamar al mtodo sort() del conjunto names. La funcin de ordenacin acepta dos parmetros, a y b, ya que procesa dos elementos de conjunto cada vez. El valor devuelto por la funcin de ordenacin indica cmo deben ordenarse los elementos:
Si el valor devuelto es -1, indica que el primer parmetro, a, precede al segundo parmetro, b. Si el valor devuelto es 1, indica que el segundo parmetro, b, precede al primero, a. Si el valor devuelto es 0, indica que los elementos tienen igual precedencia de ordenacin.
Mtodo sortOn() (slo en la clase Array) El mtodo sortOn() est diseado para objetos Array con elementos que contienen objetos. Se espera que estos objetos tengan al menos una propiedad en comn que se pueda utilizar como criterio de ordenacin. El uso del mtodo sortOn() en conjuntos de cualquier otro tipo puede producir resultados inesperados. Nota: la clase Vector no incluye un mtodo sortOn(). Este mtodo slo est disponible en objetos Array. El ejemplo siguiente revisa el conjunto poets de forma que cada elemento sea un objeto en lugar de una cadena. Cada objeto contiene el apellido del poeta y el ao de nacimiento.
36
var poets:Array = new Array(); poets.push({name:"Angelou", born:"1928"}); poets.push({name:"Blake", born:"1757"}); poets.push({name:"cummings", born:"1894"}); poets.push({name:"Dante", born:"1265"}); poets.push({name:"Wang", born:"701"});
Se puede utilizar el mtodo sortOn() para ordenar el conjunto por la propiedad born. El mtodo sortOn() define dos parmetros, fieldName y options. El argumento fieldName debe especificarse como una cadena. En el ejemplo siguiente, se llama a sortOn() con dos argumentos, "born" y Array.NUMERIC. Se utiliza el argumento Array.NUMERIC para asegurarse de que la ordenacin se realiza numricamente en lugar de alfabticamente. Esto es una prctica recomendable, incluso en el caso de que todos los nmeros tengan el mismo nmero de dgitos, ya que garantiza que la ordenacin seguir comportndose de la manera esperada si posteriormente se aade un nmero con menos (o ms) dgitos al conjunto.
poets.sortOn("born", Array.NUMERIC); for (var i:int = 0; i < poets.length; ++i) { trace(poets[i].name, poets[i].born); } /* output: Wang 701 Dante 1265 Blake 1757 cummings 1894 Angelou 1928 */
Ordenacin sin modificar el conjunto original (slo en la clase Array) Generalmente, los mtodos sort() y sortOn() modifican un conjunto. Si se desea ordenar un conjunto sin modificarlo, se debe pasar la constante Array.RETURNINDEXEDARRAY como parte del parmetro options. Esta opcin ordena a los mtodos que devuelvan un nuevo conjunto que refleje la ordenacin y deje el conjunto original sin cambios. El conjunto devuelto por los mtodos es un conjunto simple de nmeros de ndice que refleja el nuevo orden de clasificacin y no contiene ningn elemento del conjunto original. Por ejemplo, para ordenar el conjunto poets por ao de nacimiento sin modificar el conjunto, se debe incluir la constante Array.RETURNINDEXEDARRAY como parte del argumento pasado para el parmetro options. El ejemplo siguiente almacena la informacin de ndice devuelta en un conjunto denominado indices y utiliza el conjunto indices junto con el conjunto poets sin modificar para mostrar los poetas ordenados por ao de nacimiento:
var indices:Array; indices = poets.sortOn("born", Array.NUMERIC | Array.RETURNINDEXEDARRAY); for (var i:int = 0; i < indices.length; ++i) { var index:int = indices[i]; trace(poets[index].name, poets[index].born); } /* output: Wang 701 Dante 1265 Blake 1757 cummings 1894 Angelou 1928 */
37
Se pueden utilizar los mtodos join() y toString() para consultar el conjunto y devolver su contenido en forma de cadena. Si no se utiliza ningn parmetro para el mtodo join(), los dos mtodos se comportarn de forma idntica: devolvern una cadena que contiene una lista delimitada por comas de todos los elementos del conjunto. El mtodo join(), a diferencia del mtodo toString(), admite un parmetro denominado delimiter, que permite elegir el smbolo que se debe utilizar como separador entre cada elemento de la cadena devuelta. En el ejemplo siguiente se crea un conjunto denominado rivers y se llama a join() y toString() para devolver los valores del conjunto en forma de cadena. El mtodo toString() se utiliza para devolver valores separados por comas (riverCSV), mientras que el mtodo join() se utiliza para devolver valores separados por el carcter +.
var rivers:Array = ["Nile", "Amazon", "Yangtze", "Mississippi"]; var riverCSV:String = rivers.toString(); trace(riverCSV); // output: Nile,Amazon,Yangtze,Mississippi var riverPSV:String = rivers.join("+"); trace(riverPSV); // output: Nile+Amazon+Yangtze+Mississippi
Una caracterstica del mtodo join() que hay tener en cuenta es que las instancias anidadas de Array o Vector siempre se devuelven con los valores separados por comas, independientemente del separador que se especifique para los elementos del conjunto principal, como se indica en el siguiente ejemplo:
var nested:Array = ["b","c","d"]; var letters:Array = ["a",nested,"e"]; var joined:String = letters.join("+"); trace(joined); // output: a+b,c,d+e
38
Conjuntos asociativos
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior Un conjunto asociativo, tambin denominado a veces hash o asignacin, utiliza claves en lugar de un ndice numrico para organizar los valores almacenados. Cada clave de un conjunto asociativo es una cadena nica que se utiliza para acceder a un valor almacenado. Un conjunto asociativo es una instancia de la clase Object, lo que significa que cada clave corresponde a un nombre de propiedad. Los conjuntos asociativos son colecciones no ordenadas de pares formados por una clave y un valor. Hay que tener en cuenta en el cdigo que las claves de un conjunto asociativo no tienen un orden especfico. ActionScript 3.0 tambin introduce un tipo avanzado de conjunto asociativo denominado dictionary. Los diccionarios, que son instancias de la clase Dictionary del paquete flash.utils, utilizan claves que pueden ser de cualquier tipo de datos. Es decir, las claves de diccionario no estn limitadas a valores de tipo String.
Si no es necesario inicializar el conjunto en el momento de declararlo, se puede utilizar el constructor Object para crear el conjunto de la manera siguiente:
var monitorInfo:Object = new Object();
Una vez creado un conjunto con un literal de objeto o el constructor de la clase Object, se pueden aadir valores nuevos al conjunto mediante el operador de acceso a conjunto ([]) o el operador punto (.). En el ejemplo siguiente se aaden dos valores nuevos a monitorArray:
monitorInfo["aspect ratio"] = "16:10"; // bad form, do not use spaces monitorInfo.colors = "16.7 million"; trace(monitorInfo["aspect ratio"], monitorInfo.colors); // output: 16:10 16.7 million
Hay que tener en cuenta que la clave denominada aspect ratio contiene un espacio en blanco. Esto es posible con el operador de acceso a conjunto ([]) pero genera un error si se intenta con el operador punto. No es recomendable utilizar espacios en los nombres de claves. La segunda forma de crear un conjunto asociativo consiste en utilizar el constructor Array (o el constructor de cualquier clase dinmica) y posteriormente utilizar el operador de acceso a conjunto ([]) o el operador punto (.) para agregar pares de clave y valor al conjunto. Si se declara el conjunto asociativo con el tipo Array, no se podr utilizar un literal de objeto para inicializar el conjunto. En el ejemplo siguiente se crea un conjunto asociativo denominado monitorInfo empleando el constructor de Array y se aaden claves denominadas type y resolution, junto con sus valores:
39
var monitorInfo:Array = new Array(); monitorInfo["type"] = "Flat Panel"; monitorInfo["resolution"] = "1600 x 1200"; trace(monitorInfo["type"], monitorInfo["resolution"]); // output: Flat Panel 1600 x 1200
La utilizacin del constructor de Array para crear un conjunto asociativo no aporta ninguna ventaja. No se puede utilizar la propiedad Array.length ni ninguno de los mtodos de la clase Array con los conjuntos asociativos, incluso si se utiliza el constructor de Array o el tipo de datos Array. Es mejor dejar el uso del constructor de Array para la creacin de conjuntos indexados.
// objects to use as values var groupA:Object = new Object(); var groupB:Object = new Object(); // Create new key-value pairs in dictionary. groupMap[spr1] = groupA; groupMap[spr2] = groupB; groupMap[spr3] = groupB; if (groupMap[spr1] { trace("spr1 is } if (groupMap[spr2] { trace("spr2 is } if (groupMap[spr3] { trace("spr3 is } == groupA) in groupA"); == groupB) in groupB"); == groupB) in groupB");
40
Iteracin con claves de tipo objeto Puede repetir el contenido de un objeto Dictionary con un bucle for..in o un bucle for each..in. El bucle for..in permite la repeticin en funcin de las claves, mientras que el bucle for each..in lo hace en funcin de los valores asociados con cada clave. Utilice el bucle for..in para dirigir el acceso a las claves de tipo Object de un objeto Dictionary. Tambin se puede acceder a los valores del objeto Dictionary con el operador de acceso a conjunto ([]). El cdigo siguiente utiliza el ejemplo anterior del diccionario groupMap para mostrar la forma de repeticin de un objeto Dictionary con el bucle
for..in: for (var key:Object in groupMap) { trace(key, groupMap[key]); } /* output: [object Sprite] [object Object] [object Sprite] [object Object] [object Sprite] [object Object] */
El bucle for each..in para dirigir el acceso a los valores de un objeto Dictionary. El cdigo siguiente tambin utiliza el diccionario groupMap para mostrar la forma de repeticin de un objeto Dictionary con el bucle for each..in:
for each (var item:Object in groupMap) { trace(item); } /* output: [object Object] [object Object] [object Object] */
Claves de tipo objeto y administracin de memoria Adobe Flash Player y Adobe AIR utilizan un sistema de eliminacin de datos innecesarios para recuperar la memoria que ya no se est utilizando. Cuando ya no quedan referencias a un objeto, el objeto se convierte en disponible para la eliminacin de datos innecesarios y se recupera la memoria la prxima vez que se ejecute el sistema de eliminacin de datos innecesarios. Por ejemplo, el cdigo siguiente crea un nuevo objeto y asigna una referencia al objeto a la variable myObject:
var myObject:Object = new Object();
Con que exista una referencia al objeto, el sistema de eliminacin de datos innecesarios no recuperar la memoria ocupada por el objeto. Si se cambia el valor de myObject de forma que haga referencia a un objeto distinto o se establece en el valor null, la memoria ocupada por el objeto original se convierte en disponible para la eliminacin de datos innecesarios, pero slo si no hay otras referencias al objeto original. Si se utiliza myObject como clave de un objeto Dictionary, se crea otra referencia al objeto original. Por ejemplo, el cdigo siguiente crea dos referencias a un objeto: la variable myObject y la clave del objeto myMap:
import flash.utils.Dictionary; var myObject:Object = new Object(); var myMap:Dictionary = new Dictionary(); myMap[myObject] = "foo";
41
Para hacer que el objeto al que hace referencia myObject est disponible para la eliminacin de datos innecesarios, hay que eliminar todas las referencias a dicho objeto. En este caso, hay que cambiar el valor de myObject y eliminar la clave myObject de myMap, como se indica en el cdigo siguiente:
myObject = null; delete myMap[myObject];
Como alternativa, se puede utilizar el parmetro useWeakReference del constructor de Dictionary para convertir todas las claves del diccionario en referencias dbiles. El sistema de eliminacin de datos innecesarios no tiene en cuenta las referencias dbiles, lo que significa que un objeto que slo tenga referencias dbiles estar disponible para la eliminacin de datos innecesarios. Por ejemplo, en el cdigo siguiente no es necesario eliminar la clave myObject de myMap para hacer que el objeto est disponible para la eliminacin de datos innecesarios:
import flash.utils.Dictionary; var myObject:Object = new Object(); var myMap:Dictionary = new Dictionary(true); myMap[myObject] = "foo"; myObject = null; // Make object eligible for garbage collection.
Conjuntos multidimensionales
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior Los conjuntos multidimensionales contienen otros conjuntos como elementos. Piense, por ejemplo, en una lista de tareas almacenadas en forma de conjunto de cadenas indexadas:
var tasks:Array = ["wash dishes", "take out trash"];
Si se desea almacenar una lista independiente de tareas por cada da de la semana, se puede crear un conjunto multidimensional con un elemento por cada da de la semana. Cada elemento contiene un conjunto indexado, similar al conjunto tasks, que almacena la lista de tareas. Se puede utilizar cualquier combinacin de conjuntos indexados o asociativos en conjuntos multidimensionales. Los ejemplos de las secciones siguientes utilizan dos conjuntos indexados o un conjunto asociativo de conjuntos indexados. Se pueden probar las otras combinaciones como ejercicio.
42
var masterTaskList:Array = new Array(); masterTaskList[0] = ["wash dishes", "take out trash"]; masterTaskList[1] = ["wash dishes", "pay bills"]; masterTaskList[2] = ["wash dishes", "dentist", "wash dog"]; masterTaskList[3] = ["wash dishes"]; masterTaskList[4] = ["wash dishes", "clean house"]; masterTaskList[5] = ["wash dishes", "wash car", "pay rent"]; masterTaskList[6] = ["mow lawn", "fix chair"];
Puede acceder a elementos individuales de cualquiera de las listas de tareas mediante el operador de acceso a conjunto ([]). El primer conjunto de corchetes representa el da de la semana y el segundo conjunto de corchetes representa la lista de tareas para ese da. Por ejemplo, para recuperar la segunda tarea de la lista del mircoles, se debe utilizar primero el ndice 2 correspondiente al mircoles y despus el ndice 1 correspondiente a la segunda tarea de la lista.
trace(masterTaskList[2][1]); // output: dentist
Para recuperar la primera tarea de la lista del domingo se debe utilizar el ndice 6 correspondiente al domingo y el ndice 0 correspondiente a la primera tarea de la lista.
trace(masterTaskList[6][0]); // output: mow lawn
La sintaxis con punto facilita la lectura del cdigo al evitar la necesidad de utilizar varios juegos de corchetes.
trace(masterTaskList.Wednesday[1]); // output: dentist trace(masterTaskList.Sunday[0]);// output: mow lawn
Puede repetir la lista de tareas utilizando un bucle for..in, pero debe utilizar el operador de acceso a conjunto ([]) en lugar de la sintaxis de puntos para acceder al valor asociado a cada clave. Como masterTaskList es un conjunto asociativo, los elementos no se recuperan necesariamente en el orden esperado, como se muestra en el siguiente ejemplo:
43
for (var day:String in masterTaskList) { trace(day + ": " + masterTaskList[day]) } /* output: Sunday: mow lawn,fix chair Wednesday: wash dishes,dentist,wash dog Friday: wash dishes,clean house Thursday: wash dishes Monday: wash dishes,take out trash Saturday: wash dishes,wash car,pay rent Tuesday: wash dishes,pay bills */
Clonacin de conjuntos
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior La clase Array no tiene ningn mtodo incorporado para hacer copias de conjuntos. Se puede crear una copiasuperficial de un conjunto llamando a los mtodos concat() o slice() sin argumentos. En una copia superficial, si el conjunto original tiene elementos que son objetos, slo se copian las referencias a los objetos, en lugar de los mismos objetos. La copia seala a los mismos objetos que el conjunto original. Los cambios realizados en los objetos se reflejan en ambos conjuntos. En una copia completa tambin se copian los objetos del conjunto original, de forma que el nuevo conjunto no seale a los mismos objetos que el conjunto original. La copia completa requiere ms de una lnea de cdigo, que normalmente ordenan la creacin de una funcin. Dicha funcin se puede crear como una funcin de utilidad global o como un mtodo de una subclase Array. En el ejemplo siguiente se define una funcin denominada clone() que realiza una copia completa. Se utiliza un algoritmo de una tcnica de programacin comn en Java. La funcin crea una copia completa serializando el conjunto en una instancia de la clase ByteArray y leyendo a continuacin el conjunto en un nuevo conjunto. Esta funcin acepta un objeto de forma que se pueda utilizar tanto con conjuntos indexados como con conjuntos asociativos, como se indica en el cdigo siguiente:
import flash.utils.ByteArray; function clone(source:Object):* { var myBA:ByteArray = new ByteArray(); myBA.writeObject(source); myBA.position = 0; return(myBA.readObject()); }
44
Los cuatro mtodos sustituidos utilizan el espacio de nombres AS3 en lugar del atributo public, ya que en este ejemplo se supone que la opcin de compilador -as3 est establecida en true y la opcin de compilador -es est establecida en false. Esta es la configuracin predeterminada para Adobe Flash Builder y AdobeFlashProfessional.
45
Los programadores expertos que prefieren utilizar herencia de prototipo pueden hacer dos pequeos cambios en la clase TypedArray para que se compile con la opcin de compilador -es establecida en true. En primer lugar, deben quitarse todas las instancias del atributo override y debe sustituirse el espacio de nombres AS3 por el atributo public. En segundo lugar, debe sustituirse Array.prototype para las cuatro instancias de super. Constructor de TypedArray El constructor de la subclase supone un reto interesante, ya que debe aceptar una lista de argumentos de longitud arbitraria. El reto consiste en pasar los argumentos al superconstructor para crear el conjunto. Si se pasa la lista de argumentos en forma de conjunto, el superconstructor considerar que se trata de un solo argumento de tipo Array y el conjunto resultante siempre tendr una longitud de 1 elemento. La manera tradicional de controlar las listas de argumentos es utilizar el mtodo Function.apply(), que admite un conjunto de argumentos como segundo parmetro, pero la convierte en una lista de argumentos al ejecutar la funcin. Por desgracia, el mtodo Function.apply() no se puede utilizar con constructores. La nica opcin que queda es volver a generar la lgica del constructor de Array in el constructor de TypedArray. El cdigo siguiente muestra el algoritmo utilizado en el constructor de clase Array, que se puede reutilizar en el constructor de la subclase de Array:
public dynamic class Array { public function Array(...args) { var n:uint = args.length if (n == 1 && (args[0] is Number)) { var dlen:Number = args[0]; var ulen:uint = dlen; if (ulen != dlen) { throw new RangeError("Array index is not a 32-bit unsigned integer ("+dlen+")"); } length = ulen; } else { length = n; for (var i:int=0; i < n; i++) { this[i] = args[i] } } } }
El constructor de TypedArray comparte la mayor parte del cdigo del constructor de Array, con tan slo cuatro cambios. En primer lugar, la lista de parmetros incluye un nuevo parmetro requerido de tipo Class que permite especificar el tipo de datos del conjunto. En segundo lugar, el tipo de datos pasado al constructor se asigna a la variable dataType. En tercer lugar, en la sentencia else, el valor de la propiedad length se asigna despus del bucle for, de forma que length incluya nicamente argumentos del tipo adecuado. Por ltimo, el cuerpo del bucle for utiliza la versin sustituida del mtodo push() de forma que slo se aadan al conjunto los argumentos que tengan el tipo de datos correcto. En el siguiente ejemplo se muestra la funcin constructora de TypedArray:
46
public dynamic class TypedArray extends Array { private var dataType:Class; public function TypedArray(typeParam:Class, ...args) { dataType = typeParam; var n:uint = args.length if (n == 1 && (args[0] is Number)) { var dlen:Number = args[0]; var ulen:uint = dlen if (ulen != dlen) { throw new RangeError("Array index is not a 32-bit unsigned integer ("+dlen+")") } length = ulen; } else { for (var i:int=0; i < n; i++) { // type check done in push() this.push(args[i]) } length = this.length; } } }
Mtodos sustituidos de TypedArray La clase TypedArray reemplaza los cuatro mtodos de la clase Array que pueden aadir elementos a un conjunto. En cada caso, el mtodo sustituido aade una verificacin de tipos que evita la adicin de elementos que no tienen el tipo de datos correcto. Posteriormente, cada mtodo llama a la versin de s mismo de la superclase. El mtodo push() repite la lista de argumentos con un bucle for..in y realiza una verificacin de tipos en cada argumento. Cualquier argumento que no sea del tipo correcto se quitar del conjunto args con el mtodo splice(). Una vez finalizado el bucle for..in, el conjunto args slo incluir valores de tipo dataType. A continuacin, se llama a la versin de push() de la superclase con el conjunto args actualizada, como se indica en el cdigo siguiente:
AS3 override function push(...args):uint { for (var i:* in args) { if (!(args[i] is dataType)) { args.splice(i,1); } } return (super.push.apply(this, args)); }
El mtodo concat() crea un objeto TypedArray temporal denominado passArgs para almacenar los argumentos que superen la verificacin de tipos. Esto permite reutilizar el cdigo de verificacin de tipos que existe en el mtodo push(). El bucle for..in repite el conjunto args y llama a push() en cada argumento. Como passArgs es de tipo TypedArray, se ejecuta la versin de push() de TypedArray. A continuacin, el mtodo concat() llama a su propia versin de la superclase, como se indica en el cdigo siguiente:
47
AS3 override function concat(...args):Array { var passArgs:TypedArray = new TypedArray(dataType); for (var i:* in args) { // type check done in push() passArgs.push(args[i]); } return (super.concat.apply(this, passArgs)); }
El mtodo splice() admite una lista de argumentos arbitraria, pero los dos primeros argumentos siempre hacen referencia a un nmero de ndice y al nmero de elementos que se desea eliminar. Por esta razn, el mtodo splice() sustituido slo hace la verificacin de tipos para los elementos del conjunto args cuya posicin de ndice sea 2 o superior. Un aspecto interesante del cdigo es que parece una llamada recursiva a splice() desde el bucle for, pero no es una llamada recursiva, ya que args es de tipo Array, no TypedArray, lo que significa que la llamada a args.splice() es una llamada a la versin del mtodo de la superclase. Una vez finalizado el bucle for..in, el conjunto args slo incluir valores del tipo correcto en posiciones cuyo ndice sea 2 o superior, y splice() llamar a su propia versin de la superclase, como se indica en el siguiente cdigo:
AS3 override function splice(...args):* { if (args.length > 2) { for (var i:int=2; i< args.length; i++) { if (!(args[i] is dataType)) { args.splice(i,1); } } } return (super.splice.apply(this, args)); }
El mtodo unshift(), que aade elementos al principio de un conjunto, tambin acepta una lista de argumentos arbitraria. El mtodo unshift() sustituido utiliza un algoritmo muy similar al utilizado por el mtodopush(), como se indica en el siguiente ejemplo cdigo:
AS3 override function unshift(...args):uint { for (var i:* in args) { if (!(args[i] is dataType)) { args.splice(i,1); } } return (super.unshift.apply(this, args)); } }
48
Creacin de un conjunto indexado Aadir elementos a un conjunto indexado Ordenacin de un conjunto de objetos por distintas propiedades y utilizando distintas opciones de ordenacin Conversin de un conjunto en una cadena delimitada por caracteres
Para obtener los archivos de la aplicacin de este ejemplo, consulte www.adobe.com/go/learn_programmingAS3samples_flash_es. Los archivos de la aplicacin PlayList se encuentran en la carpeta Samples/PlayList. La aplicacin consta de los siguientes archivos:
Archivo PlayList.mxml o PlayList.fla com/example/programmingas3/playlist/PlayList.as Una clase que representa una lista de canciones. Utiliza un elemento Array para guardar la lista y gestiona la ordenacin de los elementos de la lista. Un objeto de valor que representa informacin sobre una sola cancin. Los elementos administrados por la clase PlayList son instancias de Song. Una seudoenumeracin cuyos valores disponibles representan las propiedades de la clase Song por las que una lista de objetos Song puede ordenarse. Descripcin El archivo de aplicacin principal en Flash (FLA) o Flex (MXML)
com/example/programmingas3/playlist/Song.as
com/example/programmingas3/playlist/SortProperty.as
Adems de la variable _songs de tipo Array utilizada por la clase PlayList para hacer un seguimiento de su lista de canciones, otras dos variables privadas hacen un seguimiento de si la lista debe ser ordenada (_needToSort) y por qu propiedad est ordenada la lista de canciones en un momento dado (_currentSort).
49
Al igual que ocurre con los objetos, declarar una instancia de Array es slo la mitad del trabajo de crear un objeto Array. Antes de acceder a las propiedades o mtodos de una instancia de Array, hay que crear una instancia en el constructor de la clase PlayList.
public function PlayList() { this._songs = new Array(); // Set the initial sorting. this.sortList(SortProperty.TITLE); }
La primera lnea del constructor crea una instancia de la variable _songs lista para usar. Adems, se llama al mtodo sortList() para establecer la propiedad por la que se va a ordenar inicialmente.
En addSong(), se llama al mtodo push() del conjunto _songs, para aadir el objeto Song que se pas a addSong() como un elemento nuevo del conjunto. Con el mtodo push() se aade el nuevo elemento al final del conjunto, independientemente de la ordenacin que se haya aplicado previamente. Esto significa que tras llamar al mtodo push(), es probable que la lista de canciones ya no est ordenada correctamente, por lo que se establece la variable _needToSort en true. En teora, el mtodo sortList() podra llamarse inmediatamente, lo que eliminara la necesidad de controlar si la lista est ordenada o no en un momento determinado. No obstante, en la prctica no es necesario ordenar la lista de canciones hasta inmediatamente antes de recuperarla. Al aplazar la operacin de ordenacin, la aplicacin no realiza una ordenacin innecesaria si, por ejemplo, se aaden varias canciones a la lista antes de recuperarla.
50
Propiedades para la ordenacin Un objeto Song hace un seguimiento de varias propiedades, como el ttulo de la cancin, el artista, el ao de publicacin, el nombre de archivo y un conjunto de gneros a los que pertenece la cancin seleccionada por el usuario. De stas, slo las tres primeras son prcticas para ordenar. Para mayor comodidad de los desarrolladores, el ejemplo incluye la clase SortProperty, que acta como una enumeracin con valores que representan las propiedades disponibles para ordenar.
public static const TITLE:SortProperty = new SortProperty("title"); public static const ARTIST:SortProperty = new SortProperty("artist"); public static const YEAR:SortProperty = new SortProperty("year");
La clase SortProperty contiene tres constantes, TITLE, ARTIST y YEAR, cada una de las cuales almacena una cadena que contiene el nombre real de propiedad de la clase Song asociada que se puede utilizar para ordenar. En el resto del cdigo, siempre que se indique una propiedad para ordenar, se har con el miembro de la enumeracin. Por ejemplo, en el constructor de PlayList, la lista se ordena inicialmente llamando al mtodo sortList() de la manera siguiente:
// Set the initial sorting. this.sortList(SortProperty.TITLE);
Como la propiedad para ordenar se especifica como SortProperty.TITLE, las canciones se ordenan por su ttulo. Ordenacin por propiedades y especificacin de opciones de ordenacin El trabajo de ordenar la lista de canciones lo realiza la clase PlayList en el mtodo sortList(), de la manera siguiente:
/** * Sorts the list of songs according to the specified property. */ public function sortList(sortProperty:SortProperty):void { ... var sortOptions:uint; switch (sortProperty) { case SortProperty.TITLE: sortOptions = Array.CASEINSENSITIVE; break; case SortProperty.ARTIST: sortOptions = Array.CASEINSENSITIVE; break; case SortProperty.YEAR: sortOptions = Array.NUMERIC; break; } // Perform the actual sorting of the data. this._songs.sortOn(sortProperty.propertyName, sortOptions); // Save the current sort property. this._currentSort = sortProperty; // Record that the list is sorted. this._needToSort = false; }
51
Al ordenar por ttulo o por artista, tiene sentido ordenar alfabticamente, pero al ordenar por ao, es ms lgico realizar una ordenacin numrica. La sentencia switch se utiliza para definir la opcin de ordenacin apropiada, almacenada en la variable sortOptions, segn el valor especificado en el parmetro sortProperty. En este caso tambin se utilizan los miembros de la enumeracin designados para distinguir entre propiedades, en lugar de utilizar valores especificados en el cdigo. Con la propiedad de ordenacin y las opciones de ordenacin determinadas, el conjunto _songs se ordena llamando a su mtodo sortOn() y pasndole esos dos valores como parmetros. Se registra la propiedad de ordenacin actual, ya que la lista de canciones est ordenada actualmente.
Al crear una nueva instancia de Song, se define el parmetro genres que se utiliza para especificar el gnero (o los gneros) al que pertenece la cancin como una instancia de Array. Esto hace que sea cmodo agrupar varios gneros en una sola variable que se puede pasar al constructor. No obstante, internamente la clase Song mantiene los gneros en la variable privada _genres como una instancia de tipo String de valores separados por signos de punto y coma. El parmetro Array se convierte en una cadena de valores separados por signos de punto y coma llamando a su mtodo join() con el valor de literal de cadena ";" como delimitador especificado. Con este mismo smbolo, los descriptores de acceso de genres permiten establecer o recuperar gneros como un conjunto:
public function get genres():Array { // Genres are stored as a semicolon-separated String, // so they need to be transformed into an Array to pass them back out. return this._genres.split(";"); } public function set genres(value:Array):void { // Genres are passed in as an array, // but stored as a semicolon-separated string. this._genres = value.join(";"); }
52
Los descriptores de acceso set de genres se comportan exactamente igual que el constructor; aceptan un conjunto y llaman al mtodo join() para convertirlo en una cadena de valores separados por signos de punto y coma. El descriptor de acceso get realiza la operacin contraria: se llama el mtodo split() de la variable _genres y la cadena se divide en un conjunto de valores utilizando el delimitador especificado (valor de cadena literal ";", como antes).
53
54
Clases Error: muchos errores tienen una clase de error asociada a ellos. Cuando se produce un error, el motor de
ejecucin de Flash (como Flash Player o Adobe AIR) crea una instancia de la clase de error especfica asociada a dicho error. El cdigo puede utilizar informacin contenida en ese objeto de error para generar una respuesta adecuada al error.
Eventos de error: a veces se produce un error cuando el motor de ejecucin de Flash normalmente desencadenara
un evento. En estos casos, se desencadena un evento de error. Cada evento de error tiene una clase asociada y el motor de ejecucin de Flash transmite una instancia de dicha clase a los mtodos que estn suscritos al evento de error. Para determinar si un mtodo concreto puede desencadenar un error o un evento de error, consulte la entrada del mtodo en Referencia de ActionScript 3.0 para la plataforma de Adobe Flash. Conceptos y trminos importantes La siguiente lista de referencia contiene trminos importantes que aparecern al programar rutinas de gestin de errores:
Asincrnico Comando de programa, como una llamada de mtodo que no proporciona un resultado inmediato; en su lugar, origina un resultado (o error) en forma de evento. Capturar Cuando se produce una excepcin (error en tiempo de ejecucin) y el cdigo la reconoce, se dice que el cdigo captura la excepcin. Una vez capturada la excepcin, el motor de ejecucin de Flash deja de notificar la excepcin a otro cdigo ActionScript. Versin de depuracin Versin especial del motor de ejecucin de Flash como, por ejemplo, versin de depuracin de Flash Player o AIR Debug Launcher (ADL), que incluye cdigo para notificar a los usuarios errores en tiempo de ejecucin. En la versin estndar de Flash Player o Adobe AIR (la que tienen la mayora de los usuarios), se omiten los errores no gestionados por el cdigo ActionScript. En las versiones de depuracin (que se incluye en Adobe Flash CS4 Professional y Adobe Flash Builder), aparece un mensaje de advertencia cuando se produce un error no gestionado. Excepcin Error que sucede mientras se ejecuta una aplicacin y que el motor de ejecucin de Flash no puede resolver
por s solo.
Nueva emisin Cuando el cdigo detecta una excepcin, el motor de ejecucin de Flash no vuelve a notificar otros
objetos de la excepcin. Si resulta importante notificar la excepcin a otros objetos, el cdigo debe volver a emitir la excepcin para que se vuelva a iniciar el proceso de notificacin.
Sincrnico Comando de programa, como una llamada de mtodo, que proporciona un resultado inmediato (o emite
inmediatamente un error), lo que implica que la respuesta puede utilizarse con el mismo bloque de cdigo.
Emitir Operacin de notificacin al motor de ejecucin de Flash (y, por lo tanto, notificacin a otros objetos y al cdigo ActionScript) de que se ha producido un error; se conoce como emitir un error.
Tipos de errores
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior Al desarrollar y ejecutar aplicaciones, se detectan diferentes tipos de errores, con su correspondiente terminologa. En la tabla siguiente se presentan los principales tipos de errores y sus trminos relacionados:
El compilador de ActionScript captura los errores en tiempo de compilacin durante la compilacin del cdigo.
Estos errores se producen cuando los problemas sintcticos del cdigo impiden crear la aplicacin.
55
Los errores en tiempo de ejecucin se producen al ejecutar la aplicacin tras compilarla. Los errores en tiempo de
ejecucin representan errores causados mientras un archivo SWF se reproduce en el motor de ejecucin de Flash (como Adobe Flash Player o Adobe AIR). En la mayora de los casos, es posible gestionar los errores en tiempo de ejecucin conforme suceden, informando sobre ellos al usuario y adoptando medidas para que la aplicacin se siga ejecutando. Si el error es grave (por ejemplo, no se puede establecer una conexin con un sitio web remoto o cargar los datos requeridos), se puede recurrir a la gestin de errores para que la aplicacin finalice sin problemas.
Los errores sincrnicos son errores en tiempo de ejecucin que se producen cuando se llama una funcin. Por
ejemplo, si se intenta utilizar un mtodo especfico y el mtodo que se transmite al argumento no es vlido, por lo que el motor de ejecucin de Flash genera una excepcin. La mayor parte de los errores se producen de forma sincrnica (cuando se ejecuta la sentencia) y el flujo del control se pasa inmediatamente a la sentencia catch ms apropiada. Por ejemplo, el fragmento de cdigo siguiente genera un error en tiempo de ejecucin porque no se llama al mtodo
browse() antes de que el programa intente cargar un archivo: var fileRef:FileReference = new FileReference(); try { fileRef.upload(new URLRequest("http://www.yourdomain.com/fileupload.cfm")); } catch (error:IllegalOperationError) { trace(error); // Error #2037: Functions called in incorrect sequence, or earlier // call was unsuccessful. }
En este caso, un error en tiempo de ejecucin se genera sincrnicamente, ya que Flash Player determin que el mtodo browse() no se llam antes de intentar cargar el archivo. Para obtener informacin detallada sobre la gestin de errores sincrnicos, consulte Gestin de errores sincrnicos en una aplicacin en la pgina 59.
Los errores asincrnicos son errores en tiempo de ejecucin que se producen en distintos puntos durante el tiempo
de ejecucin; generan eventos y los detectores de eventos los detectan. En las operaciones asincrnicas, una funcin inicia una operacin, pero no espera a que se complete. Se puede crear un detector de eventos de error para esperar a que la aplicacin o el usuario realicen alguna operacin; si sta falla, el error se captura con un detector de eventos y se responde al evento de error. A continuacin, el detector de eventos llama a una funcin de controlador de eventos para responder al evento de error de una manera til. Por ejemplo, el controlador de eventos puede iniciar un cuadro de dilogo que solicite al usuario que resuelva el error. Considrese el ejemplo de error sincrnico relativo a la carga de archivo presentado anteriormente. Si se llama correctamente al mtodo browse() antes de iniciar una carga de archivo, Flash Player distribuir varios eventos. Por ejemplo, cuando se inicia una carga, se distribuye el evento open. Si la operacin de carga de archivo finaliza correctamente, se distribuye el evento complete. Puesto que la gestin de eventos es asincrnica (es decir, que no se produce en momentos especficos, conocidos y designados previamente), hay que utilizar el mtodo addEventListener() para detectar estos eventos especficos, tal como se muestra en el cdigo siguiente:
56
var fileRef:FileReference = new FileReference(); fileRef.addEventListener(Event.SELECT, selectHandler); fileRef.addEventListener(Event.OPEN, openHandler); fileRef.addEventListener(Event.COMPLETE, completeHandler); fileRef.browse(); function selectHandler(event:Event):void { trace("...select..."); var request:URLRequest = new URLRequest("http://www.yourdomain.com/fileupload.cfm"); request.method = URLRequestMethod.POST; event.target.upload(request); } function openHandler(event:Event):void { trace("...open..."); } function completeHandler(event:Event):void { trace("...complete..."); }
Para obtener informacin detallada sobre la gestin de errores asincrnicos, consulte Respuesta al estado y a los eventos de error en la pgina 64.
Las excepciones no capturadas son errores generados sin una lgica (como una sentencia catch) que pueda
responder a ellos. Si la aplicacin genera un error y no se encuentran controladores de eventos o sentencias catch en el nivel actual o superior para gestionar el error, ste se considera una excepcin no capturada. Cuando se produce un error no capturado, el motor de ejecucin distribuye un evento uncaughtError. Este evento tambin se denomina controlador de error global. Este evento se distribuye mediante el objeto UncaughtErrorEvents del archivo SWF, que est disponible a travs de la propiedad LoaderInfo.uncaughtErrorEvents. Si no hay detectores registrados para el evento uncaughtError, el motor de ejecucin omite los errores no capturados e intenta continuar ejecutndose, siempre que el error no detenga el archivo SWF. Adems de distribuir el evento uncaughtError, las versiones de depuracin del motor de ejecucin de Flash responden a errores no capturados terminando el script actual. Posteriormente, muestran el error no capturado en la salida de la sentencia trace, o bien, mediante la especificacin del mensaje de error en un archivo de registro.Si el objeto de excepcin es una instancia de la clase Error o una de sus subclases, se llamar al mtodo getStackTrace(). La informacin de seguimiento de la pila tambin se muestra en la salida de la sentencia trace o en un archivo de registro. Para obtener ms informacin sobre el uso de la versin de depuracin de los motores de ejecucin de Flash, consulte Trabajo con las versiones de depuracin de los motores de ejecucin de Flash en la pgina 58. Nota: durante el procesamiento de un evento uncaughtError, si se emite un evento error desde un controlador uncaughtError, el controlador de eventos se llama varias veces. Esto tiene como resultado un bucle infinito de excepciones. Se recomienda evitar este escenario.
57
Clases Error. ActionScript 3.0 incluye una amplia gama de clases Error que amplan el mbito de situaciones que
pueden producir objetos de error. Cada clase Error ayuda a las aplicaciones a gestionar y responder a condiciones de error especficas, ya sean relativas a errores de sistema (como una condicin MemoryError), errores de codificacin (como una condicin ArgumentError) errores de red y comunicacin (como una condicin URIError), o bien otras situaciones. Para obtener ms informacin sobre cada clase, consulte Comparacin de las clases Error en la pgina 68.
Menos errores sin mensaje. En versiones anteriores de Flash Player, los errores se generaban y mostraban slo si se
usaba explcitamente la sentencia throw. En Flash Player 9 y versiones posteriores de los motores de ejecucin de Flash, los mtodos y las propiedades de ActionScript generan errores en tiempo de ejecucin que permiten gestionar estas excepciones de forma ms eficaz cuando se producen, as como reaccionar individualmente ante cada excepcin.
Se muestran mensajes de error claros durante la depuracin. Si se usa la versin de depuracin de un motor de
ejecucin de Flash, el cdigo o las situaciones que produzcan problemas generarn mensajes de error detallados que permitirn identificar fcilmente los motivos del error en un bloque de cdigo determinado. Estos mensajes hacen que la solucin de errores resulte ms eficaz. Para obtener ms informacin, consulte Trabajo con las versiones de depuracin de los motores de ejecucin de Flash en la pgina 58.
Los errores precisos permiten que los usuarios vean mensajes de error claros. En las versiones anteriores de Flash
Player, el mtodo FileReference.upload() devolva un valor booleano false si la llamada upload() era incorrecta, e indicaba uno de cinco errores posibles. Si se produce un error al llamar al mtodo upload() en ActionScript 3.0, cuatro errores especficos ayudan a mostrar mensajes de error ms precisos a los usuarios finales.
Gestin de errores mejorada. Se generan errores diferentes para una gran variedad de situaciones habituales. Por
ejemplo, en ActionScript 2.0, antes de que se llenara un objeto FileReference, la propiedad name tena el valor null; de este modo, antes de poder usar o mostrar la propiedad name, es necesario asegurarse de que el valor est establecido y no es null. En ActionScript 3.0, si se intenta acceder a la propiedad name antes de que se especifique su valor, Flash Player generar un error de tipo IllegalOperationError, que indica que no se ha establecido el valor y que se pueden usar bloques try.. catch..finally para gestionar el error. Para obtener ms informacin, consulte Uso de sentencias try..catch..finally en la pgina 59.
58
Existe una clase ErrorEvent que permite crear detectores de eventos de errores asincrnicos especficos. Para
obtener ms informacin, consulte Respuesta al estado y a los eventos de error en la pgina 64.
Uso de las sentencias try..catch..finally. Estas sentencias capturarn los errores cuando se produzcan. Se
pueden anidar las sentencias en una jerarqua para capturar excepciones en varios niveles de la ejecucin del cdigo. Para obtener ms informacin, consulte Uso de sentencias try..catch..finally en la pgina 59
Creacin de objetos de error personalizados. Se puede usar la clase Error para crear objetos de error personalizados,
lo que permite hacer un seguimiento de operaciones especficas de la aplicacin que no estn incluidas en los tipos de error integrados. Posteriormente puede utilizar sentencias try..catch..finally en sus propios objetos de error personalizados. Para obtener ms informacin, consulte Creacin de clases de error personalizadas en la pgina 63.
Especificacin de detectores y controladores de eventos para responder a eventos de error. Mediante esta estrategia,
se pueden crear controladores de error globales que permiten gestionar eventos similares sin duplicar demasiado cdigo en bloques try..catch..finally. Adems, es ms probable capturar errores asincrnicos con este mtodo. Para obtener ms informacin, consulte Respuesta al estado y a los eventos de error en la pgina 64.
59
Si el mtodo readBoolean() genera un error de tipo EOFError en la versin de depuracin de Flash Player, se mostrar el mensaje siguiente en el campo de texto tf: EOFError: Error #2030: Se ha detectado el final del archivo. El mismo cdigo en una versin comercial de Flash Player o Adobe AIR mostrara el siguiente texto: EOFError: Error #2030. Nota: los reproductores de depuracin emiten un evento llamado "allComplete"; evite crear eventos presonalizados con el nombre allComplete. Si lo hace, el comportamiento ser impredecible durante la depuracin. Para reducir los recursos y el tamao en las versiones comerciales, no se muestran cadenas de mensajes de error. El nmero de error se puede consultar en la documentacin (apndices de Referencia de Adobe ActionScript 3.0 para la plataforma de Adobe Flash) para conocer el significado del mensaje de error. Tambin es posible reproducir el error con las versiones de depuracin de Flash Player y AIR para ver el mensaje completo.
60
try { // some code that could throw an error } catch (err:Error) { // code to react to the error } finally { // Code that runs whether an error was thrown. This code can clean // up after the error, or take steps to keep the application running. }
Cada sentencia catch identifica el tipo de excepcin especfico que gestiona. La sentencia catch puede especificar slo clases de errores que son subclases de la clase Error. Cada sentencia catch se comprueba por orden. Slo se ejecutar la primera sentencia catch que coincida con el tipo de error generado. Dicho de otra forma, si primero se comprueba la clase Error de nivel superior y luego la subclase de la clase Error, nicamente coincidir la clase Error de nivel superior. En el cdigo siguiente se muestra este escenario:
try { throw new ArgumentError("I am an ArgumentError"); } catch (error:Error) { trace("<Error> " + error.message); } catch (error:ArgumentError) { trace("<ArgumentError> " + error.message); }
Para capturar correctamente la clase de error ArgumentError, es necesario asegurarse de que los tipos de error ms especficos se enumeran primero, y que los ms genricos aparecen despus, tal como se muestra en el cdigo siguiente:
try { throw new ArgumentError("I am an ArgumentError"); } catch (error:ArgumentError) { trace("<ArgumentError> " + error.message); } catch (error:Error) { trace("<Error> " + error.message); }
Varios mtodos y propiedades de la API de ActionScript generan errores en tiempo de ejecucin si detectan errores durante la ejecucin. Por ejemplo, el mtodo close() de la clase Sound genera un error IOError si no puede cerrar el flujo de audio, tal como se muestra en el cdigo siguiente:
61
var mySound:Sound = new Sound(); try { mySound.close(); } catch (error:IOError) { // Error #2029: This URLStream object does not have an open stream. }
A medida que el usuario se familiarice con Referencia de ActionScript 3.0 para la plataforma de Adobe Flash, reconocer los mtodos que generan excepciones, tal y como se indica en la descripcin de cada mtodo.
La sentencia throw
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior Los motores de ejecucin de Flash generan excepciones cuando localizan errores en la aplicacin que se est ejecutando. Asimismo, se pueden generar excepciones explcitamente mediante la sentencia throw. Si se generan errores de forma explcita, Adobe recomienda generar instancias de la clase Error o sus subclases. En el cdigo siguiente se muestra una sentencia throw que genera una instancia de la clase Error, MyErr, y que termina por llamar a la funcin myFunction() como respuesta tras la generacin del error:
var MyError:Error = new Error("Encountered an error with the numUsers value", 99); var numUsers:uint = 0; try { if (numUsers == 0) { trace("numUsers equals 0"); } } catch (error:uint) { throw MyError; // Catch unsigned integer errors. } catch (error:int) { throw MyError; // Catch integer errors. } catch (error:Number) { throw MyError; // Catch number errors. } catch (error:*) { throw MyError; // Catch any other error. } finally { myFunction(); // Perform any necessary cleanup here. }
Debe tenerse en cuenta que las sentencias catch se ordenan de manera que los tipos de datos ms especficos se muestren en primer lugar. Si la sentencia catch del tipo de datos Number se muestra primero, las sentencias catch de los tipos de datos uint e int nunca se ejecutarn.
62
Nota: en el lenguaje de programacin Java, cada funcin que puede generar una excepcin debe declararlo y enumerar las clases de excepcin generables en una clusula throws asociada a la declaracin de la funcin. ActionScript no requiere la declaracin de las excepciones que puede generar una funcin.
Al usar una mayor gama de clases de error y errores de compilador incorporados, ActionScript 3.0 proporciona ms informacin que las versiones anteriores acerca del motivo por el que falla algo. Esta informacin permite crear aplicaciones ms estables con una mejor gestin de errores.
63
Regeneracin de errores
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior Al crear aplicaciones, pueden existir varias circunstancias en las que sea necesario volver a generar un error, si ste no consigue gestionarse adecuadamente. Por ejemplo, el siguiente cdigo muestra un bloque anidado try..catch, que regenera un error de tipo ApplicationError personalizado si el bloque anidado catch no puede gestionar el error:
try { try { trace("<< try >>"); throw new ApplicationError("some error which will be rethrown"); } catch (error:ApplicationError) { trace("<< catch >> " + error); trace("<< throw >>"); throw error; } catch (error:Error) { trace("<< Error >> " + error); } } catch (error:ApplicationError) { trace("<< catch >> " + error); }
El bloque try anidado genera un error ApplicationError personalizado que captura el bloque catch posterior. Este bloque catch anidado puede intentar gestionar el error y, si no lo consigue, puede generar el objeto ApplicationError en el bloque try..catch en el que est contenido.
Para identificar errores o grupos de errores especficos que son exclusivos de la aplicacin.
Por ejemplo, es posible que se deseen realizar diferentes acciones en el caso de errores generados por el cdigo personalizado, adems de los que captura un motor de ejecucin de Flash. Se puede crear una subclase de la clase Error para hacer un seguimiento del nuevo tipo de datos de error en bloques try..catch.
64
Para proporcionar funciones de visualizacin de error exclusivas para errores generados por la aplicacin.
Por ejemplo, se puede crear un nuevo mtodo toString() que aplique formato a los mensajes de error de una manera determinada. Asimismo, se puede definir un mtodo lookupErrorString() que capture un cdigo de error y recupere el mensaje adecuado segn la preferencia de idioma del usuario. Las clases de error especializadas deben ampliar la clase Error principal de ActionScript. A continuacin, se muestra un ejemplo de clase AppError especializada que ampla la clase Error:
public class AppError extends Error { public function AppError(message:String, errorID:int) { super(message, errorID); } }
Nota: si se desea sustituir el mtodo Error.toString() en la subclase, hay que proporcionarle un parmetro ...(resto). La especificacin del lenguaje ECMAScript en la que est basado ActionScript 3.0 define el mtodo Error.toString() de esta forma, y ActionScript 3.0 lo define del mismo modo para conseguir compatibilidad con versiones anteriores. Por lo tanto, si se sustituye el mtodo Error.toString(), los parmetros deben coincidir exactamente. No deben transmitirse parmetros al mtodo toString() en tiempo de ejecucin, ya que dichos parmetros se omitirn.
65
public class LinkEventExample extends Sprite { private var myMP3:Sound; public function LinkEventExample() { myMP3 = new Sound(); var list:TextField = new TextField(); list.autoSize = TextFieldAutoSize.LEFT; list.multiline = true; list.htmlText = "<a href=\"event:track1.mp3\">Track 1</a><br>"; list.htmlText += "<a href=\"event:track2.mp3\">Track 2</a><br>"; addEventListener(TextEvent.LINK, linkHandler); addChild(list); }
66
private function playMP3(mp3:String):void { try { myMP3.load(new URLRequest(mp3)); myMP3.play(); } catch (err:Error) { trace(err.message); // your error-handling code here } myMP3.addEventListener(IOErrorEvent.IO_ERROR, errorHandler); } private function linkHandler(linkEvent:TextEvent):void { playMP3(linkEvent.text); // your error-handling code here } private function errorHandler(errorEvent:IOErrorEvent):void { trace(errorEvent.text); // your error-handling code here } } }
67
public class VideoExample extends Sprite { private var videoUrl:String = "Video.flv"; private var connection:NetConnection; private var stream:NetStream; public function VideoExample() { connection = new NetConnection(); connection.addEventListener(NetStatusEvent.NET_STATUS, netStatusHandler); connection.addEventListener(SecurityErrorEvent.SECURITY_ERROR, securityErrorHandler); connection.connect(null); } private function netStatusHandler(event:NetStatusEvent):void { if (event.info.level == "error") { trace("Video stream failed") } else { connectStream(); } } private function securityErrorHandler(event:SecurityErrorEvent):void { trace("securityErrorHandler: " + event); } private function connectStream():void { var stream:NetStream = new NetStream(connection); var video:Video = new Video(); video.attachNetStream(stream); stream.play(videoUrl); addChild(video); } } }
68
La clase Error puede usarse para generar La clase Error es la clase base para todos los errores en tiempo excepciones. Se trata de la clase base para otras clases de ejecucin y se recomienda para cualquier clase de error de excepcin definidas en ECMAScript: EvalError, personalizada. RangeError, ReferenceError, SyntaxError, TypeError y URIError. La clase ArgumentError representa un error que se produce cuando los valores de parmetro proporcionados durante una llamada de funcin no coinciden con los parmetros definidos para dicha funcin. Ejemplos de errores de argumento:
ArgumentError
Se proporcionan pocos o demasiados argumentos a un mtodo. Se esperaba que un argumento fuera miembro de una enumeracin, pero no fue as.
EvalError
La excepcin EvalError se genera si se pasan En ActionScript 3.0, se ha eliminado la compatibilidad con la parmetros al constructor de la clase Function, o bien funcin eval(); los intentos de uso de esta funcin generarn si el cdigo del usuario llama a la funcin eval(). errores. Las versiones anteriores de Flash Player utilizaban la funcin
eval() para acceder a variables, propiedades, objetos o clips
de pelcula por su nombre. RangeError Se genera una excepcin RangeError si un valor numrico queda fuera del rango admitido. Por ejemplo, la clase Timer generar una excepcin RangeError si la demora es negativa o no finita. Tambin se puede generar RangeError si se intenta aadir un objeto de visualizacin a una profundidad no vlida. Las excepciones para variables no definidas sealan errores potenciales, lo que ayuda a mejorar la calidad del software. Sin embargo, si el usuario no est acostumbrado a inicializar las variables, es posible que este nuevo comportamiento de ActionScript requiera cambios en sus hbitos de programacin.
ReferenceError
Se emite una excepcin ReferenceError cuando se intenta realizar una referencia a una propiedad no definida en un objeto cerrado (no dinmico). Las versiones del compilador de ActionScript anteriores a ActionScript 3.0 no generaban errores al intentar acceder a una propiedad undefined. Sin embargo, ActionScript 3.0 emite la excepcin ReferenceError en estas condiciones.
69
Descripcin La excepcin SecurityError se genera cuando se produce una infraccin de la seguridad y se deniega el acceso.
Se realiza un acceso a una propiedad o una llamada a un mtodo no autorizada a travs del lmite del entorno limitado de seguridad. Ha habido un intento de acceso a una URL no permitida por el entorno limitado de seguridad. Se ha intentado establecer una conexin de socket con un puerto, pero la poltica de sockets necesaria no estaba presente. Ha habido un intento de acceso a la cmara o al micrfono del usuario; ste ha denegado la solicitud de acceso al dispositivo.
SyntaxError
Se genera una excepcin SyntaxError cuando se produce un error de anlisis en el cdigo de ActionScript.
ActionScript emite excepciones SyntaxError cuando la clase RegExp analiza una expresin regular no vlida. ActionScript emite excepciones SyntaxError cuando la clase XMLDocument analiza XML no vlido.
TypeError
Se genera la excepcin TypeError cuando el tipo real de un operando es diferente del tipo esperado.
No se ha podido forzar el tipo de parmetro formal de un parmetro real de una funcin o un mtodo. Se ha asignado un valor a una variable y no se puede forzar el tipo de la variable. El lado derecho del operador is o instanceof no es un tipo vlido. La palabra clave super se utiliza de manera no permitida. Una consulta de propiedad da como resultado ms de una vinculacin y, por consiguiente, resulta ambigua. Se ha llamado a un mtodo en un objeto incompatible. Por ejemplo, se genera una excepcin TypeError si se inserta un mtodo de la clase RegExp en un objeto genrico y luego se llama.
URIError
Se genera la excepcin URIError cuando una de las funciones de gestin de URI global se utiliza de manera incompatible con esta definicin.
Se puede generar una excepcin URIError en las circunstancias siguientes: Se especifica un URI no vlido para una funcin de la API de Flash Player que espera un URI vlido, como Socket.connect(). Cuando un archivo SWF carga otro archivo SWF, el archivo SWF principal puede capturar una excepcin VerifyError generada por el archivo SWF cargado.
VerifyError
Se genera una excepcin VerifyError cuando se detecta un archivo SWF mal formado o daado.
70
IllegalOperationError
Se genera una excepcin IllegalOperationError si un mtodo no se implementa, o bien si la implementacin no abarca el uso actual.
Una clase base, como DisplayObjectContainer, proporciona mayor funcionalidad de la que puede admitir el escenario. Por ejemplo, si se intenta obtener o establecer una mscara en el escenario (mediante stage.mask), el motor de ejecucin de Flash generar un error IllegalOperationError con el mensaje "La clase Stage no implementa esta propiedad o mtodo". Una subclase hereda un mtodo que no requiere y que no desea admitir. Se llama a determinados mtodos de accesibilidad al compilar Flash Player sin compatibilidad de accesibilidad. Las funciones exclusivas de edicin se llaman desde una versin de Flash Player en tiempo de ejecucin. Se intenta establecer el nombre de un objeto que se coloca en la lnea de tiempo.
IOError Se genera una excepcin IOError cuando se produce algn tipo de excepcin de E/S.
Este error se obtiene, por ejemplo, si se intenta realizar una operacin de lectura y escritura en un socket no conectado o que haya perdido la conexin.
71
Descripcin Se genera una excepcin MemoryError cuando falla una peticin de asignacin de memoria.
Notas De forma predeterminada, la mquina virtual de ActionScript (ActionScript Virtual Machine 2) no impone ningn lmite en cuanto a la memoria que puede asignar un programa de ActionScript. En un sistema escritorio, los errores de asignacin de memoria no son frecuentes. Se generar un error cuando el sistema no pueda asignar la memoria necesaria para una operacin. De este modo, en un sistema de escritorio, esta excepcin es poco habitual, a menos que la peticin de asignacin sea muy grande. Por ejemplo, una peticin de 3.000 millones de bytes resulta imposible, ya que un programa para Microsoft Windows de 32 bits slo puede acceder a 2 GB del espacio de direcciones. Para evitar que un desarrollador malintencionado capture la excepcin y permanezca en un bucle infinito, slo se puede capturar la primera excepcin ScriptTimeoutError generada durante la ejecucin de un script determinado. El cdigo del usuario no podr capturar una excepcin ScriptTimeoutError posterior; sta se dirigir inmediatamente al controlador de excepciones. Una excepcin StackOverflowError puede indicar que se ha producido recursin infinita.
ScriptTimeoutError
Se genera una excepcin ScriptTimeoutError cuando se alcanza un intervalo de tiempo de espera del script de 15 segundos. Si se captura una excepcin ScriptTimeoutError, se puede gestionar el tiempo de espera del script con mayor comodidad. Si no hay controlador de excepciones, la excepcin no capturada mostrar un cuadro de dilogo con un mensaje de error. La excepcin StackOverflowError se genera cuando se agota la pila disponible para el script.
StackOverflowError
Validar un paquete XML Escribir un error personalizado Generar errores personalizados Notificar un error a los usuarios cuando se genere
Para obtener los archivos de la aplicacin de este ejemplo, consulte www.adobe.com/go/learn_programmingAS3samples_flash_es. Los archivos de aplicacin CustomErrors pueden encontrarse en la carpeta Samples/CustomError. La aplicacin consta de los siguientes archivos:
Archivo CustomErrors.mxml o CustomErrors.fla com/example/programmingas3/errors/ApplicationError.as Una clase que constituye la clase de error base para las clases FatalError y WarningError. Descripcin El archivo de aplicacin principal en Flash (FLA) o Flex (MXML)
72
Archivo com/example/programmingas3/errors/FatalError.as
Descripcin Una clase que define un error FatalError emitido por la aplicacin. Esta clase ampla la clase ApplicationError personalizada. Una clase que define un mtodo nico que valida un paquete XML para empleados proporcionado por el usuario. Una clase que define un error WarningError que puede generar la aplicacin. Esta clase ampla la clase ApplicationError personalizada.
com/example/programmingas3/errors/Validator.as
com/example/programmingas3/errors/WarningError.as
El paquete XML se muestra despus en una instancia de componente TextArea en el escenario, lo que permite modificar el paquete antes de intentar su revalidacin. Cuando el usuario hace clic en el botn Validate, se llama al mtodo validateData(). Este mtodo valida el paquete XML para empleados con el mtodo validateEmployeeXML() de la clase Validator. El cdigo siguiente muestra el mtodo validateData():
function validateData():void { try { var tempXML:XML = XML(xmlText.text); Validator.validateEmployeeXML(tempXML); status.text = "The XML was successfully validated."; } catch (error:FatalError) { showFatalError(error); } catch (error:WarningError) { showWarningError(error); } catch (error:Error) { showGenericError(error); } }
73
En primer lugar, se crea un objeto XML temporal con el contenido de la instancia de componente TextArea xmlText. A continuacin, el mtodo validateEmployeeXML() de la clase Validator personalizada (com.example.programmingas3/errors/Validator.as) se llama y transmite el objeto XML temporal como parmetro. Si el paquete XML es vlido, la instancia de componente Label status muestra un mensaje de operacin realizada correctamente y se cierra la aplicacin. Si el mtodo validateEmployeeXML() genera un error personalizado (es decir, FatalError, WarningError o Error de tipo genrico), la sentencia catch correspondiente llama al mtodo showFatalError(), showWarningError() o showGenericError() y lo ejecuta. Cada uno de estos mtodos muestra un mensaje apropiado en un rea de texto denominada statusText para notificar al usuario el error concreto que se ha producido. Los mtodos tambin actualizan la instancia de componente Label status con un mensaje determinado. Si se produce un error grave durante el intento de validar el paquete XML para empleados, el mensaje de error se muestra en el rea de texto statusText y el componente TextArea xmlText y la instancia del componente Button validateBtn se deshabilitan, tal como se indica en el cdigo siguiente:
function showFatalError(error:FatalError):void { var message:String = error.message + "\n\n"; var title:String = error.getTitle(); statusText.text = message + " " + title + "\n\nThis application has ended."; this.xmlText.enabled = false; this.validateBtn.enabled = false; hideButtons(); }
Si se produce un error de advertencia en lugar de un error grave, el mensaje de error se muestra en la instancia de TextArea statusText, pero las instancias del componente TextField y Button xmlText no se deshabilitan. El mtodo showWarningError() muestra el mensaje de error personalizado en el rea de texto statusText. El mensaje tambin pregunta al usuario si desea continuar con la validacin del XML o cancelar la ejecucin del script. El siguiente fragmento de cdigo muestra el mtodo showWarningError():
function showWarningError(error:WarningError):void { var message:String = error.message + "\n\n" + "Do you want to exit this application?"; showButtons(); var title:String = error.getTitle(); statusText.text = message; }
Cuando el usuario hace clic en el botn S o No, se llama al mtodocloseHandler(). El extracto siguiente muestra el mtodo closeHandler():
function closeHandler(event:CloseEvent):void { switch (event.detail) { case yesButton: showFatalError(new FatalError(9999)); break; case noButton: statusText.text = ""; hideButtons(); break; } }
74
Si el usuario decide cancelar la ejecucin del script haciendo clic en S, se genera un error de tipo FatalError, lo que provoca el cierre de la aplicacin.
Para que se valide un empleado, ste debe pertenecer nica y exclusivamente a un centro de coste. Si el empleado no pertenece a ningn centro de coste, el mtodo genera un error de tipo FatalError, que se propaga hasta el mtodo validateData() del archivo de aplicacin principal. Si el empleado pertenece a ms de un centro de coste, se genera un error WarningError. La ltima comprobacin en el validador de XML consiste en confirmar que el usuario tiene exactamente un nmero de seguridad social definido (el nodo ssn del paquete XML). Si no hay exactamente un nodo ssn, se genera un error de tipo FatalError. Se pueden aadir otras comprobaciones al mtodo validateEmployeeXML(); por ejemplo, para asegurarse de que el nodo ssn contiene un nmero vlido, o bien el empleado tiene definidos al menos un nmero de telfono y una direccin de correo electrnico, y los dos valores son vlidos. Asimismo, se pueden modificar los datos XML para que cada empleado tenga un ID nico y especifique el ID de su responsable.
75
public function ApplicationError() { messages = <errors> <error code="9000"> <![CDATA[Employee must be assigned to a cost center.]]> </error> <error code="9001"> <![CDATA[Employee must be assigned to only one cost center.]]> </error> <error code="9002"> <![CDATA[Employee must have one and only one SSN.]]> </error> <error code="9999"> <![CDATA[The application has been stopped.]]> </error> </errors>; }
Cada nodo de error del objeto XML contiene un cdigo numrico nico y un mensaje de error. Los mensajes de error pueden consultarse por su cdigo de error mediante E4X, tal como se muestra en el mtodo getMessageText() siguiente:
public function getMessageText(id:int):String { var message:XMLList = messages.error.(@code == id); return message[0].text(); }
El mtodo getMessageText() procesa un solo argumento de tipo entero, id, y devuelve una cadena. El argumento id es el cdigo de error que debe consultar el error. Por ejemplo, al pasar el id 9001, se recupera un error que indica que los empleados deben asignarse a un solo centro de coste. Si hay ms de un error con el mismo cdigo, ActionScript slo devuelve el mensaje de error para el primer resultado encontrado (message[0] del objeto XMLList devuelto). El siguiente mtodo de esta clase, getTitle(), no procesa ningn parmetro y devuelve un valor de cadena que contiene el ID de este error especfico. Este valor se emplea para ayudar a identificar fcilmente el error exacto, producido durante la validacin del paquete XML. El siguiente fragmento de cdigo muestra el mtodo getTitle():
public function getTitle():String { return "Error #" + id; }
El ltimo mtodo de la clase ApplicationError es toString(). Este mtodo sustituye la funcin definida en la clase Error, de manera que se puede personalizar la presentacin del mensaje de error. El mtodo devuelve una cadena que identifica el mensaje y el nmero de error especficos que se han producido.
public override function toString():String { return "[APPLICATION ERROR #" + id + "] " + message; }
76
El siguiente mtodo de la clase FatalError, getTitle(), sustituye el mtodo getTitle() definido anteriormente en la clase ApplicationError, y aade el texto "-- FATAL" al ttulo para informar al usuario de que se ha producido un error grave. El mtodo getTitle() funciona del modo siguiente:
public override function getTitle():String { return "Error #" + id + " -- FATAL"; }
El ltimo mtodo de esta clase, toString(), sustituye el mtodo toString() definido en la clase ApplicationError. El mtodo toString() funciona es:
public override function toString():String { return "[FATAL ERROR #" + id + "] " + message; }
77
Los siguientes temas describen la sintaxis bsica para crear expresiones regulares. Sin embargo, las expresiones regulares pueden tener muchas complejidades y matices. Se puede encontrar informacin detallada sobre expresiones regulares en Internet y en libreras. Hay que tener en cuenta que los distintos entornos de programacin implementan las expresiones regulares de distinta manera. ActionScript 3.0 implementa la definicin de las expresiones regulares incluida en la especificacin del lenguaje ECMAScript edicin 3 (ECMA-262).
Ms temas de ayuda
RegExp
Hay que tener en cuenta que el literal de expresin regular se delimita con el carcter barra diagonal (/). Los patrones de expresin regular tambin pueden ser complejos y, a veces, aparentemente crpticos, como la siguiente expresin para detectar una direccin de correo electrnico vlida:
/([0-9a-zA-Z]+[-._+&])*[0-9a-zA-Z]+@([-0-9a-zA-Z]+[.])+[a-zA-Z]{2,6}/
Normalmente las expresiones regulares se utilizan para buscar patrones en cadenas y para reemplazar caracteres. En estos casos, se crear un objeto de expresin regular y se utilizar como parmetro de uno de varios mtodos de la clase String. Los siguientes mtodos de la clase String toman como parmetros expresiones regulares: match(), replace(), search() y split(). Para ms informacin sobre estos mtodos, consulte Bsqueda de patrones en cadenas y sustitucin de subcadenas en la pgina 17 La clase RegExp incluye los mtodos siguientes: test() y exec(). Para ms informacin, consulte Mtodos para utilizar expresiones regulares con cadenas en la pgina 91.
78
Conceptos y trminos importantes La siguiente lista de referencias contiene trminos importantes que resultan relevantes para esta funcin:
Carcter de escape Carcter que indica que el carcter que sigue debe tratarse como un metacarcter en lugar de como un carcter literal. En sintaxis de expresiones regulares, el carcter de barra diagonal inversa (\) es el carcter de escape, por lo que una barra diagonal inversa seguida de otro carcter se interpretar como un cdigo especial en lugar de interpretarse literalmente. Indicador Carcter que especifica alguna opcin sobre cmo debe utilizarse el patrn de expresin regular (p. ej.,
El cdigo \d representa "cualquier dgito". El carcter barra diagonal inversa (\) se denomina carcter de escape y, combinado con el carcter siguiente (en este caso, la letra d), tiene un significado especial en la expresin regular. La siguiente expresin regular define el patrn de las letras ABC seguidas de un nmero arbitrario de dgitos (obsrvese el asterisco):
/ABC\d*/
El asterisco (*) es un metacarcter. Un metacarcter es un carcter que tiene un significado especial en las expresiones regulares. El asterisco es un tipo especfico de metacarcter denominado cuantificador que se utiliza para cuantificar la cantidad de repeticiones de un carcter o grupo de caracteres. Para ms informacin, consulte Cuantificadores en la pgina 83. Adems del patrn, una expresin regular puede contener indicadores, que especifican cmo debe detectarse la expresin regular. Por ejemplo, la siguiente expresin regular utiliza el indicador i, que especifica que la expresin regular no distinguir maysculas de minsculas en las cadenas coincidentes:
/ABC\d*/i
79
Para ms informacin, consulte Indicadores y propiedades en la pgina 88. Se pueden utilizar expresiones regulares con los siguientes mtodos de la clase String: match(), replace() y search(). Para ms informacin sobre estos mtodos, consulte Bsqueda de patrones en cadenas y sustitucin de subcadenas en la pgina 17
Las barras diagonales delimitan un literal de expresin regular de la misma manera que las comillas delimitan un literal de cadena. La parte de la expresin regular delimitada por las barras diagonales define el patrn. La expresin regular tambin puede incluir indicadores a continuacin de la ltima barra de delimitacin. Se considera que estos indicadores forman parte de la expresin regular, pero son independientes del patrn. Al utilizar el constructor new se pueden utilizar dos cadenas para definir la expresin regular. La primera cadena define el patrn y la segunda cadena define los indicadores, como en el siguiente ejemplo:
var pattern2:RegExp = new RegExp("bob", "i");
Si se incluye una barra diagonal en una expresin regular definida con los delimitadores de barra diagonal, hay que escribir inmediatamente antes de dicha barra diagonal el carcter de escape de barra diagonal inversa (\). Por ejemplo, la siguiente expresin regular detecta el patrn 1/2:
var pattern:RegExp = /1\/2/;
Para incluir comillas en una expresin regular definida con el constructor new, hay que aadir el carcter de escape de barra diagonal inversa (\) antes de las comillas (de la misma manera que al definir un literal de cadena). Por ejemplo, las siguientes expresiones regulares detectan el patrn eat at "joe's":
var pattern1:RegExp = new RegExp("eat at \"joe's\"", ""); var pattern2:RegExp = new RegExp('eat at "joe\'s"', "");
No se debe utilizar el carcter de escape barra diagonal inversa con comillas en expresiones regulares definidas con los delimitadores de barra diagonal. De forma similar, no se debe utilizar el carcter de escape con barras diagonales en expresiones regulares definidas con el constructor new. Las siguientes expresiones regulares son equivalentes y definen el patrn 1/2 "joe's":
var pattern1:RegExp = /1\/2 "joe's"/; var pattern2:RegExp = new RegExp("1/2 \"joe's\"", ""); var pattern3:RegExp = new RegExp('1/2 "joe\'s"', '');
Adems, en una expresin definida con el constructor new, para utilizar una metasecuencia que comience con el carcter barra diagonal inversa (\) como, por ejemplo, \d (que coincide con cualquier dgito), debe escribirse el carcter barra diagonal inversa dos veces:
var pattern:RegExp = new RegExp("\\d+", ""); // matches one or more digits
En este caso hay que escribir el carcter barra diagonal inversa dos veces, ya que el primer parmetro del mtodo constructor RegExp() es una cadena y en un literal de cadena hay que escribir un carcter barra diagonal inversa dos veces para que se reconozca como un solo carcter barra diagonal inversa.
80
En las secciones siguientes se describe la sintaxis para definir patrones de expresiones regulares. Para ms informacin sobre los indicadores, consulte Indicadores y propiedades en la pgina 88.
No obstante, los siguientes caracteres, denominados metacaracteres, tienen significados especiales en las expresiones regulares:
^ $ \ . * + ? ( ) [ ] { } |
Por ejemplo, la siguiente expresin regular detecta la letra A seguida de cero o ms instancias de la letra B (el metacarcter asterisco indica esta repeticin), seguidas de la letra C:
/AB*C/
Para incluir un metacarcter sin su significado especial en un patrn de expresin regular, hay que utilizar el carcter de escape de barra diagonal inversa (\). Por ejemplo, la siguiente expresin regular detecta la letra A seguida de la letra B, seguida de un asterisco, seguido de la letra C:
var pattern:RegExp = /AB\*C/;
Una metasecuencia, al igual que un metacarcter, tiene un significado especial en una expresin regular. Las metasecuencias estn formadas por ms de un carcter. Las secciones siguientes proporcionan detalles sobre la utilizacin de metacaracteres y metasecuencias. Metacaracteres En la tabla siguiente se muestra un resumen de los metacaracteres que se pueden utilizar en las expresiones regulares:
Metacarcter
^ (intercalacin)
Descripcin Detecta el principio de la cadena. Con el indicador m (multiline) establecido, el signo de intercalacin tambin detecta el inicio de cada lnea (consulte Indicadores y propiedades en la pgina 88 ). Hay que tener en cuenta que cuando se utiliza al principio de una clase de caracteres, el signo de intercalacin indica negacin, no el principio de una cadena. Para ms informacin, consulte Clases de caracteres en la pgina 82. Detecta el final de la cadena. Con el indicador m (multiline) establecido, $ detecta la posicin anterior a un carcter de nueva lnea (\n). Para ms informacin, consulte Indicadores y propiedades en la pgina 88. Omite el significado especial de los metacaracteres. Tambin debe utilizarse el carcter barra diagonal inversa si se desea utilizar un carcter barra diagonal en un literal de expresin regular, como /1\/2/ (para detectar el carcter 1, seguido del carcter barra diagonal, seguido del carcter 2).
$ (signo dlar)
. (punto)
Detecta cualquier carcter individual. El punto detecta un carcter de nueva lnea (\n) slo si est establecido el indicador s (dotall). Para ms informacin, consulte Indicadores y propiedades en la pgina 88.
* (asterisco)
Detecta el elemento anterior repetido cero o ms veces. Para ms informacin, consulte Cuantificadores en la pgina 83.
81
Metacarcter
+ (ms)
Descripcin Detecta el elemento anterior repetido una o ms veces. Para ms informacin, consulte Cuantificadores en la pgina 83.
? (signo de interrogacin)
Detecta el elemento anterior repetido cero veces o una sola vez. Para ms informacin, consulte Cuantificadores en la pgina 83.
(y)
Define grupos dentro de la expresin regular. Los grupos se pueden utilizar para:
Para limitar el mbito del alternador |: /(a|b|c)d/ Para definir el mbito de un cuantificador: /(walla.){1,2}/ En referencias a elementos detectados previamente. Por ejemplo, en la siguiente expresin regular, \1 detectar lo que se haya detectado en el primer grupo delimitado con parntesis del patrn:
/(\w*) se repite: \1/
Define una clase de caracteres, que especifica posibles coincidencias para un solo carcter:
/[aeiou]/ detecta cualquiera de los caracteres especificados.
Adems, se debe insertar una barra diagonal inversa para omitir el significado especial de los caracteres ] y - caracteres:
/[+\-]\d+/ detecta + o - antes de uno o ms dgitos.
En las clases de caracteres, los caracteres que normalmente metacaracteres se tratan como caracteres normales (no metacaracteres), sin necesidad de utilizar una barra diagonal inversa:
/[$]/ detecta $o .
Metasecuencias Las metasecuencias son secuencias de caracteres que tienen un significado especial en un patrn de expresin regular. En la tabla siguiente se describen estas metasecuencias:
Metasecuencia
{n} {n,}
y
{n,n}
Detecta la posicin entre un carcter de palabra y un carcter de otro tipo. Si el primer o el ltimo carcter de la cadena es un carcter de palabra, tambin detecta el principio o el final de la cadena. Detecta la posicin entre dos caracteres de palabra. Tambin detecta la posicin entre dos caracteres de otro tipo.
\B
82
Metasecuencia
\d \D \f \n \r \s \S \t \unnnn
Descripcin Detecta un dgito decimal. Detecta cualquier carcter que no sea un dgito. Detecta un carcter de salto de pgina. Detecta el carcter de nueva lnea. Detecta el carcter de retorno. Detecta cualquier carcter de espacio en blanco (un carcter de espacio, tabulacin, nueva lnea o retorno). Detecta cualquier carcter que no sea un espacio en blanco. Detecta el carcter de tabulacin. Detecta el carcter Unicode con el cdigo de carcter especificado por el nmero hexadecimal nnnn. Por ejemplo, \u263a es el carcter smiley. Detecta un carcter de avance vertical. Detecta un carcter de palabra (AZ, az, 0-9 o _). Hay que tener en cuenta que \w no detecta caracteres que no sean los del idioma ingls, como , o . Detecta cualquier carcter que no sea un carcter de palabra. Detecta el carcter con el valor ASCII especificado, definido por el nmero hexadecimal nn.
\v \w
\W \\xnn
Clases de caracteres
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior Se pueden utilizar clases de caracteres para especificar una lista de caracteres con el fin de detectar una posicin en la expresin regular. Las clases de caracteres se definen con corchetes ( [ y ] ). Por ejemplo, la siguiente expresin regular define una clase de caracteres que detecta bag, beg, big, bog o bug:
/b[aeiou]g/
Secuencias de escape en clases de caracteres La mayora de los metacaracteres y las metasecuencias que normalmente tienen significados especiales en una expresin regular no tienen el mismo significado dentro de una clase de caracteres. Por ejemplo, en una expresin regular, el asterisco se utiliza para indicar repeticin, pero en una clase de caracteres no tiene este significado. La siguiente clase de caracteres detecta el asterisco literalmente, junto con cualquiera de los otros caracteres indicados:
/[abc*123]/
Sin embargo, los tres caracteres mostrados en la tabla siguiente funcionan como metacaracteres (tienen un significado especial) en las clases de caracteres:
Metacarcter
] \
Significado en las clases de caracteres Define el final de la clase de caracteres. Define un rango de caracteres (consulte la siguiente seccin "Rangos de caracteres en clases de caracteres"). Define metasecuencias y omite el significado especial de los metacaracteres.
83
Para que se reconozca cualquiera de estos caracteres como un carcter literal (sin su significado especial de metacarcter), hay que escribir el carcter de escape barra diagonal inversa inmediatamente antes del carcter. Por ejemplo, la siguiente expresin regular incluye una clase de caracteres que detecta cualquiera de los cuatro smbolos ($, \, ] o -):
/[$\\\]\-]/
Adems de los metacaracteres que conservan su significado especial, las siguientes metasecuencias funcionan como metasecuencias en las clases de caracteres:
Metasecuencia
\n \r \t \unnnn \\xnn
Significado en las clases de caracteres Detecta un carcter de nueva lnea. Detecta un carcter de retorno. Detecta un carcter de tabulacin. Detecta el carcter con el valor de cdigo Unicode especificado (definido por el nmero hexadecimal nnnn). Detecta el carcter con el valor ASCII especificado (definido por el nmero hexadecimal nn).
Otros metacaracteres y metasecuencias de expresin regular se tratan como caracteres normales dentro de una clase de caracteres. Rangos de caracteres en clases de caracteres Se utiliza un guin para especificar un rango de caracteres, como A-Z, a-z o 0-9. Estos caracteres deben constituir un rango vlido en el conjunto de caracteres. Por ejemplo, la siguiente clase de caracteres detecta cualquiera de los caracteres del intervalo a-z o cualquier dgito:
/[a-z0-9]/
Tambin se puede utilizar el cdigo de carcter ASCII \\xnn para especificar un rango por valor ASCII. Por ejemplo, la siguiente clase de caracteres detecta cualquier carcter de un conjunto de caracteres extendidos ASCII (como y ):
\\x
Clases de caracteres denegados Si se utiliza un carcter de intercalacin (^) al principio de una clase de caracteres, deniega los caracteres de la clase: detectar cualquier carcter que no est en la clase. La siguiente clase de caracteres detecta cualquier carcter salvo una letra minscula (az) o un dgito:
/[^a-z0-9]/
Para indicar la negacin se debe escribir el carcter de intercalacin (^) al principio de una clase de caracteres. De lo contrario, slo se aade el carcter de intercalacin a los caracteres de la clase de caracteres. Por ejemplo, la siguiente clase de caracteres detecta cualquier carcter de un conjunto de caracteres de smbolo, incluido el signo de intercalacin:
/[!.,#+*%$&^]/
Cuantificadores
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior Los cuantificadores se utilizan para especificar repeticiones de caracteres o secuencias en patrones, de la manera siguiente:
84
Metacarcter de cuantificador
* (asterisco) + (ms) ? (signo de interrogacin) {n} {n,}
Descripcin
Detecta el elemento anterior repetido cero o ms veces. Detecta el elemento anterior repetido una o ms veces. Detecta el elemento anterior repetido cero veces o una sola vez. Especifica un cuantificador numrico o un rango de cuantificadores para el elemento anterior:
/A{27}/ detecta el carcter A repetido 27 veces. /A{3,}/ detecta el carcter A repetido 3 o ms veces. /A{3,5}/ detecta el carcter A repetido entre 3 y 5 veces.
y
{n,n}
/a+/ detecta el carcter a repetido una o ms veces. /\d+/ detecta uno o ms dgitos. /[abc]+/ detecta una repeticin de uno o ms caracteres, cada uno de las cuales puede sera, b o c. /(very, )*/ detecta la palabra very seguida de una coma y un espacio repetido cero o ms veces.
Se pueden utilizar cuantificadores dentro de grupos delimitados por parntesis que tengan cuantificadores aplicados. Por ejemplo, el siguiente cuantificador detecta cadenas como word y word-word-word:
/\w+(-\w+)*/
De manera predeterminada, las expresiones regulares realizan lo que se conoce como una deteccin de la coincidencia ms larga posible (greedy matching). Cualquier subpatrn de la expresin regular (como .*) intentar detectar la mayor cantidad posible de caracteres en la cadena antes de pasar a la siguiente parte de la expresin regular. Por ejemplo, considrense la expresin regular y la cadena siguientes:
var pattern:RegExp = /<p>.*<\/p>/; str:String = "<p>Paragraph 1</p> <p>Paragraph 2</p>";
Sin embargo, si slo se desea detectar una agrupacin <p>...</p>, se puede hacer lo siguiente:
<p>Paragraph 1</p>
Aadir un signo de interrogacin (?) a continuacin de cualquier cuantificador para convertirlo en un cuantificador perezoso, que detecta la coincidencia ms corta posible. Por ejemplo, la siguiente expresin regular, que utiliza un cuantificador de este tipo, *? , detecta <p> seguido del mnimo nmero posible de caracteres, seguidos de </p>:
/<p>.*?<\/p>/
Hay que tener en cuenta los siguientes aspectos sobre los cuantificadores:
Los cuantificadores {0} y {0,0} no excluyen un elemento de una coincidencia. No se deben combinar varios cuantificadores, como en /abc+*/. El punto (.) no abarca lneas a menos que se establezca el indicador s (dotall), aunque est seguido de un
cuantificador *. Por ejemplo, considrese el fragmento de cdigo siguiente:
85
var str:String = "<p>Test\n"; str += "Multiline</p>"; var re:RegExp = /<p>.*<\/p>/; trace(str.match(re)); // null; re = /<p>.*<\/p>/s; trace(str.match(re)); // output: <p>Test //
Multiline</p>
Alternancia
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior El carcter | (barra vertical) se utiliza en una expresin regular para que el motor de expresiones regulares considere alternativas para la deteccin. Por ejemplo, la siguiente expresin regular detecta cualquiera de las palabras cat, dog, pig, rat:
var pattern:RegExp = /cat|dog|pig|rat/;
Se pueden utilizar parntesis para definir grupos a fin de restringir el mbito del alternador |. La siguiente expresin regular detecta cat seguida de nap o nip:
var pattern:RegExp = /cat(nap|nip)/;
Para ms informacin, consulte Grupos en la pgina 85. Las dos expresiones regulares siguientes, una con el alternador | y la otra con una clase de caracteres (definida con [ y ] ), son equivalentes:
/1|3|5|7|9/ /[13579]/
Grupos
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior Se puede especificar un grupo en una expresin regular utilizando parntesis, de la manera siguiente:
/class-(\d*)/
Aplicar un cuantificador a ms de un carcter. Delimitar subpatrones que debe aplicarse mediante alternancia (utilizando el carcter |). Capturar coincidencias de subcadenas (por ejemplo, utilizando \1 en una expresin regular para detectar un grupo
detectado previamente o utilizando $1 de forma similar en el mtodo replace() de la clase String). En las secciones siguientes se proporcionan detalles sobre estos usos de los grupos. Uso de grupos con cuantificadores Si no se utiliza un grupo, un cuantificador se aplica al carcter o la clase de caracteres que lo precede, como se indica a continuacin:
86
var pattern:RegExp = /ab*/ ; // matches the character a followed by // zero or more occurrences of the character b pattern = /a\d+/; // matches the character a followed by // one or more digits pattern = /a[123]{1,3}/; // matches the character a followed by // one to three occurrences of either 1, 2, or 3
No obstante, se puede utilizar un grupo para aplicar un cuantificador a ms de un carcter o clase de caracteres:
var pattern:RegExp = /(ab)*/; // matches zero or more occurrences of the character a // followed by the character b, such as ababab pattern = /(a\d)+/; // matches one or more occurrences of the character a followed by // a digit, such as a1a5a8a3 pattern = /(spam ){1,3}/; // matches 1 to 3 occurrences of the word spam followed by a space
Para ms informacin sobre los cuantificadores, consulte Cuantificadores en la pgina 83. Uso de los grupos con el carcter alternador (|) Se pueden utilizar grupos para definir el grupo de caracteres al que se desea aplicar un carcter alternador (|), de la manera siguiente:
var pattern:RegExp = /cat|dog/; // matches cat or dog pattern = /ca(t|d)og/; // matches catog or cadog
Uso de grupos para capturar coincidencias de subcadenas Si se define un grupo delimitado por parntesis estndar en un patrn, se puede hacer referencia al mismo en una parte posterior de la expresin regular. Esto se denomina referencia a un elemento detectado previamente (backreference) y estos tipos de grupos se denominan grupos de captura. Por ejemplo, en la siguiente expresin regular, la secuencia \1 detectar la subcadena que se haya detectado en el primer grupo de captura delimitado con parntesis:
var pattern:RegExp = /(\d+)-by-\1/; // matches the following: 48-by-48
Se pueden especificar hasta 99 de estas referencias a elementos detectados previamente escribiendo \1, \2, ..., \99. De forma similar, en el mtodo replace() de la clase String, se puede utilizar $1$99 para insertar subcadenas coincidentes detectadas con un grupo de captura en la cadena de sustitucin:
var pattern:RegExp = /Hi, (\w+)\./; var str:String = "Hi, Bob."; trace(str.replace(pattern, "$1, hello.")); // output: Bob, hello.
Adems, si se utilizan grupos de captura, el mtodo exec() de la clase RegExp y el mtodo match() de la clase String devuelven subcadenas que detectan los grupos de captura:
87
Uso de grupos que no capturan y grupos de bsqueda hacia delante Un grupo que no captura es un grupo que slo se utiliza para agrupar; no se "almacena" ni proporciona referencias numeradas de elementos detectados previamente. Para definir grupos que no capturan se utiliza (?: y ), de la manera siguiente:
var pattern = /(?:com|org|net);
Por ejemplo, vase la diferencia entre colocar (com|org) en grupo de captura y en un grupo que no captura (el mtodo exec() muestra los grupos de captura despus de la coincidencia completa):
var pattern:RegExp = /(\w+)@(\w+).(com|org)/; var str:String = "bob@example.com"; trace(pattern.exec(str)); // bob@example.com,bob,example,com //noncapturing: var pattern:RegExp = /(\w+)@(\w+).(?:com|org)/; var str:String = "bob@example.com"; trace(pattern.exec(str)); // bob@example.com,bob,example
Un tipo especial de grupo que no captura es el grupo de bsqueda hacia delante, del cual hay dos tipos: el grupo de bsqueda positiva hacia delante y el grupo de bsqueda negativa hacia delante. Para definir un grupo de bsqueda positiva hacia delante, que especifica que el subpatrn del grupo debe coincidir en la posicin, se utiliza (?= y ). No obstante, la parte de la cadena que coincide con el grupo de bsqueda positiva hacia delante puede coincidir con los dems patrones de la expresin regular. Por ejemplo, como (?=e) es un grupo de bsqueda positiva hacia delante en el cdigo siguiente, el carcter e que detecta puede ser detectado por una parte posterior de la expresin regular, en este caso, el grupo de captura, \w*):
var pattern:RegExp = /sh(?=e)(\w*)/i; var str:String = "Shelly sells seashells by the seashore"; trace(pattern.exec(str)); // Shelly,elly
Para definir un grupo de bsqueda negativa hacia delante, que especifica que el subpatrn del grupo no debe coincidir en la posicin, se utiliza (?! y ). Por ejemplo:
var pattern:RegExp = /sh(?!e)(\w*)/i; var str:String = "She sells seashells by the seashore"; trace(pattern.exec(str)); // shore,ore
Uso de grupos con nombre Un grupo con nombre es un tipo de grupo en una expresin regular al que se le da un identificador designado. Para definir el grupo con nombre se utiliza (?P<nombre> y ) Por ejemplo, la siguiente expresin regular incluye un grupo con nombre con el identificador denominado digits:
var pattern = /[a-z]+(?P<digits>\d+)[a-z]+/;
Cuando se utiliza el mtodo exec(), se aade un grupo con nombre coincidente como una propiedad del conjunto result:
88
var myPattern:RegExp = /([a-z]+)(?P<digits>\d+)[a-z]+/; var str:String = "a123bcd"; var result:Array = myPattern.exec(str); trace(result.digits); // 123
Otro ejemplo, en el que se utilizan dos grupos con nombre, con los identificadores name y dom:
var emailPattern:RegExp = /(?P<name>(\w|[_.\-])+)@(?P<dom>((\w|-)+))+\.\w{2,4}+/; var address:String = "bob@example.com"; var result:Array = emailPattern.exec(address); trace(result.name); // bob trace(result.dom); // example
Nota: los grupos con nombre no forman parte de la especificacin del lenguaje ECMAScript. Son una caracterstica aadida de ActionScript 3.0.
Indicadores y propiedades
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior En la tabla siguiente se muestran los cinco indicadores que se pueden establecer para expresiones regulares. Se puede acceder a cada indicador como una propiedad del objeto de expresin regular.
Indicador
g i
Propiedad
global ignoreCase
Descripcin Detecta todas las coincidencias. Detecta sin distinguir maysculas de minsculas. Se aplica a los caracteres AZ y az, pero no a caracteres extendidos como y . Con este indicador establecido, $ y ^ pueden detectar el principio y el final de una lnea, respectivamente. Con este indicador establecido, . (punto) puede detectar el carcter de nueva lnea (\n). Permite utilizar expresiones regulares extendidas. Estas expresiones permiten escribir espacios que se omitirn como parte del patrn. Esto facilita la lectura del cdigo de una expresin regular.
multiline
s x
dotall extended
Hay que tener en cuenta que estas propiedades son de slo lectura. Se puede establecer los indicadores (g, i, m, s, x) al establecer una variable de expresin regular, de la manera siguiente:
var re:RegExp = /abc/gimsx;
Sin embargo, las propiedades con nombre no se pueden establecer directamente. Por ejemplo, el siguiente cdigo genera un error:
var re:RegExp = /abc/; re.global = true; // This generates an error.
De manera predeterminada, los indicadores no se establecen y las propiedades correspondientes se establecen en false, a menos que se especifiquen en la declaracin de la expresin regular. Adems, las expresiones regulares tienen otras dos propiedades:
La propiedad lastIndex especifica la posicin del ndice en la cadena que se debe utilizar para la siguiente llamada
al mtodo exec() o test() de una expresin regular.
La propiedad source especifica la cadena que define la parte del patrn de la expresin regular.
89
El indicador g (global) Si el indicador g (global) no se incluye, la expresin regular detectar una sola coincidencia. Por ejemplo, si no se incluye el indicador g en la expresin regular, el mtodo String.match() devuelve una sola cadena coincidente:
var str:String = "she sells seashells by the seashore."; var pattern:RegExp = /sh\w*/; trace(str.match(pattern)) // output: she
Si se establece el indicador g, el mtodo Sting.match() devuelve varias coincidencias, como se indica a continuacin:
var str:String = "she sells seashells by the seashore."; var pattern:RegExp = /sh\w*/g; // The same pattern, but this time the g flag IS set. trace(str.match(pattern)); // output: she,shells,shore
El indicador i (ignoreCase) De manera predeterminada, las expresiones regulares distinguen maysculas de minsculas al detectar coincidencias. Si se establece el indicador i (ignoreCase), no se distinguirn maysculas de minsculas. Por ejemplo, la s minscula de la expresin regular no detecta la letra S mayscula, el primer carcter de la cadena:
var str:String = "She sells seashells by the seashore."; trace(str.search(/sh/)); // output: 13 -- Not the first character
Sin embargo, con el indicador i establecido, la expresin regular detecta la letra S mayscula:
var str:String = "She sells seashells by the seashore."; trace(str.search(/sh/i)); // output: 0
El indicador i no distingue maysculas de minsculas nicamente para los caracteres AZ y az, pero s para caracteres extendidos como y . El indicador m (multiline) Si no se establece el indicador m (multiline), ^ detecta el principio de la cadena y $ detecta el final de la cadena. Con m establecido, estos caracteres detectan el principio y el final de una lnea, respectivamente. Considrese la siguiente cadena, que incluye un carcter de nueva lnea:
var str:String = "Test\n"; str += "Multiline"; trace(str.match(/^\w*/g)); // Match a word at the beginning of the string.
Aunque se establezca el indicador g (global) en la expresin regular, el mtodo match() detecta una sola subcadena, ya que hay una sola coincidencia con ^, el principio de la cadena. El resultado es:
Test
Hay que tener en cuenta que slo el carcter \n indica el final de una lnea. Los caracteres siguientes no:
90
En este caso, la coincidencia es toda la subcadena entre las etiquetas <p>, incluido el carcter de nueva lnea:
<p>Test Multiline</p>
El indicador x (extended) Las expresiones regulares pueden ser difciles de leer, especialmente cuando incluyen muchos metasmbolos y metasecuencias. Por ejemplo:
/<p(>|(\s*[^>]*>)).*?<\/p>/gi
Si se utiliza el indicador x (extended) en una expresin regular, se omitirn los espacios en blanco que se escriban en el patrn. Por ejemplo, la siguiente expresin regular es idntica a la del ejemplo anterior:
/ <p (> | (\s* [^>]* >)) .*? <\/p> /gix
Si se establece el indicador x y se desea detectar un carcter de espacio en blanco, se debe escribir una barra diagonal inversa inmediatamente antes del espacio en blanco. Por ejemplo, las dos expresiones normales siguientes son equivalentes:
/foo bar/ /foo \ bar/x
La propiedad lastIndex La propiedad lastIndex especifica la posicin de ndice de la cadena en la que debe comenzar la siguiente bsqueda. Esta propiedad afecta a los mtodos exec() y test() llamados en una expresin regular que tiene el indicador g establecido en true. Por ejemplo, observe el siguiente cdigo:
var pattern:RegExp = /p\w*/gi; var str:String = "Pedro Piper picked a peck of pickled peppers."; trace(pattern.lastIndex); var result:Object = pattern.exec(str); while (result != null) { trace(pattern.lastIndex); result = pattern.exec(str); }
91
La propiedad lastIndex est establecida en 0 de manera predeterminada (para iniciar las bsquedas al principio de la cadena). Despus de cada deteccin, se establece en la posicin de ndice siguiente a la de la coincidencia. Por tanto, el resultado del cdigo anterior es el siguiente:
0 5 11 18 25 36 44
Si el indicador global est establecido en false, los mtodos exec() y test() no utilizan ni establecen la propiedad lastIndex. Los mtodos match(), replace() y search() de la clase String inician todas las bsquedas desde el principio de la cadena, independientemente del valor de la propiedad lastIndex de la expresin regular utilizada en la llamada al mtodo. (Sin embargo, el mtodo match() establece lastIndex en 0.) Se puede establecer la propiedad lastIndex para ajustar la posicin de inicio en la cadena para la deteccin de expresiones regulares. La propiedad source La propiedad source especifica la cadena que define la parte del patrn de una expresin regular. Por ejemplo:
var pattern:RegExp = /foo/gi; trace(pattern.source); // foo
El mtodo test()
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior El mtodo test() de la clase RegExp comprueba simplemente la cadena suministrada para ver si contiene una coincidencia para la expresin regular, como se indica en el siguiente ejemplo:
var pattern:RegExp = /Class-\w/; var str = "Class-A"; trace(pattern.test(str)); // output: true
92
El mtodo exec()
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior El mtodo exec() de la clase RegExp comprueba la cadena suministrada para detectar una coincidencia con la expresin regular y devuelve un conjunto con lo siguiente:
El mtodo exec() se utiliza varias veces para detectar varias subcadenas cuando se establece el indicador g (global) para la expresin regular:
var pattern:RegExp = /\w*sh\w*/gi; var str:String = "She sells seashells by the seashore"; var result:Array = pattern.exec(str); while (result != null) { trace(result.index, "\t", pattern.lastIndex, "\t", result); result = pattern.exec(str); } //output: // 0 3 She // 10 19 seashells // 27 35 seashore
Convertir lneas de texto que coinciden con un patrn de Wiki de origen con las cadenas HTML de salida
apropiadas.
93
Utilizar una expresin regular para convertir patrones de URL en etiquetas de hipervnculos HTML <a>. Usar una expresin regular para convertir cadenas con valores monetarios en dlares de EE.UU. (como "$9,95")
en cadenas que contienen valores monetarios en euros (como "8,24 "). Para obtener los archivos de la aplicacin para esta muestra, consulte www.adobe.com/go/learn_programmingAS3samples_flash_es. Los archivos de la aplicacin WikiEditor se encuentran en la carpeta Samples/WikiEditor. La aplicacin consta de los siguientes archivos:
Archivo WikiEditor.mxml o WikiEditor.fla com/example/programmingas3/regExpExamples/WikiParser.as Una clase que incluye mtodos que utilizan expresiones regulares para convertir patrones de texto de Wiki de origen en la salida HTML equivalente. Una clase que incluye mtodos que utilizan expresiones regulares para convertir cadenas de URL en etiquetas de hipervnculos HTML <a>. Una clase que incluye mtodos que utilizan expresiones regulares para convertir cadenas con valores monetarios en dlares de EE.UU. en cadenas en euros. Descripcin El archivo de aplicacin principal en Flash (FLA) o Flex (MXML).
com/example/programmingas3/regExpExamples/URLParser.as
com/example/programmingas3/regExpExamples/CurrencyConverter.as
Cuando el usuario hace clic en el botn Test de la aplicacin de ejemplo, la aplicacin invoca al mtodo parseWikiString() del objeto WikiParser. Este mtodo llama a otros mtodos, que a su vez crean la cadena HTML resultante.
public function parseWikiString(wikiString:String):String { var result:String = parseBold(wikiString); result = parseItalic(result); result = linesToParagraphs(result); result = parseBullets(result); return result; }
94
Cada uno de los mtodos llamados, parseBold(), parseItalic(), linesToParagraphs() y parseBullets() utiliza el mtodo replace() de la cadena para sustituir patrones coincidentes, definidos por una expresin regular, a fin de transformar el texto de entrada del Wiki en texto con formato HTML. Conversin de patrones en negrita y en cursiva El mtodo parseBold() busca un patrn de texto de Wiki en negrita (como '''foo''') y lo transforma en su equivalente HTML (como <b>foo</b>), de la manera siguiente:
private function parseBold(input:String):String { var pattern:RegExp = /'''(.*?)'''/g; return input.replace(pattern, "<b>$1</b>"); }
Hay que tener en cuenta que la parte (.?*) de la expresin regular detecta un nmero arbitrario de caracteres (*) entre los dos patrones delimitadores'''. El cuantificador ? hace que no se detecte la mayor cantidad posible de caracteres, de forma que para una cadena como '''aaa''' bbb '''ccc''', la primera cadena detectada ser '''aaa''' y no la cadena completa (que empieza y termina con el patrn '''). Los parntesis de la expresin regular definen un grupo de captura y el mtodo replace() hace referencia a este grupo mediante el cdigo $1 en la cadena de sustitucin. El indicador g (global) de la expresin regular garantiza que el mtodo replace() sustituye todas las coincidencias de la cadena (no slo la primera). El mtodo parseItalic() funciona de forma similar al mtodo parseBold(), con la diferencia de que busca dos apstrofes (''), no tres, como delimitador del texto en cursiva:
private function parseItalic(input:String):String { var pattern:RegExp = /''(.*?)''/g; return input.replace(pattern, "<i>$1</i>"); }
Conversin de patrones de vietas Como se indica en el siguiente ejemplo, el mtodo parseBullet() busca el patrn de lnea de vieta del Wiki (como * foo) y la transforma en su equivalente HTML (como <li>foo</li>):
private function parseBullets(input:String):String { var pattern:RegExp = /^\*(.*)/gm; return input.replace(pattern, "<li>$1</li>"); }
El smbolo ^ al principio de la expresin regular detecta el principio de una lnea. El indicador m (multiline) de la expresin regular hace que la expresin regular detecte el smbolo ^ en cada principio de lnea, no slo al principio de la cadena. El patrn \* detecta un asterisco (se utiliza la barra diagonal inversa para indicar un asterisco literal en lugar del cuantificador *). Los parntesis de la expresin regular definen un grupo de captura y el mtodo replace() hace referencia a este grupo mediante el cdigo $1 en la cadena de sustitucin. El indicador g (global) de la expresin regular garantiza que el mtodo replace() sustituye todas las coincidencias de la cadena (no slo la primera). Conversin de patrones de prrafo de Wiki El mtodo linesToParagraphs() convierte cada lnea de la cadena de entrada de Wiki en una etiqueta de prrafo HTML, <p>. Estas lneas del mtodo eliminan las lneas vacas de la cadena de Wiki de entrada:
95
Los smbolos ^ y $ hacen que la expresin regular detecte el principio y el final de una lnea. El indicador m (multiline) de la expresin regular hace que la expresin regular detecte el smbolo ^ en cada principio de lnea, no slo al principio de la cadena. El mtodo replace() sustituye todas las subcadenas coincidentes (lneas vacas) con una cadena vaca (""). El indicador g (global) de la expresin regular garantiza que el mtodo replace() sustituye todas las coincidencias de la cadena (no slo la primera).
La funcin constructora RegExp() se utiliza para crear una expresin regular (urlPattern) a partir de varios constituyentes. Estos constituyentes son cadenas que definen partes del patrn de la expresin regular. La primera parte del patrn de la expresin regular, definida por la cadena protocol, define un protocolo de URL:
http:// o ftp://. Los parntesis definen un grupo que no captura, indicado por el smbolo ?. Esto significa que los
parntesis se utilizan simplemente para definir un grupo para el patrn de alternancia|; el grupo no detectar cdigos de elementos detectados previamente ($1, $2, $3) en la cadena de sustitucin del mtodo replace(). Los otros elementos constituyentes de la expresin regular utilizan grupos de captura (indicados mediante parntesis en el patrn), que se utilizan en los cdigos de referencia a elementos detectados previamente ($1, $2, $3) en la cadena de sustitucin del mtodo replace(). La parte del patrn definida por la cadena urlPart detecta al menos uno de los siguientes caracteres: a-z, 0-9, _ o -. El cuantificador + indica que debe detectarse al menos un carcter. \. indica un carcter punto (.) requerido. Y el resto detecta otra cadena que conste al menos de uno de los siguientes caracteres: a-z, 0-9, _ o -. La parte del patrn definida por la cadena optionalUrlPart detecta cero o ms de los caracteres siguientes: un punto (. seguido de cualquier nmero de caracteres alfanumricos (incluidos _ y -. El cuantificador * indica que deben detectarse cero o ms caracteres. La llamada al mtodo replace() utiliza la expresin regular y crea la cadena HTML de sustitucin utilizando referencias a elementos detectados previamente. A continuacin, el mtodo urlToATag() llama al mtodo emailToATag(), que utiliza tcnicas similares para sustituir patrones de correo electrnico por cadenas de hipervnculos HTML <a>. Las expresiones regulares utilizadas para detectar direcciones URL HTTP, FTP y de correo electrnico en este archivo son bastante sencillas (para los fines del ejemplo); hay expresiones regulares mucho ms complicadas para detectar direcciones URL de forma correcta.
96
Conversin de cadenas con valores monetarios en dlares de EE.UU. en cadenas con valores monetarios en euros
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior Cuando el usuario hace clic en el botn Test de la aplicacin de ejemplo, si activ la casilla de verificacin dollarToEuro, la aplicacin llama al mtodo esttico CurrencyConverter.usdToEuro() para convertir cadenas con valores monetarios en dlares de EE.UU. (como "$9.95") en cadenas con valores monetarios en euros (como "8.24"), de la manera siguiente:
var usdPrice:RegExp = /\$([\d,]+.\d+)+/g; return input.replace(usdPrice, usdStrToEuroStr);
La primera lnea define un patrn sencillo para detectar cadenas con valores monetarios en dlares de EE.UU. Obsrvese que antes del carcter $ se escribe una barra diagonal inversa de escape (\). El mtodo replace() utiliza la expresin regular como detector de patrones y llama a la funcin usdStrToEuroStr() para determinar la cadena de sustitucin (un valor en euros). Cuando se utiliza un nombre de funcin como segundo parmetro del mtodo replace(), se pasan a la funcin llamada los parmetros siguientes:
La parte coincidente de la cadena. Las coincidencias detectadas por grupos de parntesis de captura. El nmero de argumentos pasados de esta forma
vara en funcin del nmero de capturas de grupos entre parntesis. Se puede determinar el nmero de capturas de grupos entre parntesis comprobando arguments.length - 3 dentro del cdigo de la funcin.
Hay que tener en cuenta que args[1] representa la captura de grupo entre parntesis detectada por la expresin regular usdPrice. sta es la parte numrica de la cadena de dlares de EE.UU., es decir, la cantidad de dlares sin el smbolo $. El mtodo aplica una conversin de tasa de cambio y devuelve la cadena resultante (con un smbolo final, en lugar de un smbolo $ inicial).
97
Ms temas de ayuda
XML, clase Tutorial de procesamiento de XML con E4X en Mozilla Especificacin ECMA-357
Los datos XML tambin pueden ser ms complejos, con etiquetas anidadas dentro de otras etiquetas as como atributos y otros componentes estructurales. A continuacin se muestra un ejemplo ms complejo de datos XML:
98
<album> <title>Questions, unanswered</title> <artist>Steve and the flubberblubs</artist> <year>1989</year> <tracks> <song tracknumber="1" length="4:05"> <title>What do you know?</title> <artist>Steve and the flubberblubs</artist> <lastplayed>2006-10-17-08:31</lastplayed> </song> <song tracknumber="2" length="3:45"> <title>Who do you know?</title> <artist>Steve and the flubberblubs</artist> <lastplayed>2006-10-17-08:35</lastplayed> </song> <song tracknumber="3" length="5:14"> <title>When do you know?</title> <artist>Steve and the flubberblubs</artist> <lastplayed>2006-10-17-08:39</lastplayed> </song> <song tracknumber="4" length="4:19"> <title>Do you know?</title> <artist>Steve and the flubberblubs</artist> <lastplayed>2006-10-17-08:44</lastplayed> </song> </tracks> </album>
Este documento XML contiene otras estructuras XML completas (como las etiquetas song con sus elementos secundarios). Tambin muestra otras estructuras XML como atributos (tracknumber y length en las etiquetas song) y etiquetas que contienen otras etiquetas en lugar de contener datos (como la etiqueta tracks). Introduccin a XML A continuacin se ofrece una descripcin breve de los aspectos ms comunes de los datos XML para usuarios con poca o ninguna experiencia en la utilizacin de XML. Los datos XML se escriben en formato de texto simple, con una sintaxis especfica para organizar la informacin en un formato estructurado. Generalmente, un conjunto individual de datos XML se denomina documento XML. En formato XML, los datos se organizan en elementos (que pueden ser elementos de datos individuales o contenedores para otros elementos) con una estructura jerrquica. Cada documento XML tiene un elemento individual como elemento de nivel superior o principal; dentro de este elemento raz puede haber un solo elemento de informacin, aunque es ms probable que haya otros elementos, que a su vez contienen otros elementos, etc. Por ejemplo, este documento XML contiene informacin sobre un lbum de msica:
<song tracknumber="1" length="4:05"> <title>What do you know?</title> <artist>Steve and the flubberblubs</artist> <mood>Happy</mood> <lastplayed>2006-10-17-08:31</lastplayed> </song>
Cada elemento se distingue mediante un conjunto de etiquetas, constituidas por el nombre del elemento entre corchetes angulares (signos menor que y mayor que). La etiqueta inicial, que indica el principio del elemento, tiene el nombre de elemento:
<title>
La etiqueta final, que marca el final del elemento, tiene una barra diagonal antes del nombre del elemento:
99
</title>
Si un elemento no contiene nada, puede escribirse como un elemento vaco (y se representa con una sola etiqueta). En XML, este elemento:
<lastplayed/>
Adems del contenido del elemento entre las etiquetas inicial y final, un elemento tambin puede incluir otros valores, denominados atributos, que se definen en la etiqueta inicial del elemento. Por ejemplo, este elemento XML define un solo atributo denominado length, con valor "4:19" :
<song length="4:19"></song>
Cada elemento XML tiene contenido, que puede ser un valor individual, uno o ms elementos XML, o nada (en el caso de un elemento vaco). Ms informacin sobre XML Para ms informacin sobre la utilizacin de XML, hay vario libros y recursos adicionales, incluidos estos sitios web:
Tutorial XML de W3Schools: http://w3schools.com/xml/ Tutoriales, listas de discusin y otros elementos de XMLpitstop: http://xmlpitstop.com/
Clases de ActionScript para trabajar con XML ActionScript 3.0 incluye varias clases que se utilizan para trabajar con informacin estructurada en formato XML. Las dos clases principales son:
XML: representa un solo elemento XML, que puede ser un documento XML con varios elementos secundarios o
un elemento con un solo valor en un documento.
XMLList: representa un conjunto de elementos XML. El objeto XMLList se utiliza cuando hay varios elementos
XML del mismo nivel (estn en el mismo nivel y pertenecen al mismo elemento principal en la jerarqua del documento XML). Por ejemplo, una instancia de XMLList sera la manera ms sencilla de trabajar con este conjunto de elementos XML (que se supone contenido en un documento XML):
<artist type="composer">Fred Wilson</artist> <artist type="conductor">James Schmidt</artist> <artist type="soloist">Susan Harriet Thurndon</artist>
Para usos ms avanzados que requieran espacios de nombres XML, ActionScript tambin incluye las clases Namespace y QName. Para ms informacin, consulte Uso de espacios de nombres XML en la pgina 112. Adems de las clases incorporadas para trabajar con XML, ActionScript 3.0 tambin incluye varios operadores que proporcionan funcionalidad especfica para acceder a datos XML y manipularlos. Este enfoque para trabajar con XML mediante estas clases y operadores se denomina ECMAScript for XML (E4X) y est definido en la especificacin de ECMA-357 edicin 2. Conceptos y trminos importantes La siguiente lista de referencia contiene trminos importantes que aparecern al programar rutinas de gestin XML:
Elemento Elemento individual de un documento XML, identificado como una etiqueta inicial y una etiqueta final, y
el contenido existente entre las etiquetas (incluidas estas). Los elementos XML pueden contener texto o elementos de otro tipo, o pueden estar vacos.
100
Elemento vaco Elemento XML que no contiene elementos secundarios. Los elementos vacos se suelen escribir con
puede constar nicamente de un elemento vaco); no obstante, debe tener un solo elemento de nivel superior que contenga a todos los dems elementos del documento.
Nodo Nombre alternativo para un elemento XML. Atributo Valor con nombre asociado con un elemento que se escribe en la etiqueta inicial del elemento con el formato
nombreAtributo="valor", en lugar de escribirse como un elemento secundario independiente anidado dentro del
elemento.
Simplicidad: siempre que sea posible, E4X facilita la escritura y comprensin del cdigo para trabajar con datos XML. Coherencia: los mtodos y la lgica que subyacen a E4X son coherentes internamente y con otros componentes de
ActionScript.
Familiaridad: los datos XML se manipulan con operadores conocidos, como el operador punto (.).
Nota: ActionScript 2.0 tena una clase XML. En ActionScript 3.0 se ha cambiado su nombre a XMLDocument para que no entre en conflicto con la clase XML de ActionScript 3.0 que forma parte de E4X. Las clases antiguas (XMLDocument, XMLNode, XMLParser y XMLTag) se incluyen en el paquete flash.xml principalmente por compatibilidad con cdigo antiguo. Las nuevas clases de E4X son clases principales; no es necesario importar un paquete para utilizarlas. Para obtener informacin sobre las clases XML heredadas de ActionScript 2.0, consulte el paquete flash.xml en Referencia de ActionScript 3.0 para la plataforma de Adobe Flash. A continuacin se muestra un ejemplo de manipulacin de datos con E4X:
var myXML:XML = <order> <item id='1'> <menuName>burger</menuName> <price>3.95</price> </item> <item id='2'> <menuName>fries</menuName> <price>1.45</price> </item> </order>
A menudo, la aplicacin cargar datos XML desde un origen externo, como un servicio web o un canal RSS. No obstante, para mayor claridad, los ejemplos de cdigo proporcionados asignan datos XML como literales. Tal y como se muestra en el cdigo siguiente, E4X incluye algunos operadores intuitivos, como el operador punto (.) y el operador de identificador de atributo (@), para acceder a propiedades y atributos en datos XML:
101
El mtodo appendChild() se utiliza para asignar un nuevo nodo secundario a los datos XML, como se indica en el siguiente fragmento de cdigo:
var newItem:XML = <item id="3"> <menuName>medium cola</menuName> <price>1.25</price> </item> myXML.appendChild(newItem);
Los operadores @ y . se utilizan no slo para leer datos, sino tambin para asignar datos, como se indica a continuacin:
myXML.item[0].menuName="regular burger"; myXML.item[1].menuName="small fries"; myXML.item[2].menuName="medium cola"; myXML.item.(menuName=="regular burger").@quantity = "2"; myXML.item.(menuName=="small fries").@quantity = "2"; myXML.item.(menuName=="medium cola").@quantity = "2";
Se puede utilizar un bucle for para recorrer nodos de los datos XML, de la manera siguiente:
var total:Number = 0; for each (var property:XML in myXML.item) { var q:int = Number(property.@quantity); var p:Number = Number(property.price); var itemTotal:Number = q * p; total += itemTotal; trace(q + " " + property.menuName + " $" + itemTotal.toFixed(2)) } trace("Total: $", total.toFixed(2));
Objetos XML
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior Un objeto XML puede representar un elemento, atributo, comentario, instruccin de procesamiento o elemento de texto XML. Los objetos XML pueden clasificarse como de contenido simple o de contenido complejo. Un objeto XML que tiene nodos secundarios se clasifica como objeto de contenido complejo. Se dice que un objeto XML tiene contenido simple si es cualquiera de los siguientes elementos: un atributo, un comentario, una instruccin de procesamiento o un nodo de texto. Por ejemplo, el siguiente objeto XML contiene contenido complejo, incluidos un comentario y una instruccin de procesamiento:
102
XML.ignoreComments = false; XML.ignoreProcessingInstructions = false; var x1:XML = <order> <!--This is a comment. --> <?PROC_INSTR sample ?> <item id='1'> <menuName>burger</menuName> <price>3.95</price> </item> <item id='2'> <menuName>fries</menuName> <price>1.45</price> </item> </order>
Como se muestra en el siguiente ejemplo, ahora se pueden utilizar los mtodos comments() y processingInstructions() para crear nuevos objetos XML, un comentario y una instruccin de procesamiento:
var x2:XML = x1.comments()[0]; var x3:XML = x1.processingInstructions()[0];
Propiedades XML
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior La clase XML tiene cinco propiedades estticas:
La propiedad ignoreWhitespace determina si deben omitirse los caracteres de espacio en blanco en las etiquetas
de elemento y las expresiones incorporadas que slo estn separadas por caracteres de espacio en blanco.
Las propiedades prettyIndentyprettyPrinting se utilizan para aplicar formato al texto devuelto por los
mtodos toString() y toXMLString() de la clase XML. Para obtener informacin sobre estas propiedades, consulte Referencia de ActionScript 3.0 para la plataforma de Adobe Flash.
Mtodos XML
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior Los siguientes mtodos permiten trabajar con la estructura jerrquica de los objetos XML:
103
attribute() attributes()
Los siguientes mtodos sirven para trabajar con nombres completos y espacios de nombres:
addNamespace() inScopeNamespaces() localName() name() namespace() namespaceDeclarations() removeNamespace() setLocalName() setName() setNamespace()
Los siguientes mtodos sirven para trabajar con (y determinar) tipos especficos de contenido XML:
Los siguientes mtodos sirven para la conversin a cadenas y para aplicar formato a objetos XML:
104
Para obtener informacin sobre estos mtodos, consulte Referencia de ActionScript 3.0 para la plataforma de Adobe Flash.
Objetos XMLList
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior Una instancia de XMLList representa una coleccin arbitraria de objetos XML. Puede contener documentos XML completos, fragmentos XML o los resultados de una consulta XML. Los siguientes mtodos permiten trabajar con la estructura jerrquica de los objetos XMLList:
attribute() attributes()
hasOwnProperty() propertyIsEnumerable()
Los siguientes mtodos sirven para trabajar con (y determinar) tipos especficos de contenido XML:
Los siguientes mtodos sirven para la conversin a cadenas y para aplicar formato al objeto XMLList:
105
Para obtener informacin sobre estos mtodos, consulte Referencia de ActionScript 3.0 para la plataforma de Adobe Flash. Para un objeto XMLList que contiene exactamente un elemento XML se pueden utilizar todas las propiedades y mtodos de la clase XML, ya que un objeto XMLList con un elemento XML se trata igual que un objeto XML. Por ejemplo, en el cdigo siguiente, como doc.div es un objeto XMLList que contiene un elemento, se puede utilizar el mtodo appendChild() de la clase XML:
var doc:XML = <body> <div> <p>Hello</p> </div> </body>; doc.div.appendChild(<p>World</p>);
Para obtener una lista de propiedades y mtodos XML, consulte Objetos XML en la pgina 101.
Como se indica en el siguiente fragmento de cdigo, tambin se puede utilizar el constructor new para crear una instancia de un objeto XML de una cadena que contiene datos XML:
var str:String = "<order><item id='1'><menuName>burger</menuName>" + "<price>3.95</price></item></order>"; var myXML:XML = new XML(str);
Si los datos XML de la cadena no estn bien formados (por ejemplo, si falta una etiqueta final), aparecer un error en tiempo de ejecucin. Tambin se puede pasar datos por referencia (desde otras variables) a un objeto XML, como se indica en el siguiente ejemplo:
106
var tagname:String = "item"; var attributename:String = "id"; var attributevalue:String = "5"; var content:String = "Chicken"; var x:XML = <{tagname} {attributename}={attributevalue}>{content}</{tagname}>; trace(x.toXMLString()) // Output: <item id="5">Chicken</item>
Para cargar datos XML desde una direccin URL hay que utilizar la clase URLLoader, como se indica en el siguiente ejemplo:
import flash.events.Event; import flash.net.URLLoader; import flash.net.URLRequest; var externalXML:XML; var loader:URLLoader = new URLLoader(); var request:URLRequest = new URLRequest("xmlFile.xml"); loader.load(request); loader.addEventListener(Event.COMPLETE, onComplete); function onComplete(event:Event):void { var loader:URLLoader = event.target as URLLoader; if (loader != null) { externalXML = new XML(loader.data); trace(externalXML.toXMLString()); } else { trace("loader is not a URLLoader!"); } }
Para leer datos XML desde una conexin de socket hay que utilizar la clase XMLSocket. Para obtener ms informacin, consulte la clase XMLSocket en Referencia de ActionScript 3.0 para la plataforma de Adobe Flash.
Los mtodos insertChildBefore() e insertChildAfter() permiten aadir una propiedad antes o despus (respectivamente) de una propiedad especificada, como se indica a continuacin:
107
var x:XML = <body> <p>Paragraph 1</p> <p>Paragraph 2</p> </body> var newNode:XML = <p>Paragraph 1.5</p> x = x.insertChildAfter(x.p[0], newNode) x = x.insertChildBefore(x.p[2], <p>Paragraph 1.75</p>)
Como se indica en el siguiente ejemplo, tambin se pueden utilizar operadores de llave ( { y } ) para pasar datos por referencia (desde otras variables) al construir objetos XML:
var ids:Array = [121, 122, 123]; var names:Array = [["Murphy","Pat"], ["Thibaut","Jean"], ["Smith","Vijay"]] var x:XML = new XML("<employeeList></employeeList>"); for (var i:int = 0; i < 3; i++) { var newnode:XML = new XML(); newnode = <employee id={ids[i]}> <last>{names[i][0]}</last> <first>{names[i][1]}</first> </employee>; x = x.appendChild(newnode) }
Se pueden asignar propiedades y atributos a un objeto XML utilizando el operador =, como se indica a continuacin:
var x:XML = <employee> <lastname>Smith</lastname> </employee> x.firstname = "Jean"; x.@id = "239";
108
El objeto myXML.book es un objeto XMLList que contiene propiedades secundarias del objeto myXML denominado book. Son dos objetos XML, que coinciden con las dos propiedades book del objeto myXML. El objeto myXML..lastName es un objeto XMLList que contiene todas las propiedades de descendentes denominadas
lastName. Son dos objetos XML, que coinciden con las dos propiedades lastName del objeto myXML.
El objeto myXML.book.editor.lastName es un objeto XMLList que contiene los elementos secundarios que tengan el nombre lastName de los elementos secundarios denominados editor de los elementos secundarios llamados book del objeto myXML: en este caso, es un objeto XMLList que contiene slo un objeto XML (la propiedad lastName con el valor "Case").
109
Para acceder a un elemento terciario especfico se pueden especificar nmeros de ndice para los nombres del elemento secundario y el elemento terciario:
myXML.book[0].title[0]
Sin embargo, si x.book[0] slo tuviera un elemento secundario denominado title, se puede omitir la referencia al ndice, como se muestra a continuacin:
myXML.book[0].title
De forma similar, si slo hay un elemento secundario book del objeto x y dicho objeto secundario tiene un solo objeto de ttulo, se pueden omitir ambas referencias de ndice, como se muestra a continuacin:
myXML.book.title
Se puede utilizar el mtodo child() para desplazarse por los elementos secundarios con nombres basados en una variable o expresin, como se indica en el siguiente ejemplo:
var myXML:XML = <order> <book> <title>Dictionary</title> </book> </order>; var childName:String = "book"; trace(myXML.child(childName).title) // output: Dictionary
Acceso a atributos
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior El smbolo @ (el operador identificador de atributo) se utiliza para acceder a atributos de un objeto XML o XMLList, como se muestra en el cdigo siguiente:
var employee:XML = <employee id="6401" code="233"> <lastName>Wu</lastName> <firstName>Erin</firstName> </employee>; trace(employee.@id); // 6401
Se puede utilizar el smbolo de comodn * con el smbolo @ para acceder a todos los atributos de un objeto XML o XMLList, como se muestra en el cdigo siguiente:
var employee:XML = <employee id="6401" code="233"> <lastName>Wu</lastName> <firstName>Erin</firstName> </employee>; trace(employee.@*.toXMLString()); // 6401 // 233
Se puede utilizar el mtodo attribute() o attributes() para acceder a un atributo especfico o a todos los atributos de un objeto XML o XMLList, como se muestra en el cdigo siguiente:
110
var employee:XML = <employee id="6401" code="233"> <lastName>Wu</lastName> <firstName>Erin</firstName> </employee>; trace(employee.attribute("id")); // 6401 trace(employee.attribute("*").toXMLString()); // 6401 // 233 trace(employee.attributes().toXMLString()); // 6401 // 233
Tambin se puede utilizar la sintaxis siguiente para acceder a atributos, como se muestra en el siguiente ejemplo:
employee.attribute("id") employee["@id"] employee.@["id"]
x.employee.(lastName == "McGee"); es el segundo nodo employee. x.employee.(lastName == "McGee").firstName; es la propiedad firstName del segundo nodo employee. x.employee.(lastName == "McGee").@id; es el valor del atributo id del segundo nodo employee. x.employee.(@id == 347); es el primer nodo employee. x.employee.(@id== 347).lastName; es la propiedad lastName del primer nodo employee. x.employee.(@id > 300); es un objeto XMLList con ambas propiedades employee. x.employee.(position.toString().search("analyst") > -1); es un objeto XMLList con ambas
propiedades position. Si se intentan filtrar atributos o elementos que no existen, se emitir una excepcin. Por ejemplo, la lnea final del cdigo siguiente genera un error porque no hay ningn atributo id en el segundo elemento p:
111
var doc:XML = <body> <p id='123'>Hello, <b>Bob</b>.</p> <p>Hello.</p> </body>; trace(doc.p.(@id == '123'));
De manera similar, la lnea final del cdigo siguiente genera un error porque no hay ningn atributo b en el segundo elemento p:
var doc:XML = <body> <p id='123'>Hello, <b>Bob</b>.</p> <p>Hello.</p> </body>; trace(doc.p.(b == 'Bob'));
Para evitar estos errores, se pueden identificar las propiedades que tienen los atributos o elementos coincidentes mediante los mtodos attribute() y elements(), como se muestra en el cdigo siguiente:
var doc:XML = <body> <p id='123'>Hello, <b>Bob</b>.</p> <p>Hello.</p> </body>; trace(doc.p.(attribute('id') == '123')); trace(doc.p.(elements('b') == 'Bob'));
112
El bucle for each..in permite recorrer las propiedades del objeto XMLList:
var total2:Number = 0; for each (var prop:XML in myXML.item) { total2 += prop.@quantity * prop.price; }
El espacio de nombres tiene un prefijo, soap, y un URI que define el espacio de nombres, http://schemas.xmlsoap.org/soap/envelope/. ActionScript 3.0 incluye la clase Namespace para trabajar con espacios de nombres XML. Para el objeto XML del ejemplo anterior se puede utilizar la clase Namespace de la manera siguiente:
var soapNS:Namespace = message.namespace("soap"); trace(soapNS); // Output: http://schemas.xmlsoap.org/soap/envelope/ var wNS:Namespace = new Namespace("w", "http://www.test.com/weather/"); message.addNamespace(wNS); var encodingStyle:XMLList = message.@soapNS::encodingStyle; var body:XMLList = message.soapNS::Body; message.soapNS::Body.wNS::GetWeatherResponse.wNS::tempurature = "78";
La clase XML incluye los siguientes mtodos para trabajar con espacios de nombres: addNamespace(), inScopeNamespaces(), localName(), name(), namespace(), namespaceDeclarations(), removeNamespace(), setLocalName(), setName() y setNamespace(). La directiva default xml namespace permite asignar un espacio de nombres predeterminado para objetos XML. Por ejemplo, en el fragmento de cdigo siguiente, x1 y x2 tienen el mismo espacio de nombres predeterminado:
113
var ns1:Namespace = new Namespace("http://www.example.com/namespaces/"); default xml namespace = ns1; var x1:XML = <test1 />; var x2:XML = <test2 />;
Si se utiliza el mtodo trace() sin especificar toString() ni toXMLString(), los datos se convierten con el mtodo toString() de manera predeterminada, como se muestra en el cdigo siguiente:
var myXML:XML = <order> <item id='1' quantity='2'> <menuName>burger</menuName> <price>3.95</price> </item> <order>; trace(myXML.item[0].menuName); // burger
Al utilizar el mtodo trace() para depurar cdigo, generalmente se desear utilizar el mtodo toXMLString() para que el mtodo trace() devuelva datos ms completos.
114
Si se intenta convertir una cadena en XML a partir de una cadena que representa datos XML no vlidos o que no estn bien formados, se emitir un error en tiempo de ejecucin, como se muestra a continuacin:
var x:XML = new XML("<a>test"); // throws an error
Si este cdigo no utilizara la funcin Number(), interpretara el operador + como el operador de concatenacin de cadenas y el mtodo trace() en la ltima lnea emitira lo siguiente:
01.003.95
115
import flash.events.Event; import flash.net.URLLoader; var myXML:XML = new XML(); var XML_URL:String = "http://www.example.com/Sample3.xml"; var myXMLURL:URLRequest = new URLRequest(XML_URL); var myLoader:URLLoader = new URLLoader(myXMLURL); myLoader.addEventListener(Event.COMPLETE, xmlLoaded); function xmlLoaded(event:Event):void { myXML = XML(myLoader.data); trace("Data loaded."); }
Tambin se puede utilizar la clase XMLSocket para configurar una conexin de socket XML asncrona con un servidor. Para obtener ms informacin, consulte Referencia de ActionScript 3.0 para la plataforma de Adobe Flash.
Uso de mtodos XML para recorrer datos XML en forma de canal RSS. Uso de mtodos XML para crear datos XML en formato HTML para utilizarlos en un campo de texto.
Se ha extendido el uso del formato RSS para sindicar noticias en formato XML. El aspecto de un archivo de datos RSS simple ser similar al siguiente:
116
<?xml version="1.0" encoding="UTF-8" ?> <rss version="2.0" xmlns:dc="http://purl.org/dc/elements/1.1/"> <channel> <title>Alaska - Weather</title> <link>http://www.nws.noaa.gov/alerts/ak.html</link> <description>Alaska - Watches, Warnings and Advisories</description> <item> <title> Short Term Forecast - Taiya Inlet, Klondike Highway (Alaska) </title> <link> http://www.nws.noaa.gov/alerts/ak.html#A18.AJKNK.1900 </link> <description> Short Term Forecast Issued At: 2005-04-11T19:00:00 Expired At: 2005-04-12T01:00:00 Issuing Weather Forecast Office Homepage: http://pajk.arh.noaa.gov </description> </item> <item> <title> Short Term Forecast - Haines Borough (Alaska) </title> <link> http://www.nws.noaa.gov/alerts/ak.html#AKZ019.AJKNOWAJK.190000 </link> <description> Short Term Forecast Issued At: 2005-04-11T19:00:00 Expired At: 2005-04-12T01:00:00 Issuing Weather Forecast Office Homepage: http://pajk.arh.noaa.gov </description> </item> </channel> </rss>
La aplicacin SimpleRSS lee datos RSS de Internet, analiza dichos datos en busca de titulares (ttulos), vnculos y descripciones, y devuelve esos datos. La clase SimpleRSSUI proporciona la interfaz de usuario y llama a la clase SimpleRSS, que lleva a cabo todo el procesamiento de los datos XML. Para obtener los archivos de la aplicacin para esta muestra, consulte www.adobe.com/go/learn_programmingAS3samples_flash_es. Los archivos de la aplicacin RSSViewer se encuentran en la carpeta Samples/RSSViewer. La aplicacin consta de los siguientes archivos:
Archivo RSSViewer.mxml o RSSViewer.fla com/example/programmingas3/rssViewer/RSSParser.as Una clase que contiene mtodos que utilizan E4X para atravesar datos RSS (XML) y generan una representacin HTML correspondiente. Un archivo RSS de ejemplo. La aplicacin est configurada para leer datos RSS de Internet, en un canal RSS de Flex alojado por Adobe. No obstante, se puede modificar fcilmente para que lea datos RSS de este documento, que utiliza un esquema ligeramente distinto del que utiliza el canal RSS de Flex. Descripcin El archivo de aplicacin principal en Flash (FLA) o Flex (MXML).
RSSData/ak.rss
117
Las lneas siguientes recorren el contenido del origen de datos XML, examinando cada propiedad descendente denominada item:
for each (var item:XML in rssXML..item) { var itemTitle:String = item.title.toString(); var itemDescription:String = item.description.toString(); var itemLink:String = item.link.toString(); outXML += buildItemHTML(itemTitle, itemDescription, itemLink); }
Las tres primeras lneas son simplemente un conjunto de variables de cadena para representar las propiedades de ttulo, descripcin y vnculo de la propiedad item de los datos XML. A continuacin, la siguiente lnea llama al mtodo buildItemHTML() para obtener datos HTML en forma de objeto XMLList, utilizando las tres nuevas variables de cadena como parmetros.
Las primeras lneas del mtodo borran el espacio de nombres XML predeterminado:
default xml namespace = new Namespace();
La directiva default xml namespace tiene mbito de nivel de bloque de funcin. Esto significa que el mbito de esta declaracin es el mtodo buildItemHTML(). Las lneas siguientes crean el objeto XMLList basndose en los argumentos de cadena pasados a la funcin:
118
var body:XMLList = new XMLList(); body += new XML("<b>" + itemTitle + "</b>"); var p:XML = new XML("<p>" + itemDescription + "</p>"); var link:XML = <a></a>; link.@href = itemLink; // <link href="itemLinkString"></link> link.font.@color = "#008000"; // <font color="#008000"></font></a> // 0x008000 = green link.font = "More..."; p.appendChild(<br/>); p.appendChild(link); body += p;
Este objeto XMLList representa una cadena datos adecuada para un campo de texto HTML de ActionScript. El mtodo xmlLoaded() utiliza el valor devuelto por el mtodo buildItemHTML() y lo convierte en una cadena:
XML.prettyPrinting = false; rssOutput = outXML.toXMLString();
Por ltimo, el mtodo xmlLoaded() genera un evento, que notifica a la aplicacin que los datos ha sido analizados y estn disponibles:
dataWritten = new Event("dataWritten", true);
119
Ms temas de ayuda
Paquete flash.events Especificacin de eventos del modelo de objetos de documento (DOM) de nivel 3
120
Se pueden usar detectores de eventos en el cdigo para detectar los objetos de evento. Los detectores de eventos son las funciones o mtodos que se escriben para responder a los distintos eventos. Para garantizar que el programa responde a los eventos, es necesario aadir detectores de eventos al destino del evento o a cualquier objeto de la lista de visualizacin que forme parte del flujo del evento de un objeto de evento. Cuando se escribe cdigo para un detector de eventos, se suele seguir esta estructura bsica (los elementos en negrita son marcadores de posicin que se sustituyen en cada caso especfico):
function eventResponse(eventObject:EventType):void { // Actions performed in response to the event go here. } eventTarget.addEventListener(EventType.EVENT_NAME, eventResponse);
Este cdigo realiza dos operaciones. En primer lugar, define una funcin, que es la forma de especificar las operaciones que se llevarn a cabo como respuesta al evento. A continuacin, llama al mtodo addEventListener() del objeto de origen, bsicamente "suscribiendo" la funcin al evento especificado de modo que se lleven a cabo las acciones de la funcin cuando ocurra el evento. Cuando el evento se produce finalmente, el destino de evento comprueba la lista de todas las funciones y mtodos registrados como detectores de eventos. A continuacin llama a cada uno a su vez, pasando el objeto de evento como parmetro. Es necesario modificar cuatro elementos del cdigo para crear un detector de eventos personalizado. En primer lugar se debe cambiar el nombre de la funcin por el nombre que se desee usar (es necesario realizar este cambio en dos lugares, donde en el cdigo aparece eventResponse). Seguidamente, hay que especificar el nombre de clase adecuado para el objeto de evento distribuido por el evento que se desea detectar (EventType en el cdigo) y hay que indicar la constante apropiada para el evento especfico (EVENT_NAME en el listado). En tercer lugar, es necesario llamar al mtodo addEventListener() en el objeto que distribuir el evento (eventTarget en este cdigo). Opcionalmente, se puede cambiar el nombre de la variable utilizada como parmetro de la funcin (eventObject en el cdigo). Conceptos y trminos importantes La siguiente lista de referencia contiene trminos importantes que aparecern al escribir rutinas de gestin de eventos:
Propagacin Sucede para algunos eventos, de forma que un objeto de visualizacin principal puede responder a eventos distribuidos por sus elementos secundarios. Fase de propagacin Parte del flujo de eventos en la que un evento se propaga hasta los objetos de visualizacin
el evento, denominado comportamiento predeterminado. Por ejemplo, cuando un usuario escribe texto en un campo de texto, se activa un evento de introduccin de texto. El comportamiento predeterminado de ese evento es mostrar el carcter que se ha escrito en el campo de texto, si bien se puede sustituir ese comportamiento predeterminado (si, por alguna razn, no se desea que se muestre el carcter escrito).
Distribuir Notificar a los detectores de eventos que se ha producido un evento. Evento Algo que le sucede a un objeto y que dicho objeto puede comunicar a otros. Flujo de eventos Cuando los eventos se producen en un objeto de la lista de visualizacin (un objeto que se muestra
en pantalla), todos los objetos que contienen ese objeto reciben la notificacin del evento y, a su vez, notifican a sus detectores de eventos. El proceso comienza en el escenario y avanza a travs de la lista de visualizacin hasta el objeto
121
en el que se ha producido el evento para despus volver de nuevo hasta el escenario. Este proceso se conoce como el flujo del evento.
Objeto Event Objeto que contiene informacin acerca de un evento en concreto y que se enva a todos los detectores
Controladores de eventos on() que se pueden colocar directamente en instancias de Button y MovieClip. Controladores onClipEvent() que se pueden colocar directamente en instancias de MovieClip. Propiedades de funciones callback, como XML.onload y Camera.onActivity. Detectores de eventos que pueden registrarse con el mtodo addListener(). La clase UIEventDispatcher que implementaba parcialmente el modelo de eventos DOM.
Cada uno de estos mecanismos presenta sus propias ventajas y limitaciones. Los controladores on() y onClipEvent() son fciles de usar, pero dificultan el mantenimiento posterior de los proyectos, ya que el cdigo colocado directamente en los botones y clips de pelculas puede ser difcil de encontrar. Las funciones callback tambin son sencillas de implementar, pero slo permiten una funcin callback por evento. La implementacin de los detectores de eventos es ms compleja, ya que no slo es necesario crear un objeto y una funcin de detector, sino tambin registrar el detector en el objeto que genera el evento. No obstante, este trabajo adicional permite crear varios objetos detectores y registrarlos todos para el mismo evento.
122
El desarrollo de componentes para ActionScript 2.0 dio lugar a un nuevo modelo de eventos. Este nuevo modelo, representado por la clase UIEventDispatcher, se basaba en un subconjunto de la especificacin de eventos DOM, de modo que, para los desarrolladores que conozcan la gestin de eventos de componentes, la transicin al nuevo modelo de eventos de ActionScript 3.0 resultar relativamente sencilla. Por desgracia, la sintaxis utilizada en los distintos modelos de eventos es igual en algunos casos y diferente en otros. Por ejemplo, en ActionScript 2.0, algunas propiedades, como TextField.onChanged, se pueden usar como funcin callback o como detector de eventos. Sin embargo, la sintaxis para registrar objetos detectores vara dependiendo de si se utiliza una de las seis clases que admiten detectores en la clase UIEventDispatcher. Para las clases Key, Mouse, MovieClipLoader, Selection, Stage y TextField se debe usar el mtodo addListener(), mientras que para la gestin de eventos de componentes es necesario utilizar un mtodo llamado addEventListener(). Otra complicacin introducida por los distintos modelos de gestin de eventos es que el mbito de la funcin de controlador de eventos vara ampliamente dependiendo del mecanismo usado. Dicho de otro modo, el significado de la palabra clave this vara entre los distintos sistemas de gestin de eventos.
123
Hay varios tipos de objetos de evento que no tienen asociado ningn comportamiento predeterminado. Por ejemplo, Flash Player distribuye un objeto de evento connect cuando se establece una conexin de red, pero no hay ningn comportamiento predeterminado asociado a l. La documentacin de la API para la clase Event y sus subclases relaciona cada tipo de evento y describe el comportamiento predeterminado que tiene asociado, e indica si es posible impedir dicho comportamiento. Es importante comprender que los comportamientos predeterminados slo estn asociados con objetos de eventos distribuidos por Flash Player o AIR y que no existen para objetos de eventos distribuidos mediante programacin a travs de ActionScript. Por ejemplo, se pueden usar los mtodos de la clase EventDispatcher para distribuir un objeto de evento de tipo textInput, pero ese objeto de evento no tendr ningn comportamiento predeterminado asociado. Es decir, Flash Player y AIR no mostrarn un carcter en un objeto TextField como resultado de un evento textInput que se haya distribuido mediante programacin. Novedades de los detectores de eventos de ActionScript 3.0 Para los desarrolladores con experiencia en el uso del mtodo addListener() de ActionScript 2.0, puede resultar til sealar las diferencias entre el modelo de detectores de eventos de ActionScript 2.0 y el de ActionScript 3.0. En la siguiente lista se muestran algunas de las diferencias principales entre los dos modelos de eventos:
Para aadir detectores de eventos en ActionScript 2.0, es necesario usar addListener() en algunos casos y
addEventListener() en otros, mientras que en ActionScript 3.0 siempre se utiliza addEventListener().
En ActionScript 2.0 no existe el flujo del evento, lo que quiere decir que el mtodo addListener() slo se puede
llamar en el objeto que difunde el evento, mientras que en ActionScript 3.0, el mtodo addEventListener() se puede llamar en cualquier objeto que forme parte del flujo del evento.
En ActionScript 2.0, los detectores de eventos pueden ser funciones, mtodos u objetos, mientras que en
ActionScript 3.0 slo las funciones o los mtodos pueden ser detectores de eventos.
Flujo de eventos
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior Flash Player o AIR distribuyen objetos de evento siempre que se produce un evento. Si el destino del evento no est en la lista de visualizacin, Flash Player o AIR distribuyen el objeto de evento directamente al destino del evento. Por ejemplo, Flash Player distribuye el objeto de evento progress directamente a un objeto URLStream. Sin embargo, si el destino del evento est en la lista de visualizacin, Flash Player distribuye el objeto de evento en la lista de visualizacin, de modo que recorre la lista hasta llegar al destino del evento. El flujo del evento describe el modo en el que un objeto de evento se desplaza por la lista de visualizacin. La lista de visualizacin se organiza en una jerarqua que puede describirse como un rbol. En la parte superior de la jerarqua de la lista de visualizacin se encuentra el objeto Stage, que es un contenedor de objeto de visualizacin especial que acta como raz de la lista de visualizacin. El objeto Stage se representa mediante la clase flash.display.Stage y slo es posible acceder a l a travs de un objeto de visualizacin. Todos los objetos de visualizacin tienen una propiedad llamada stage que hace referencia al objeto Stage de esa aplicacin. Cuando Flash Player o AIR distribuyen un objeto de evento para un evento relacionado con la lista de visualizacin, ste realiza un viaje de ida y vuelta desde el objeto Stage hasta el nodo de destino. La especificacin de eventos DOM define el nodo de destino como el nodo que representa el destino del evento. Dicho de otro modo, el nodo de destino es el objeto de la lista de visualizacin en el que se ha producido el evento. Por ejemplo, si un usuario hace clic en un objeto de lista de visualizacin denominado child1, Flash Player o AIR distribuirn un objeto de evento usando child1 como nodo de destino.
124
El flujo del evento se divide conceptualmente en tres partes. La primera parte se llama fase de captura y consta de todos los nodos desde el objeto Stage hasta el elemento principal del nodo de destino. La segunda parte se llama fase de destino y consiste solamente en el nodo de destino. La tercera parte se llama fase de propagacin. La fase de propagacin consta de los nodos encontrados en el viaje de vuelta desde el elemento principal del nodo de destino hasta el objeto Stage. Los nombres de las fases cobran ms sentido imaginando la lista de visualizacin como una jerarqua vertical con el objeto Stage en la parte superior, segn se muestra en el diagrama siguiente:
Escenario
Nodo principal
Nodo secundario1
Nodo secundario2
Si un usuario hace clic en Child1 Node, Flash Player o AIR distribuyen un objeto de evento en el flujo del evento. Como muestra la imagen siguiente, el viaje del objeto empieza en Stage, desciende hasta Parent Node, luego avanza hasta Child1 Node y, finalmente, se propaga de vuelta hasta Stage cruzando de nuevo Parent Node en su vuelta a Stage.
En este ejemplo, la fase de captura consta de Stage y Parent Node durante el viaje descendente inicial. La fase de destino est compuesta por el tiempo empleado en Child1 Node. La fase de propagacin consta de Parent Node y Stage, segn se encuentran durante el viaje ascendente de vuelta hasta el nodo raz. El flujo del evento contribuye a lograr un sistema de gestin de eventos con mayores prestaciones que el que tenan anteriormente a su disposicin los programadores de ActionScript. En las versiones anteriores de ActionScript, el flujo del evento no existe, de modo que los detectores de eventos slo se pueden aadir al objeto que genera el evento. Por contra, en ActionScript 3.0, es posible aadir detectores de eventos no slo a un nodo de destino, sino tambin a cualquier nodo que pertenezca al flujo del evento. La posibilidad de aadir detectores de eventos a lo largo del flujo del evento resulta til cuando un componente de la interfaz de usuario consta de ms de un objeto. Por ejemplo, un objeto de botn suele contener un objeto de texto que acta como etiqueta del botn. Sin la capacidad de aadir un detector al flujo del evento, sera necesario aadir un detector tanto al objeto de botn como al objeto de texto para garantizar que se reciben las notificaciones de eventos de clic que se producen en cualquier punto del botn. No obstante, gracias al flujo del evento es posible colocar un nico detector de eventos en el objeto de botn para controlar los eventos de clic que se produzcan tanto en el objeto de texto como en las reas del objeto de botn que no estn cubiertas por el objeto de texto.
125
Sin embargo, no todos los objetos participan en las tres fases del flujo del evento. Algunos tipos de eventos, como enterFrame e init, se distribuyen directamente al nodo de destino y no participan ni en la fase de captura ni en la de propagacin. Otros eventos pueden tener como destino objetos que no aparecen en la lista de visualizacin, como los eventos distribuidos a las instancias de la clase Socket. Estos objetos de evento tambin van directamente al objeto de destino sin participar en las fases de captura y propagacin. Para conocer el comportamiento de un tipo particular de evento, se puede consultar la documentacin de la API o examinar las propiedades del objeto de evento. En la siguiente seccin se explica cmo examinar las propiedades del objeto de evento.
Objetos de evento
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior Los objetos de evento tienen una doble finalidad en el nuevo sistema de gestin de eventos. Primero, representan los eventos reales, guardando informacin acerca de eventos concretos en una serie de propiedades. En segundo lugar, los objetos de evento contienen una serie de mtodos que permiten manipular los objetos de evento y afectan al comportamiento del sistema de gestin de eventos. Para facilitar el acceso a estas propiedades y mtodos, la API de Flash Player define una clase Event que constituye la clase base de todos los objetos de evento. La clase Event define una serie fundamental de propiedades y mtodos que son comunes a todos los objetos de evento. Esta seccin comienza con una explicacin de las propiedades de la clase Event, prosigue con una descripcin de los mtodos de la clase Event y finaliza con un anlisis de las razones por las que existen subclases de la clase Event.
Los tipos de objetos de evento se representan mediante constantes y se almacenan en la propiedad Event.type. La posibilidad de impedir el comportamiento predeterminado de un evento se representa mediante un valor
booleano y se almacena en la propiedad Event.cancelable.
La informacin del flujo del evento est contenida en las propiedades restantes.
Tipos de objetos de evento Todos los objetos de evento estn asociados a algn tipo de evento. Los tipos de evento se guardan en la propiedad Event.type como valores de cadena. Es til saber de qu tipo es el objeto de evento para que el cdigo pueda distinguir entre objetos de distintos tipos Por ejemplo, el siguiente cdigo especifica que la funcin de detector clickHandler() debe responder a cualquier objeto de evento de clic del ratn que se pase a myDisplayObject:
myDisplayObject.addEventListener(MouseEvent.CLICK, clickHandler);
Existen unos veinte tipos de eventos asociados a la clase Event, los cuales se representan con constantes de clase Event, algunas de las cuales se muestran en el siguiente extracto de la definicin de la clase Event:
126
package flash.events { public class Event { // class constants public static const ACTIVATE:String = "activate"; public static const ADDED:String= "added"; // remaining constants omitted for brevity } }
Estas constantes proporcionan una forma sencilla de hacer referencia a tipos de eventos especficos. Es aconsejable utilizar estas constantes en lugar de las cadenas a las que representan. Si se escribe incorrectamente el nombre de una constante en el cdigo, el compilador detectar el error, pero si se usan cadenas, un error tipogrfico podra pasarse por alto durante la compilacin y dar lugar a un comportamiento inesperado difcil de depurar. Por ejemplo, al aadir un detector de eventos, es preferible usar el siguiente cdigo:
myDisplayObject.addEventListener(MouseEvent.CLICK, clickHandler);
en lugar de:
myDisplayObject.addEventListener("click", clickHandler);
Informacin sobre el comportamiento predeterminado El cdigo puede comprobar si el comportamiento predeterminado para un objeto de evento en particular puede impedirse a travs de la propiedad cancelable. La propiedad cancelable contiene un valor booleano que indica si es posible impedir un comportamiento predeterminado. Para impedir o cancelar el comportamiento predeterminado asociado con algunos eventos se puede utilizar el mtodo preventDefault(). Para obtener ms informacin, consulte Cancelacin del comportamiento predeterminado de eventos en Aspectos bsicos de los mtodos de la clase Event en la pgina 128. Informacin sobre el flujo del evento Las dems propiedades de la clase Event contienen informacin importante acerca de un objeto de evento y su relacin con el flujo del evento, segn se describe en la siguiente lista:
La propiedad bubbles contiene informacin acerca de las partes del flujo del evento en el que participa el objeto
de evento.
La propiedad eventPhase indica la fase en curso del flujo del evento. La propiedad target almacena una referencia al destino del evento. La propiedad currentTarget almacena una referencia al objeto de la lista de visualizacin que est procesando en
ese momento el objeto de evento. La propiedad bubbles Se dice que un evento se propaga ("bubbles", en ingls) si su objeto de evento participa en la fase de propagacin del flujo del evento, lo que quiere decir que dicho objeto regresa desde el nodo de destino, a travs de sus ascendientes, hasta alcanzar el objeto Stage. La propiedad Event.bubbles almacena un valor booleano que indica si el objeto de evento participa en la fase de propagacin. Dado que todos los eventos que se propagan tambin participan en las fases de captura y destino, cualquier evento que se propague participa en las tres fases del flujo del evento. Si el valor es true, el objeto de evento participa en las tres fases. Si es false, el objeto de evento no participa en la fase de propagacin.
127
La propiedad eventPhase Es posible determinar la fase del evento de un objeto de evento estudiando su propiedad eventPhase. La propiedad eventPhase contiene un valor entero sin signo que representa una de las tres fases del flujo del evento. La API de Flash Player define una clase EventPhase independiente que contiene tres constantes que se corresponden con los tres valores enteros sin signo, segn se muestra en el siguiente extracto de cdigo:
package flash.events { public final class EventPhase { public static const CAPTURING_PHASE:uint = 1; public static const AT_TARGET:uint = 2; public static const BUBBLING_PHASE:uint= 3; } }
Estas constantes corresponden a los tres valores vlidos de la propiedad eventPhase. Es aconsejable usar estas constantes para hacer que el cdigo sea ms legible. Por ejemplo, para asegurarse de que una funcin denominada miFunc() slo se llame si el destino del evento est en la fase de destino, es posible usar el siguiente cdigo para probar dicha condicin:
if (event.eventPhase == EventPhase.AT_TARGET) { myFunc(); }
La propiedad target La propiedad target contiene una referencia al objeto que es el destino del evento. En algunas situaciones esto resulta evidente, como cuando se activa un micrfono, en cuyo caso el destino del objeto de evento es el objeto Microphone. Sin embargo, si el destino se encuentra en la lista de visualizacin, es necesario tener en cuenta la jerarqua de sta. Por ejemplo, si un usuario hace clic con el ratn en un punto que incluye objetos solapados de la lista de visualizacin, Flash Player o AIR siempre seleccionan el objeto que se encuentra ms lejos del objeto Stage como destino del evento. En el caso de archivos SWF complejos, especialmente aquellos en los que los botones se decoran sistemticamente con objetos secundarios menores, la propiedad target no puede usarse con demasiada frecuencia, ya que en muchas ocasiones sealar a los objetos secundarios de los botones en lugar de a los propios botones. En estas situaciones, lo habitual es aadir detectores de eventos al botn y usar la propiedad currentTarget, ya que sta seala al botn, mientras que la propiedad target puede sealar a un elemento secundario del mismo. La propiedad currentTarget La propiedad currentTarget contiene una referencia al objeto que est procesando en ese momento al objeto de evento. Aunque puede parecer extrao no saber qu nodo est procesando en ese momento al objeto de evento que se est examinando, es necesario recordar que se puede aadir una funcin de detector a cualquier objeto de visualizacin en el flujo del evento de ese objeto de evento y que dicha funcin puede colocarse en cualquier lugar. Adems, es posible aadir la misma funcin de detector a distintos objetos de visualizacin. A medida que el tamao y la complejidad de un proyecto crecen, la propiedad currentTarget resulta cada vez ms til.
128
Mtodos de utilidad, que pueden crear copias de un objeto de evento o convertirlo en una cadena. Mtodos de flujo del evento, que eliminan objetos de evento del flujo del evento. Mtodos de comportamiento predeterminado, que impiden que se produzca el comportamiento predeterminado
o comprueban si se ha impedido Mtodos de utilidad de la clase Event Existen dos mtodos de utilidad en la clase Event. El mtodo clone() permite crear copias de un objeto de evento. El mtodo toString() permite generar una representacin en forma de cadena de las propiedades de un objeto de evento, junto con sus valores. El sistema de modelos de evento usa ambos mtodos internamente, pero estn a disposicin de los desarrolladores para el uso general. Los desarrolladores avanzados que deseen crear subclases de la clase Event deben sustituir e implementar versiones de ambos mtodos de utilidad para asegurarse de que la subclase de eventos funcionar correctamente. Detener el flujo del evento Se puede llamar al mtodo Event.stopPropagation() o Event.stopImmediatePropagation() para impedir que un objeto de evento siga movindose por el flujo del evento. Ambos mtodos son casi idnticos y slo se diferencian en que uno permite que se ejecuten los dems detectores de eventos del nodo en curso y el otro no:
El mtodo Event.stopPropagation() impide que el objeto de evento avance hasta el siguiente nodo, pero slo
despus de permitir que se ejecuten todos los dems detectores de eventos del nodo en curso.
129
Detectores de eventos
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior Los detectores de eventos, tambin llamados controladores de eventos, son funciones que ejecutan Flash Player y AIR como respuesta a eventos especficos. El proceso de aadir un detector de eventos consta de dos pasos. En primer lugar se debe crear una funcin o mtodo de clase para que Flash Player o AIR lo ejecuten como respuesta al evento. Esto a veces recibe el nombre de funcin de detector o funcin de controlador de eventos. En segundo lugar, es necesario usar el mtodo addEventListener() para registrar la funcin de detector en el destino del evento o en cualquier objeto de la lista de visualizacin que se encuentre en el trayecto del flujo del evento adecuado.
130
Funcin de detector definida fuera de una clase El siguiente cdigo crea un archivo SWF sencillo que muestra una forma cuadrada roja. Una funcin de detector denominada clickHandler(), que no forma parte de ninguna clase, detecta los eventos de clic del ratn sobre el cuadrado rojo.
package { import flash.display.Sprite; public class ClickExample extends Sprite { public function ClickExample() { var child:ChildSprite = new ChildSprite(); addChild(child); } } } import flash.display.Sprite; import flash.events.MouseEvent; class ChildSprite extends Sprite { public function ChildSprite() { graphics.beginFill(0xFF0000); graphics.drawRect(0,0,100,100); graphics.endFill(); addEventListener(MouseEvent.CLICK, clickHandler); } } function clickHandler(event:MouseEvent):void { trace("clickHandler detected an event of type: " + event.type); trace("the this keyword refers to: " + this); }
Cuando el usuario interacta con el archivo SWF resultante haciendo clic en el cuadrado, Flash Player o AIR generan la siguiente salida de traza:
clickHandler detected an event of type: click the this keyword refers to: [object global]
Cabe destacar que el objeto de evento se pasa como argumento a clickHandler(). Esto permite a la funcin de detector examinar el objeto de evento. En este ejemplo se usa la propiedad type del objeto de evento para determinar si se trata de un evento de clic. En el ejemplo tambin se comprueba el valor de la palabra clave this. En este caso, this representa el objeto global, lo cual es totalmente lgico, ya que la funcin se ha definido fuera de todo objeto o clase personalizada. Funcin de detector definida como mtodo de clase El siguiente ejemplo es idntico al anterior en el que se define la clase ClickExample, excepto en que la funcin clickHandler() se define como un mtodo de la clase ChildSprite:
131
package { import flash.display.Sprite; public class ClickExample extends Sprite { public function ClickExample() { var child:ChildSprite = new ChildSprite(); addChild(child); } } } import flash.display.Sprite; import flash.events.MouseEvent; class ChildSprite extends Sprite { public function ChildSprite() { graphics.beginFill(0xFF0000); graphics.drawRect(0,0,100,100); graphics.endFill(); addEventListener(MouseEvent.CLICK, clickHandler); } private function clickHandler(event:MouseEvent):void { trace("clickHandler detected an event of type: " + event.type); trace("the this keyword refers to: " + this); } }
Cuando el usuario interacta con el archivo SWF resultante haciendo clic en el cuadrado rojo, Flash Player o AIR generan la siguiente salida de traza:
clickHandler detected an event of type: click the this keyword refers to: [object ChildSprite]
La palabra clave this hace referencia a la instancia de ChildSprite denominada child. Se trata de un cambio de comportamiento respecto a ActionScript 2.0. Los usuarios que usaban componentes en ActionScript 2.0 sin duda recordarn que, al pasar un mtodo de clase a UIEventDispatcher.addEventListener(), el mbito del mtodo estaba vinculado al componente que difunda el evento en lugar de a la clase en la que estaba definido el mtodo de detector. Dicho de otro modo, si se usara esta tcnica en ActionScript 2.0, la palabra clave this hara referencia al componente que realiza la difusin en lugar de a la instancia de ChildSprite. Esto constitua un problema significativo para algunos programadores, ya que implicaba que no podan acceder a otros mtodos y propiedades de la clase que contena el mtodo detector. Como solucin, los programadores de ActionScript 2.0 podan usar la clase mx.util.Delegate para cambiar el mbito del mtodo detector. Esto ya no es necesario, ya que ActionScript 3.0 crea un mtodo vinculado cuando se llama a addEventListener(). A consecuencia de ello, la palabra clave this hace referencia a la instancia de ChildSprite denominada child y el programador puede acceder a los dems mtodos y propiedades de la clase ChildSprite.
132
Detector de eventos de uso no recomendado Existe una tercera tcnica, que no se recomienda, en la que se crea un objeto genrico con una propiedad que seala a una funcin de detector asignada dinmicamente. Se analiza aqu porque se sola utilizar en ActionScript 2.0, aunque no se debe emplear en ActionScript 3.0. Esta tcnica no se recomienda, ya que la palabra clave this har referencia al objeto global en lugar de al objeto detector. El siguiente ejemplo es idntico al anterior de la clase ClickExample, excepto en que la funcin de detector se define como parte de un objeto genrico denominado myListenerObj:
package { import flash.display.Sprite; public class ClickExample extends Sprite { public function ClickExample() { var child:ChildSprite = new ChildSprite(); addChild(child); } } } import flash.display.Sprite; import flash.events.MouseEvent; class ChildSprite extends Sprite { public function ChildSprite() { graphics.beginFill(0xFF0000); graphics.drawRect(0,0,100,100); graphics.endFill(); addEventListener(MouseEvent.CLICK, myListenerObj.clickHandler); } } var myListenerObj:Object = new Object(); myListenerObj.clickHandler = function (event:MouseEvent):void { trace("clickHandler detected an event of type: " + event.type); trace("the this keyword refers to: " + this); }
Cabra esperar que this hiciera referencia a myListenerObj y que la salida de traza fuese [object Object] pero, en vez de eso, hace referencia al objeto global. Al pasar el nombre de una propiedad dinmica como un argumento a addEventListener(), Flash Player o AIR no pueden crear un mtodo vinculado. Esto se debe a que lo que se transmite como parmetro listener no es ms que la direccin de memoria de la funcin de detector y Flash Player y AIR son incapaces de vincular esa direccin de memoria con la instancia de myListenerObj.
133
La API de Flash Player implementa la interfaz IEventDispatcher con la clase EventDispatcher, que sirve como clase base de todas las clases que pueden ser destinos de eventos o parte de un flujo de eventos. Por ejemplo, la clase DisplayObject hereda de la clase EventDispatcher. Esto quiere decir que cualquier objeto de la lista de visualizacin tiene acceso a los mtodos de la interfaz IEventDispatcher. Aadir detectores de eventos El mtodo addEventListener() es el elemento ms ampliamente utilizado de la interfaz IEventDispatcher. Se utiliza para registrar las funciones de detector. Los dos parmetros necesarios son type y listener. Se puede usar el parmetro type para especificar el tipo de evento. El parmetro listener, por su parte, se emplea para especificar la funcin de detector que se ejecutar cuando se produzca el evento. El parmetro listener puede ser una referencia a una funcin o a un mtodo de clase. no utilice parntesis al especificar el parmetro listener. Por ejemplo, la funcin clickHandler() se especifica sin parntesis en la siguiente llamada al mtodo addEventListener():
addEventListener(MouseEvent.CLICK, clickHandler)
El parmetro useCapture del mtodo addEventListener() permite controlar la fase del flujo del evento en la que estar activa el detector. Si useCapture se establece en true, el detector estar activo durante la fase de captura del flujo del evento. Si useCapture se establece en false, el detector estar activo durante las fases de destino y de propagacin del flujo del evento. Para detectar un evento durante todas las fases del flujo del evento se debe llamar a addEventListener() dos veces, una con useCapture establecido en true y luego otra con useCapture establecido en false.
134
El parmetro priority del mtodo addEventListener() no es parte oficial del modelo de eventos DOM de nivel 3. Se incluye en ActionScript 3.0 para ofrecer una mayor flexibilidad a la hora de organizar los detectores de eventos. Cuando se llama a addEventListener(), es posible establecer la prioridad de ese detector de eventos pasando un valor entero como parmetro priority. El valor predeterminado es 0, pero se le pueden asignar valores enteros negativos o positivos. Cuanto mayor sea el nmero, antes se ejecutar el detector de eventos. Los detectores de eventos con la misma prioridad se ejecutan en el orden en que se aadieron, de modo que cuanto antes se aada, antes se ejecutar. El parmetro useWeakReference permite especificar si la referencia a la funcin de detector es dbil o normal. Si este parmetro se establece como true se pueden evitar situaciones en las que las funciones de detector permanecen en memoria incluso cuando ya no se necesitan. Flash Player y AIR usan una tcnica denominada eliminacin de datos innecesarios para borrar de la memoria objetos que han dejado de utilizarse. Se considera que un objeto ha dejado de usarse si no existe ninguna referencia a l. El recolector de datos innecesarios descarta las referencias dbiles, de modo que una funcin de detector que slo seala a una referencia dbil puede ser eliminada, al considerarse como datos innecesarios. Eliminacin de detectores de eventos El mtodo removeEventListener() sirve para eliminar un detector de eventos que ya no se necesita. Siempre conviene eliminar los detectores que no se vayan a usar ms. Los parmetros obligatorios incluyen eventName y listener, los mismos que para el mtodo addEventListener(). Conviene recordar que se pueden detectar eventos durante todas las fases de eventos llamando a addEventListener() dos veces, una vez con useCapture establecido en true y luego otra establecido en false. Para eliminar los dos detectores de eventos sera necesario llamar a removeEventListener() dos veces, una con useCapture establecido en true y luego otra establecido en false. Distribucin de eventos Los programadores expertos pueden usar el mtodo dispatchEvent() para distribuir un objeto de evento personalizado en el flujo del evento. Este mtodo slo acepta un parmetro, consistente en una referencia a un objeto de evento, que debe ser una instancia de la clase Event o una subclase de sta. Una vez distribuido, la propiedad target del objeto de evento se establece en el objeto en el que se llam a dispatchEvent(). Comprobacin de detectores de eventos existentes Los dos ltimos mtodos de la interfaz IEventDispatcher ofrecen informacin til sobre la existencia de detectores de eventos. El mtodo hasEventListener() devuelve true si se encuentra un detector de eventos para un tipo de evento especfico en un objeto concreto de la lista de visualizacin. El mtodo willTrigger() tambin devuelve true si se encuentra un detector para un objeto concreto de la lista de visualizacin, pero willTrigger() no slo comprueba la existencia de detectores en el objeto de la lista de visualizacin, sino tambin en todos los ascendientes del objeto de la lista de visualizacin para todas las fases del flujo del evento.
135
La mayor parte de los eventos de error se basan en la clase ErrorEvent y, por lo tanto, tienen una propiedad denominada text que se usa para almacenar el mensaje de error que muestra Flash Player o AIR. Las dos excepciones a esta regla son las clases StatusEvent y NetStatusEvent. Ambas clases tienen una propiedad level (StatusEvent.level y NetStatusEvent.info.level). Cuando el valor de la propiedad level es "error", estos tipos de evento se consideran eventos de error. Un evento de error no hace que el archivo SWF deje de ejecutarse. Slo se manifestar como un cuadro de dilogo en las versiones de depuracin de los plugins de navegadores y de los reproductores autnomos, como un mensaje en el panel de salida del reproductor de edicin y como una entrada en el archivo de registro de Adobe Flash Builder. No se manifiesta en las versiones oficiales de Flash Player o AIR.
Deteccin y respuesta a un evento Notificacin a los detectores de un evento Creacin de un tipo de evento personalizado
136
Para obtener los archivos de aplicacin de Flash Professional para esta muestra, consulte http://www.adobe.com/go/learn_programmingAS3samples_flash_es. Para obtener los archivos de aplicacin de Flex para esta muestra, consulte http://www.adobe.com/go/as3examples_es. Los archivos de la aplicacin del reloj con alarma se encuentran en la carpeta Samples/AlarmClock. La aplicacin consta de los siguientes archivos:
Archivo AlarmClockApp.mxml o AlarmClockApp.fla com/example/programmingas3/clock/AlarmClock.as Una clase que ampla la clase SimpleClock y aade la funcin de alarma al reloj. Una clase de eventos personalizada (una subclase de flash.events.Event) que acta como el objeto de evento del evento alarm de la clase AlarmClock. Dibuja una esfera de reloj redonda y las manecillas de hora, minutos y segundos, en funcin de la hora (descrita en el ejemplo SimpleClock). Un componente de la interfaz de reloj con funciones sencillas de control de tiempo (descrito en el ejemplo de SimpleClock). Descripcin El archivo de aplicacin principal en Flash (FLA) o Flex (MXML)
com/example/programmingas3/clock/AlarmEvent.as
com/example/programmingas3/clock/AnalogClockFace.as
com/example/programmingas3/clock/SimpleClock.as
Activacin de la alarma
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior Segn se ha mencionado con anterioridad, la nica funcionalidad que la clase AlarmClock ofrece realmente est relacionada con la configuracin y activacin de la alarma. La clase integrada Timer (flash.utils.Timer) proporciona un mecanismo para que los desarrolladores definan cdigo que se ejecutar tras un perodo de tiempo especificado. La clase AlarmClock utiliza una instancia de Timer para determinar cundo activar la alarma.
137
import flash.events.TimerEvent; import flash.utils.Timer; /** * The Timer that will be used for the alarm. */ public var alarmTimer:Timer; ... /** * Instantiates a new AlarmClock of a given size. */ public override function initClock(faceSize:Number = 200):void { super.initClock(faceSize); alarmTimer = new Timer(0, 1); alarmTimer.addEventListener(TimerEvent.TIMER, onAlarm); }
La instancia de Timer definida en la clase AlarmClock se denomina alarmTimer. El mtodo initClock(), que lleva a cabo las operaciones de configuracin necesarias para la instancia de AlarmClock, realiza dos operaciones con la variable alarmTimer. En primer lugar, se crea una instancia de la variable con parmetros que indican a la instancia Timer que debe esperar 0 milisegundos y activar su evento de temporizador slo una vez. Tras crear la instancia de alarmTimer, el cdigo llama al mtodo addEventListener() de la variable para indicar que desea realizar una deteccin en el evento timer de esa variable. Las instancias de Timer funcionan distribuyendo su evento timer una vez transcurrida una cantidad de tiempo especificada. La clase AlarmClock necesitar saber cundo se distribuye el evento timer para activar su propia alarma. Al llamar a addEventListener(), el cdigo de AlarmClock se registra como detector con alarmTimer. Los dos parmetros indican que la clase AlarmClock desea detectar el evento timer (indicado por la constante TimerEvent.TIMER) y que, cuando ste se produzca, debe llamarse al mtodo onAlarm() de la clase AlarmClock como respuesta al evento. Para establecer la alarma, se llama al mtodo setAlarm() de la clase AlarmClock del siguiente modo:
138
/** * Sets the time at which the alarm should go off. * @param hour The hour portion of the alarm time. * @param minutes The minutes portion of the alarm time. * @param message The message to display when the alarm goes off. * @return The time at which the alarm will go off. */ public function setAlarm(hour:Number = 0, minutes:Number = 0, message:String = "Alarm!"):Date { this.alarmMessage = message; var now:Date = new Date(); // Create this time on today's date. alarmTime = new Date(now.fullYear, now.month, now.date, hour, minutes); // Determine if the specified time has already passed today. if (alarmTime <= now) { alarmTime.setTime(alarmTime.time + MILLISECONDS_PER_DAY); } // Stop the alarm timer if it's currently set. alarmTimer.reset(); // Calculate how many milliseconds should pass before the alarm should // go off (the difference between the alarm time and now) and set that // value as the delay for the alarm timer. alarmTimer.delay = Math.max(1000, alarmTime.time - now.time); alarmTimer.start(); return alarmTime; }
Este mtodo realiza varias tareas, entre ellas almacenar el mensaje de alarma y crear un objeto Date (alarmTime) que representa el instante de tiempo real en el que debe sonar la alarma. En las ltimas lneas del mtodo, el temporizador de la variable alarmTimer se define y se activa, lo que resulta de especial relevancia para este anlisis. En primer lugar, se llama a su mtodo reset(), deteniendo el temporizador y reinicindolo en caso de que ya se estuviese ejecutando. A continuacin, se resta la hora actual (representada por la variable now) del valor de la variable alarmTime para determinar cuntos milisegundos tienen que transcurrir antes de que suene la alarma. La clase Timer no activa su evento timer a una hora absoluta, de manera que es esta diferencia relativa de tiempo la que se asigna a la propiedad delay de alarmTimer. Finalmente, se llama al mtodo start() para iniciar el temporizador. Una vez que ha transcurrido la cantidad especificada de tiempo, alarmTimer distribuye el evento timer. Dado que la clase AlarmClock ha registrado su mtodo onAlarm() como un detector de ese evento, cuando se produzca el evento timer se llamar a onAlarm().
/** * Called when the timer event is dispatched. */ public function onAlarm(event:TimerEvent):void { trace("Alarm!"); var alarm:AlarmEvent = new AlarmEvent(this.alarmMessage); this.dispatchEvent(alarm); }
139
Un mtodo que se registra como detector de eventos debe definirse con la firma adecuada (es decir, el conjunto de parmetros y el tipo de devolucin del mtodo). Para que un mtodo pueda ser detector del evento timer de la clase Timer, debe definir un parmetro cuyo tipo de datos sea TimerEvent (flash.events.TimerEvent), una subclase de la clase Event. Cuando la instancia de Timer llama a sus detectores de eventos, pasa una instancia TimerEvent como objeto de evento.
Estas lneas de cdigo estn tomadas del mtodo onAlarm() de la clase AlarmClock (que se ha mostrado al completo anteriormente). Se llama al mtodo dispatchEvent() de la instancia de AlarmClock que, a su vez, notifica a todos los detectores registrados que el evento alarm de la instancia de AlarmClock se ha activado. El parmetro que se pasa a dispatchEvent() es el objeto de evento que se pasar a los mtodos detectores. En este caso es una instancia de la clase AlarmEvent, una subclase de Event creada especficamente para este ejemplo.
140
import flash.events.Event; /** * This custom Event class adds a message property to a basic Event. */ public class AlarmEvent extends Event { /** * The name of the new AlarmEvent type. */ public static const ALARM:String = "alarm"; /** * A text message that can be passed to an event handler * with this event object. */ public var message:String; /** *Constructor. *@param message The text to display when the alarm goes off. */ public function AlarmEvent(message:String = "ALARM!") { super(ALARM); this.message = message; } ... }
La mejor forma de crear una clase de objetos de evento personalizados es definir una clase que ample la clase Event, segn se muestra en el ejemplo anterior. Para complementar la funcionalidad heredada, la clase AlarmEvent define una propiedad message que contiene el texto del mensaje de alarma asociado al evento; el valor de message se pasa como un parmetro en el constructor de AlarmEvent. La clase AlarmEvent tambin define la constante ALARM, que se puede utilizar para hacer referencia al evento especfico (alarm) al llamar al mtodo addEventListener() de la clase AlarmClock. Adems de aadir funcionalidad personalizada, cada subclase de Event debe sustituir el mtodo clone() heredado como parte del marco de gestin de eventos de ActionScript. Las subclases Event tambin pueden sustituir el mtodo heredado toString() para incluir las propiedades del evento personalizado en el valor que se devuelve al llamar al mtodo toString().
141
/** * Creates and returns a copy of the current instance. * @return A copy of the current instance. */ public override function clone():Event { return new AlarmEvent(message); } /** * Returns a String containing all the properties of the current * instance. * @return A string representation of the current instance. */ public override function toString():String { return formatToString("AlarmEvent", "type", "bubbles", "cancelable", "eventPhase", "message"); }
El mtodo clone() sustituido necesita devolver una nueva instancia de la subclase personalizada de Event con todas las propiedades personalizadas definidas para coincidir con la instancia actual. En el mtodo toString() sustituido, el mtodo de utilidad formatToString() (heredado de Event) se utiliza para proporcionar una cadena con el nombre del tipo personalizado, adems de los nombres y valores de todas sus propiedades.
142
143
public class ApplicationDomainExample extends Sprite { private var ldr:Loader; public function ApplicationDomainExample() { ldr = new Loader(); var req:URLRequest = new URLRequest("Greeter.swf"); var ldrContext:LoaderContext = new LoaderContext(false, ApplicationDomain.currentDomain); ldr.contentLoaderInfo.addEventListener(Event.COMPLETE, completeHandler); ldr.load(req, ldrContext); } private function completeHandler(event:Event):void { var myGreeter:Class = ApplicationDomain.currentDomain.getDefinition("Greeter") as Class; var myGreeter:Greeter = Greeter(event.target.content); var message:String = myGreeter.welcome("Tommy"); trace(message); // Hello, Tommy } } }
Consulte tambin el ejemplo de la clase ApplicationDomain en Referencia de ActionScript 3.0 para la plataforma de Adobe Flash. Otras cosas que hay que tener en cuenta al trabajar con dominios de aplicacin son las siguientes:
Todo el cdigo de un archivo SWF se define como existente en un dominio de aplicacin. El dominio actual es el
lugar en el que se ejecuta la aplicacin principal. El dominio del sistema contiene todos los dominios de la aplicacin, incluido el dominio actual, lo que significa que contiene todas las clases de Flash Player.
Todos los dominios de aplicacin tienen asociado un dominio principal, excepto el dominio del sistema. El
dominio principal del dominio de aplicacin principal es el dominio del sistema. Slo es necesario definir las clases cargadas si su clase principal no las ha definido todava. No es posible anular una definicin de clase cargada con otra definicin ms reciente. En el diagrama siguiente se muestra una aplicacin que carga contenido de diversos archivos SWF de un solo dominio, domain1.com. En funcin del contenido que se cargue, se pueden utilizar distintos dominios de aplicacin. El texto siguiente describe la lgica que se utiliza para establecer el dominio de aplicacin apropiado para cada archivo SWF de la aplicacin.
144
El archivo de aplicacin principal es application1.swf. Contiene objetos Loader que cargan contenido de otros archivos SWF. En este escenario, el dominio actual es Application domain 1. Los usos A, B y C ilustran distintas tcnicas para establecer el dominio de aplicacin apropiado para cada archivo SWF de una aplicacin.
Uso A Dividir el archivo SWF secundario creando un elemento secundario del dominio del sistema. En el diagrama, el dominio de aplicacin 2 se crea como un elemento secundario del dominio del sistema. El archivo application2.swf se carga en el dominio de aplicacin 2 y sus definiciones de clase se dividen de las clases definidas en application1.swf.
Una aplicacin de esta tcnica es hacer que una aplicacin antigua cargue dinmicamente una versin ms reciente de la misma aplicacin sin conflictos. No hay conflictos porque, aunque se usen los mismos nombres de clase, se dividen en distintos dominios de aplicacin. El cdigo siguiente crea un dominio de aplicacin que es un elemento secundario del dominio del sistema y comienza a cargar un archivo SWF que utiliza ese dominio de aplicacin:
var appDomainA:ApplicationDomain = new ApplicationDomain(); var contextA:LoaderContext = new LoaderContext(false, appDomainA); var loaderA:Loader = new Loader(); loaderA.load(new URLRequest("application2.swf"), contextA);
Uso B: Aadir nuevas definiciones de clase a las definiciones de clase actuales. El dominio de aplicacin de module1.swf se establece en el dominio actual (dominio de aplicacin 1). Esto permite aadir nuevas definiciones de clase al conjunto actual de definiciones de clase de la aplicacin. Esto se puede utilizar para una biblioteca compartida en tiempo de ejecucin de la aplicacin principal. El archivo SWF cargado se trata como una biblioteca remota compartida (RSL). Esta tcnica se utiliza para cargar bibliotecas RSL mediante un precargador antes de que se inicie la aplicacin.
El cdigo siguiente carga un archivo SWF, estableciendo su dominio de aplicacin en el dominio actual:
145
var appDomainB:ApplicationDomain = ApplicationDomain.currentDomain; var contextB:LoaderContext = new LoaderContext(false, appDomainB); var loaderB:Loader = new Loader(); loaderB.load(new URLRequest("module1.swf"), contextB);
Uso C: Utilizar las definiciones de clase del elemento principal creando un nuevo dominio secundario del dominio actual. El dominio de aplicacin de module3.swf es un elemento secundario del dominio actual y el elemento secundario utiliza las versiones del elemento principal de todas las clases. Una aplicacin de esta tcnica podra ser un mdulo de una aplicacin de Internet compleja de varias pantallas, cargada como un elemento secundario de la aplicacin principal y que utiliza los tipos de la aplicacin principal. Si hay la seguridad de que siempre se actualizarn todas las clases para ser compatibles con versiones anteriores y que la aplicacin de carga es siempre ms reciente que los elementos que carga, los elementos secundarios utilizarn las versiones del elemento principal. Tener un nuevo dominio de aplicacin tambin permite descargar todas las definiciones de clase para eliminar datos innecesarios, si hay la seguridad de que no siguen existiendo referencias al archivo SWF secundario.
Esta tcnica permite que los mdulos cargados compartan los objetos singleton del cargador y los miembros de clase estticos. El cdigo siguiente crea un nuevo dominio secundario del dominio actual y comienza a cargar un archivo SWF que utiliza ese dominio de aplicacin:
var appDomainC:ApplicationDomain = new ApplicationDomain(ApplicationDomain.currentDomain); var contextC:LoaderContext = new LoaderContext(false, appDomainC); var loaderC:Loader = new Loader(); loaderC.load(new URLRequest("module3.swf"), contextC);
146
147
Tal y como muestra la ilustracin, los elementos en pantalla se ubican en uno o varios de los siguientes grupos:
Objeto Stage
El objeto Stage es el contenedor base de los objetos de visualizacin. Cada aplicacin tiene un objeto Stage, que contiene todos los objetos de visualizacin en pantalla. El objeto Stage es el contenedor de nivel superior y se encuentra arriba del todo en la jerarqua de la lista de visualizacin: Cada archivo SWF tiene una clase de ActionScript asociada, conocida como la clase principal del archivo SWF. Cuando se abre un archivo SWF en Flash Player o en Adobe AIR, Flash Player o AIR llama a la funcin constructora de dicha clase y la instancia que se crea (que es siempre un tipo de objeto de visualizacin) se aade como elemento secundario del objeto Stage. La clase principal de un archivo SWF siempre ampla la clase Sprite (para obtener ms informacin, consulte Ventajas de la utilizacin de la lista de visualizacin en la pgina 152). Es posible acceder al objeto Stage a travs de la propiedad stage de ninguna instancia de DisplayObject. Para obtener ms informacin, consulte Configuracin de las propiedades de Stage en la pgina 161.
Objetos de visualizacin
148
En ActionScript 3.0, todos los elementos que aparecen en la pantalla de una aplicacin son tipos de objetos de visualizacin. El paquete flash.display incluye una clase DisplayObject . Se trata de una clase base ampliada por otras. Estas distintas clases representan tipos diferentes de objetos de visualizacin, como formas vectoriales, clips de pelcula o campos de texto, entre otros. Para obtener informacin general de estas clases, consulte Ventajas de la utilizacin de la lista de visualizacin en la pgina 152.
A. Un objeto SimpleButton. Este tipo de objeto de visualizacin tiene distintos estados "Arriba", "Abajo" y "Sobre". B. Un objeto Bitmap. En este caso, el objeto Bitmap se carg de un archivo JPEG externo a travs de un objeto Loader. C. Un objeto Shape. El "marco del cuadro" contiene un rectngulo redondeado que se dibuja en ActionScript. Este objeto Shape tiene aplicado un filtro de sombra. D. Un objeto TextField.
Cuando se habla de los objetos de visualizacin, tambin se hace referencia a los objetos DisplayObjectContainer como contenedores de objetos de visualizacin o simplemente como contenedores. Como se ha comentado previamente, el objeto Stage es un contenedor de objeto de visualizacin. Aunque todos los objetos de visualizacin visibles heredan de la clase DisplayObject, el tipo de cada uno de ellos pertenece a una subclase especfica de la clase DisplayObject. Por ejemplo, hay una funcin constructora para la clase Shape o la clase Video, pero no hay ninguna funcin constructora para la clase DisplayObject. Conceptos y trminos importantes La siguiente lista de referencia contiene trminos importantes que aparecen al programar grficos de ActionScript:
Alfa Valor del color que representa el grado de transparencia (en realidad, el grado de opacidad) de un color. Por ejemplo, un color con un valor de canal alfa de 60% slo muestra el 60% de su intensidad total y es un 40% transparente. Grfico de mapa de bits Grfico que se define en el equipo como una cuadrcula (filas y columnas) de pxeles de colores. Los grficos de mapa de bits suelen incluir fotos e imgenes similares.
149
Modo de fusin Especificacin de cmo debe interactuar el contenido de dos imgenes solapadas. Normalmente, una imagen opaca sobre otra imagen simplemente bloquea la imagen de debajo de forma que no est visible; no obstante, los distintos modos de mezcla hacen que los colores de las imgenes se mezclen de maneras diferentes, por lo que el contenido resultante es una combinacin de las dos imgenes. Lista de visualizacin Jerarqua de objetos de visualizacin que Flash Player y AIR representarn como contenido
visible en pantalla. El escenario es la raz de la lista de visualizacin y todos los objetos de visualizacin asociados al escenario o a uno de sus elementos secundarios constituyen la lista de visualizacin, aunque el objeto no se represente realmente (por ejemplo, si est fuera de los lmites del escenario).
Objeto de visualizacin Objeto que representa algn tipo de contenido visual en Flash Player o AIR. Slo se pueden
incluir objetos de visualizacin en la lista de visualizacin y todas las clases de objetos de visualizacin son subclases de la clase DisplayObject.
Contenedor de objetos de visualizacin Tipo especial de objeto de visualizacin que puede contener objetos de
la visualizacin de partes determinadas de una imagen). Las partes ocultas de la imagen pasan a ser transparentes, por lo que se puede ver el contenido de debajo. El trmino en ingls ("masking") est relacionado con la cinta de pintor ("masking tape") que se aplica para evitar pintar donde no hay que pintar.
Escenario Contenedor visual que constituye la base o el fondo de todo el contenido visual de un archivo SWF. Transformacin Ajuste de una caracterstica visual de un grfico, como girar el objeto, modificar su escala, sesgar o distorsionar su forma, o bien, modificar su color. Grfico vectorial Grfico definido en el equipo como lneas y formas dibujadas con caractersticas especficas (como
150
AVM1Movie
Bitmap
InteractiveObject
MorphShape
Shape
StaticText
Video
DisplayObjectContainer SimpleButton
TextField
Loader
Sprite
Stage
MovieClip
En la ilustracin se muestra la herencia de clases de las clases principales de visualizacin. Debe tenerse en cuenta que algunas de estas clases, en concreto, StaticText, TextField y Video, no se encuentran en el paquete flash.display pero tambin heredan de la clase DisplayObject. Todas las clases que amplan la clase DisplayObject heredan sus mtodos y propiedades. Para obtener ms informacin, consulte Propiedades y mtodos de la clase DisplayObject en la pgina 155. Pueden crearse instancias de objetos de las siguientes clases contenidas en el paquete flash.display:
Bitmap: la clase Bitmap se usa para definir objetos de mapa de bits cargados de archivos externos o representados
a travs de ActionScript. Para cargar mapas de bits de archivos externos, se puede usar la clase Loader. Se pueden cargar archivos GIF, JPG o PNG. Tambin es posible crear un objeto BitmapData con datos personalizados y crear a continuacin un objeto Bitmap que utilice dichos datos. Se pueden usar los mtodos de la clase BitmapData para modificar mapas de bits, tanto si se cargan como si se crean en ActionScript. Para obtener ms informacin, consulte Carga de objetos de visualizacin en la pgina 196 y Trabajo con mapas de bits en la pgina 241.
Loader: la clase Loader se usa para cargar activos externos (archivos SWF o grficos). Para obtener ms
informacin, consulte Carga dinmica de contenido de visualizacin en la pgina 195.
Shape: la clase Shape se usa para crear grficos vectoriales como rectngulos, lneas, crculos, etc. Para obtener ms
informacin, consulte Uso de la API de dibujo en la pgina 219.
Sprite: un objeto Sprite puede contener grficos propios y tambin objetos de visualizacin secundarios. La clase
Sprite ampla la clase DisplayObjectContainer. Para obtener ms informacin, consulte Trabajo con contenedores de objetos de visualizacin en la pgina 155 y Uso de la API de dibujo en la pgina 219.
151
La clase TextField, incluida en el paquete flash.text, es un objeto de visualizacin para mostrar e introducir texto.
Para obtener ms informacin, consulte Fundamentos de la utilizacin de texto en la pgina 373.
La clase TextLine, incluida en el paquete flash.text.engine, es el objeto de visualizacin utilizado para mostrar lneas
de texto compuestas por Flash Text Engine y Text Layout Framework. Para obtener ms informacin, consulte Uso de Flash Text Engine en la pgina 400 y Uso de Text Layout Framework en la pgina 430.
La clase Video, incluida en el paquete flash.media, es el objeto de visualizacin que se utiliza para mostrar archivos
de vdeo. Para obtener ms informacin, consulte Trabajo con vdeo en la pgina 478. Las siguientes clases del paquete flash.display amplan la clase DisplayObject, pero no es posible crear instancias de las mismas. En lugar de eso, actan como clases principales de otros objetos de visualizacin y combinan la funcionalidad comn en una sola clase.
AVM1Movie: la clase AVM1Movie se usa para representar los archivos SWF cargados que se crearon en
ActionScript 1.0 y 2.0.
DisplayObjectContainer: las clases Loader, Stage, Sprite y MovieClip amplan la clase DisplayObjectContainer.
Para obtener ms informacin, consulte Trabajo con contenedores de objetos de visualizacin en la pgina 155.
InteractiveObject: InteractiveObject es la clase base de todos los objetos y se utiliza para interactuar con el ratn y
el teclado. Los objetos SimpleButton, TextField, Loader, Sprite, Stage y MovieClip son subclases de la clase InteractiveObject. Para obtener ms informacin sobre la creacin de interaccin de teclado y ratn, consulte Aspectos bsicos de la interaccin con el usuario en la pgina 557.
MorphShape: estos objetos se crean al crear una interpolacin de forma en la herramienta de edicin de Flash. No
es posible crear instancias de estos objetos con ActionScript pero se puede acceder a ellos desde la lista de visualizacin.
Stage: la clase Stage ampla la clase DisplayObjectContainer. Hay una instancia de Stage por aplicacin y se sita en
lo ms alto de la jerarqua de la lista de visualizacin. Para acceder a Stage, debe usarse la propiedad stage de cualquier instancia de DisplayObject. Para obtener ms informacin, consulte Configuracin de las propiedades de Stage en la pgina 161. Adems, la clase StaticText del paquete flash.text ampla la clase DisplayObject, pero no es posible crear una instancia de ella en el cdigo. Los campos de texto esttico se crean nicamente en Flash. Las siguientes clases no son objetos de visualizacin ni contenedores de objetos de visualizacin y tampoco aparecen en la lista de visualizacin, pero muestran grficos en el escenario. Estas clases se dibujan en un rectngulo, denominado ventana grfica, y se sitan con relacin al escenario.
StageVideo: muestra el contenido de vdeo, utilizado la aceleracin de hardware, si es posible. Esta clase est
disponible desde Flash Player 10.2 y AIR 2.5 (en los perfiles AIR para TV). Para obtener ms informacin, consulte Uso de la clase StageVideo para la presentacin con aceleracin por hardware en la pgina 518.
StageWebView: esta clase muestra contenido HTML. Esta clase se encuentra disponible en AIR 2.5. Para obtener
ms informacin, consulte Objetos StageWebView en la pgina 1048.
152
Las siguientes clases fl.display proporcionan una funcionalidad similar a la de las clases flash.display.Loader y LoaderInfo. Utilice estas clases en lugar de sus equivalentes flash.display si est realizando el desarrollo en el entorno de Flash Professional (CS5.5 o posterior). En dicho entorno, esas clases ayudan a resolver problemas que implican TLF con la precarga de RSL. Para obtener ms informacin, consulte Uso de las clases ProLoader y ProLoaderInfo en la pgina 199.
Mayor eficacia de representacin y disminucin del uso de memoria Mejor administracin de profundidad Recorrido completo de la lista de visualizacin Objetos de visualizacin fuera de la lista Creacin ms sencilla de subclases de objetos de visualizacin
153
En ActionScript 3.0, al mover un objeto de visualizacin a una nueva posicin en la lista de elementos secundarios de una instancia de DisplayObjectContainer, los dems elementos secundarios del contenedor de objeto de visualizacin se vuelven a colocar automticamente y reciben la asignacin de las posiciones adecuadas en el ndice de elementos secundarios del contenedor de objeto de visualizacin. Adems, en ActionScript 3.0 siempre es posible descubrir todos los objetos secundarios de cualquier contenedor de objeto de visualizacin. Cada instancia de DisplayObjectContainer tiene una propiedad numChildren, que muestra el nmero de elementos secundarios en el contenedor de objeto de visualizacin. Y como la lista de elementos secundarios de un contenedor de objeto de visualizacin es siempre una lista con ndice, se puede examinar cada objeto de la lista desde la posicin 0 hasta la ltima posicin del ndice (numChildren - 1). Esto no era posible con los mtodos y propiedades de un objeto MovieClip en ActionScript 1.0 y 2.0. En ActionScript 3.0, se puede recorrer fcilmente la lista de visualizacin de forma secuencial; no hay huecos en los nmeros de ndice de una lista de elementos secundarios de un contenedor de objeto de visualizacin. Recorrer la lista de visualizacin y administrar la profundidad de los objetos es mucho ms sencillo que lo era en ActionScript 1.0 y 2.0. En ActionScript 1.0 y 2.0, un clip de pelcula poda incluir objetos con huecos intermitentes en el orden de profundidad, lo que poda dificultar el recorrido de la lista de objetos. En ActionScript 3.0, cada lista de elementos secundarios de un contenedor de objeto de visualizacin se almacena en cach internamente como un conjunto, lo que permite realizar bsquedas rpidamente (por ndice). Reproducir indefinidamente todos los elementos secundarios de un contenedor de objeto de visualizacin es tambin muy rpido. En ActionScript 3.0, tambin se puede acceder a los elementos secundarios de un contenedor de objeto de visualizacin a travs del mtodo getChildByName() de la clase DisplayObjectContainer.
154
155
Cuando se aade un elemento visual al escenario, dicho elemento se convierte en un elemento secundario del objeto Stage. El primer archivo SWF cargado en una aplicacin (por ejemplo, el que se incorpora en una pgina HTML) se aade automticamente como elemento secundario del escenario. Puede ser un objeto de cualquier tipo que ample la clase Sprite. Los objetos de visualizacin que se crean sin usar ActionScript (por ejemplo, aadiendo una etiqueta MXML en un archivo MXML de Flex o colocando un elemento en el escenario de Flash Professional) se aaden a la lista de visualizacin. Aunque estos objetos de visualizacin no se aadan mediante ActionScript, s se puede acceder a ellos a travs de ActionScript. Por ejemplo, el cdigo siguiente ajusta la anchura de un objeto denominado button1, que se aadi en la herramienta de edicin (no a travs de ActionScript):
button1.width = 200;
156
Un contenedor de objeto de visualizacin es por s mismo un tipo de objeto de visualizacin; puede aadirse a otro contenedor de objeto de visualizacin. Por ejemplo, en la imagen siguiente se muestra un contenedor de objeto de visualizacin, pictureScreen, que contiene una forma de contorno y otros cuatro contenedores de objetos de visualizacin (del tipo PictureFrame):
A B
A. Una forma que define el borde del contenedor de objeto de visualizacin pictureScreen B. Cuatro contenedores de objetos de visualizacin que son elementos secundarios del objeto pictureScreen
Para que un objeto de visualizacin aparezca en la lista de visualizacin, debe aadirse a un contenedor de objeto de visualizacin incluido en la lista de visualizacin. Para ello, se utiliza el mtodo addChild() o el mtodo addChildAt() del objeto contenedor. Por ejemplo, sin la lnea final del cdigo siguiente, no se mostrara el objeto myTextField:
var myTextField:TextField = new TextField(); myTextField.text = "hello"; this.root.addChild(myTextField);
En este ejemplo de cdigo, this.root seala al contenedor de objeto de visualizacin MovieClip que contiene el cdigo. En el cdigo real, se puede especificar un contenedor distinto.
157
Se debe usar el mtodo addChildAt() para aadir el elemento secundario a una posicin especfica de la lista secundaria del contenedor de objeto de visualizacin. Estas posiciones del ndice basado en cero de la lista de elementos secundarios se refieren a la organizacin en capas (orden de delante a atrs) de los objetos de visualizacin. Por ejemplo, observe los tres objetos de visualizacin siguientes. Cada objeto se cre a partir de una clase personalizada denominada Ball.
La organizacin en capas de estos objetos de visualizacin en el contenedor puede ajustarse con el mtodo
addChildAt(). Por ejemplo, considrese el fragmento de cdigo siguiente: ball_A = new Ball(0xFFCC00, "a"); ball_A.name = "ball_A"; ball_A.x = 20; ball_A.y = 20; container.addChild(ball_A); ball_B = new Ball(0xFFCC00, "b"); ball_B.name = "ball_B"; ball_B.x = 70; ball_B.y = 20; container.addChild(ball_B); ball_C = new Ball(0xFFCC00, "c"); ball_C.name = "ball_C"; ball_C.x = 40; ball_C.y = 60; container.addChildAt(ball_C, 1);
Despus de ejecutar este cdigo, los objetos de visualizacin se colocan del siguiente modo en el objeto DisplayObjectContainer container. Observe la organizacin en capas de los objetos.
Para volver a colocar un objeto en la parte superior de la lista de visualizacin, simplemente hay que volver a aadirlo a la lista. Por ejemplo, despus del cdigo anterior, para mover ball_A a la parte superior de la pila, debe utilizarse esta lnea de cdigo:
container.addChild(ball_A);
Este cdigo quita ball_A de su ubicacin en la lista de visualizacin de container y vuelve a aadirlo a la parte superior de la lista, por lo que finalmente se mueve a la parte superior de la pila.
158
Puede usarse el mtodo getChildAt() para verificar el orden de las capas de los objetos de visualizacin. El mtodo getChildAt() devuelve objetos secundarios de un contenedor basndose en el nmero de ndice que se pasa. Por ejemplo, el cdigo siguiente muestra nombres de objetos de visualizacin en distintas posiciones de la lista de elementos secundarios del objeto DisplayObjectContainer container:
trace(container.getChildAt(0).name); // ball_A trace(container.getChildAt(1).name); // ball_C trace(container.getChildAt(2).name); // ball_B
Si se quita un objeto de visualizacin de la lista de elementos secundarios del contenedor principal, los elementos de niveles superiores de la lista descienden una posicin en el ndice de elementos secundarios. Por ejemplo, siguiendo con el cdigo anterior, el cdigo siguiente muestra cmo el objeto de visualizacin que estaba en la posicin 2 del objeto DisplayObjectContainer container se mueve a la posicin 1 si se quita un objeto de visualizacin situado en un nivel inferior de la lista de elementos secundarios:
container.removeChild(ball_C); trace(container.getChildAt(0).name); // ball_A trace(container.getChildAt(1).name); // ball_B
Los mtodos removeChild() y removeChildAt() no eliminan completamente una instancia de objeto de visualizacin. Simplemente la quitan de la lista de elementos secundarios del contenedor. Otra variable podr seguir haciendo referencia a la instancia. (Para eliminar completamente un objeto, debe usarse el operador delete.) Dado que un objeto de visualizacin slo tiene un contenedor principal, se puede aadir una instancia de un objeto de visualizacin a un solo contenedor de objeto de visualizacin. Por ejemplo, el cdigo siguiente muestra que el objeto de visualizacin tf1 slo puede existir en un contenedor (en este caso, un objeto Sprite, que ampla la clase DisplayObjectContainer):
tf1:TextField = new TextField(); tf2:TextField = new TextField(); tf1.name = "text 1"; tf2.name = "text 2"; container1:Sprite = new Sprite(); container2:Sprite = new Sprite(); container1.addChild(tf1); container1.addChild(tf2); container2.addChild(tf1); trace(container1.numChildren); // 1 trace(container1.getChildAt(0).name); // text 2 trace(container2.numChildren); // 1 trace(container2.getChildAt(0).name); // text 1
Si se aade un objeto de visualizacin de un contenedor de objeto de visualizacin a otro contenedor de objeto de visualizacin, se elimina de la lista de elementos secundarios del primer contenedor de objeto de visualizacin. Adems de los mtodos anteriormente descritos, la clase DisplayObjectContainer define varios mtodos para trabajar con objetos de visualizacin secundarios, entre los que se encuentran:
contains(): determina si un objeto de visualizacin es un elemento secundario de DisplayObjectContainer. getChildByName(): recupera un objeto de visualizacin por el nombre. getChildIndex(): devuelve la posicin de ndice de un objeto de visualizacin. setChildIndex(): cambia la posicin de un objeto de visualizacin secundario. swapChildren(): intercambia el orden de delante a atrs de dos objetos de visualizacin.
159
swapChildrenAt(): intercambia el orden de delante a atrs de dos objetos de visualizacin, especificados por sus
valores de ndice. Para obtener ms informacin, consulte las entradas correspondiente en Referencia de ActionScript 3.0 para la plataforma de Adobe Flash. Cabe recordar que un objeto de visualizacin que est fuera de la lista de visualizacin (es decir, que no est incluido en un contenedor de objeto de visualizacin secundario del objeto Stage) se denomina objeto de visualizacin fuera de la lista.
La clase DisplayObjectContainer incluye propiedades y mtodos para recorrer la lista de visualizacin, mediante las listas de elementos secundarios de los contenedores de objetos de visualizacin. Por ejemplo, el cdigo siguiente aade dos objetos de visualizacin, title y pict, al objeto container (que es un objeto Sprite y la clase Sprite ampla la clase DisplayObjectContainer):
160
var container:Sprite = new Sprite(); var title:TextField = new TextField(); title.text = "Hello"; var pict:Loader = new Loader(); var url:URLRequest = new URLRequest("banana.jpg"); pict.load(url); pict.name = "banana loader"; container.addChild(title); container.addChild(pict);
El mtodo getChildAt() devuelve el elemento secundario de la lista de visualizacin en una posicin de ndice especfica:
trace(container.getChildAt(0) is TextField); // true
Tambin se puede acceder a los objetos secundarios por el nombre. Todos los objetos de visualizacin tienen una propiedad de nombre y, si no se asigna, Flash Player o AIR asignan un valor predeterminado como, por ejemplo, "instance1". Por ejemplo, el cdigo siguiente muestra cmo utilizar el mtodo getChildByName() para acceder a un objeto de visualizacin secundario con el nombre "banana loader":
trace(container.getChildByName("banana loader") is Loader); // true
Si se utiliza el mtodo getChildByName() el resultado es ms lento que si se usa el mtodo getChildAt(). Como un contenedor de objeto de visualizacin puede contener otros contenedores de objetos de visualizacin como objetos secundarios en su lista de visualizacin, se puede recorrer toda la lista de visualizacin de la aplicacin como un rbol. Por ejemplo, en el fragmento de cdigo anterior, cuando finaliza la operacin de carga del objeto Loader pict, el objeto pict tendr cargado un objeto de visualizacin secundario, que es el mapa de bits. Para acceder a este objeto de visualizacin de mapa de bits, se puede escribir pict.getChildAt(0). Tambin se puede escribir container.getChildAt(0).getChildAt(0) (porque container.getChildAt(0) == pict). La funcin siguiente proporciona una salida trace() con sangra de la lista de visualizacin desde un contenedor de objeto de visualizacin:
function traceDisplayList(container:DisplayObjectContainer,indentString:String = ""):void { var child:DisplayObject; for (var i:uint=0; i < container.numChildren; i++) { child = container.getChildAt(i); trace(indentString, child, child.name); if (container.getChildAt(i) is DisplayObjectContainer) { traceDisplayList(DisplayObjectContainer(child), indentString + "") } } }
Adobe Flex Si utiliza Flex, debe saber que define varias clases del objeto de visualizacin de componente y estas clases sustituyen los mtodos de acceso de la lista de visualizacin de la clase DisplayObjectContainer. Por ejemplo, la clase Container del paquete mx.core sustituye al mtodo addChild() y a otros mtodos de la clase DisplayObjectContainer (que ampla la clase Container). En el caso del mtodo addChild(), la clase sustituye el mtodo de tal modo que no es posible agregar todos los tipos de objetos de visualizacin a una instancia de Container en Flex. En este caso, el mtodo sustituido requiere que el objeto secundario que se va a agregar sea un tipo de objeto mx.core.UIComponent.
161
StageScaleMode.EXACT_FIT escala el archivo SWF para rellenar las nuevas dimensiones del escenario sin tener en cuenta la relacin de aspecto del contenido original. Puede que los factores de escala no sean los mismos para la anchura y la altura, por lo que el contenido puede aparecer comprimido o expandido si cambia la relacin de aspecto del escenario. StageScaleMode.SHOW_ALL escala el archivo SWF para ajustarse por completo a las nuevas dimensiones del
escenario sin cambiar la relacin de aspecto del contenido. Este modo de escala muestra todo el contenido, pero puede generar bordes de pantalla ancha, como las barras negras que aparecen al ver una pelcula de pantalla ancha en una televisin estndar.
StageScaleMode.NO_BORDER escala el archivo SWF para ajustarse por completo a las nuevas dimensiones del
escenario sin cambiar la relacin de aspecto del contenido. Este modo de escala hace un uso completo del rea de visualizacin de escenario, pero puede suponer un recorte.
StageScaleMode.NO_SCALE: no escala el archivo SWF. Si las nuevas dimensiones del escenario son ms pequeas, el contenido se recorta; si son mayores, el espacio aadido est en blanco.
Slo en el modo de escala StageScaleMode.NO_SCALE, las propiedades Width y Height de la clase Stage, se pueden utilizar para determinar las dimensiones en pxeles reales del escenario cuyo tamao ha cambiado. (En los otros modos de escala, las propiedades stageWidth y stageHeight siempre reflejan la anchura y la altura originales del archivo SWF.) Adems, si se establece scaleMode en StageScaleMode.NO_SCALE y se ajusta el tamao del archivo SWF, se distribuye el evento resize de la clase Stage, lo que permite realizar los ajustes necesarios.
162
Por consiguiente, si establece scaleMode en StageScaleMode.NO_SCALE, tendr mayor control sobre el ajuste del contenido de la pantalla al cambiar el tamao de la ventana. Por ejemplo, en un archivo SWF que contiene un vdeo y una barra de control, puede que desee que la barra de control mantenga el mismo tamao cuando se cambie el tamao del escenario y modificar nicamente el tamao de la ventana de vdeo para adaptarla al cambio de tamao del escenario. Esto se ilustra en el siguiente ejemplo:
// videoScreen is a display object (e.g. a Video instance) containing a // video; it is positioned at the top-left corner of the Stage, and // it should resize when the SWF resizes. // // // // controlBar is a display object (e.g. a Sprite) containing several buttons; it should stay positioned at the bottom-left corner of the Stage (below videoScreen) and it should not resize when the SWF resizes. flash.display.Stage; flash.display.StageAlign; flash.display.StageScaleMode; flash.events.Event;
var swfStage:Stage = videoScreen.stage; swfStage.scaleMode = StageScaleMode.NO_SCALE; swfStage.align = StageAlign.TOP_LEFT; function resizeDisplay(event:Event):void { var swfWidth:int = swfStage.stageWidth; var swfHeight:int = swfStage.stageHeight; // Resize the video window. var newVideoHeight:Number = swfHeight - controlBar.height; videoScreen.height = newVideoHeight; videoScreen.scaleX = videoScreen.scaleY; // Reposition the control bar. controlBar.y = newVideoHeight; } swfStage.addEventListener(Event.RESIZE, resizeDisplay);
Definicin del modo de escala del escenario para las ventanas de AIR La propiedad scaleMode del escenario determina el modo en que el escenario escala y recorta los objetos de visualizacin secundarios cuando una ventana cambia de tamao. nicamente el modo noScale se debe utilizar en AIR. En este modo, no se aplica escala al escenario. En cambio, el tamao del escenario cambia directamente con los lmites de la ventana. Los objetos se pueden recortar si se reduce el tamao de la ventana. Los modos de escala de escenario se designan para su uso en entornos como, por ejemplo, un navegador web donde no siempre se tiene control sobre la proporcin de tamao o aspecto del escenario. Los modos permiten seleccionar la opcin ms adecuada cuando el escenario no coincide con la relacin de aspecto o tamao ideal de la aplicacin. En AIR, siempre se tiene control del escenario, por lo que en la mayora de los casos con la nueva distribucin del contenido o el ajuste de las dimensiones de la ventana, se obtendrn mejores resultados que activando el ajuste de escala del escenario.
163
En el navegador y para la ventana de AIR inicial, la relacin entre el tamao de la ventana y el factor de escala inicial se leen desde el archivo SWF cargado. No obstante, cuando se crea un objeto NativeWindow, AIR selecciona una relacin arbitraria entre el tamao de la ventana y el factor de escala de 72:1. De este modo, si la cuenta con 72x72 pxeles, un rectngulo de 10x10 aadido a la ventana se dibuja con el tamao correcto de 10x10 pxeles. Sin embargo, si la ventana presenta 144x144 pxeles, a un rectngulo de 10x10 pxeles se le aplica una escala de 20x20 pxeles. Si se utiliza scaleMode en lugar de noScale para un escenario de la ventana, la compensacin se puede realizar estableciendo el factor de escala de cualquier objeto de visualizacin de la ventana en una relacin de 72 pxeles en la anchura y altura actual del escenario. Por ejemplo, el siguiente cdigo calcula el factor de escala necesario para un objeto de visualizacin denominado client:
if(newWindow.stage.scaleMode != StageScaleMode.NO_SCALE){ client.scaleX = 72/newWindow.stage.stageWidth; client.scaleY = 72/newWindow.stage.stageHeight; }
Nota: las ventanas de Flex y HTML establecen automticamente el valor scaleMode del escenario en noScale. Al cambiar el valor scaleMode, se interrumpen los mecanismos de diseo automtico en estos tipos de ventanas.
En Flash Player, el modo de pantalla completa slo puede iniciarse a travs de ActionScript como respuesta a un clic del ratn (incluido el clic con el botn derecho) o una pulsacin de tecla. El contenido de AIR que se ejecuta en el entorno limitado de seguridad de la aplicacin no requiere que se indique el modo de pantalla completa como respuesta a un gesto del usuario. Para salir del modo de pantalla completa, debe establecerse la propiedad displayState en StageDisplayState.NORMAL.
stage.displayState = StageDisplayState.NORMAL;
Asimismo, el usuario puede optar por salir del modo de pantalla completa cambiando a una ventana diferente o utilizando una de las distintas combinaciones de teclas: tecla Esc (todas las plataformas), Control-W (Windows), Comando-W (Mac) o Alt-F4 (Windows). Activacin del modo de pantalla completa en Flash Player Para activar el modo de pantalla completa en un archivo SWF incorporado en una pgina HTML, el cdigo HTML para incorporar Flash Player debe incluir una etiqueta param y un atributo embed con el nombre allowFullScreen y el valor true, como en el siguiente cdigo:
<object> ... <param name="allowFullScreen" value="true" /> <embed ... allowfullscreen="true" /> </object>
164
En la herramienta de edicin de Flash, seleccione Archivo -> Configuracin de publicacin y en el cuadro de dilogo Configuracin de publicacin, en la ficha HTML, seleccione la plantilla Slo Flash - Permitir pantalla completa. En Flex, asegrese de que la plantilla HTML incluya las etiquetas <object> y <embed> que son compatibles con la pantalla completa. Si se utiliza JavaScript en una pgina web para generar las etiquetas de incorporacin de SWF, se debe modificar JavaScript para aadir el atributo/etiqueta de parmetro allowFullScreen. Por ejemplo, si la pgina HTML utiliza la funcin AC_FL_RunContent() (que se usa en pginas HTML generadas en Flash Professional y Flash Builder), se debe aadir el parmetro allowFullScreen a dicha llamada de funcin, del siguiente modo:
AC_FL_RunContent( ... 'allowFullScreen','true', ... ); //end AC code
Esto no se aplica a los archivos SWF que se ejecutan en el reproductor Flash Player autnomo. Nota: si el modo de ventana (wmode en HTML) se establece en Opaco sin ventanas (opaco) o Transparente sin ventanas (transparente), la ventana de pantalla completa siempre es opaca. Tambin existen limitaciones relacionadas con la seguridad al utilizar el modo de pantalla completa de Flash Player en un navegador. Estas limitaciones se describen en el captulo Seguridad en la pgina 1059. Escala y tamao del escenario en pantalla completa Las propiedades Stage.fullScreenHeight y Stage.fullScreenWidth devuelven la altura y la anchura del monitor que se utiliza cuando se pasa al tamao de pantalla completa, si ese estado se introduce de forma inmediata. Estos valores pueden ser incorrectos si el usuario tiene la oportunidad de mover el navegador de un monitor a otro despus de recuperar estos valores pero antes de pasar al modo de pantalla completa. Si se recuperan estos valores en el mismo controlador de eventos en el que se estableci la propiedad Stage.displayState como StageDisplayState.FULL_SCREEN, los valores son correctos. Para usuarios de varios monitores, el contenido de SWF slo se expandir para llenar un monitor. Flash Player y AIR usan una mtrica para determinar el monitor que contiene la mayor parte del archivo SWF y utiliza dicho monitor en el modo de pantalla completa. Las propiedades fullScreenHeight y fullScreenWidth slo reflejan el tamao del monitor que se utiliza para el modo de pantalla completa. Para obtener ms informacin, consulte Stage.fullScreenHeight y Stage.fullScreenWidth en Referencia de ActionScript 3.0 para la plataforma de Adobe Flash. El comportamiento de ajuste de escala del escenario en el modo de pantalla completa es el mismo que en el modo normal; el ajuste de escala se controla con la propiedad scaleMode de la clase Stage. Si la propiedad scaleMode se establece en StageScaleMode.NO_SCALE, las propiedades stageWidth y stageHeight de Stage cambian para reflejar el tamao del rea de la pantalla ocupada por el archivo SWF (toda la pantalla en este caso); si se visualiza en el navegador, el parmetro HTML controla la configuracin. Se puede utilizar el evento fullScreen de la clase Stage para detectar cundo se activa y desactiva el modo de pantalla completa, y para responder ante ello. Por ejemplo, puede ser que se desee volver a colocar, aadir o quitar elementos de la pantalla al activar o desactivar el modo de pantalla completa, como en el ejemplo:
165
import flash.events.FullScreenEvent; function fullScreenRedraw(event:FullScreenEvent):void { if (event.fullScreen) { // Remove input text fields. // Add a button that closes full-screen mode. } else { // Re-add input text fields. // Remove the button that closes full-screen mode. } } mySprite.stage.addEventListener(FullScreenEvent.FULL_SCREEN, fullScreenRedraw);
Tal y como se muestra en este cdigo, el objeto del evento fullScreen es una instancia de la clase flash.events.FullScreenEvent, que incluye una propiedad fullScreen que indica si el modo de pantalla completa est activado (true) o no (false). Compatibilidad con el teclado en modo de pantalla completa Cuando Flash Player se ejecuta en un navegador, todo el cdigo ActionScript relacionado con el teclado, como los eventos de teclado y la introduccin de texto en instancias de TextField, se desactiva en modo de pantalla completa. Las excepciones (teclas que permanecen activadas) son:
Determinadas teclas que no afectan a la impresin, como las teclas de flecha, la barra espaciadora o el tabulador Mtodos abreviados de teclado que cierran el modo de pantalla completa: Esc (Windows y Mac), Control-W
(Windows), Comando-W (Mac) y Alt-F4 Estas restricciones no se aplican a contenido de SWF ejecutado en el reproductor autnomo de Flash Player o en AIR. AIR admite un modo interactivo de pantalla completa que permite la entrada del teclado. Escala de hardware en modo de pantalla completa La propiedad fullScreenSourceRect de la clase Stage se puede utilizar para establecer que Flash Player o AIR escalen una regin especfica del escenario al modo de pantalla completa. La escala de hardware en Flash Player y AIR, en caso de estar disponible, se activa en la tarjeta grfica y de vdeo del equipo y suele mostrar el contenido con mayor rapidez que la escala de software. Para aprovechar la escala de hardware, debe establecer todo el escenario o parte del mismo en modo de pantalla completa. El siguiente cdigo ActionScript 3.0 establece todo el escenario en modo de pantalla completa:
import flash.geom.*; { stage.fullScreenSourceRect = new Rectangle(0,0,320,240); stage.displayState = StageDisplayState.FULL_SCREEN; }
Cuando esta propiedad se establece en un rectngulo vlido y la propiedad displayState se define en modo de pantalla completa, Flash Player y AIR aplican escala al rea especificada. El tamao real del escenario expresado en pxeles dentro de ActionScript no cambia. Flash Player y AIR aplican un lmite mnimo para el tamao del rectngulo de modo que se ajuste al mensaje estndar Press Esc to exit full-screen mode (Presione Esc para salir del modo de pantalla completa). Este lmite suele ser de 260 x 30 pxeles, pero puede variar segn la plataforma y la versin de Flash Player.
166
La propiedad fullScreenSourceRect slo se puede definir cuando Flash Player o AIR no estn en modo de pantalla completa. Para utilizar esta propiedad correctamente, primero debe establecerse y, seguidamente, definir la propiedad displayState en modo de pantalla completa. Para activar la escala, establezca la propiedad fullScreenSourceRect en un objeto rectangle.
stage.fullScreenSourceRect = new Rectangle(0,0,320,240);
Para aprovechar ntegramente las funciones de aceleracin de hardware con Flash Player, actvela mediante el cuadro de dilogo Configuracin de Flash Player. Para cargar el cuadro de dilogo, haga clic con el botn derecho del ratn (Windows) o presione Control y haga clic (Mac) dentro del contenido de Flash Player en el navegador. Seleccione la ficha Visualizacin, que es la primera ficha, y active la casilla de verificacin: Activar aceleracin de hardware. Modos de ventana directo y de composicin con GPU Flash Player 10 introduce dos modos de ventana, directo y composicin por GPU, que se pueden habilitar desde la configuracin de publicacin de la herramienta de edicin de Flash. Estos modos no se admiten en AIR. Para poder utilizar estos modos, es preciso activar la aceleracin de hardware para Flash Player. El modo directo utiliza la ruta ms rpida y directa para introducir grficos en pantalla, lo que resulta apropiado para la reproduccin de vdeo. La composicin con GPU utiliza la unidad de procesamiento de grficos de la tarjeta de vdeo para acelerar la composicin. La composicin de vdeo es el proceso de organizacin en capas de varias imgenes para crear una sola imagen de vdeo. Cuando la composicin se acelera con la GPU, es posible mejorar el rendimiento de la conversin YUV, la correccin de color, la rotacin o la escala, as como la fusin. La conversin YUV hace referencia a la conversin de color de las seales analgicas del compuesto, que se utilizan para la transmisin, en el modelo de color RGB (rojo, verde, azul) que utilizan las pantallas y las cmaras de vdeo. El uso de la GPU para acelerar la composicin reduce la demanda del equipo y la memoria que se aplica a la CPU. Tambin supone una reproduccin ms suavizada para el vdeo de definicin estndar. Sea cuidadoso al implementar estos modos de ventana. El uso de la composicin con GPU puede resultar costoso en trminos de recursos de CPU y memoria. Si algunas operaciones (por ejemplo, modos de fusin, recorte o enmascaramiento) no se pueden llevar a cabo en la GPU, se realizan mediante el software. Adobe recomienda la limitacin a un archivo SWF por pgina HTML cuando se utilicen estos modos, que no deben se habilitar para banners. La funcin Probar pelcula de Flash no utiliza la aceleracin de hardware, pero puede emplearla mediante la opcin Vista previa de publicacin. La definicin de una velocidad de fotogramas en el archivo SWF que sea superior a 60, velocidad mxima de actualizacin de pantalla, no resulta til. El establecimiento de la velocidad de fotogramas de 50 a 55 permite fotogramas eliminados, lo cual puede suceder por distintos motivos en algunas ocasiones. Para poder utilizar el modo directo, es preciso disponer de Microsoft DirectX 9 con VRAM de 128 MB en Windows y OpenGL para Apple Macintosh, Mac OS X v10.2 o versiones posteriores. El modo de composicin por GPU requiere compatibilidad con Microsoft DirectX 9 y Pixel Shader 2.0 en Windows con 128 MB de VRAM. En Mac OS X y Linux, la composicin por GPU requiere OpenGL 1.5 y diversas extensiones de OpenGL (objeto framebuffer, objetos multitexture y shader, lenguaje de sombreado y sombreados de fragmentos). Puede activar los modos de aceleracin directo y gpu por archivo SWF mediante el cuadro de dilogo de configuracin de publicacin de Flash, utilizando el men de aceleracin de hardware de la ficha Flash. Si selecciona Ninguno, el modo de ventana vuelve a los valores predeterminado, transparente u opaco, tal y como se especifica en la configuracin del modo de ventana en la ficha HTML.
167
Para obtener ms informacin, consulte Gestin de eventos en la pgina 119. Un aspecto importante que hay que tener en cuenta cuando se trabaja con eventos de objetos de visualizacin es el efecto que los detectores de eventos pueden tener sobre la eliminacin automtica de objetos de visualizacin de la memoria (recopilados como datos innecesarios) cuando se quitan de la lista de visualizacin. Si un objeto de visualizacin tiene objetos suscritos a sus eventos como detectores, dicho objeto de visualizacin no se eliminar de la memoria aunque se quite de la lista de visualizacin, porque seguir teniendo referencias a esos objetos detectores. Para obtener ms informacin, consulte Administracin de detectores de eventos en la pgina 133.
Si no se necesita un objeto que pueda ser un contenedor de otros objetos de visualizacin (es decir, que slo se
necesita uno que acte como un elemento de pantalla autnomo), debe elegirse una de estas subclases DisplayObject o InteractiveObject, dependiendo del uso que se le vaya a dar:
Bitmap para mostrar una imagen de mapa de bits. TextField para aadir texto. Video para mostrar vdeo.
168
Shape para obtener un "lienzo" donde dibujar contenido en pantalla. En concreto, si se desea crear una instancia
para dibujar formas en la pantalla y no se va a utilizar como contenedor de otros objetos de visualizacin, se obtendrn importantes ventajas de rendimiento si se usa Shape en lugar de Sprite o MovieClip.
MorphShape, StaticText o SimpleButton para los elementos creados con la herramienta de edicin de Flash. (No
es posible crear instancias de estas clases mediante programacin, pero s crear variables con estos tipos de datos para hacer referencia a los elementos creados con la herramienta de edicin de Flash.)
Si se necesita una variable para hacer referencia al escenario principal, debe usarse la clase Stage como su tipo de
datos.
Si se necesita un contenedor para cargar un archivo SWF o un archivo de imagen externo, se debe usar una instancia
de Loader. El contenido cargado se aadir a la lista de visualizacin como un elemento secundario de la instancia de Loader. Su tipo de datos depender de la naturaleza del contenido cargado, como se indica a continuacin:
Una imagen cargada ser una instancia de Bitmap. Un archivo SWF cargado, escrito en ActionScript 3.0, ser una instancia de Sprite o MovieClip (o una instancia
de una subclase de esas clases, segn lo especifique el creador de contenido).
Un archivo SWF cargado, escrito en ActionScript 1.0 o ActionScript 2.0, ser una instancia de AVM1Movie. Si se necesita que un objeto acte como contenedor de otros objetos de visualizacin, aunque se vaya a dibujar o no
en el objeto de visualizacin mediante ActionScript, debe elegirse una de las subclases de DisplayObjectContainer:
Sprite si el objeto se crear solamente con ActionScript, o como la clase base de un objeto de visualizacin
personalizado que se crear y manipular exclusivamente con ActionScript.
MovieClip si se crea una variable para hacer referencia a un smbolo de clip de pelcula creado en la herramienta
de edicin de Flash.
Si se crea una clase que se asociar a un smbolo de clip de pelcula en la biblioteca de Flash, se debe elegir una de
las siguientes subclases de DisplayObjectContainer como clase base:
MovieClip si el smbolo de clip de pelcula asociado tiene contenido en ms de un fotograma. Sprite si el smbolo de clip de pelcula asociado tiene contenido slo en el primer fotograma.
Cambio de posicin
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior La manipulacin ms bsica de cualquier objeto de visualizacin es su colocacin en la pantalla. Para definir la posicin de un objeto de visualizacin, deben cambiarse las propiedades x e y del objeto.
169
El sistema de colocacin de objetos de visualizacin trata el escenario como un sistema de coordenadas cartesiano (el sistema de cuadrcula habitual, con un eje x horizontal y un eje y vertical). El origen del sistema de coordenadas (la coordenada 0,0 donde convergen los ejes x e y) est situado en la esquina superior izquierda del escenario. Tomando esta coordenada como punto de referencia, los valores x son positivos si estn a la derecha y negativos si estn a la izquierda, mientras que los valores y son positivos si estn abajo y negativos si estn arriba (al contrario que en los sistemas grficos tpicos). Por ejemplo, las anteriores lneas de cdigo mueven el objeto myShape a la coordenada x 17 (17 pxeles a la derecha del origen) y a la coordenada y 212 (212 pxeles por debajo del origen). De forma predeterminada, cuando se crea un objeto de visualizacin con ActionScript, las propiedades x e y se establecen en 0, colocando el objeto en la esquina superior izquierda de su contenido principal.
170
// Position the shape at the top-left corner of the Stage, // regardless of where its parent is located. // Create a Sprite, positioned at x:200 and y:200. var mySprite:Sprite = new Sprite(); mySprite.x = 200; mySprite.y = 200; this.addChild(mySprite); // Draw a dot at the Sprite's 0,0 coordinate, for reference. mySprite.graphics.lineStyle(1, 0x000000); mySprite.graphics.beginFill(0x000000); mySprite.graphics.moveTo(0, 0); mySprite.graphics.lineTo(1, 0); mySprite.graphics.lineTo(1, 1); mySprite.graphics.lineTo(0, 1); mySprite.graphics.endFill(); // Create the circle Shape instance. var circle:Shape = new Shape(); mySprite.addChild(circle); // Draw a circle with radius 50 and center point at x:50, y:50 in the Shape. circle.graphics.lineStyle(1, 0x000000); circle.graphics.beginFill(0xff0000); circle.graphics.drawCircle(50, 50, 50); circle.graphics.endFill(); // Move the Shape so its top-left corner is at the Stage's 0, 0 coordinate. var stagePoint:Point = new Point(0, 0); var targetPoint:Point = mySprite.globalToLocal(stagePoint); circle.x = targetPoint.x; circle.y = targetPoint.y;
Tambin se puede usar el mtodo localToGlobal() de la clase DisplayObject para convertir las coordenadas locales en coordenadas del escenario.
171
// This code creates a mouse drag interaction using the startDrag() // technique. // square is a MovieClip or Sprite instance). import flash.events.MouseEvent; // This function is called when the mouse button is pressed. function startDragging(event:MouseEvent):void { square.startDrag(); } // This function is called when the mouse button is released. function stopDragging(event:MouseEvent):void { square.stopDrag(); } square.addEventListener(MouseEvent.MOUSE_DOWN, startDragging); square.addEventListener(MouseEvent.MOUSE_UP, stopDragging);
Esta tcnica presenta una limitacin realmente importante: con startDrag() nicamente se puede arrastrar un elemento cada vez. Si se arrastra un objeto de visualizacin y se llama al mtodo startDrag() en otro objeto de visualizacin, el primer objeto deja de seguir al ratn inmediatamente. Por ejemplo, si se cambia la funcin startDragging() como se muestra aqu, slo se arrastrar el objeto circle, en lugar de la llamada al mtodo square.startDrag():
function startDragging(event:MouseEvent):void { square.startDrag(); circle.startDrag(); }
Como consecuencia de poder arrastrar un solo objeto cada vez cuando se usa startDrag(), es posible llamar al mtodo stopDrag() en cualquier objeto de visualizacin y detenerlo sea cual sea el objeto que se est arrastrando. Si se necesita arrastrar ms de un objeto de visualizacin o evitar la posibilidad de conflictos porque ms de un objeto pueda utilizar startDrag(), se recomienda usar la tcnica de seguimiento del ratn para crear el efecto de arrastre. Con esta tcnica, cuando se presiona el botn del ratn, se suscribe una funcin al evento mouseMove del escenario, como detector. Esta funcin, que se llama cada vez que se mueve el ratn, hace que el objeto arrastrado salte a las coordenadas x, y del ratn. Cuando se suelta el botn del ratn, se quita la suscripcin de la funcin como detector, de modo que ya no se llama cuando se mueve el ratn y el objeto deja de seguir al cursor del ratn. En el cdigo siguiente se muestra esta tcnica:
172
// This code moves display objects using the mouse-following // technique. // circle is a DisplayObject (e.g. a MovieClip or Sprite instance). import flash.events.MouseEvent; var offsetX:Number; var offsetY:Number; // This function is called when the mouse button is pressed. function startDragging(event:MouseEvent):void { // Record the difference (offset) between where // the cursor was when the mouse button was pressed and the x, y // coordinate of the circle when the mouse button was pressed. offsetX = event.stageX - circle.x; offsetY = event.stageY - circle.y; // tell Flash Player to start listening for the mouseMove event stage.addEventListener(MouseEvent.MOUSE_MOVE, dragCircle); } // This function is called when the mouse button is released. function stopDragging(event:MouseEvent):void { // Tell Flash Player to stop listening for the mouseMove event. stage.removeEventListener(MouseEvent.MOUSE_MOVE, dragCircle); } // This function is called every time the mouse moves, // as long as the mouse button is pressed down. function dragCircle(event:MouseEvent):void { // Move the circle to the location of the cursor, maintaining // the offset between the cursor's location and the // location of the dragged object. circle.x = event.stageX - offsetX; circle.y = event.stageY - offsetY; // Instruct Flash Player to refresh the screen after this event. event.updateAfterEvent(); } circle.addEventListener(MouseEvent.MOUSE_DOWN, startDragging); circle.addEventListener(MouseEvent.MOUSE_UP, stopDragging);
Adems de hacer que un objeto de visualizacin siga al cursor del ratn, suele ser conveniente mover el objeto arrastrado al frente de la pantalla, de modo que parezca que flota sobre todos los dems objetos. Por ejemplo, supongamos que se dispone de dos objetos, un crculo y un cuadrado, y que ambos se pueden mover con el ratn. Si el crculo est por debajo del cuadrado en la lista de visualizacin, y se hace clic en el crculo y se arrastra de modo que el cursor quede sobre el cuadrado, el crculo parecer deslizarse detrs del cuadrado, rompiendo as la ilusin de arrastrar y colocar. En lugar de eso, se puede hacer que el crculo se mueva a la parte superior de la lista de visualizacin cuando se hace clic en l, de modo que el crculo siempre aparezca encima de cualquier otro contenido.
173
El siguiente cdigo (adaptado del ejemplo anterior) permite que dos objetos de visualizacin, un crculo y un cuadrado, se muevan con el ratn. Cuando se presiona el botn del ratn sobre cualquiera de los dos, el elemento en cuestin se mueve a la parte superior de la lista de visualizacin del escenario, de modo que el elemento arrastrado aparece siempre encima. (El cdigo nuevo o cambiado con respecto a la lista anterior aparece en negrita.)
// // // // This code creates a drag-and-drop interaction using the mouse-following technique. circle and square are DisplayObjects (e.g. MovieClip or Sprite instances).
import flash.display.DisplayObject; import flash.events.MouseEvent; var offsetX:Number; var offsetY:Number; var draggedObject:DisplayObject; // This function is called when the mouse button is pressed. function startDragging(event:MouseEvent):void { // remember which object is being dragged draggedObject = DisplayObject(event.target); // Record the difference (offset) between where the cursor was when // the mouse button was pressed and the x, y coordinate of the // dragged object when the mouse button was pressed. offsetX = event.stageX - draggedObject.x; offsetY = event.stageY - draggedObject.y; // move the selected object to the top of the display list stage.addChild(draggedObject); // Tell Flash Player to start listening for the mouseMove event. stage.addEventListener(MouseEvent.MOUSE_MOVE, dragObject); } // This function is called when the mouse button is released. function stopDragging(event:MouseEvent):void { // Tell Flash Player to stop listening for the mouseMove event. stage.removeEventListener(MouseEvent.MOUSE_MOVE, dragObject); }
174
// This function is called every time the mouse moves, // as long as the mouse button is pressed down. function dragObject(event:MouseEvent):void { // Move the dragged object to the location of the cursor, maintaining // the offset between the cursor's location and the location // of the dragged object. draggedObject.x = event.stageX - offsetX; draggedObject.y = event.stageY - offsetY; // Instruct Flash Player to refresh the screen after this event. event.updateAfterEvent(); } circle.addEventListener(MouseEvent.MOUSE_DOWN, startDragging); circle.addEventListener(MouseEvent.MOUSE_UP, stopDragging); square.addEventListener(MouseEvent.MOUSE_DOWN, startDragging); square.addEventListener(MouseEvent.MOUSE_UP, stopDragging);
Para aumentar este efecto, por ejemplo en un juego en el que se mueven fichas o cartas entre distintas pilas, se podra aadir el objeto arrastrado a la lista de visualizacin del escenario cuando se selecciona y luego aadirlo a otra lista de visualizacin (por ejemplo, la pila donde se coloca), cuando se suelta el botn del ratn. Finalmente, para mejorar el efecto, se podra aplicar un filtro de sombra al objeto de visualizacin al hacer clic en l (al iniciar el arrastre) y quitar la sombra al soltar el objeto. Para obtener informacin detallada sobre el uso del filtro de sombra y otros filtros de objetos de visualizacin en ActionScript, consulte Aplicacin de filtros a objetos de visualizacin en la pgina 267.
175
import flash.events.MouseEvent; import flash.geom.Rectangle; // Define the initial viewable area of the TextField instance: // left: 0, top: 0, width: TextField's width, height: 350 pixels. bigText.scrollRect = new Rectangle(0, 0, bigText.width, 350); // Cache the TextField as a bitmap to improve performance. bigText.cacheAsBitmap = true; // called when the "up" button is clicked function scrollUp(event:MouseEvent):void { // Get access to the current scroll rectangle. var rect:Rectangle = bigText.scrollRect; // Decrease the y value of the rectangle by 20, effectively // shifting the rectangle down by 20 pixels. rect.y -= 20; // Reassign the rectangle to the TextField to "apply" the change. bigText.scrollRect = rect; } // called when the "down" button is clicked function scrollDown(event:MouseEvent):void { // Get access to the current scroll rectangle. var rect:Rectangle = bigText.scrollRect; // Increase the y value of the rectangle by 20, effectively // shifting the rectangle up by 20 pixels. rect.y += 20; // Reassign the rectangle to the TextField to "apply" the change. bigText.scrollRect = rect; } up.addEventListener(MouseEvent.CLICK, scrollUp); down.addEventListener(MouseEvent.CLICK, scrollDown);
Tal y como se ilustra en este ejemplo, cuando se trabaja con la propiedad scrollRect de un objeto de visualizacin, es mejor especificar que Flash Player o AIR deben almacenar en cach el contenido del objeto de visualizacin como un mapa de bits, usando para ello la propiedad cacheAsBitmap. De este modo, Flash Player o AIR no tienen que volver a dibujar todo el contenido del objeto de visualizacin cada vez que se desplaza verticalmente y, en su lugar, pueden utilizar el mapa de bits almacenado en cach para representar la parte necesaria directamente en pantalla. Para obtener ms informacin, consulte Almacenamiento en cach de los objetos de visualizacin en la pgina 178.
176
// Resize a display object. square.width = 420; square.height = 420; // Determine the radius of a circle display object. var radius:Number = circle.width / 2;
Al cambiar la altura (height) o anchura (width) de un objeto de visualizacin, se ajusta la escala del objeto, de modo que el contenido del mismo se contrae o expande para ajustarse a la nueva rea. Si el objeto de visualizacin slo contiene formas vectoriales, dichas formas volvern a dibujarse en la nueva escala sin perder la calidad. Los elementos grficos de mapa de bits del objeto de visualizacin ajustarn su escala en lugar de dibujarse de nuevo. As pues, por ejemplo, una foto digital cuya anchura y altura hayan aumentado ms all de las dimensiones reales de la informacin de pxeles de la imagen aparecer pixelada y con bordes dentados. Cuando se cambian las propiedades width o height de un objeto de visualizacin, Flash Player y AIR actualizan tambin las propiedades scaleX y scaleY del objeto. Nota: los objetos TextField son una excepcin a este comportamiento de escala. Los campos de texto deben ajustar su tamao automticamente para alojar el texto y los tamaos de fuente. Por ello, reajustan sus valores scaleX o scaleY a 1 tras el cambio de tamao. Sin embargo, si se ajustan los valores scaleX o scaleY de un objeto TextField, los valores de anchura y altura cambian para escalar los valores proporcionados. Estas propiedades representan el tamao relativo del objeto de visualizacin con respecto a su tamao original. Las propiedades scaleX y scaleY utilizan valores fraccionarios (decimales) para representar el porcentaje. Por ejemplo, si se cambia la anchura (width) de un objeto de visualizacin a la mitad de su tamao original, la propiedad scaleX del objeto tendr el valor .5, que significa 50 por ciento. Si se duplica la altura, la propiedad scaleY tendr el valor 2, que significa 200 por ciento.
// circle is a display object whose width and height are 150 pixels. // At original size, scaleX and scaleY are 1 (100%). trace(circle.scaleX); // output: 1 trace(circle.scaleY); // output: 1 // When you change the width and height properties, // Flash Player changes the scaleX and scaleY properties accordingly. circle.width = 100; circle.height = 75; trace(circle.scaleX); // output: 0.6622516556291391 trace(circle.scaleY); // output: 0.4966887417218543
Los cambios de tamao no son proporcionales. Dicho de otro modo, si se cambia la altura (height) de un cuadrado pero no la anchura (width), ya no tendr las mismas proporciones y ya no ser un cuadrado sino un rectngulo. Si se desea cambiar relativamente el tamao de un objeto de visualizacin, se pueden definir los valores de las propiedades scaleX y scaleY para cambiar el tamao del objeto, en lugar de definir las propiedades width o height. Por ejemplo, este cdigo cambia la anchura (width) del objeto de visualizacin denominado square y luego modifica la escala vertical (scaleY) para que coincida con la escala horizontal, de modo que el tamao del cuadrado siga siendo proporcional.
// Change the width directly. square.width = 150; // Change the vertical scale to match the horizontal scale, // to keep the size proportional. square.scaleY = square.scaleX;
177
Sin embargo, en este caso es preferible tener el control del ajuste de escala, es decir, poder designar las reas en las que debe ajustarse la escala (los lados rectos y la parte central) y las reas en las que no, de forma que el ajuste de escala se produzca sin una distorsin visible.
Se puede usar la escala en 9 divisiones (Scale-9) para crear objetos de visualizacin cuyo ajuste de escala pueda controlarse. Con la escala en 9 divisiones, el objeto de visualizacin se divide en nueve rectngulos independientes (una cuadrcula de 3 por 3, como la cuadrcula de un tablero de tres en raya). Los rectngulos no son necesariamente del mismo tamao; el usuario designa la ubicacin de las lneas de la cuadrcula. El contenido de los cuatro rectngulos de bordes redondeados (como las esquinas redondeadas de un botn) no se expandir ni comprimir cuando se ajuste la escala del objeto de visualizacin. Los rectngulos superior central e inferior central ajustarn la escala horizontalmente pero no verticalmente, mientras que los rectngulos izquierdo central y derecho central ajustarn la escala verticalmente pero no horizontalmente. El rectngulo central ajustar la escala tanto vertical como horizontalmente.
Teniendo esto en cuenta, cuando se crea un objeto de visualizacin y se desea que nunca se ajuste la escala de determinado contenido, simplemente hay que asegurarse de que las lneas divisorias de la cuadrcula de escala en 9 divisiones se siten de forma que el contenido finalice en uno de los rectngulos de bordes redondeados.
178
En ActionScript, al establecer un valor de la propiedad scale9Grid de un objeto de visualizacin, se activa la escala en 9 divisiones en el objeto y se define el tamao de los rectngulos en la cuadrcula Scale-9 del objeto. Se utiliza una instancia de la clase Rectangle como valor de la propiedad scale9Grid, del siguiente modo:
myButton.scale9Grid = new Rectangle(32, 27, 71, 64);
Los cuatro parmetros del constructor de Rectangle son la coordenada x, la coordenada y, la anchura y la altura. En este ejemplo, la esquina superior izquierda del rectngulo se sita en el punto x: 32, y: 27 en el objeto de visualizacin denominado myButton. El rectngulo tiene una anchura de 71 pxeles y una altura de 64 pxeles (es decir, su borde derecho est en la coordenada x 103 del objeto de visualizacin y su borde inferior en la coordenada y 92 del objeto de visualizacin).
El rea real contenida en el rea definida por la instancia de Rectangle representa el rectngulo central de la cuadrcula Scale-9. Para calcular los dems rectngulos, Flash Player y AIR amplan los lados de la instancia de Rectangle, como se muestra a continuacin:
En este caso, a medida que el botn ajusta la escala para expandirse o comprimirse, las esquinas redondeadas no se expanden ni comprimen, pero las dems reas se ajustan a la escala.
179
Nota: es posible actualizar los datos vectoriales, momento en el cual se recrea la superficie. Por tanto, los datos vectoriales almacenados en cach en la superficie no tienen por qu permanecer intactos en todo el archivo SWF. Al establecer la propiedad cacheAsBitmap del objeto de visualizacin en true, el objeto de visualizacin almacena en cach una representacin de mapa de bits de s mismo. Flash Player o AIR crean un objeto de superficie para la instancia, que es un mapa de bits almacenado en cach, en lugar de los datos vectoriales. Si cambia los lmites del objeto de visualizacin, la superficie se recrea en lugar de modificarse su tamao. Las superficies pueden anidarse dentro de otras superficies. La superficie secundaria copia el mapa de bits en su superficie principal. Para obtener ms informacin, consulte Activacin de almacenamiento de mapas de bits en cach en la pgina 181. Las propiedades opaqueBackground y scrollRect de la clase DisplayObject se relacionan con el almacenamiento en cach de mapa de bits a travs de la propiedad cacheAsBitmap. Aunque estas propiedades son independientes entre s, las propiedades opaqueBackground y scrollRect funcionan mejor cuando un objeto se almacena en cach como un mapa de bits; las ventajas de rendimiento de las propiedades opaqueBackground y scrollRect slo se evidencian cuando se establece cacheAsBitmap en true. Para obtener ms informacin sobre el desplazamiento del contenido de objetos de visualizacin, consulte Desplazamiento lateral y vertical de objetos de visualizacin en la pgina 174. Para obtener ms informacin sobre la configuracin de un fondo opaco, consulte Configuracin de un color de fondo opaco en la pgina 182. Para obtener informacin sobre el enmascaramiento del canal alfa, que requiere que establezca la propiedad cacheAsBitmap como true, consulte Enmascarar objetos de visualizacin en la pgina 186.
Imagen de fondo compleja Una aplicacin que contiene una imagen de fondo compleja y detallada de datos de
vectoriales (quizs una imagen en la que aplica el comando Trazar mapa de bits o ilustraciones que ha creado en Adobe Illustrator). Podran animarse los caracteres del fondo, lo que ralentizara la animacin porque el fondo necesita la regeneracin constante de los datos vectoriales. Para mejorar el rendimiento, se puede establecer la propiedad opaqueBackground del objeto de visualizacin de fondo en true. El fondo se representa como mapa de bits y puede redibujarse rpidamente, por lo que la animacin se reproduce con mucha mayor velocidad.
180
Campo de texto con desplazamiento: aplicacin que muestra una gran cantidad de texto en un campo de texto con
desplazamiento. Se puede colocar el campo de texto en un objeto de visualizacin definido como desplazable con lmites con desplazamiento (propiedad scrollRect). De este modo, se permite un desplazamiento rpido por los pxeles de la instancia especificada. Cuando el usuario se desplaza por la instancia del objeto de visualizacin, Flash Player o AIR mueven hacia arriba los pxeles desplazados y generan la regin recin expuesta en lugar de regenerar todo el campo de texto.
Sistema de ventanas: aplicacin con un complejo sistema de ventanas superpuestas. Cada ventana puede abrirse o
cerrarse (por ejemplo, las ventanas de un navegador web). Si se marca cada ventana como una superficie (estableciendo la propiedad cacheAsBitmap en true), cada ventana se asla y se almacena en cach. Los usuarios pueden arrastrar las ventanas para que se puedan superponer y cada ventana no necesita regenerar el contenido vectorial.
Enmascaramiento del canal alfa: si se usa el enmascaramiento del canal alfa, la propiedad cacheAsBitmap se debe
establecer en true. Para obtener ms informacin, consulte Enmascarar objetos de visualizacin en la pgina 186. La activacin de la cach de mapa de bits en todas estas situaciones mejora el nivel de respuesta e interactividad de la aplicacin, pues optimiza los grficos vectoriales. Asimismo, si se aplica un filtro a un objeto de visualizacin, cacheAsBitmap se establece automticamente en true, aunque el usuario lo establezca explcitamente en false. Si se quitan todos los filtros del objeto de visualizacin, la propiedad cacheAsBitmap recupera el valor que se estableci por ltima vez. Cundo es conveniente evitar utilizar la cach de mapa de bits El uso de esta funcin en circunstancias inadecuadas, puede afectar de forma negativa al rendimiento del archivo SWF. Cuando utilice la cach de mapa de bits, recuerde las siguientes directrices:
No haga un uso abusivo de las superficies (objetos de visualizacin para los que est activada la cach). Cada
superficie utiliza ms memoria que un objeto de visualizacin normal, lo que significa que slo deber utilizar las superficies cuando necesite mejorar el rendimiento de la representacin. Un mapa de bits almacenado en cach utiliza bastante ms memoria que un objeto de visualizacin normal. Por ejemplo, si una instancia de Sprite en el escenario tiene un tamao de 250 por 250 pxeles, al almacenarse en cach podra utilizar 250 KB en lugar de 1 KB cuando se trata de una instancia de Sprite normal (no almacenada en cach).
Evite aplicar zoom a las superficies almacenadas en cach. Si utiliza en exceso la cach de mapa de bits, se consume
una gran cantidad de memoria (consulte el apartado anterior), especialmente si aplica el zoom para acercar el contenido.
Utilice superficies para instancias de objetos de visualizacin que sean principalmente estticas (sin animacin).
Puede arrastrar o mover la instancia, pero el contenido de la instancia no debe incluir demasiada animacin ni cambiar mucho. (La animacin o el cambio de contenido son ms frecuentes en las instancias de MovieClip que contienen animacin o en las instancias de Video.) Por ejemplo, si gira o transforma una instancia, sta cambia entre la superficie y los datos vectoriales, lo que dificulta el procesamiento y afecta de forma negativa al archivo SWF.
Si mezcla superficies con datos vectoriales, aumentar la cantidad de procesamiento que deben llevar a cabo Flash
Player y AIR (y, a veces, el equipo). Agrupe las superficies tanto como sea posible; por ejemplo, cuando cree aplicaciones de gestin de ventanas.
181
No almacene en cach los objetos cuyos grficos cambien frecuentemente. Cada vez que se aplica la escala, el sesgo,
la rotacin del objeto de visualizacin, el cambio del parmetro alfa o la transformacin de color, el movimiento de los objetos de visualizacin secundarios o el dibujo utilizando la propiedad de grficos, la cach de mapa de bits se vuelve a dibujar. Si esto sucede en cada fotograma, el motor de ejecucin debe dibujar el objeto en un mapa de bits y, a continuacin, copiar ese mapa de bits en el escenario, lo que implica un trabajo adicional si se compara con slo dibujar el objeto no almacenado en cach en el escenario. El inconveniente menor de rendimiento del almacenamiento en cach frente a la frecuencia de actualizacin depende de la complejidad y el tamao del objeto de visualizacin y slo se puede determinar probando el contenido especfico.
Una vez establecida la propiedad cacheAsBitmap en true, es posible observar que el objeto de visualizacin ajusta automticamente los pxeles a coordenadas enteras. Al probar el archivo SWF, debera apreciarse un aumento considerable en la velocidad de representacin de imgenes vectoriales complejas. Si se dan una o varias de las siguientes condiciones, no se crea ninguna superficie (mapa de bits almacenado en cach) aunque cacheAsBitmap se haya establecido en true:
El mapa de bits tiene una altura o una anchura superior a 2880 pxeles. No se puede asignar el mapa de bits (se produce un error de memoria insuficiente).
Matrices de transformacin de mapa de bits almacenadas en cach Adobe AIR 2.0 y posterior (perfil mvil) En las aplicaciones de AIR para dispositivos mviles, es necesario establecer la propiedad cacheAsBitmapMatrix siempre que se defina la propiedad cacheAsBitmap. El establecimiento de esta propiedad permite aplicar un mayor rango de transformaciones al objeto de visualizacin sin activar la representacin.
mySprite.cacheAsBitmap = true; mySprite.cacheAsBitmapMatrix = new Matrix();
Cuando se establece esta propiedad de matriz, se puede aplicar la siguiente transformacin adicional al objeto de visualizacin sin volver a almacenar el objeto en cach:
Movimiento o conversin sin ajuste a pxeles Girar Escala Sesgo Cambio de alfa (transparencia de entre 0 y 100%)
Estas transformaciones se aplican directamente al mapa de bits almacenado en cach.
182
En este caso, el color de fondo del objeto Shape denominado myShape se establece en rojo (0xFF0000). Suponiendo que la instancia de Shape contiene un dibujo de un tringulo verde, en un escenario con un fondo blanco, se mostrara como un tringulo verde con color rojo en el espacio vaco del recuadro de delimitacin de la instancia de Shape (el rectngulo que abarca completamente Shape).
Por supuesto, este cdigo tendra ms sentido si se utilizara con un escenario que tuviera un fondo de color rojo slido. Con un fondo de otro color, dicho color se especificara en su lugar. Por ejemplo, en un archivo SWF con un fondo blanco, la propiedad opaqueBackground probablemente se establecera en 0xFFFFFF, o blanco puro.
BlendMode.ADD ("add"): suele utilizarse para crear un efecto de disolucin de aclarado animado entre dos
imgenes.
BlendMode.ALPHA ("alpha"): suele utilizarse para aplicar la transparencia del primer plano al fondo. (No se
183
BlendMode.DIFFERENCE ("difference"): suele utilizarse para crear colores ms vivos. BlendMode.ERASE ("erase"): se suele utilizar para recortar (borrar) parte del fondo utilizando el alfa de primer
procesamiento de GPU.)
BlendMode.INVERT ("invert"): se utiliza para invertir el fondo. BlendMode.LAYER ("layer"): se utiliza para forzar la creacin de un bfer temporal para la composicin previa
procesamiento de GPU.)
BlendMode.SCREEN ("screen"): se suele emplear para crear resaltados y destellos de lentes. BlendMode.SHADER ("shader"): se utiliza para especificar que se usa un sombreado de Pixel Bender para crear un
efecto de fusin personalizado. Para obtener ms informacin sobre el uso de sombreados, consulte Trabajo con sombreados de Pixel Bender en la pgina 302. (No se admite en procesamiento de GPU.)
Una vez creada una instancia de ColorTransform, se pueden leer sus valores de propiedades para saber cules son las transformaciones de color que ya se han aplicado o se pueden definir dichos valores para realizar cambios de color en el objeto de visualizacin. Para actualizar el objeto de visualizacin despus de haber realizado cambios, es necesario reasignar la instancia de ColorTransform a la propiedad transform.colorTransform.
var colorInfo:ColorTransform = myDisplayObject.transform.colorTransform; // Make some color transformations here. // Commit the change. myDisplayObject.transform.colorTransform = colorInfo;
184
Cuando se cambia el color de un objeto de visualizacin a travs de la propiedad color, se cambia completamente el color de todo el objeto, independientemente de que el objeto tuviera varios colores. Por ejemplo, si hay un objeto de visualizacin que contiene un crculo verde con texto negro encima, al definir como una sombra de rojo la propiedad color de la instancia de ColorTransform asociada a dicho objeto, todo el objeto, crculo y texto, se volver rojo (de modo que el texto ya no podr distinguirse del resto del objeto).
185
En el cdigo siguiente se carga una imagen JPEG y se aplica una transformacin de color que modifica los canales rojo y verde a medida que el puntero del ratn se mueve por los ejes x e y. En este caso, como no se especifica ningn valor de desplazamiento, el valor de cada uno de los canales de color mostrados en pantalla ser un porcentaje del valor de color original de la imagen, lo que significa que la mayora de rojo y verde mostrado en cualquier pxel ser la cantidad original de rojo o verde de dicho pxel.
import import import import import flash.display.Loader; flash.events.MouseEvent; flash.geom.Transform; flash.geom.ColorTransform; flash.net.URLRequest;
// Load an image onto the Stage. var loader:Loader = new Loader(); var url:URLRequest = new URLRequest("http://www.helpexamples.com/flash/images/image1.jpg"); loader.load(url); this.addChild(loader); // This function is called when the mouse moves over the loaded image. function adjustColor(event:MouseEvent):void { // Access the ColorTransform object for the Loader (containing the image) var colorTransformer:ColorTransform = loader.transform.colorTransform; // Set the red and green multipliers according to the mouse position. // The red value ranges from 0% (no red) when the cursor is at the left // to 100% red (normal image appearance) when the cursor is at the right. // The same applies to the green channel, except it's controlled by the // position of the mouse in the y axis. colorTransformer.redMultiplier = (loader.mouseX / loader.width) * 1; colorTransformer.greenMultiplier = (loader.mouseY / loader.height) * 1; // Apply the changes to the display object. loader.transform.colorTransform = colorTransformer; } loader.addEventListener(MouseEvent.MOUSE_MOVE, adjustColor);
Rotacin de objetos
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior Los objetos de visualizacin pueden girarse a travs de la propiedad rotation. Se puede leer este valor para saber si se ha girado un objeto. Para girar el objeto, se puede establecer esta propiedad en un nmero (en grados) que representa la cantidad de rotacin que se aplica al objeto. Por ejemplo, en la siguiente lnea de cdigo se gira el objeto square 45 grados (un octavo de vuelta):
square.rotation = 45;
Para girar un objeto de visualizacin tambin se puede utilizar una matriz de transformacin; esto se describe en Trabajo con la geometra en la pgina 207.
186
Tambin se puede modificar la transparencia de un objeto de visualizacin mediante los ajustes de color disponibles a travs de la clase ColorTransform. Para obtener ms informacin, consulte Ajuste de los colores de DisplayObject en la pgina 183.
El objeto de visualizacin con mscara aparece bajo todas las zonas opacas (no transparentes) del objeto de visualizacin que acta como mscara. Por ejemplo, el cdigo siguiente crea una instancia de Shape que contiene un cuadrado rojo de 100 por 100 pxeles y una instancia de Sprite que contiene un crculo azul con un radio de 25 pxeles. Cuando se hace clic en un crculo, se define como la mscara del cuadrado, de forma que la nica parte del cuadrado que aparece visible es la que queda cubierta por la parte slida del crculo. Dicho de otro modo, slo se ve un crculo rojo.
187
// This code assumes it's being run within a display object container // such as a MovieClip or Sprite instance. import flash.display.Shape; // Draw a square and add it to the display list. var square:Shape = new Shape(); square.graphics.lineStyle(1, 0x000000); square.graphics.beginFill(0xff0000); square.graphics.drawRect(0, 0, 100, 100); square.graphics.endFill(); this.addChild(square); // Draw a circle and add it to the display list. var circle:Sprite = new Sprite(); circle.graphics.lineStyle(1, 0x000000); circle.graphics.beginFill(0x0000ff); circle.graphics.drawCircle(25, 25, 25); circle.graphics.endFill(); this.addChild(circle); function maskSquare(event:MouseEvent):void { square.mask = circle; circle.removeEventListener(MouseEvent.CLICK, maskSquare); } circle.addEventListener(MouseEvent.CLICK, maskSquare);
El objeto de visualizacin que acta como mscara puede arrastrarse, animarse, cambiar de tamao automticamente y usar formas independientes en una sola mscara. No es necesario aadir el objeto de visualizacin de mscara a la lista de visualizacin. Sin embargo, si se desea ajustar la escala del objeto de mscara cuando se ajusta la escala del escenario, o permitir la interaccin del usuario con la mscara (por ejemplo, el arrastre o cambio de tamao controlado por el usuario), el objeto de mscara debe aadirse a la lista de visualizacin. El ndice z real (de delante a atrs) de los objetos de visualizacin no es relevante, siempre y cuando el objeto de mscara se aada a la lista de visualizacin. (El objeto de mscara slo aparecer en la pantalla como una mscara.) Si el objeto de mscara es una instancia de MovieClip con varios fotogramas, reproduce todos ellos en su lnea de tiempo, tal y como hara si no actuara como una mscara. Para eliminar una mscara, debe establecerse la propiedad mask en null:
// remove the mask from mySprite mySprite.mask = null;
No puede utilizar una mscara para enmascarar otra mscara ni definir la propiedad alpha de un objeto de visualizacin de mscara. En un objeto de visualizacin que se usa como mscara, slo se pueden utilizar los rellenos; los trazos se pasan por alto.
188
AIR 2 Si un objeto de visualizacin enmascarado se almacena en cach estableciendo las propiedades cacheAsBitmap y cacheAsBitmapMatrix, la mscara debe ser un objeto secundario del objeto de visualizacin enmascarado. Del mismo modo, si el objeto de visualizacin enmascarado es un descendiente de un contenedor del objeto de visualizacin que est almacenado en cach, tanto la mscara como el objeto de visualizacin deben ser descendentes de dicho contenedor. Si el objeto enmascarado es un descendiente de varios contenedores del objeto de visualizacin almacenado en cach, la mscara debe ser un descendiente del contenedor almacenado en cach ms cercano al objeto enmascarado en la lista de visualizacin.
Una aplicacin de enmascaramiento del canal alfa consiste, por ejemplo, en usar un filtro del objeto de mscara independientemente del filtro aplicado al objeto de visualizacin enmascarado. En el siguiente ejemplo se carga un archivo de imagen externo en el escenario. Dicha imagen (mejor dicho, la instancia de Loader en la que se ubica) ser el objeto de visualizacin que se enmascare. Se dibuja un valo con degradado (de color negro slido en el centro y con transparencia progresiva en los bordes) sobre la imagen; ser la mscara alfa. Ambos objetos de visualizacin tienen activada la cach de mapa de bits. El valo se define como una mscara de la imagen y luego se convierte en un elemento que se puede arrastrar.
189
// This code assumes it's being run within a display object container // such as a MovieClip or Sprite instance. import import import import import flash.display.GradientType; flash.display.Loader; flash.display.Sprite; flash.geom.Matrix; flash.net.URLRequest;
// Load an image and add it to the display list. var loader:Loader = new Loader(); var url:URLRequest = new URLRequest("http://www.helpexamples.com/flash/images/image1.jpg"); loader.load(url); this.addChild(loader); // Create a Sprite. var oval:Sprite = new Sprite(); // Draw a gradient oval. var colors:Array = [0x000000, 0x000000]; var alphas:Array = [1, 0]; var ratios:Array = [0, 255]; var matrix:Matrix = new Matrix(); matrix.createGradientBox(200, 100, 0, -100, -50); oval.graphics.beginGradientFill(GradientType.RADIAL, colors, alphas, ratios, matrix); oval.graphics.drawEllipse(-100, -50, 200, 100); oval.graphics.endFill(); // add the Sprite to the display list this.addChild(oval); // Set cacheAsBitmap = true for both display objects. loader.cacheAsBitmap = true; oval.cacheAsBitmap = true; // Set the oval as the mask for the loader (and its child, the loaded image) loader.mask = oval; // Make the oval draggable. oval.startDrag(true);
Animacin de objetos
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior La animacin es el proceso de mover algo o, alternativamente, hacer que algo cambie con el tiempo. La animacin mediante scripts es una parte fundamental de los videojuegos, que a menudo se utiliza para pulir y aadir tiles indicaciones de interaccin a otras aplicaciones.
190
La idea fundamental en la que se basa la animacin mediante scripts es la necesidad de realizar un cambio y de dividir dicho cambio en incrementos temporales. Repetir algo en ActionScript es tan sencillo como usar una sentencia de bucle comn. Sin embargo, es necesario reproducir todas las repeticiones de un bucle para poder actualizar la visualizacin. Para crear animacin mediante scripts, es necesario escribir cdigo ActionScript que repita alguna accin a lo largo del tiempo y que adems actualice la pantalla cada vez que se ejecuta. Por ejemplo, imagine que desea crear una sencilla animacin de una bola que se desplaza a travs de la pantalla. ActionScript incluye un mecanismo sencillo que permite seguir el paso del tiempo y actualizar la pantalla de forma correspondiente, lo que significa que se puede escribir cdigo que mueva la bola un poco cada vez hasta llegar a su destino. La pantalla se actualiza despus de cada movimiento, de forma que el movimiento a travs del escenario es visible para el espectador. Desde un punto de vista prctico, tiene sentido sincronizar la animacin mediante scripts con la velocidad de fotogramas del archivo SWF (es decir, hacer que una animacin cambie cada vez que se muestra un nuevo fotograma), ya que define la frecuencia con la que Flash Player o AIR actualiza la pantalla. Cada objeto de visualizacin tiene un evento enterFrame que se distribuye segn la velocidad de fotogramas del archivo SWF: un evento por fotograma. La mayora de los desarrolladores que crean animacin mediante scripts utilizan el evento enterFrame para crear acciones que se repiten a lo largo del tiempo. Se puede escribir un cdigo que detecte el evento enterFrame y mueva la bola animada una cantidad determinada en cada fotograma y, al actualizarse la pantalla (en cada fotograma), redibuje la bola en la nueva ubicacin, creando movimiento. Nota: otra forma de repetir una accin a lo largo del tiempo consiste en utilizar la clase Timer. Una instancia de Timer activa una notificacin de evento cada vez que pasa un tiempo determinado. Se puede escribir cdigo que lleve a cabo la animacin mediante la gestin del evento timer de la clase Timer, si se define un intervalo de tiempo pequeo (alguna fraccin de un segundo). Para obtener ms informacin sobre el uso de la clase Timer, consulte Control de intervalos de tiempo en la pgina 4. En el ejemplo siguiente, se crea en el escenario una instancia de Sprite circular, denominada circle. Cuando el usuario hace clic en el crculo, se inicia una secuencia de animacin mediante scripts que provoca la desaparicin progresiva de circle (se reduce su propiedad alpha) hasta que es completamente transparente:
191
import flash.display.Sprite; import flash.events.Event; import flash.events.MouseEvent; // draw a circle and add it to the display list var circle:Sprite = new Sprite(); circle.graphics.beginFill(0x990000); circle.graphics.drawCircle(50, 50, 50); circle.graphics.endFill(); addChild(circle); // When this animation starts, this function is called every frame. // The change made by this function (updated to the screen every // frame) is what causes the animation to occur. function fadeCircle(event:Event):void { circle.alpha -= .05; if (circle.alpha <= 0) { circle.removeEventListener(Event.ENTER_FRAME, fadeCircle); } } function startAnimation(event:MouseEvent):void { circle.addEventListener(Event.ENTER_FRAME, fadeCircle); } circle.addEventListener(MouseEvent.CLICK, startAnimation);
Cuando el usuario hace clic en el crculo, se suscribe la funcin fadeCircle() como detector del evento enterFrame, lo que significa que se inicia su llamada una vez en cada fotograma. Esa funcin hace que circle desaparezca progresivamente cambiando su propiedad alpha, de modo que, una vez en cada fotograma, el valor de alpha del crculo se reduce en 0,05 (5 por ciento) y se actualiza la pantalla. Finalmente, cuando el valor de alpha es 0 (circle es completamente transparente), se elimina la funcin fadeCircle() como detector de eventos y finaliza la animacin. Este mismo cdigo podra utilizarse, por ejemplo, para crear un movimiento de animacin en lugar de la desaparicin progresiva. Si se sustituye otra propiedad de alpha en la funcin que acta como detector del evento enterFrame, esa propiedad se animar. Por ejemplo, si se cambia esta lnea
circle.alpha -= .05;
se animar la propiedad x, haciendo que el crculo se mueva hacia la derecha a travs del escenario. La condicin que finaliza la animacin puede cambiarse para que la animacin termine (es decir, se quite la suscripcin del detector de enterFrame) al llegar a la coordenada x especificada.
192
Stage.orientation: indica la orientacin del escenario respecto a la posicin predeterminada. Cuando se activa la
orientacin automtica, el escenario gira en direccin contraria al dispositivo para permanecer en posicin vertical. De este modo, las posiciones derecha e izquierda indicadas por la propiedad orientation son las contrarias de las que se indican mediante la propiedad deviceOrientation. Por ejemplo, si deviceRotation indica girado a la derecha, la orientacin indica girado a la izquierda. La relacin de aspecto del escenario se puede obtener simplemente comparando la achura y altura actuales del escenario:
var aspect:String = this.stage.stageWidth >= this.stage.stageHeight ? StageAspectRatio.LANDSCAPE : StageAspectRatio.PORTRAIT;
193
Orientacin automtica
Si la orientacin automtica est activada y el usuario gira su dispositivo, el sistema operativo reorienta toda la interfaz de usuario,incluyendo la barra de tareas del sistema y la aplicacin. Como resultado, la relacin de aspecto del escenario cambia de vertical a horizontal, o viceversa. Cuando cambia la relacin de aspecto, las dimensiones del escenario tambin cambian. Active o desactive la orientacin automtica en tiempo de ejecucin, estableciendo la propiedad autoOrients del escenario en true o false. Es posible establecer el valor inicial de esta propiedad en el descriptor de la aplicacin de AIR con el elemento <autoOrients>. (Se debe tener en cuenta que antes de AIR 2.6, autoOrients es una propiedad de slo lectura y slo se puede establecer en el descriptor de la aplicacin.) Cambios de dimensin del escenario Cuando cambian las dimensiones del escenario, el contenido del escenario se escala y se puede volver a situar tal y como se especifica mediante las propiedades scaleMode y align del objeto Stage. En la mayora de los casos, al confiar en el comportamiento automtico proporcionado por la configuracin de scaleMode de Stage, no se obtienen buenos resultados. Es necesario volver a disear o dibujar los grficos y componentes para que admitan varias relaciones de aspecto. (Proporcionar una lgica de diseo flexible tambin significa que la aplicacin funcionar mejor en diversos dispositivos con diferentes tamaos de pantalla y relaciones de aspecto.) En la siguiente ilustracin se muestran los efectos de las diferentes configuraciones de scaleMode al girar un dispositivo mvil comn:
La ilustracin muestra el comportamiento del ajuste de escala que se produce al girar de una relacin de aspecto horizontal a una relacin de aspecto vertical con diferentes modos de escala. El giro de posicin vertical a horizontal produce un conjunto similar de efectos.
194
Eventos de cambio de orientacin El objeto Stage distribuye dos tipos de eventos que se pueden utilizar para detectar y reaccionar frente a los cambios de orientacin. Ambos eventos resize y orientationChange del escenario se distribuyen cuando se activa la orientacin automtica. El evento resize es el ms adecuado cuando en la orientacin automtica la pantalla debe permanecer en posicin vertical. Cuando el escenario distribuya un evento resize, vuelva a disear o dibujar el contenido, segn sea necesario. El evento resize slo se distribuye cuando el modo de escala del escenario se establece en noScale. El evento orientationChange slo se puede utilizar para detectar cambios de orientacin. El evento
orientationChange slo se distribuye cuando se activa la orientacin automtica.
Nota: en algunas plataformas mviles, el escenario distribuye un evento orientationChanging que se puede cancelar antes de distribuir los eventos resize u orientationChange. Debido a que el evento no se admite en todas las plataformas, se debe evitar basarse en el mismo.
Orientacin manual
AIR 2.6 y posterior Es posible controlar la orientacin del escenario con los mtodos setOrientation() o setAspectRatio() del objeto Stage. Definicin de la orientacin del escenario Puede definir la orientacin del escenario en tiempo de ejecucin con el mtodo setOrientation() del objeto Stage. Utilice las constantes de cadena definidas por la clase StageOrientation para especificar la orientacin que desee:
this.stage.setOrientation( StageOrientation.ROTATED_RIGHT );
No todos los dispositivos y sistemas operativos admiten todas las orientaciones posibles. Por ejemplo, la programacin de Android 2.2 no permite elegir mediante programacin la orientacin girada a la izquierda en dispositivos con orientacin estndar vertical ni permite la orientacin invertida en ningn caso. La propiedad supportedOrientations del escenario ofrece una lista con las orientaciones que pueden transferirse al mtodo setOrientation():
var orientations:Vector.<String> = this.stage.supportedOrientations; for each( var orientation:String in orientations ) { trace( orientation ); }
Definicin de la relacin de aspecto del escenario Si lo que ms le importa es la relacin de aspecto del escenario, puede definirla en vertical o en horizontal. Puede definir la relacin de aspecto en el descriptor de la aplicacin de AIR o, en tiempo de ejecucin a travs del mtodo setAspectRatio() del objeto Stage:
this.stage.setAspectRatio( StageAspectRatio.LANDSCAPE );
El motor de ejecucin seleccionar una de las dos orientaciones posibles para la relacin de aspecto especificada. Puede no coincidir con la orientacin actual del dispositivo. La orientacin predeterminada se elige con preferencia a la orientacin invertida. La orientacin adecuada para el teclado emergente se elige con preferencia a la orientacin opuesta.
195
Ejemplo: Definicin de la orientacin del escenario para coincidir con la del dispositivo El siguiente ejemplo muestra una funcin que actualiza la orientacin del escenario para que coincida con la orientacin actual del dispositivo. La propiedad deviceOrientation del escenario indica la orientacin fsica del dispositivo, incluso si est desactivada la orientacin automtica.
function refreshOrientation( theStage:Stage ):void { switch ( theStage.deviceOrientation ) { case StageOrientation.DEFAULT: theStage.setOrientation( StageOrientation.DEFAULT ); break; case StageOrientation.ROTATED_RIGHT: theStage.setOrientation( StageOrientation.ROTATED_LEFT ); break; case StageOrientation.ROTATED_LEFT: theStage.setOrientation( StageOrientation.ROTATED_RIGHT ); break; case StageOrientation.UPSIDE_DOWN: theStage.setOrientation( StageOrientation.UPSIDE_DOWN ); break; default: //No change } }
El cambio de orientacin es asncrono. Es posible detectar el evento orientationChange distribuido por el escenario para detectar la finalizacin del cambio. Si un dispositivo no admite una orientacin, la llamada setOrientation() falla sin emitir un error.
Un archivo SWF creado en ActionScript 3.0: este archivo puede ser un objeto Sprite, MovieClip o de cualquier clase
que ample Sprite. En aplicaciones de AIR en iOS, solo se pueden cargar archivos SWF que no contienen cdigo de bytes de ActionScript. Esto significa que los archivos SWF que contienen datos incorporados, como imgenes o sonido, se podrn cargar, pero no los archivos SWF que contengan cdigo ejecutable.
Un archivo de imagen: por ejemplo, archivos JPG, PNG y GIF. Un archivo SWF AVM1: un archivo SWF escrito en ActionScript 1.0 2.0. (no se admite en aplicaciones de AIR
para mviles) Estos activos se cargan mediante la clase Loader.
196
Cuando se carga el archivo SWF o la imagen, se puede mover el objeto de visualizacin cargado a otro contenedor de objeto de visualizacin, como el objeto DisplayObjectContainer container que se muestra en este ejemplo:
import flash.display.*; import flash.net.URLRequest; import flash.events.Event; var container:Sprite = new Sprite(); addChild(container); var pictLdr:Loader = new Loader(); var pictURL:String = "banana.jpg" var pictURLReq:URLRequest = new URLRequest(pictURL); pictLdr.load(pictURLReq); pictLdr.contentLoaderInfo.addEventListener(Event.COMPLETE, imgLoaded); function imgLoaded(event:Event):void { container.addChild(pictLdr.content); }
197
El siguiente diagrama muestra los diferentes usos del objeto LoaderInfo para la instancia de la clase principal del archivo SWF, para un objeto Loader y para un objeto cargado por el objeto Loader:
Se puede acceder al objeto LoaderInfo como una propiedad tanto del objeto Loader como del objeto de visualizacin cargado. En cuanto comienza la carga, se puede acceder al objeto LoaderInfo a travs de la propiedad contentLoaderInfo del objeto Loader. Cuando finaliza la carga del objeto de visualizacin, tambin es posible acceder al objeto LoaderInfo como una propiedad del objeto de visualizacin cargado, a travs de la propiedad loaderInfo del objeto de visualizacin. La propiedad loaderInfo del objeto de visualizacin hace referencia al mismo objeto LoaderInfo al que se refiere la propiedad contentLoaderInfo del objeto Loader. Dicho de otro modo, un objeto LoaderInfo se comparte entre un objeto cargado y el objeto Loader que lo ha cargado (es decir, entre el contenido cargado y el cargador). Para acceder a las propiedades del contenido cargado, es necesario aadir un detector de eventos al objeto LoaderInfo, como se muestra en el siguiente cdigo:
import flash.display.Loader; import flash.display.Sprite; import flash.events.Event; var ldr:Loader = new Loader(); var urlReq:URLRequest = new URLRequest("Circle.swf"); ldr.load(urlReq); ldr.contentLoaderInfo.addEventListener(Event.COMPLETE, loaded); addChild(ldr); function loaded(event:Event):void { var content:Sprite = event.target.content; content.scaleX = 2; }
198
checkPolicyFile: utilice esta propiedad slo si carga un archivo de imagen (no un archivo SWF). Si establece esta
propiedad en true, Loader comprueba el servidor de origen de un archivo de poltica (consulte Controles de sitio web (archivos de poltica) en la pgina 1069). Slo es necesaria en el contenido procedente de dominios ajenos al del archivo SWF que contiene el objeto Loader. Si el servidor concede permisos al dominio de Loader, el cdigo ActionScript de los archivos SWF del dominio de Loader puede acceder a los datos de la imagen cargada y, por lo tanto, se puede usar el comando BitmapData.draw() para acceder a los datos de la imagen cargada. Tenga en cuenta que un archivo SWF de otros dominios ajenos al del objeto Loader puede llamar a
Security.allowDomain() para permitir el uso de un dominio especfico.
securityDomain: utilice esta propiedad slo si carga un archivo SWF (no una imagen). Esta propiedad se especifica en un archivo SWF de un dominio ajeno al del archivo que contiene el objeto Loader. Si se especifica esta opcin, Flash Player comprueba la existencia de un archivo de poltica y, en caso de que exista uno, los archivos SWF de los dominios permitidos en el archivo de poltica entre dominios pueden reutilizar los scripts del contenido SWF cargado. Se puede especificar flash.system.SecurityDomain.currentDomain como este parmetro. applicationDomain: utilice esta propiedad solamente si carga un archivo SWF escrito en ActionScript 3.0 (no una imagen ni un archivo SWF escritos en ActionScript 1.0 2.0). Al cargar el archivo, se puede especificar que se incluya en el mismo dominio de aplicacin del objeto Loader; para ello, hay que establecer el parmetro applicationDomain en flash.system.ApplicationDomain.currentDomain. Al colocar el archivo SWF cargado en el mismo dominio de aplicacin, se puede acceder a sus clases directamente. Esto puede ser muy til si se carga un archivo SWF que contiene medios incorporados, a los que se puede tener acceso a travs de sus nombres de clase asociados. Para obtener ms informacin, consulte Trabajo con dominios de aplicacin en la pgina 142.
A continuacin se muestra un ejemplo de comprobacin de un archivo de poltica durante la carga de un mapa de bits de otro dominio:
var context:LoaderContext = new LoaderContext(); context.checkPolicyFile = true; var urlReq:URLRequest = new URLRequest("http://www.[your_domain_here].com/photo11.jpg"); var ldr:Loader = new Loader(); ldr.load(urlReq, context);
A continuacin se muestra un ejemplo de comprobacin de un archivo de poltica durante la carga de un archivo SWF de otro dominio, con el fin de colocar el archivo en el mismo entorno limitado de seguridad que el objeto Loader. Adems, el cdigo aade las clases del archivo SWF cargado al mismo dominio de aplicacin que el del objeto Loader:
var context:LoaderContext = new LoaderContext(); context.securityDomain = SecurityDomain.currentDomain; context.applicationDomain = ApplicationDomain.currentDomain; var urlReq:URLRequest = new URLRequest("http://www.[your_domain_here].com/library.swf"); var ldr:Loader = new Loader(); ldr.load(urlReq, context);
Para obtener ms informacin, consulte la clase LoaderContext en Referencia de ActionScript 3.0 para la plataforma de Adobe Flash.
199
La creacin de scripts entre el archivo de carga y el archivo cargado no se comporta como estaba previsto. La
clase ProLoader establece automticamente el archivo SWF en carga como elemento principal del archivo SWF cargado. De este modo, las comunicaciones del archivo SWF de carga van directamente al archivo SWF cargado.
La aplicacin SWF debe gestionar activamente el proceso de carga. Esto requiere la implementacin de eventos
adicionales como, por ejemplo, added, removed, addedToStage y removedFromStage. Si la aplicacin se destina a Flash Player 10.2 o posterior, ProLoader elimina la necesidad de este trabajo adicional. Actualizacin de cdigo para utilizar con ProLoader en lugar de Loader Como ProLoader imita a la clase Loader, es posible alternar fcilmente entre las dos clases en el cdigo. El siguiente ejemplo muestra cmo actualizar el cdigo existente para utilizar la nueva clase:
import flash.display.Loader; import flash.events.Event; var l:Loader = new Loader(); addChild(l); l.contentLoaderInfo.addEventListener(Event.COMPLETE, loadComplete); l.load("my.swf"); function loadComplete(e:Event) { trace('load complete!'); }
Este cdigo se puede actualizar para usar ProLoader del modo siguiente:
200
import fl.display.ProLoader; import flash.events.Event; var l:ProLoader = new ProLoader(); addChild(l); l.contentLoaderInfo.addEventListener(Event.COMPLETE, loadComplete); l.load("my.swf"); function loadComplete(e:Event) { trace('load complete!'); }
Ampliacin de las clases de objetos de visualizacin Aadir objetos a la lista de visualizacin Organizacin en capas de los objetos de visualizacin y utilizacin de contenedores de objetos de visualizacin Respuesta a eventos de objetos de visualizacin Uso de propiedades y mtodos de objetos de visualizacin
Para obtener los archivos de la aplicacin de este ejemplo, consulte www.adobe.com/go/learn_programmingAS3samples_flash_es. Los archivos de la aplicacin SpriteArranger se encuentran en la carpeta Examples/SpriteArranger. La aplicacin consta de los siguientes archivos:
Archivo SpriteArranger.mxml o SpriteArranger.fla com/example/programmingas3/SpriteArranger/CircleSprite.as Una clase que define un tipo de objeto Sprite que representa un crculo en pantalla. Una clase que define el lienzo, que es un contenedor de objeto de visualizacin que contiene objetos GeometricSprite. Una clase que define un tipo de objeto Sprite que representa un cuadrado en pantalla. Una clase que define un tipo de objeto Sprite que representa un tringulo en pantalla. Una clase que ampla el objeto Sprite y que se usa para definir una forma en pantalla. CircleSprite, SquareSprite y TriangleSprite amplan esta clase. Descripcin El archivo de aplicacin principal en Flash (FLA) o Flex (MXML).
com/example/programmingas3/SpriteArranger/DrawingCanvas.as
com/example/programmingas3/SpriteArranger/SquareSprite.as
com/example/programmingas3/SpriteArranger/TriangleSprite.as
com/example/programmingas3/SpriteArranger/GeometricSprite.as
201
Archivo com/example/programmingas3/geometricshapes/IGeometricShape.as
Descripcin La interfaz base que define los mtodos que implementarn todas las clases de formas geomtricas. Una interfaz que define los mtodos que implementarn las clases de formas geomtricas que tienen varios lados. Un tipo de forma geomtrica que tiene lados de igual longitud, simtricamente ubicados alrededor del centro de la forma. Un tipo de forma geomtrica que define un crculo. Una subclase de RegularPolygon que define un tringulo con todos los lados de la misma longitud. Una subclase de RegularPolygon que define un rectngulo con los cuatro lados de la misma longitud. Una clase que contiene un "mtodo de fbrica" para crear formas a partir de un tipo y tamao de forma.
com/example/programmingas3/geometricshapes/IPolygon.as
com/example/programmingas3/geometricshapes/RegularPolygon.as
com/example/programmingas3/geometricshapes/Circle.as com/example/programmingas3/geometricshapes/EquilateralTriangle.as
com/example/programmingas3/geometricshapes/Square.as
com/example/programmingas3/geometricshapes/GeometricShapeFactory.as
La clase UIComponent hereda de las clases DisplayObject, DisplayObjectContainer y Sprite y el cdigo de la clase DrawingCanvas emplea mtodos y propiedades para estas clases. La clase DrawingCanvas ampla la clase Sprite y su herencia se define en la declaracin de la clase DrawingCanvas de la manera siguiente:
public class DrawingCanvas extends Sprite
La clase Sprite es una subclase de las clases DisplayObjectContainer y DisplayObject, y la clase DrawingCanvas utiliza los mtodos y las propiedades de dichas clases. El mtodo constructor DrawingCanvas() configura un objeto Rectangle, bounds, que se utiliza para dibujar el contorno del lienzo. A continuacin, llama al mtodo initCanvas(), del siguiente modo:
this.bounds = new Rectangle(0, 0, w, h); initCanvas(fillColor, lineColor);
202
Tal y como se muestra en el ejemplo siguiente, el mtodo initCanvas() define diversas propiedades del objeto DrawingCanvas que se pasaron como argumentos a la funcin constructora:
this.lineColor = lineColor; this.fillColor = fillColor; this.width = 500; this.height = 200;
El mtodo initCanvas() llama entonces al mtodo drawBounds(), que dibuja el lienzo a travs de la propiedad graphics de DrawingCanvas. La propiedad graphics se hereda de la clase Shape.
this.graphics.clear(); this.graphics.lineStyle(1.0, this.lineColor, 1.0); this.graphics.beginFill(this.fillColor, 1.0); this.graphics.drawRect(bounds.left - 1, bounds.top - 1, bounds.width + 2, bounds.height + 2); this.graphics.endFill();
Los siguientes mtodos adicionales de la clase DrawingCanvas se llaman en funcin de las interacciones del usuario con la aplicacin:
Los mtodos addShape() y describeChildren(), que se describen en Aadir objetos de visualizacin al lienzo
en la pgina 203
Los mtodos moveToBack(), moveDown(), moveToFront() y moveUp(), descritos en Reorganizacin de las capas
de los objetos de visualizacin en la pgina 205
La clase GeometricSprite incluye varias propiedades comunes para todos los objetos GeometricSprite. Estas propiedades se definen en la funcin constructora segn los parmetros pasados a la funcin. Por ejemplo:
this.size = size; this.lineColor = lColor; this.fillColor = fColor;
La propiedad geometricShape de la clase GeometricSprite define una interfaz IGeometricShape, que define las propiedades matemticas de la forma, pero no las propiedades visuales. Las clases que implementan la interfaz IGeometricShape se definen en la aplicacin de ejemplo GeometricShapes en Aprendizaje de ActionScript 3.0. La clase GeometricSprite define el mtodo drawShape(), que se refina en las definiciones de sustitucin de cada una de las subclases de GeometricSprite. Para obtener ms informacin, consulte la siguiente seccin "Aadir objetos de visualizacin al lienzo".
203
Los mtodos onMouseDown() y onMouseUp(), que se describen en Seleccin mediante clic y arrastre de objetos de
visualizacin en la pgina 204
Los mtodos showSelected() y hideSelected(), descritos en Seleccin mediante clic y arrastre de objetos de
visualizacin en la pgina 204
Cada mtodo constructor llama al mtodo drawShape(), que utiliza la propiedad graphics de la clase (heredada de la clase Sprite) para dibujar el grfico vectorial adecuado. Por ejemplo, el mtodo drawShape() de la clase CircleSprite incluye el siguiente cdigo:
this.graphics.clear(); this.graphics.lineStyle(1.0, this.lineColor, 1.0); this.graphics.beginFill(this.fillColor, 1.0); var radius:Number = this.size / 2; this.graphics.drawCircle(radius, radius, radius);
La penltima lnea de la funcin addShape() define la propiedad alpha del objeto de visualizacin (heredada de la clase DisplayObject), de forma que cada objeto de visualizacin que se aade al lienzo es ligeramente transparente, lo que permite que el usuario vea los objetos que hay detrs. La lnea final del mtodo addChild() aade el nuevo objeto de visualizacin a la lista de elementos secundarios de la instancia de la clase DrawingCanvas, que ya se encuentra en la lista de visualizacin. Como resultado, el nuevo objeto de visualizacin aparece en el escenario.
204
La interfaz de la aplicacin incluye dos campos de texto: selectedSpriteTxt y outputTxt. Las propiedades de texto de estos campos se actualizan con la informacin relativa a los objetos GeometricSprite que se han aadido al lienzo o que ha seleccionado el usuario. La clase GeometricSprite gestiona esta tarea de notificacin de informacin mediante la sustitucin del mtodo toString(), del siguiente modo:
public override function toString():String { return this.shapeType + " of size " + this.size + " at " + this.x + ", " + this.y; }
La propiedad shapeType se establece en el valor adecuado en el mtodo constructor de cada subclase de GeometricSprite. Por ejemplo, el mtodo toString() podra devolver el siguiente valor de una instancia de CircleSprite recin aadida a la instancia de DrawingCanvas:
Circle of size 50 at 0, 0
El mtodo describeChildren() de la clase DrawingCanvas reproduce indefinidamente la lista de elementos secundarios del lienzo, utilizando la propiedad numChildren (heredada de la clase DisplayObjectContainer) para definir el lmite del bucle for. Genera una cadena con el valor de cada elemento secundario, del siguiente modo:
var desc:String = ""; var child:DisplayObject; for (var i:int=0; i < this.numChildren; i++) { child = this.getChildAt(i); desc += i + ": " + child + '\n'; }
La cadena resultante se utiliza para establecer la propiedad text del campo de texto outputTxt.
A continuacin, el mtodo onMouseDown() llama al mtodo showSelected() del objeto GeometricSprite. Si es la primera vez que se ha llamado a este mtodo en el objeto, el mtodo crea un nuevo objeto Shape denominado selectionIndicator y utiliza la propiedad graphics del objeto Shape para dibujar un rectngulo de resaltado rojo, del siguiente modo:
this.selectionIndicator = new Shape(); this.selectionIndicator.graphics.lineStyle(1.0, 0xFF0000, 1.0); this.selectionIndicator.graphics.drawRect(-1, -1, this.size + 1, this.size + 1); this.addChild(this.selectionIndicator);
Si no es la primera vez que se llama al mtodo onMouseDown(), el mtodo simplemente establece la propiedad visible del objeto Shape selectionIndicator(heredada de la clase DisplayObject), del siguiente modo:
this.selectionIndicator.visible = true;
El mtodo hideSelected() oculta el objeto Shape selectionIndicator del objeto seleccionado previamente estableciendo su propiedad visible en false.
205
El mtodo del controlador de eventos onMouseDown() tambin llama al mtodo startDrag() (heredado de la clase Sprite), que incluye el siguiente cdigo:
var boundsRect:Rectangle = this.parent.getRect(this.parent); boundsRect.width -= this.size; boundsRect.height -= this.size; this.startDrag(false, boundsRect);
De esta forma, el usuario puede arrastrar el objeto seleccionado por el lienzo, dentro de los lmites definidos por el rectngulo boundsRect. Cuando el usuario suelta el botn del ratn, se distribuye el evento mouseUp. El mtodo constructor de DrawingCanvas configura el siguiente detector de eventos:
this.addEventListener(MouseEvent.MOUSE_UP, onMouseUp);
Este detector de eventos se define en el objeto DrawingCanvas y no en cada uno de los objetos GeometricSprite. El motivo de ello es que, al arrastrar el objeto GeometricSprite, ste podra acabar detrs de otro objeto de visualizacin (otro objeto GeometricSprite) al soltar el botn del ratn. El objeto de visualizacin en primer plano recibira el evento de soltar el ratn pero no as el objeto de visualizacin que arrastra el usuario. Al aadir el detector al objeto DrawingCanvas, se garantiza un control perpetuo del evento. El mtodo onMouseUp() llama al mtodo onMouseUp() del objeto GeometricSprite, que a su vez llama al mtodo stopDrag() del objeto GeometricSprite.
El mtodo utiliza el mtodo setChildIndex() (heredado de la clase DisplayObjectContainer) para colocar el objeto de visualizacin en la posicin de ndice 0 en la lista de elementos secundarios de la instancia de DrawingCanvas (this). El mtodo moveDown() funciona de forma similar, excepto en que reduce en 1 la posicin de ndice del objeto de visualizacin en la lista de elementos secundarios de la instancia de DrawingCanvas:
206
public function moveDown(shape:GeometricSprite):void { var index:int = this.getChildIndex(shape); if (index > 0) { this.setChildIndex(shape, index - 1); } }
Los mtodos moveUp() y moveToFront() funcionan de modo similar a los mtodos moveToBack() y moveDown().
207
Ms temas de ayuda
flash.geom, paquete
Fundamentos de geometra
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior El paquete flash.geom contiene clases que definen objetos geomtricos, como puntos, rectngulos y matrices de transformacin. Estas clases no siempre proporcionan funcionalidad; sin embargo, se utilizan para definir las propiedades de los objetos que se usan en otras clases. Todas las clases de geometra se basan en la idea de que las ubicaciones de la pantalla se representan como un plano bidimensional. La pantalla se trata como un grfico plano con un eje horizontal (x) y un eje vertical (y). Cualquier ubicacin (o punto) de la pantalla se puede representar como un par de valores x e y (las coordenadas de dicha ubicacin). Todos los objetos de visualizacin, incluyendo el escenario, cuentan con su propio espacio de coordenadas. El espacio de coordenadas es un grfico propio del objeto para representar las ubicaciones de objetos de visualizacin secundarios, dibujos, etc. El origen est en la ubicacin de la coordenada 0, 0 (donde coinciden los ejes x e y), y se sita en la esquina superior izquierda del objeto de visualizacin. Aunque esta ubicacin de origen siempre es vlida para el escenario, no lo es necesariamente para otros objetos de visualizacin. Los valores del eje x aumentan hacia la derecha y disminuyen hacia la izquierda. En las ubicaciones situadas a la izquierda del origen, la coordenada x es negativa. No obstante, a diferencia de los sistemas de coordenadas tradicionales, los valores de coordenadas del motor de ejecucin de Flash del eje y aumentan en la parte inferior de la pantalla y disminuyen en la parte superior. Los valores superiores al origen presentan una coordenada y negativa. Puesto que la esquina superior izquierda del escenario es el origen de su espacio de coordenadas, la mayora de los objetos del escenario tienen una coordenada x mayor que 0 y menor que la anchura del escenario. Y el mismo objeto cuenta con una coordenada y mayor que 0 y menor que la altura del escenario. Se pueden utilizar instancias de la clase Point para representar puntos individuales de un espacio de coordenadas. Adems, se puede crear una instancia de Rectangle para representar una regin rectangular en un espacio de coordenadas. Los usuarios avanzados pueden utilizar una instancia de Matrix para aplicar varias transformaciones o transformaciones complejas a un objeto de visualizacin. Muchas transformaciones simples, como la rotacin o los cambios de posicin y de escala se pueden aplicar directamente a un objeto de visualizacin mediante las propiedades de dicho objeto. Para obtener ms informacin sobre la aplicacin de transformaciones con propiedades de objetos de visualizacin, consulte Manipulacin de objetos de visualizacin en la pgina 168.
208
Conceptos y trminos importantes La siguiente lista de referencia contiene trminos de geometra importantes:
Coordenadas cartesianas Las coordenadas se suelen escribir como un par de nmeros (como 5, 12 17, -23). Los dos
elementos secundarios.
Origen Punto de un espacio de coordenadas en el que el eje x converge con el eje y. Este punto tiene las coordenadas 0, 0. Punto Ubicacin individual en un espacio de coordenadas. En el sistema de coordenadas bidimensional utilizado en
ActionScript, la ubicacin a lo largo de los ejes x e y (coordenadas del punto) define el punto.
Punto de registro En un objeto de visualizacin, el origen (coordenada 0, 0) de su espacio de coordenadas. Escala Tamao de un objeto en relacin con su tamao original. Ajustar la escala de un objeto significa cambiar su
209
Asimismo, para calcular la distancia del punto de registro de un objeto de visualizacin denominado target con respecto a un punto especfico del escenario, se puede usar el mtodo localToGlobal() de la clase DisplayObject:
import flash.geom.*; var stageCenter:Point = new Point(); stageCenter.x = this.stage.stageWidth / 2; stageCenter.y = this.stage.stageHeight / 2; var targetCenter:Point = new Point(target.x, target.y); targetCenter = target.localToGlobal(targetCenter); var distance:Number = Point.distance(stageCenter, targetCenter);
210
Clase DisplayObjectContainer
Mtodos o propiedades
areInaccessibleObjectsUnderPoint()getObject sUnderPoint()
Descripcin Se usa para devolver una lista de objetos bajo un punto en un contenedor de objetos de visualizacin. Se usa para definir el pxel en el objeto BitmapData, as como el punto en el que se busca una zona activa. Se usa para definir las posiciones de los rectngulos que definen las operaciones.
BitmapData
hitTest()
BitmapData
Matrix
deltaTransformPoint() transformPoint()
Se usa para definir los puntos para los que se desea aplicar una transformacin. Se usa para definir estas propiedades.
Rectangle
211
import flash.geom.Rectangle; var x1:Number = 0; var y1:Number = 0; var width1:Number = 100; var height1:Number = 50; var rect1:Rectangle = new Rectangle(x1, y1, width1, height1); trace(rect1) // (x=0, y=0, w=100, h=50) rect1.x = 20; rect1.y = 30; trace(rect1); // (x=20, y=30, w=100, h=50)
Tal y como se muestra en el siguiente cdigo, cuando se cambia la propiedad left o top de un objeto Rectangle, el rectngulo cambia de posicin. Las propiedades x e y del rectngulo coinciden con las propiedades left y top, respectivamente. Sin embargo, no se modifica la posicin de la esquina inferior izquierda del objeto Rectangle y cambia su tamao.
import flash.geom.Rectangle; var x1:Number = 0; var y1:Number = 0; var width1:Number = 100; var height1:Number = 50; var rect1:Rectangle = new Rectangle(x1, y1, width1, height1); trace(rect1) // (x=0, y=0, w=100, h=50) rect1.left = 20; rect1.top = 30; trace(rect1); // (x=20, y=30, w=80, h=20)
Asimismo, tal como se muestra en el ejemplo siguiente, si se cambia la propiedad bottom o right del objeto Rectangle, no se ver modificada la posicin de su esquina superior izquierda. El rectngulo cambia de tamao de forma correspondiente:
import flash.geom.Rectangle; var x1:Number = 0; var y1:Number = 0; var width1:Number = 100; var height1:Number = 50; var rect1:Rectangle = new Rectangle(x1, y1, width1, height1); trace(rect1) // (x=0, y=0, w=100, h=50) rect1.right = 60; trect1.bottom = 20; trace(rect1); // (x=0, y=0, w=60, h=20)
Tambin se puede cambiar la posicin de un objeto Rectangle con el mtodo offset(), del siguiente modo:
import flash.geom.Rectangle; var x1:Number = 0; var y1:Number = 0; var width1:Number = 100; var height1:Number = 50; var rect1:Rectangle = new Rectangle(x1, y1, width1, height1); trace(rect1) // (x=0, y=0, w=100, h=50) rect1.offset(20, 30); trace(rect1); // (x=20, y=30, w=100, h=50)
El mtodo offsetPt() funciona de un modo similar, con la excepcin de que utiliza un objeto Point como parmetro, en lugar de valores de desplazamiento x e y.
212
Tambin se puede cambiar el tamao de un objeto Rectangle con el mtodo inflate(), que incluye dos parmetros, dx y dy. El parmetro dx representa el nmero de pxeles que los lados izquierdo y derecho del rectngulo se desplazan respecto al centro. El parmetro dy representa el nmero de pxeles que la parte superior e inferior del rectngulo se desplazan respecto al centro:
import flash.geom.Rectangle; var x1:Number = 0; var y1:Number = 0; var width1:Number = 100; var height1:Number = 50; var rect1:Rectangle = new Rectangle(x1, y1, width1, height1); trace(rect1) // (x=0, y=0, w=100, h=50) rect1.inflate(6,4); trace(rect1); // (x=-6, y=-4, w=112, h=58)
El mtodo inflatePt() funciona de un modo similar, con la excepcin de que utiliza un objeto Point como parmetro, en lugar de valores dx y dy.
El mtodo intersection() se usa para buscar la regin rectangular formada por el rea solapada de dos rectngulos:
import flash.display.*; import flash.geom.Rectangle; var rect1:Rectangle = new Rectangle(0, 0, 100, 100); trace(rect1); // (x=0, y=0, w=100, h=100) var rect2:Rectangle = new Rectangle(80, 60, 100, 100); trace(rect2); // (x=120, y=60, w=100, h=100) trace(rect1.intersection(rect2)); // (x=80, y=60, w=20, h=40)
El mtodo intersects() se usa para saber si dos rectngulos presentan un punto de interseccin. Asimismo, se puede usar el mtodo intersects() para conocer si en una regin determinada del escenario hay un objeto de visualizacin. Por ejemplo, en el cdigo siguiente, se considera que el espacio de coordenadas del contenedor de objetos de visualizacin que incluye el objeto circle es el mismo que el del escenario. En el ejemplo se muestra cmo utilizar el mtodo intersects() para determinar si un objeto de visualizacin, circle, crea una interseccin con regiones especificadas del escenario, definidas por los objetos Rectangle target1 y target2:
213
import flash.display.*; import flash.geom.Rectangle; var circle:Shape = new Shape(); circle.graphics.lineStyle(2, 0xFF0000); circle.graphics.drawCircle(250, 250, 100); addChild(circle); var circleBounds:Rectangle = circle.getBounds(stage); var target1:Rectangle = new Rectangle(0, 0, 100, 100); trace(circleBounds.intersects(target1)); // false var target2:Rectangle = new Rectangle(0, 0, 300, 300); trace(circleBounds.intersects(target2)); // true
Asimismo, se puede utilizar el mtodo intersects() para saber si se superponen los rectngulos de delimitacin de dos objetos de visualizacin. Se puede utilizar el mtodo getRect() de la clase DisplayObject para incluir el espacio adicional que puedan aadir los trazos de un objeto de visualizacin a la regin de delimitacin.
Descripcin Se usa como el tipo de algunos parmetros para definir una regin del objeto BitmapData.
DisplayObject
Se usa como el tipo de datos de la propiedad o el tipo de datos que se devuelve. Se usa para definir el parmetro printArea. Se usa para definir el parmetro bounds. Se usa como el tipo de valor devuelto. Se usa como el tipo de datos.
214
Aunque se puede definir una matriz ajustando directamente las propiedades (a, b, c, d, tx, ty) de un objeto Matrix, resulta ms fcil utilizar el mtodo createBox(). Este mtodo incluye parmetros que permiten definir directamente los efectos de ajuste de escala, rotacin y traslacin del objeto Matrix resultante. Por ejemplo, el cdigo siguiente crea un objeto Matrix que ajusta la escala de un objeto con un factor de 2 horizontalmente y 3 verticalmente, lo gira 45 grados y lo mueve (es decir, lo traslada) 10 pxeles a la derecha y 20 pxeles hacia abajo:
var matrix:Matrix = new Matrix(); var scaleX:Number = 2.0; var scaleY:Number = 3.0; var rotation:Number = 2 * Math.PI * (45 / 360); var tx:Number = 10; var ty:Number = 20; matrix.createBox(scaleX, scaleY, rotation, tx, ty);
Tambin se pueden ajustar los efectos de escala, rotacin y traslacin de un objeto Matrix con los mtodos scale(), rotate() y translate(). Estos mtodos se combinan con los valores del objeto Matrix existente. Por ejemplo, en el cdigo siguiente se establece un objeto Matrix que ajusta la escala de un objeto con un factor de 4 y lo gira 60 grados, ya que los mtodos scale() y rotate() se llaman dos veces.
var matrix:Matrix = new Matrix(); var rotation:Number = 2 * Math.PI * (30 / 360); // 30 var scaleFactor:Number = 2; matrix.scale(scaleFactor, scaleFactor); matrix.rotate(rotation); matrix.scale(scaleX, scaleY); matrix.rotate(rotation); myDisplayObject.transform.matrix = matrix;
Para aplicar una transformacin de sesgo a un objeto Matrix, debe ajustarse su propiedad b o c. Al ajustar la propiedad b, se sesga la matriz verticalmente y al ajustar la propiedad c, se sesga la matriz horizontalmente. En el cdigo siguiente, se sesga el objeto Matrix myMatrix verticalmente con un factor de 2:
var skewMatrix:Matrix = new Matrix(); skewMatrix.b = Math.tan(2); myMatrix.concat(skewMatrix);
Se puede aplicar una transformacin de objeto Matrix a la propiedad transform de un objeto de visualizacin. Por ejemplo, el cdigo siguiente aplica una transformacin de matriz a un objeto de visualizacin denominado myDisplayObject:
var matrix:Matrix = myDisplayObject.transform.matrix; var scaleFactor:Number = 2; var rotation:Number = 2 * Math.PI * (60 / 360); // 60 matrix.scale(scaleFactor, scaleFactor); matrix.rotate(rotation); myDisplayObject.transform.matrix = matrix;
La primera lnea define un objeto Matrix en la matriz de transformacin existente que utiliza el objeto de visualizacin myDisplayObject (la propiedad matrix de la propiedad transformation del objeto de visualizacin myDisplayObject). De este modo, los mtodos de la clase Matrix que se llamen tendrn un efecto acumulativo sobre la posicin, la escala y la rotacin del objeto de visualizacin.
215
Nota: la clase ColorTransform tambin est incluida en el paquete flash.geometry. Esta clase se utiliza para establecer la propiedad colorTransform de un objeto Transform. Puesto que no aplica ningn tipo de transformacin geomtrica, no se describe aqu detalladamente. Para obtener ms informacin, consulte la clase ColorTransform en Referencia de ActionScript 3.0 para la plataforma de Adobe Flash.
Girar el objeto de visualizacin Ajustar la escala del objeto de visualizacin Trasladar el objeto de visualizacin (cambiar su posicin) Sesgar el objeto de visualizacin
La aplicacin proporciona una interfaz para ajustar los parmetros de la transformacin de matriz del modo siguiente:
Cuando el usuario hace clic en el botn Transformar, la aplicacin aplica la transformacin correspondiente.
216
El objeto de visualizacin original, y el mismo objeto con una rotacin de -45 y un ajuste de escala del 50%
Para obtener los archivos de la aplicacin de este ejemplo, consulte www.adobe.com/go/learn_programmingAS3samples_flash_es. Los archivos de la aplicacin DisplayObjectTransformer se encuentran en la carpeta Samples/DisplayObjectTransformer. La aplicacin consta de los siguientes archivos:
Archivo DisplayObjectTransformer.mxml o DisplayObjectTransformer.fla com/example/programmingas3/geometry/MatrixTransformer.as Una clase que contiene mtodos para aplicar transformaciones de matriz. Un directorio que contiene archivos de imagen de ejemplo que utiliza la aplicacin. Descripcin El archivo de aplicacin principal en Flash (FLA) o Flex (MXML)
img/
sourceMatrix: matriz de entrada que es transformada por el mtodo. xScale e yScale: factor de escala x e y. dx y dy: magnitudes de traslacin x e y, representadas en pxeles. rotation: magnitud de rotacin, expresada en grados. skew: factor de sesgo, como porcentaje. skewType: direccin del sesgo, ya sea "right" (derecha) o "left" (izquierda).
El valor devuelto es la matriz resultante. El mtodo transform() llama a los siguientes mtodos estticos de la clase:
217
rotate()
Cada uno devuelve la matriz de origen con la transformacin aplicada. Mtodo skew() El mtodo skew() sesga la matiz ajustando las propiedades b y c de la misma. Un parmetro opcional, unit, determina las unidades que se utilizan para definir el ngulo de sesgo y, si es necesario, el mtodo convierte el valor angle en radianes:
if (unit == { angle = } if (unit == { angle = } "degrees") Math.PI * 2 * angle / 360; "gradients") Math.PI * 2 * angle / 100;
Se crea y se ajusta un objeto skewMatrix para aplicar la transformacin de sesgo. Inicialmente, es la matriz de identidad:
var skewMatrix:Matrix = new Matrix();
El parmetro skewSide determina el lado en el que se aplica el sesgo. Si se establece en "right", el cdigo siguiente establece la propiedad b de la matriz:
skewMatrix.b = Math.tan(angle);
De lo contrario, el lado inferior se sesga ajustando la propiedad c de la matriz, del siguiente modo:
skewMatrix.c = Math.tan(angle);
El sesgo resultante se aplica a la matriz existente mediante la concatenacin de las dos matrices, como se muestra en el ejemplo siguiente:
sourceMatrix.concat(skewMatrix); return sourceMatrix;
Mtodo scale() Tal y como se muestra en el ejemplo, el mtodo scale() ajusta primero el factor de escala si se proporciona como porcentaje y luego utiliza el mtodo scale() del objeto de matriz:
if (percent) { xScale = xScale / 100; yScale = yScale / 100; } sourceMatrix.scale(xScale, yScale); return sourceMatrix;
Mtodo translate() El mtodo translate() aplica simplemente los factores de traslacin dx y dy llamando al mtodo translate() del objeto de matriz:
sourceMatrix.translate(dx, dy); return sourceMatrix;
218
Mtodo rotate() El mtodo rotate() convierte el factor de rotacin de entrada en radianes (si se proporciona en grados o gradientes), y luego llama al mtodo rotate() del objeto de matriz:
if (unit == "degrees") { angle = Math.PI * 2 * angle / 360; } if (unit == "gradients") { angle = Math.PI * 2 * angle / 100; } sourceMatrix.rotate(angle); return sourceMatrix;
La aplicacin aplica el valor devuelto a la propiedad matrix de la propiedad transform del objeto de visualizacin, con lo que se activa la transformacin:
img.content.transform.matrix = tempMatrix;
219
Ms temas de ayuda
flash.display.Graphics
alcanza el punto de control, no obstante, se curva como si fuese arrastrada hacia ste.
Espacio de coordenadas Grfico de coordenadas incluido en un objeto de visualizacin, en el que se sitan sus
elementos secundarios.
220
Relleno Parte interior slida de una forma que tiene una lnea rellena con color o la totalidad de una forma que no tiene contorno. Degradado Color que est formado por la transicin gradual de un color a otro u otros (a diferencia de un color
slido).
Punto Ubicacin individual en un espacio de coordenadas. En el sistema de coordenadas bidimensional utilizado en ActionScript, el punto se define por su ubicacin en el eje x y en el eje y (las coordenadas del punto). Curva cuadrtica de Bzier Tipo de curva definida por una frmula matemtica concreta. En este tipo de curva, la forma se calcula basndose en las posiciones de los puntos de ancla (los extremos de la curva) y el punto de control que define la direccin y la curvatura del trazo. Escala Tamao de un objeto en relacin con su tamao original. Ajustar la escala de un objeto significa cambiar su
Clase Graphics
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior Todos los objetos Shape, Sprite y MovieClip tienen una propiedad graphics, que es una instancia de la clase Graphics. La clase Graphics incluye propiedades y mtodos para dibujar lneas, rellenos y formas. Cuando se necesita un objeto de visualizacin que se va a utilizar nicamente como un lienzo para dibujar contenido, se puede utilizar una instancia de Shape. Las instancias de Shape funcionan mejor que otros objetos de visualizacin a la hora de dibujar porque no tienen la sobrecarga de la funcionalidad adicional con la que cuentan las clases Sprite y MovieClip. En caso de que se desee un objeto de visualizacin en el que se pueda dibujar contenido grfico y que, al mismo tiempo, pueda contener otros objetos de visualizacin, se puede utilizar una instancia de Sprite. Para ms informacin sobre la forma de determinar qu objeto de visualizacin debe usarse para las distintas tareas, consulte Seleccin de una subclase DisplayObject en la pgina 167.
Definir los estilos de lnea y relleno. Establecer la posicin inicial de dibujo. Dibujar lneas, curvas y formas (moviendo opcionalmente el punto de dibujo). En caso de ser necesario, finalizar creando un relleno.
221
El valor predeterminado del parmetro alfa es de 1,0 (100%), de modo que se puede omitir el parmetro si se desea una lnea completamente opaca. El mtodo lineStyle() tambin acepta dos parmetros ms para las sugerencias de pxeles y el modo de escala. Para obtener ms informacin sobre el uso de estos parmetros, consulte la descripcin del mtodo Graphics.lineStyle() en Referencia de ActionScript 3.0 para la plataforma de Adobe Flash. Para crear una lnea con gradiente se emplea el mtodo lineGradientStyle(). Este mtodo se describe en Creacin de lneas y rellenos degradados en la pgina 224. Para crear una forma con relleno es necesario llamar a los mtodos beginFill(), beginGradientFill(), beginBitmapFill() o beginShaderFill() antes de empezar a dibujar. El ms bsico de ellos, el mtodo beginFill(), acepta dos parmetros: el color de relleno y (opcionalmente) un valor de alfa para el color de relleno. Por ejemplo, para dibujar una forma con un relleno verde slido, se puede usar el siguiente cdigo (suponiendo que se vaya a dibujar un objeto llamado myShape):
myShape.graphics.beginFill(0x00FF00);
Llamar a cualquier mtodo de relleno termina de forma implcita cualquier relleno antes de iniciar uno nuevo. Llamar a cualquier mtodo que especifique un estilo de trazo sustituye al trazo anterior, pero no modifica el relleno especificado previamente (y viceversa). Una vez indicado el estilo de lnea y las propiedades de relleno, el siguiente paso es especificar el punto de inicio del dibujo. La instancia de Graphics tiene un punto de dibujo, como la punta de un lpiz sobre la superficie de un papel. La siguiente accin de dibujo empezar all donde se encuentre el punto de dibujo. Inicialmente, los objetos Graphics tienen su punto de dibujo en el punto 0,0 del espacio de coordenadas del objeto en el que se est dibujando. Para empezar a dibujar en un punto diferente es necesario llamar primero al mtodo moveTo() antes de llamar a cualquiera de los mtodos de dibujo. Esto es anlogo a levantar la punta del lpiz del papel y moverla a una nueva posicin. Una vez que el punto de dibujo est colocado en su lugar, se empieza a dibujar utilizando una serie de llamadas a los mtodos de dibujo lineTo() (para dibujar lneas rectas) y curveTo() (para dibujar curvas). Mientras se dibuja es posible llamar al mtodo moveTo() en cualquier momento para mover el punto de dibujo a una nueva posicin sin dibujar. Durante el dibujo, si se ha especificado un color de relleno, es posible cerrar el relleno llamando al mtodo endFill(). Si no se ha dibujado una forma cerrada (dicho de otro modo, si en el momento en que se llama a endFill() el punto de dibujo no se encuentra en el punto de inicio de la forma), al llamar al mtodo endFill(), el motor de ejecucin de Flash cerrar automticamente la forma dibujando una lnea recta desde el punto de dibujo actual hasta la ubicacin especificada en la llamada a moveTo() ms reciente. Si se ha iniciado un relleno y no se ha llamado a endFill(), al llamar a beginFill() (o a cualquier otro mtodo de relleno) se cerrar el relleno actual y se iniciar uno nuevo.
222
El siguiente ejemplo dibuja tringulos de color rojo y verde con una altura de 100 pxeles:
var triangleHeight:uint = 100; var triangle:Shape = new Shape(); // red triangle, starting at point 0, 0 triangle.graphics.beginFill(0xFF0000); triangle.graphics.moveTo(triangleHeight / 2, 0); triangle.graphics.lineTo(triangleHeight, triangleHeight); triangle.graphics.lineTo(0, triangleHeight); triangle.graphics.lineTo(triangleHeight / 2, 0); // green triangle, starting at point 200, 0 triangle.graphics.beginFill(0x00FF00); triangle.graphics.moveTo(200 + triangleHeight / 2, 0); triangle.graphics.lineTo(200 + triangleHeight, triangleHeight); triangle.graphics.lineTo(200, triangleHeight); triangle.graphics.lineTo(200 + triangleHeight / 2, 0); this.addChild(triangle);
Dibujo de curvas
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior El mtodo curveTo() dibuja una curva cuadrtica de Bzier, es decir, un arco que conecta dos puntos (llamados puntos de ancla) y se inclina hacia un tercero (llamado punto de control). El objeto Graphics utiliza la posicin de dibujo actual como primer punto de ancla. Al llamar al mtodo curveTo(), se pasan cuatro parmetros: las coordenadas x e y, seguidas por las coordenadas x e y del segundo punto de ancla. Por ejemplo, el siguiente cdigo dibuja una curva que empieza en el punto 100, 100 y termina en el punto 200, 200. Dado que el punto de control se encuentra en 175, 125, la curva que se genera se mueve hacia la derecha y luego hacia abajo:
myShape.graphics.moveTo(100, 100); myShape.graphics.curveTo(175, 125, 200, 200);
El siguiente ejemplo dibuja objetos circulares rojos y verdes con una altura y una anchura de 100 pxeles. Hay que tener en cuenta que, debido a la naturaleza de la ecuacin cuadrtica de Bzier, no son crculos perfectos:
223
var size:uint = 100; var roundObject:Shape = new Shape(); // red circular shape roundObject.graphics.beginFill(0xFF0000); roundObject.graphics.moveTo(size / 2, 0); roundObject.graphics.curveTo(size, 0, size, size / 2); roundObject.graphics.curveTo(size, size, size / 2, size); roundObject.graphics.curveTo(0, size, 0, size / 2); roundObject.graphics.curveTo(0, 0, size / 2, 0); // green circular shape roundObject.graphics.beginFill(0x00FF00); roundObject.graphics.moveTo(200 + size / 2, 0); roundObject.graphics.curveTo(200 + size, 0, 200 + size, size / 2); roundObject.graphics.curveTo(200 + size, size, 200 + size / 2, size); roundObject.graphics.curveTo(200, size, 200, size / 2); roundObject.graphics.curveTo(200, 0, 200 + size / 2, 0); this.addChild(roundObject);
En un objeto Sprite o MovieClip, el contenido de dibujo creado con la propiedad graphics siempre aparece detrs de todos los objetos de visualizacin secundarios contenidos en el objeto. Adems, el contenido de la propiedad graphics no es un objeto de visualizacin independiente, de modo que no aparece en la lista de un elemento secundario de un objeto Sprite o MovieClip. Por ejemplo, el siguiente objeto Sprite tiene un crculo dibujado con su propiedad graphics y un objeto TextField en su lista de objetos de visualizacin secundarios:
224
var mySprite:Sprite = new Sprite(); mySprite.graphics.beginFill(0xFFCC00); mySprite.graphics.drawCircle(30, 30, 30); var label:TextField = new TextField(); label.width = 200; label.text = "They call me mellow yellow..."; label.x = 20; label.y = 20; mySprite.addChild(label); this.addChild(mySprite);
Hay que tener en cuenta que el objeto TextField aparece sobre el crculo dibujado con el objeto graphics.
El primer parmetro especifica el tipo de degradado que se va a crear. Los valores aceptables son
GradientType.LINEAR o GradientType.RADIAL.
El segundo parmetro especifica el conjunto de valores de color que se usar. En un degradado lineal, los colores se
ordenarn de izquierda a derecha. En un degradado radial, se organizarn de dentro a fuera. El orden de los colores del conjunto representa el orden en el que los colores se dibujarn en el degradado.
El tercer parmetro especifica los valores de transparencia alfa de los colores correspondientes al parmetro
anterior.
El cuarto parmetro especifica las proporciones, o el nfasis que cada color tiene dentro del gradiente. Los valores
vlidos se encuentran entre 0 y 255. Estos valores no representan una altura o anchura, sino una posicin dentro del degradado; 0 representa el inicio del degradado y 255 el final. El conjunto de proporciones debe aumentar secuencialmente y tener el mismo nmero de entradas que los conjuntos de color y de alfa especificados en el segundo y tercer parmetros. Si bien el quinto parmetro, la matriz de transformacin, es opcional, se suele utilizar con frecuencia, ya que constituye una forma fcil y potente de controlar la apariencia del degradado. Este parmetro acepta una instancia de Matrix. La forma ms sencilla de crear un objeto Matrix para el degradado es usar el mtodo createGradientBox() de la clase Matrix.
225
La forma ms fcil de definir la matriz consiste en utilizar el mtodo createGradientBox() de la clase Matrix, que crea una matriz que se usa para definir el degradado. La escala, la rotacin y la posicin del degradado se definen con los parmetros que se pasan al mtodo createGradientBox(). El mtodo createGradientBox() acepta los siguientes parmetros:
Anchura del cuadro del degradado: la anchura (en pxeles) en que se extender el degradado Altura del cuadro del degradado: la altura (en pxeles) sobre la que se extender el degradado Rotacin del cuadro de degradado: la rotacin (en radianes) que se aplicar al degradado Traslacin horizontal: el desplazamiento horizontal (en pxeles) que se aplicar al degradado Traslacin vertical: el desplazamiento vertical (en pxeles) que se aplicar al degradado
Por ejemplo, en el caso de un degradado con las caractersticas siguientes:
GradientType.LINEAR 255]
En los ejemplos siguientes, se muestran los degradados en los que el parmetro rotation del mtodo createGradientBox() difiere del modo indicado, pero el resto de valores no cambia:
width = 100; height = 100; rotation = 0; tx = 0; ty = 0; width = 100; height = 100; rotation = Math.PI/4; // 45 tx = 0; ty = 0; width = 100; height = 100; rotation = Math.PI/2; // 90 tx = 0; ty = 0;
En el ejemplo siguiente se muestran los efectos sobre un degradado lineal de verde a azul, en el que los parmetros rotation, tx y ty del mtodo createGradientBox() difieren del modo indicado, pero el resto de valores no cambia:
226
width = 50; height = 100; rotation = 0; tx = 0; ty = 0; width = 50; height = 100; rotation = 0 tx = 50; ty = 0; width = 100; height = 50; rotation = Math.PI/2; // 90 tx = 0; ty = 0; width = 100; height = 50; rotation = Math.PI/2; // 90 tx = 0; ty = 50;
Los parmetros width, height, tx y ty del mtodo createGradientBox() tambin afectan al tamao y la posicin de un relleno con degradado radial, tal como se muestra en el ejemplo siguiente:
width = 50; height = 100; rotation = 0; tx = 25; ty = 0;
227
import flash.display.Shape; import flash.display.GradientType; import flash.geom.Matrix; var var var var var var var type:String = GradientType.RADIAL; colors:Array = [0x00FF00, 0x000088]; alphas:Array = [1, 1]; ratios:Array = [0, 255]; spreadMethod:String = SpreadMethod.PAD; interp:String = InterpolationMethod.LINEAR_RGB; focalPtRatio:Number = 0;
var matrix:Matrix = new Matrix(); var boxWidth:Number = 50; var boxHeight:Number = 100; var boxRotation:Number = Math.PI/2; // 90 var tx:Number = 25; var ty:Number = 0; matrix.createGradientBox(boxWidth, boxHeight, boxRotation, tx, ty); var square:Shape = new Shape; square.graphics.beginGradientFill(type, colors, alphas, ratios, matrix, spreadMethod, interp, focalPtRatio); square.graphics.drawRect(0, 0, 100, 100); addChild(square);
No hay que olvidar que la anchura y altura del relleno degradado vienen dadas por la anchura y la altura de la matriz de degradado en lugar de por la anchura o la altura dibujadas usando el objeto Graphics. Al dibujar con el objeto Graphics, se dibuja lo que existe en esas coordenadas en la matriz de degradado. Incluso si se usa uno de los mtodos de forma de un objeto Graphics, como drawRect(), el degradado no se estira hasta adaptarse al tamao de la forma dibujada, sino que el tamao del degradado debe especificarse en la propia matriz de degradado. El siguiente ejemplo ilustra la diferencia visual entre las dimensiones de la matriz de degradado y las dimensiones del dibujo:
var myShape:Shape = new Shape(); var gradientBoxMatrix:Matrix = new Matrix(); gradientBoxMatrix.createGradientBox(100, 40, 0, 0, 0); myShape.graphics.beginGradientFill(GradientType.LINEAR, [0xFF0000, 0x00FF00, 0x0000FF], [1, 1, 1], [0, 128, 255], gradientBoxMatrix); myShape.graphics.drawRect(0, 0, 50, 40); myShape.graphics.drawRect(0, 50, 100, 40); myShape.graphics.drawRect(0, 100, 150, 40); myShape.graphics.endFill(); this.addChild(myShape);
228
Este cdigo dibuja tres degradados con el mismo estilo de relleno especificado una distribucin idntica de rojo, verde y azul. Los degradados se dibujan utilizando el mtodo drawRect() con anchuras de 50, 100 y 150 pxeles respectivamente. La matriz de degradado especificada en el mtodo beginGradientFill() se crea con una anchura de 100 pxeles. Esto quiere decir que el primer degradado abarcar slo la mitad del espectro del degradado, el segundo lo englobar totalmente y el tercero lo incluir por completo y adems tendr 50 pxeles ms de azul extendindose hacia la derecha. El mtodo lineGradientStyle() funciona de forma similar a beginGradientFill() excepto en que, adems de definir el degradado, es necesario especificar el grosor del trazo utilizando el mtodo lineStyle() antes de dibujar. El siguiente cdigo dibuja un cuadrado con un trazo degradado rojo, verde y azul:
var myShape:Shape = new Shape(); var gradientBoxMatrix:Matrix = new Matrix(); gradientBoxMatrix.createGradientBox(200, 40, 0, 0, 0); myShape.graphics.lineStyle(5, 0); myShape.graphics.lineGradientStyle(GradientType.LINEAR, [0xFF0000, 0x00FF00, 0x0000FF], [1, 1, 1], [0, 128, 255], gradientBoxMatrix); myShape.graphics.drawRect(0, 0, 200, 40); this.addChild(myShape);
Para ms informacin sobre la clase Matrix, consulte Uso de objetos Matrix en la pgina 213.
El siguiente ejemplo crea una onda de seno y una onda de coseno para poner de manifiesto la diferencia entre los mtodos Math.sin() y Math.cos() para un valor dado.
229
sinWavePosition = 100; cosWavePosition = 200; sinWaveColor:uint = 0xFF0000; cosWaveColor:uint = 0x00FF00; waveMultiplier:Number = 10; waveStretcher:Number = 5;
var i:uint; for(i = 1; i < stage.stageWidth; i++) { var sinPosY:Number = Math.sin(i / waveStretcher) * waveMultiplier; var cosPosY:Number = Math.cos(i / waveStretcher) * waveMultiplier; graphics.beginFill(sinWaveColor); graphics.drawRect(i, sinWavePosition + sinPosY, 2, 2); graphics.beginFill(cosWaveColor); graphics.drawRect(i, cosWavePosition + cosPosY, 2, 2); }
230
stage.frameRate = 31; var currentDegrees:Number = 0; var radius:Number = 40; var satelliteRadius:Number = 6; var container:Sprite = new Sprite(); container.x = stage.stageWidth / 2; container.y = stage.stageHeight / 2; addChild(container); var satellite:Shape = new Shape(); container.addChild(satellite); addEventListener(Event.ENTER_FRAME, doEveryFrame); function doEveryFrame(event:Event):void { currentDegrees += 4; var radians:Number = getRadians(currentDegrees); var posX:Number = Math.sin(radians) * radius; var posY:Number = Math.cos(radians) * radius; satellite.graphics.clear(); satellite.graphics.beginFill(0); satellite.graphics.drawCircle(posX, posY, satelliteRadius); } function getRadians(degrees:Number):Number { return degrees * Math.PI / 180; }
Se puede experimentar modificando los valores de inicializacin de las variables currentDegrees, radius y satelliteRadius al comienzo del cdigo para lograr unos resultados completamente diferentes. Por ejemplo, se puede reducir la variable radius o incrementar la variable totalSatellites. Esto no es ms que un ejemplo de la forma en la que la API de dibujo puede crear una presentacin visual cuya complejidad oculta la sencillez de su creacin.
Utilizar la API de dibujo para dibujar una forma bsica con apariencias dinmicas Conectar la interaccin del usuario con las propiedades que se usan en un dibujo Producir una animacin borrando y redibujando el escenario en cada fotograma
El ejemplo de la subseccin anterior animaba un "satelite" solitario mediante el evento Event.ENTER_FRAME. En este ejemplo se ampla el ejemplo anterior creando un panel de control con varios controles deslizantes que actualizan inmediatamente la presentacin visual de varios satlites. En este ejemplo se formaliza el cdigo en clases externas y se rodea con un bucle el cdigo de creacin del satlite, almacenando una referencia a cada satlite en un conjunto satellites.
231
Para obtener los archivos de la aplicacin para esta muestra, consulte www.adobe.com/go/learn_programmingAS3samples_flash_es. Los archivos de la aplicacin se encuentran en la carpeta Samples/AlgorithmicVisualGenerator. Esta carpeta contiene los siguientes archivos:
Archivo AlgorithmicVisualGenerator.fla com/example/programmingas3/algorithmic/AlgorithmicVisualGenerator.as Descripcin El archivo principal de la aplicacin en Flash (FLA). La clase que proporciona la funcionalidad principal de la aplicacin, incluido el dibujo de satlites en el escenario y la respuesta a los eventos del panel de control para actualizar las variables que afectan al dibujo de satlites. Una clase que gestiona la interaccin con el usuario mediante varios controles deslizantes y distribuye eventos cuando esto ocurre. Una clase que representa al objeto de visualizacin que gira en una rbita alrededor de un punto central y contiene propiedades relacionadas con su estado de dibujo actual.
com/example/programmingas3/algorithmic/ControlPanel.as
com/example/programmingas3/algorithmic/Satellite.as
232
Personalizacin avanzada
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior Este ejemplo constituye tan slo un esquema bsico de la forma en que se pueden generar efectos visuales mediante la API de dibujo. Emplea relativamente pocas lneas de cdigo para crear una experiencia interactiva que, en apariencia, es muy compleja y, an as, este ejemplo puede ampliarse mediante pequeos cambios. A continuacin se exponen algunas ideas:
La funcin doEveryFrame() puede incrementar el valor del color de los satlites. La funcin doEveryFrame() puede reducir o aumentar el radio del satlite a lo largo del tiempo. El radio del satlite no tiene por qu ser circular. Se puede usar la clase Math para se muevan siguiendo, por ejemplo,
una onda sinusoidal.
Los satlites pueden emplear un mecanismo de deteccin de colisiones con otros satlites.
Se puede utilizar la API de dibujo como alternativa para crear efectos visuales en el entorno de edicin de Flash, dibujando formas bsicas en tiempo de ejecucin. Asimismo, se puede usar para crear efectos visuales de una variedad y extensin imposibles de alcanzar manualmente. Mediante la API de dibujo y un poco de matemticas, el autor puede dar vida a un sinnmero de creaciones sorprendentes.
233
Uso de objetos Vector para almacenar datos para mtodos de dibujo. Definicin de trazados para dibujar formas mediante programacin. Definicin de reglas de direccin de trazado para determinar cmo se rellenan las formas superpuestas. Uso de clases de datos grficos Uso de tringulos y mtodos de dibujo para efectos tridimensionales.
Conceptos y trminos importantes La siguiente lista de referencia contiene trminos importantes que se utilizan en esta seccin:
Vector: conjunto de valores del mismo tipo de datos. Un objeto Vector puede almacenar un conjunto de valores
que los mtodos de dibujo utilizan para crear lneas y formas con un solo comando. Para obtener ms informacin sobre los objetos Vector, consulte Conjuntos indexados en la pgina 27.
Trazado: un trazado se compone de uno o varios segmentos rectos o curvos. El principio y el final de cada segmento
estn marcados con coordenadas, que funcionan como grapas que mantienen un cable en su lugar. Un trazado puede estar cerrado (por ejemplo, un crculo), o abierto, con marcados puntos finales (por ejemplo, una lnea ondulante).
Direccin de trazado: la direccin de un trazado interpretada por el procesador; positiva (en el sentido de las agujas
del reloj) o negativa (en el sentido contrario a las agujas del reloj).
GraphicsStroke: clase para definir el estilo de lnea. Aunque el trazo no se incluye entre las mejoras de la API de
dibujo, el uso de una clase para designar un estilo de lnea con su propia propiedad de relleno s supone una mejora. Se puede ajustar dinmicamente un estilo de lnea utilizando la clase GraphicsStroke.
234
Trazados de dibujo
Flash Player 10 y posterior, Adobe AIR 1.5 y posterior La seccin sobre dibujo de lneas y curvas (consulte Dibujo de lneas y curvas en la pgina 220) introdujo los comandos para dibujar una sola lnea (Graphics.lineTo()) o curva (Graphics.curveTo()) y posteriormente mover la lnea a otro punto (Graphics.moveTo()) para realizar una forma. Algunas de las mejoras de la API de dibujo de ActionScript, como Graphics.drawPath() y Graphics.drawTriangles(), utilizan los comandos de dibujo existentes como parmetros. Por lo tanto, se pueden proporcionar una serie de comandos Graphics.lineTo(), Graphics.curveTo() o Graphics.moveTo() para el motor de ejecucin de Flash para que se ejecuten en una sola sentencia. Dos de las mejoras de la API de dibujo permiten que Graphics.drawPath() y Graphics.drawTriangles() consoliden comandos existentes:
Conjuntos vectoriales: contiene una serie de valores de un tipo de datos especfico. Por lo tanto, se almacena una
serie de constantes GraphicsPathCommand en un objeto Vector y varias coordenadas en otro objeto Vector. Graphics.drawPath() o Graphics.drawTriangles() asigna estos valores de forma conjunta para generar un trazado de dibujo o forma. Ya no es necesario separar comandos para cada segmento de una forma. Por ejemplo, el mtodo Graphics.drawPath() consolida Graphics.moveTo(), Graphics.lineTo() y Graphics.curveTo() en un solo mtodo. En lugar de que los mtodos se llamen por separado, se abstraen en identificadores numricos, tal y como se define en la clase GraphicsPathCommand. Una operacin moveTo() se expresa mediante un 1, mientras que la operacin lineTo() es un 2. Almacene un conjunto de estos valores en un objeto Vector.<int> object para su uso en el parmetro commands. A continuacin, cree otro conjunto que contenga coordenadas en un objeto Vector.<Number> para el parmetro data. Cada valor GraphicsPathCommand se corresponde con los valores de coordenadas almacenados en el parmetro de datos donde dos nmeros consecutivos definen una ubicacin en el espacio de coordenadas de destino. Nota: los valores en el vector no son objetos Point; el vector es una serie de nmeros donde cada grupo de dos nmeros representa un par de coordenadas x/y. El mtodo Graphics.drawPath() hace coincidir cada comando con sus respectivos valores de coma (un conjunto de dos o cuatro nmeros) para generar un trazado en el objeto Graphics:
235
package{ import flash.display.*; public class DrawPathExample extends Sprite { public function DrawPathExample(){ var square_commands:Vector.<int> = new Vector.<int>(5,true); square_commands[0] = 1;//moveTo square_commands[1] = 2;//lineTo square_commands[2] = 2; square_commands[3] = 2; square_commands[4] = 2; var square_coord:Vector.<Number> = new Vector.<Number>(10,true); square_coord[0] = 20; //x square_coord[1] = 10; //y square_coord[2] = 50; square_coord[3] = 10; square_coord[4] = 50; square_coord[5] = 40; square_coord[6] = 20; square_coord[7] = 40; square_coord[8] = 20; square_coord[9] = 10; graphics.beginFill(0x442266);//set the color graphics.drawPath(square_commands, square_coord); } } }
En el ejemplo anterior, cada comando y par de coordenadas se asignan individualmente para mostrar su posicin en el conjunto, pero se pueden asignar en una sola sentencia. En el siguiente ejemplo se dibuja la misma estrella asignando los valores para cada conjunto en una sola sentencia push():
package{ import flash.display.*; public class DrawPathExample extends Sprite { public function DrawPathExample(){ var square_commands:Vector.<int> = new Vector.<int>(); square_commands.push(1, 2, 2, 2, 2); var square_coord:Vector.<Number> = new Vector.<Number>(); square_coord.push(20,10, 50,10, 50,40, 20,40, 20,10); graphics.beginFill(0x442266); graphics.drawPath(square_commands, square_coord); } } }
236
3 B
1 C
Direccin de trazado positivo y negativo A. Las flechas indican la direccin de trazado B. Direccin de trazado de curva positiva (en el sentido de las agujas del reloj) C. Direccin de trazado de curva negativa (en el sentido contrario a las agujas del reloj)
Asimismo, se debe tener en cuenta que el mtodo Graphics.drawPath() tiene un tercer parmetro opcional denominado winding:
drawPath(commands:Vector.<int>, data:Vector.<Number>, winding:String = "evenOdd"):void
En este contexto, el tercer parmetro es una cadena o una constante que especifica la direccin de trazado o regla de relleno para los trazados de interseccin. (Los valores de la constante se definen en la clase GraphicsPathWinding comoGraphicsPathWinding.EVEN_ODD o GraphicsPathWinding.NON_ZERO.) La regla de direccin de trazado es importante cuando los trazados se intersecan. La regla par-impar es la regla de direccin de trazado estndar y se utiliza en la API de dibujo heredada. La regla parimpar tambin es la predeterminada para el mtodo Graphics.drawPath(). Con la regla de direccin de trazado parimpar, cualquier trazado de interseccin alterna entre rellenos abiertos y cerrados. Si dos cuadrados dibujados con el mismo relleno intersecan, el rea de interseccin se rellena. Generalmente, las reas adyacentes no estn ambas rellenas ni vacas. Por otra parte, la regla distinta a cero depende de la direccin de trazado(direccin de dibujo) para determinar si se rellenan las reas definidas mediante trazados de interseccin. Cuando los trazados de direccin opuesta se intersecan, el rea definida no se rellena, al igual que con la regla par-impar. Para los trazados con la misma direccin, el rea que quedara vaca se rellena:
237
Reglas de direccin de trazado para reas de interseccin A. Regla de direccin de trazado par-impar B. Regla de direccin de trazado distinta a cero
Rellenos y recuentos de la regla de direccin de trazado A. Regla de direccin de trazado par-impar B. Regla de direccin de trazado distinta a cero
238
Forma de estrella con distintas reglas de direccin de trazado A. 10 lneas (par-impar) B. 5 lneas (par-impar) C. 5 lneas distintas a cero
A medida que las imgenes se animan o se utilizan como texturas en objetos tridimensionales y se superponen, las reglas de direccin de trazado cobran mayor importancia.
239
Mtodo Graphics lineGradientStyle() lineShaderStyle() lineStyle() moveTo() lineTo() curveTo() drawPath() drawTriangles()
GraphicsTrianglePath
Asimismo, la clase GraphicsPath tiene sus propios mtodos de utilidad GraphicsPath.moveTo(), GraphicsPath.lineTo(), GraphicsPath.curveTo(), GraphicsPath.wideLineTo() y GraphicsPath.wideMoveTo() para definir fcilmente los comandos para una instancia de GraphicsPath. Estos mtodos de utilidad facilitan la definicin o actualizacin de los comandos y valores de datos directamente. Una vez que se dispone de una coleccin de instancias de IGraphicsData, utilice Graphics.drawGraphicsData() para representar los grficos. El mtodo Graphics.drawGraphicsData() ejecuta un vector de las instancias de IGraphicsData mediante la API de dibujo en orden secuencial:
// stroke object var stroke:GraphicsStroke = new GraphicsStroke(3); stroke.joints = JointStyle.MITER; stroke.fill = new GraphicsSolidFill(0x102020);// solid stroke // fill object var fill:GraphicsGradientFill = new GraphicsGradientFill(); fill.colors = [0x0000FF, 0xEEFFEE]; fill.matrix = new Matrix(); fill.matrix.createGradientBox(70,70, Math.PI/2); // path object var path:GraphicsPath = new GraphicsPath(new Vector.<int>(), new Vector.<Number>()); path.commands.push(1,2,2); path.data.push(125,0, 50,100, 175,0); // combine objects for complete drawing var drawing:Vector.<IGraphicsData> = new Vector.<IGraphicsData>(); drawing.push(stroke, fill, path); // draw the drawing graphics.drawGraphicsData(drawing);
Con la modificacin de un valor en el trazado utilizado por el dibujo en el ejemplo, la forma se puede volver a dibujar varias veces para una imagen ms compleja:
240
// draw the drawing multiple times // change one value to modify each variation graphics.drawGraphicsData(drawing); path.data[2] += 200; graphics.drawGraphicsData(drawing); path.data[2] -= 150; graphics.drawGraphicsData(drawing); path.data[2] += 100; graphics.drawGraphicsData(drawing); path.data[2] -= 50;graphicsS.drawGraphicsData(drawing);
Aunque los objetos IGraphicsData pueden definir estilos de trazo y de relleno, stos no constituyen un requisito. Es decir, los mtodos de la clase Graphics se pueden utilizar para definir estilos, mientras que los objetos IGraphicsData se pueden emplear para dibujar una coleccin de trazados guardados, o viceversa. Nota: utilice el mtodo Graphics.clear() para borrar un dibujo anterior antes de comenzar uno nuevo, a no ser que se trate de una adicin al dibujo original, tal y como se muestra en el ejemplo anterior. Conforme cambia una sola parte de un trazado o coleccin de objetos IGraphicsData, vuelva a dibujar todo el dibujo para ver los cambios. Cuando se utilizan clases de datos grficos, el relleno se representa siempre que se dibujan tres o ms puntos, ya que la figura se encuentra cerrada en este punto. Aunque se cierre el relleno, el trazo no lo hace y este comportamiento es diferente al uso de varios comandos Graphics.lineTo() o Graphics.moveTo().
Uso de drawTriangles()
Flash Player 10 y posterior, Adobe AIR 1.5 y posterior Otro mtodo avanzado incluido en Flash Player 10 y Adobe AIR 1.5, Graphics.drawTriangles(), es similar al mtodo Graphics.drawPath(). El mtodo Graphics.drawTriangles() tambin utiliza un objeto Vector.<Number> para especificar ubicaciones de punto para dibujar un trazado. Sin embargo, el principal objetivo del mtodo Graphics.drawTriangles() es facilitar efectos tridimensionales en ActionScript. Para obtener ms informacin sobre el uso de Graphics.drawTriangles() para generar efectos tridimensionales, consulte Uso de tringulos para efectos 3D en la pgina 365.
241
Renaun Erickson: Rendering game assets in ActionScript using blitting techniques Bitmap programming: Captulo 26 de ActionScript 3 de Colin Moock (O'Reilly Media, 2007) Mike Jones: Working with Sprites in Pushbutton Engine Flash & Math: Pixel Particles Made Simple Flixel
242
Formatos de mapa de bits Las imgenes de mapa de bits se agrupan en una serie de formatos de archivo comunes. Estos formatos utilizan distintos tipos de algoritmos de compresin para reducir el tamao del archivo y optimizar su calidad basndose en el uso que se vaya a dar a la imagen. Los formatos de imgenes de mapa de bits admitidos en los motores de ejecucin de Adobe son BMP, GIF, JPG, PNG y TIFF. BMP El formato BMP (mapa de bits) es un formato de imagen predeterminado utilizado por el sistema operativo Microsoft Windows. No utiliza ningn algoritmo de compresin, por lo que el tamao de los archivos suele ser grande. GIF El formato GIF (Graphics Interchange Format) fue desarrollado originalmente por CompuServe en 1987 como medio para transmitir imgenes con 256 colores (color de 8 bits). Este formato da lugar a archivos de pequeo tamao y es ideal para imgenes que se van a usar en la web. A causa de lo limitado de la paleta de colores de este formato, las imgenes GIF normalmente no son adecuadas para fotografas, que suelen requerir mayores variaciones de tonalidad y degradados de color. En las imgenes GIF es posible utilizar transparencia de un bit, lo que permite designar un color como vaco (o transparente). Esto hace que el color de fondo de una pgina web se pueda ver a travs de la imagen en la que se ha asignado la transparencia. JPEG Desarrollado por el Joint Photographic Experts Group (JPEG), el formato de imagen JPEG (a veces escrito JPG) utiliza un algoritmo de compresin con prdida que permite combinar una profundidad de color de 24 bits con un tamao de archivo reducido. En la compresin con prdida, la imagen pierde calidad y datos cada vez que se guarda, pero se logra un tamao de archivo menor. El formato JPEG resulta perfecto para fotografas, ya que puede mostrar millones de colores. La capacidad de controlar el grado de compresin aplicado a una imagen permite jugar con la calidad de la imagen y el tamao del archivo. PNG El formato PNG (Portable Network Graphics) se origin como alternativa de cdigo abierto al formato de archivo GIF, que est patentado. Los archivos PNG permiten una profundidad de color de hasta 64 bits, lo que equivale a ms de 16 millones de colores. Dado que el formato PNG es relativamente nuevo, algunos navegadores antiguos no admiten este tipo de archivos. Al contrario que los JPG, los archivos PNG utilizan una compresin sin prdida, lo que quiere decir que cuando la imagen se guarda no se pierden datos. Los archivos PNG tambin permiten el uso de transparencias alfa, con un mximo de 256 niveles de transparencia. TIFF El formato TIFF (formato de archivo de imagen etiquetada) era el formato multiplataforma ms utilizado antes de la aparicin del formato PNG. El inconveniente del formato TIFF proviene de las muchas variedades de TIFF existentes y de la ausencia de un nico lector capaz de gestionarlas todas. Adems, ningn navegador web admite este formato actualmente. El formato TIFF puede utilizar compresin con o sin prdidas y es capaz de gestionar espacios de color especficos del dispositivo (por ejemplo, CMYK). Mapas de bits transparentes y opacos Las imgenes de mapa de bits que utilizan los formatos GIF o PNG pueden tener un byte extra (canal alfa) para cada pxel, que representa su valor de transparencia.
243
Las imgenes GIF permiten una transparencia de un solo bit, lo que quiere decir que se puede especificar que un nico color, de la paleta de 256, puede ser transparente. Por su parte, las imgenes PNG pueden tener hasta 256 niveles de transparencia. Esta funcin resulta especialmente til cuando es necesario que las imgenes o el texto se fundan con los fondos. ActionScript 3.0 replica este byte de transparencia extra de los pxeles dentro de la clase BitmapData. De manera similar al modelo de transparencia de PNG, ActionScript ofrece hasta 256 niveles de transparencia. Conceptos y trminos importantes La siguiente lista contiene trminos importantes que aparecen al tratar el tema de los grficos de mapa de bits:
Alfa Nivel de transparencia (o, para ser ms precisos, opacidad) de un color o una imagen. La cantidad de alfa suele describirse como el valor del canal alfa. Color ARGB Esquema de color en el que el color de cada pxel es una mezcla de los valores de los colores rojo, verde y azul, y su transparencia se especifica como un valor alfa. Canal de color Normalmente, los colores se representan como una mezcla de varios colores bsicos (en el campo de
los grficos digitales suelen ser rojo, verde y azul). Cada color bsico se considera un canal de color. La mezcla de la cantidad de color de cada canal determina el color final.
Profundidad de color Tambin denominada profundidad de bits, este concepto hace referencia a la cantidad de
memoria del equipo dedicada a cada pxel que, a su vez, determina el nmero de posibles colores que se pueden representar en la imagen.
Pxel Unidad de informacin mnima de una imagen de mapa de bits (esencialmente, un punto de color). Resolucin Dimensiones en pxeles de una imagen, que determinan el nivel de detalle que contiene la imagen. La resolucin se suele expresar en trminos del nmero de pxeles de anchura y de altura. Color RGB Esquema de color en el que el color de cada pxel se representa como una mezcla de los valores de los colores
Ms temas de ayuda
flash.display.Bitmap flash.display.BitmapData
244
Suele ocurrir que, cuando se escalan las imgenes de mapa de bits, stas se vuelven difusas y distorsionadas. Para reducir esta distorsin se puede utilizar la propiedad smoothing de la clase BitmapData. Cuando esta propiedad booleana est definida como true, al escalar la imagen, los pxeles de sta se suavizan. Esto otorga a la imagen una apariencia ms clara y natural.
Los parmetros width y height especifican el tamao del mapa de bits. En AIR 1.5 y en Flash Player 10, el tamao mximo de un objeto BitmapData es 8.191 pxeles de anchura o de altura; el nmero total de pxeles no puede superar los 16.777.215. (De modo que, si un objeto BitmapData tiene 8.191 pxeles de anchura, tendr como mucho 2.048 pxeles de altura.) En Flash Player 9 y versiones anteriores, y en AIR 1.1 y versiones anteriores, la limitacin es de 2.880 pxeles de altura y 2.880 de anchura.
245
El parmetro transparent especifica si entre los datos del mapa de bits se incluye un canal alfa (true) o no (false). El parmetro fillColor es un valor de color de 32 bits que especifica el color de fondo, as como el valor de la transparencia (si se le ha definido como true). En el siguiente ejemplo se crea un objeto BitmapData con un fondo anaranjado y una transparencia del 50 por ciento:
var myBitmap:BitmapData = new BitmapData(150, 150, true, 0x80FF3300);
Para representar en la pantalla un objeto BitmapData recin creado, se debe asignar a una instancia de Bitmap o envolverse en ella. Para ello, se puede pasar el objeto BitmapData como parmetro del constructor del objeto Bitmap o asignarlo a la propiedad bitmapData de una instancia de Bitmap existente. Tambin es necesario aadir la instancia de Bitmap a la lista de visualizacin llamando para ello a los mtodos addChild() o addChildAt() del contenedor del objeto de visualizacin que contendr a la instancia de Bitmap. Para obtener ms informacin sobre el trabajo con la lista de visualizacin, consulte Aadir objetos de visualizacin a la lista de visualizacin en la pgina 155. En el siguiente ejemplo se crea un objeto BitmapData con un relleno rojo y se muestra en una instancia de Bitmap:
var myBitmapDataObject:BitmapData = new BitmapData(150, 150, false, 0xFF0000); var myImage:Bitmap = new Bitmap(myBitmapDataObject); addChild(myImage);
Manipulacin de pxeles
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior La clase BitmapData contiene un conjunto de mtodos que permiten manipular los valores de los datos de los pxeles.
246
import flash.display.Bitmap; import flash.display.BitmapData; var myBitmapData:BitmapData = new BitmapData(100, 100, false, 0x009900); for (var i:uint = 0; i < 100; i++) { var red:uint = 0xFF0000; myBitmapData.setPixel(50, i, red); myBitmapData.setPixel(i, 50, red); } var myBitmapImage:Bitmap = new Bitmap(myBitmapData); addChild(myBitmapImage); var pixelValue:uint = myBitmapData.getPixel(50, 50); trace(pixelValue.toString(16));
Si se desea leer el valor de un grupo de pxeles, en lugar del de uno solo, se debe usar el mtodo getPixels(). Este mtodo genera un conjunto de bytes a partir de una regin rectangular de datos de pxeles que se transmite como parmetro. Cada uno de los elementos del conjunto de bytes (dicho de otro modo, los valores de los pxeles) es un entero sin signo, es decir, un valor de pxel no multiplicado de 32 bits. A la inversa, para cambiar (o definir) el valor de un grupo de pxeles, se usa el mtodo setPixels(). Este mtodo recibe dos parmetros (rect y inputByteArray), que se combinan para dar lugar a una regin rectangular (rect) de datos de pxeles (inputByteArray). A medida que se leen (y escriben) los datos de inputByteArray, se llama al mtodo ByteArray.readUnsignedInt() para cada uno de los pxeles del conjunto. Si, por algn motivo, inputByteArray no contiene todo un rectngulo de datos de pxeles, el mtodo deja de procesar los datos de imagen en ese punto. Es importante recordar que, tanto para leer como para definir los datos de los pxeles, el conjunto de bytes espera valores de pxeles de 32 bits compuestos por los canales alfa, rojo, verde y azul (ARGB). En el siguiente ejemplo se utilizan los mtodos getPixels() y setPixels() para copiar un grupo de pxeles de un objeto BitmapData a otro:
import import import import flash.display.Bitmap; flash.display.BitmapData; flash.utils.ByteArray; flash.geom.Rectangle;
var bitmapDataObject1:BitmapData = new BitmapData(100, 100, false, 0x006666FF); var bitmapDataObject2:BitmapData = new BitmapData(100, 100, false, 0x00FF0000); var rect:Rectangle = new Rectangle(0, 0, 100, 100); var bytes:ByteArray = bitmapDataObject1.getPixels(rect); bytes.position = 0; bitmapDataObject2.setPixels(rect, bytes); var bitmapImage1:Bitmap = new Bitmap(bitmapDataObject1); addChild(bitmapImage1); var bitmapImage2:Bitmap = new Bitmap(bitmapDataObject2); addChild(bitmapImage2); bitmapImage2.x = 110;
247
firstPoint (Point): este parmetro hace referencia a la posicin del pxel de la esquina superior izquierda del
esta prueba.
secondObject (objeto): este parmetro representa el rea de impacto. El objeto secondObject puede ser un objeto Rectangle, Point, Bitmap o BitmapData. Este objeto representa el rea de impacto sobre la que se realizar la deteccin de colisiones. secondBitmapDataPoint (Point): este parmetro opcional se utiliza para definir la posicin de un pxel en el
segundo objeto BitmapData. y slo se utiliza cuando el valor de secondObject es un objeto BitmapData. El valor predeterminado es null.
secondAlphaThreshold (uint): este parmetro opcional representa el valor de canal alfa ms alto que se considera opaco en el segundo objeto BitmapData. El valor predeterminado es 1. Este parmetro slo se utiliza cuando el valor de secondObject es un objeto BitmapData y los dos objetos BitmapData son transparentes.
Al llevar a cabo la deteccin de colisiones sobre imgenes opacas, es conveniente recordar que ActionScript trata la imagen como si fuera un rectngulo (o recuadro delimitador) totalmente opaco. Por otra parte, al realizar la prueba de impactos a nivel de pxeles en imgenes transparentes, es necesario que las dos imgenes sean transparentes. Adems, ActionScript utiliza los parmetros de umbral alfa para determinar en qu punto los pxeles pasan de ser transparentes a opacos. En el siguiente ejemplo se crean tres imgenes de mapa de bits y se realiza una deteccin de colisiones de pxeles utilizando dos puntos de colisin distintos (uno devuelve false y el otro true):
248
import flash.display.Bitmap; import flash.display.BitmapData; import flash.geom.Point; var bmd1:BitmapData = new BitmapData(100, 100, false, 0x000000FF); var bmd2:BitmapData = new BitmapData(20, 20, false, 0x00FF3300); var bm1:Bitmap = new Bitmap(bmd1); this.addChild(bm1); // Create a red square. var redSquare1:Bitmap = new Bitmap(bmd2); this.addChild(redSquare1); redSquare1.x = 0; // Create a second red square. var redSquare2:Bitmap = new Bitmap(bmd2); this.addChild(redSquare2); redSquare2.x = 150; redSquare2.y = 150; // Define the var pt1:Point // Define the var pt2:Point // Define the var pt3:Point point = new point = new point = new at the top-left corner of the bitmap. Point(0, 0); at the center of redSquare1. Point(20, 20); at the center of redSquare2. Point(160, 160);
249
import flash.display.Bitmap; import flash.display.BitmapData; var myParentSquareBitmap:BitmapData = new BitmapData(100, 100, false, 0x00ff3300); var myClonedChild:BitmapData = myParentSquareBitmap.clone(); var myParentSquareContainer:Bitmap = new Bitmap(myParentSquareBitmap); this.addChild(myParentSquareContainer); var myClonedChildContainer:Bitmap = new Bitmap(myClonedChild); this.addChild(myClonedChildContainer); myClonedChildContainer.x = 110;
El mtodo copyPixels() constituye una forma rpida y sencilla de copiar pxeles de un objeto BitmapData a otro. Este mtodo toma una instantnea rectangular (definida por el parmetro sourceRect) de la imagen de origen y la copia en un rea rectangular distinta (del mismo tamao). La ubicacin del rectngulo recin "pegado" se define mediante el parmetro destPoint. El mtodo copyChannel() toma una muestra de un valor de canal de color predefinido (alfa, rojo, verde o azul) de un objeto BitmapData de origen y la copia en un canal de un objeto BitmapData de destino. Llamar a este mtodo no afecta a los dems canales del objeto BitmapData de destino. El mtodo draw() dibuja, o representa, el contenido grfico de un objeto Sprite, de un clip de pelcula o de otro objeto de visualizacin de origen en un nuevo mapa de bits. Mediante los parmetros matrix, colorTransform, blendMode y clipRect de destino, es posible modificar la forma en la que se representa el nuevo mapa de bits. Este mtodo utiliza el vector procesado en Flash Player y AIR para generar los datos. Al llamar a draw(), se le pasa el objeto de origen (objeto Sprite, clip de pelcula u otro objeto de visualizacin) como primer parmetro, tal y como puede verse a continuacin:
myBitmap.draw(movieClip);
Si al objeto de origen se le ha aplicado alguna transformacin (color, matriz, etc.) despus de haber sido cargado originalmente, stas no se copiarn en el nuevo objeto. Para copiar las transformaciones en el nuevo mapa de bits, es necesario copiar el valor de la propiedad transform del objeto original en la propiedad transform del objeto Bitmap utilizado por el nuevo objeto BitmapData.
randomSeed (int): nmero de inicializacin aleatorio que determinar el patrn. A pesar de lo que indica su
nombre, este nmero crea los mismos resultados siempre que se pasa el mismo nmero. Para obtener un resultado realmente aleatorio, es necesario utilizar el mtodo Math.random() a fin de pasar un nmero aleatorio a este parmetro.
250
low (uint): este parmetro hace referencia al valor ms bajo que se generar para cada pxel (de 0 a 255). El valor predeterminado es 0. Si se establece un valor ms bajo, se originar un patrn de ruido ms oscuro, mientras que con un valor ms alto, el patrn ser ms brillante. high (uint): este parmetro hace referencia al valor ms alto que se generar para cada pxel (de 0 a 255). El valor
predeterminado es 255. Si se establece un valor ms bajo, se originar un patrn de ruido ms oscuro, mientras que con un valor ms alto, el patrn ser ms brillante.
channelOptions (uint): este parmetro especifica el canal de color del objeto de mapa de bits al que se aplicar el patrn de ruido. El nmero puede ser una combinacin de cualquiera de los cuatro valores ARGB de los canales de color. El valor predeterminado es 7. grayScale (Boolean): cuando se define como true, este parmetro aplica el valor de randomSeed a los pxeles del
mapa de bits, de modo que se elimina todo el color de la imagen. El canal alfa no se ve afectado por este parmetro. El valor predeterminado es false. En el siguiente ejemplo se crea una imagen de mapa de bits y se le aplica un patrn de ruido azul:
import flash.display.Bitmap; import flash.display.BitmapData; var myBitmap:BitmapData = new BitmapData(250, 250,false, 0xff000000); myBitmap.noise(500, 0, 255, BitmapDataChannel.BLUE,false); var image:Bitmap = new Bitmap(myBitmap); addChild(image);
Si se desea crear una textura de apariencia ms orgnica, es aconsejable utilizar el mtodo perlinNoise(). El mtodo perlinNoise() produce texturas orgnicas realistas que resultan idneas para humo, nubes, agua, fuego e incluso explosiones. Dado que se genera mediante un algoritmo, el mtodo perlinNoise() utiliza menos memoria que las texturas basadas en mapas de bits. Sin embargo, puede repercutir en el uso del procesador y ralentizar el contenido, haciendo que la pantalla se vuelva a dibujar ms lentamente que la velocidad de fotogramas, sobre todo en equipos antiguos. Principalmente esto se debe a los clculos en punto flotante que se deben ejecutar para procesar los algoritmos de ruido Perlin. Este mtodo acepta nueve parmetros (los seis primeros son obligatorios):
baseX (Number): determina el valor x (tamao) de los patrones creados. baseY (Number): determina el valor y (tamao) de los patrones creados. numOctaves (uint): nmero de octavas o funciones de ruido individuales que se van a combinar para crear este
ruido. A mayor nmero de octavas, mayor detalle pero tambin ms tiempo de procesamiento.
randomSeed (int): el nmero de inicializacin aleatorio funciona exactamente igual que en la funcin noise().
Para obtener un resultado realmente aleatorio, es necesario utilizar el mtodo Math.random() para transmitir un nmero aleatorio a este parmetro.
stitch (Boolean): si se establece en true, este mtodo intenta unir (o suavizar) los bordes de transicin de la imagen para crear texturas continuas que se pueden utilizar como mosaicos para rellenos de mapas de bits. fractalNoise (Boolean): este parmetro hace referencia a los bordes de los degradados generados mediante este mtodo. Si se define como true, el mtodo genera ruido fractal que suaviza los bordes del efecto. Si se define como false, genera turbulencia. Una imagen con turbulencia presenta discontinuidades visibles en el degradado que pueden producir efectos visuales ms ntidos, como llamas u olas del mar. channelOptions (uint): el parmetro channelOptions funciona del mismo modo que en el mtodo noise(). Con
l es posible especificar a qu canal de color (del mapa de bits) se aplicar el patrn de ruido. El nmero puede ser una combinacin de cualquiera de los cuatro valores ARGB de los canales de color. El valor predeterminado es 7.
251
grayScale (Boolean): el parmetro grayScale funciona del mismo modo que en el mtodo noise(). Si se define como true, aplica el valor de randomSeed a los pxeles del mapa de bits, de modo que se elimina todo el color de la imagen. El valor predeterminado es false. offsets (Conjunto): conjunto de puntos que corresponde a desplazamientos x e y para cada octava. Mediante la
manipulacin de los valores de desplazamiento se pueden mover suavemente las capas de la imagen. Cada punto de la conjunto de desplazamiento afecta a una funcin de ruido de octava especfica. El valor predeterminado es null. En el siguiente ejemplo se crea un objeto BitmapData de 150 x 150 pxeles que llama al mtodo perlinNoise() para generar un efecto de nubes azul y verde:
import flash.display.Bitmap; import flash.display.BitmapData; var myBitmapDataObject:BitmapData = new BitmapData(150, 150, false, 0x00FF0000); var seed:Number = Math.floor(Math.random() * 100); var channels:uint = BitmapDataChannel.GREEN | BitmapDataChannel.BLUE myBitmapDataObject.perlinNoise(100, 80, 6, seed, false, true, channels, false, null); var myBitmap:Bitmap = new Bitmap(myBitmapDataObject); addChild(myBitmap);
252
import flash.display.Bitmap; import flash.display.BitmapData; var myBitmapDataObject:BitmapData = new BitmapData(1000, 1000, false, 0x00FF0000); var seed:Number = Math.floor(Math.random() * 100); var channels:uint = BitmapDataChannel.GREEN | BitmapDataChannel.BLUE; myBitmapDataObject.perlinNoise(100, 80, 6, seed, false, true, channels, false, null); var myBitmap:Bitmap = new Bitmap(myBitmapDataObject); myBitmap.x = -750; myBitmap.y = -750; addChild(myBitmap); addEventListener(Event.ENTER_FRAME, scrollBitmap); function scrollBitmap(event:Event):void { myBitmapDataObject.scroll(1, 1); }
Un mapa de bits (archivos JPEG, GIF o PNG) que se muestra utilizando la clase Loader de ActionScript 3.0. Un mapa de bits de la biblioteca de un documento de Flash Professional. Un objeto BitmapData. Un mapa de bits que se muestra utilizando la funcin loadMovie() de ActionScript 2.0.
Los mapas MIP no se aplican a objetos filtrados o clips de pelcula almacenados en cach de mapa de bits. Sin embargo, los mapas MIP se aplican si dispone de transformaciones de mapa de bits en un objeto de visualizacin filtrado, aunque el mapa de bits est en un contenido con mscara. La tcnica de "mipmapping" se realiza automticamente, pero puede seguir algunas directrices para garantizar que sus imgenes aprovechan esta optimizacin:
Para la reproduccin de vdeo, establezca la propiedad smoothing en true para el objeto Video (consulte la clase
Video).
Para los mapas de bits, la propiedad smoothing no tiene que establecerse en true, pero las mejoras de calidad sern
ms visibles si los mapas de bits utilizan el suavizado.
253
Utilice tamaos de mapa de bits que sean divisibles por 4 u 8 para imgenes bidimensionales (por ejemplo, 640 x
128, que se puede reducir del siguiente modo: 320 x 64 > 160 x 32 > 80 x 16 > 40 x 8 > 20 x 4 > 10 x 2 > 5 x 1) y 2^n para texturas tridimensionales. Los mapas MIP se generan a partir de mapas de bits de una anchura y altura de 2^n (por ejemplo, 256 x 256, 512 x 512, 1024 x 1024). La tcnica de mipmapping no se produce para el contenido de mapa de bits con una altura o anchura distinta.
Carga de una imagen externa y acceso a sus datos de imagen sin procesar. Creacin de una animacin copiando pxeles de forma repetida de diferentes partes de una imagen de origen. Creacin de una imagen de mapa de bits estableciendo valores de pxel.
Para obtener los archivos de la aplicacin de este ejemplo, consulte www.adobe.com/go/learn_programmingAS3samples_flash_es. Los archivos de la aplicacin de la luna giratoria animada se encuentran en la carpeta Samples/SpinningMoon. La aplicacin consta de los siguientes archivos:
Archivo SpinningMoon.mxml o SpinningMoon.fla com/example/programmingas3/moon/MoonSphere.as moonMap.png Clase que realiza la funcionalidad de cargar, visualizar y animar la luna. Archivo de imagen que contiene una fotografa de la superficie de la luna, que se carga y se utiliza para crear la luna giratoria animada. Descripcin Archivo principal de la aplicacin en Flex (MXML) o en Flash (FLA).
254
La primera lnea declara la instancia de Loader denominada imageLoader. La tercera lnea inicia realmente el proceso de carga llamando al mtodo load() del objeto Loader, transmitiendo una instancia de URLRequest que representa la URL de la imagen que se va a cargar. La segunda lnea configura el detector de eventos que se activar cuando la imagen se haya cargado por completo. Se debe tener en cuenta que el mtodo addEventListener() no se llama en la propia instancia de Loader; en cambio, se llama en la propiedad contentLoaderInfo del objeto Loader. La propia instancia de Loader no distribuye eventos relacionados con el contenido que se est cargando. No obstante, su propiedad contentLoaderInfo contiene una referencia al objeto LoaderInfo que se asocia al contenido que se est cargando en el objeto Loader (la imagen externa en este caso). El objeto LoaderInfo proporciona varios eventos relacionados con el curso y la finalizacin de la carga de contenido externo, incluyendo el evento complete (Event.COMPLETE) que activar una llamada al mtodo imageLoadComplete() cuando la imagen se haya cargado por completo. Aunque el inicio de la carga de la imagen externa es una parte importante del proceso, es igualmente relevante saber qu hacer cuando finalice la carga. Tal y como se muestra en el cdigo anterior, la funcin imageLoadComplete() se llama cuando se carga la imagen. La funcin realiza varias operaciones con los datos de imagen cargados, lo que se describe posteriormente. No obstante, para utilizar los datos de imagen, es necesario acceder a los mismos. Si se usa un objeto Loader para cargar una imagen externa, la imagen cargada se convierte en una instancia de Bitmap, que se asocia como objeto de visualizacin secundario del objeto Loader. En este caso, la instancia de Loader est disponible para el mtodo del detector de eventos como parte del objeto de evento que se transmite al mtodo como parmetro. Las primeras lneas del mtodo imageLoadComplete() se presentan del siguiente modo:
private function imageLoadComplete(event:Event):void { textureMap = event.target.content.bitmapData; ... }
Observe que el parmetro del objeto de evento se denomina event y es una instancia de la clase Event. Todas las instancias de la clase Event disponen de una propiedad target, que hace referencia al objeto que activa el evento (en este caso, la instancia de LoaderInfo en la que se llam el mtodo addEventListener(), tal y como se describi anteriormente). Por su parte, el objeto LoaderInfo tiene una propiedad content que (una vez completado el proceso de carga) contiene la instancia de Bitmap con la imagen de mapa de bits cargada. Si desea visualizar la imagen directamente en pantalla, puede asociar esta instancia de Bitmap (event.target.content) a un contenedor de objetos de visualizacin. (Tambin puede asociar el objeto Loader a un contenedor de objetos de visualizacin). No obstante, en este ejemplo el contenido cargado se utiliza como origen de los datos de la imagen sin procesar en lugar de mostrarse en pantalla. Por ello, la primera lnea del mtodo imageLoadComplete() lee la propiedad bitmapData de la instancia de Bitmap cargada (event.target.content.bitmapData) y la almacena en la variable de la instancia denominada textureMap, que se utiliza como origen de los datos de imagen para crear la animacin de la luna en rotacin. Este punto se describe a continuacin.
255
Como se puede ver, la imagen no es una o varias esferas; se trata de una fotografa rectangular de la superficie de la luna. Debido a que la foto fue tomada exactamente en el ecuador de la luna, las partes de la imagen ms cercanas a la parte superior e inferior de la imagen estn expandidas y distorsionadas. Para eliminar la distorsin de la imagen y hacerla parecer esfrica, utilizaremos un filtro de mapa de desplazamiento, tal y como se describe ms adelante. Sin embargo. debido a que esta imagen de origen es un rectngulo, para crear la ilusin de que la esfera est girando, el cdigo simplemente necesita deslizar la fotografa de la superficie de la luna horizontalmente. Se debe tener en cuenta que la imagen incluye realmente dos copias de la fotografa de la superficie de la luna prximas entre s. Esta imagen es la de origen a partir de la que los datos de imagen se copian repetidamente para crear la apariencia de movimiento. Al tener dos copias de la imagen prximas entre s, un efecto de desplazamiento ininterrumpido y continuo puede ser ms fcil de crear. Analicemos el proceso de animacin paso a paso para ver su funcionamiento. El proceso incluye dos objetos de ActionScript independientes. En primer lugar se dispone de la imagen de origen cargada, que en el cdigo se representa mediante una instancia de BitmapData denominada textureMap. Tal y como se ha descrito anteriormente, textureMap se llena con datos de imagen una vez cargada la imagen externa, utilizando este cdigo:
textureMap = event.target.content.bitmapData;
El contenido de textureMap es la imagen de la luna con forma rectangular. Asimismo, para crear la rotacin animada, en el cdigo se utiliza una instancia de Bitmap denominada sphere, que es el objeto de visualizacin real que muestra la imagen de la luna en pantalla. Al igual que sucede con textureMap, el objeto sphere se crea y se llena con sus datos de imagen inicial en el mtodo imageLoadComplete(), empleando el siguiente cdigo:
sphere = new Bitmap(); sphere.bitmapData = new BitmapData(textureMap.width / 2, textureMap.height); sphere.bitmapData.copyPixels(textureMap, new Rectangle(0, 0, sphere.width, sphere.height), new Point(0, 0));
256
Tal y como muestra el cdigo, se crea una instancia de sphere. Su propiedad bitmapData (los datos de la imagen sin procesar que se muestran mediante sphere) se crea con la misma altura y la mitad de anchura de textureMap. Es decir, el contenido de sphere ser el tamao de una fotografa de la luna (ya que la imagen textureMap contiene dos fotografas de la luna, una junto a otra). A continuacin, la propiedad bitmapData se llena con los datos de imagen utilizando su mtodo copyPixels(). Los parmetros en la llamada al mtodo copyPixels() indican varios puntos:
El primer parmetro indica que los datos de imagen se copian desde textureMap. El segundo parmetro, una nueva instancia de Rectangle, especifica desde qu parte de textureMap se debe tomar
la instantnea de la imagen; en este caso, la instantnea es un rectngulo que comienza en la esquina superior izquierda de textureMap (indicado mediante los dos primeros parmetros Rectangle(): 0, 0) y la altura y anchura de la instantnea del rectngulo coinciden con las propiedades width y height de sphere.
El tercer parmetro, una nueva instancia de Point con los valores x e y de 0, define el destino de los datos de pxel;
en este caso, la esquina superior izquierda de (0, 0) de sphere.bitmapData. Representado visualmente, el cdigo copia los pxeles desde textureMap destacado en la siguiente imagen y los pega en sphere. Es decir, el contenido de BitmapData de sphere es la parte de textureMap resaltada aqu:
No obstante, recuerde que esto slo es el estado inicial de sphere; el contenido de la primera imagen que se copia en
sphere.
Con la imagen de origen cargada y sphere creada, la tarea final realizada por el mtodo imageLoadComplete() es configurar la animacin. La animacin se activa mediante una instancia de Timer denominadarotationTimer, que se crea y se inicia mediante el siguiente cdigo:
var rotationTimer:Timer = new Timer(15); rotationTimer.addEventListener(TimerEvent.TIMER, rotateMoon); rotationTimer.start();
En primer lugar, el cdigo crea la instancia de Timer denominada rotationTimer; el parmetro transmitido al constructor Timer() indica que rotationTimer debe activar su evento timer cada 15 millisegundos. A continuacin, se llama al mtodo addEventListener(), especificando que cuando sucede el evento timer (TimerEvent.TIMER), se llama al mtodo rotateMoon(). Finalmente, timer se inicia realmente llamando a su mtodo start(). Debido al modo en que se define rotationTimer, aproximadamente cada 15 millisegundos Flash Player llama al mtodo rotateMoon() en la clase MoonSphere, que es donde sucede la animacin de la luna. El cdigo fuente del mtodo rotateMoon() se presenta del siguiente modo:
257
private function rotateMoon(event:TimerEvent):void { sourceX += 1; if (sourceX > textureMap.width / 2) { sourceX = 0; } sphere.Data.copyPixels(textureMap, new Rectangle(sourceX, 0, sphere.width, sphere.height), new Point(0, 0)); event.updateAfterEvent(); }
Tal y como se puede observar, sourceX se usa para determinar la ubicacin en textureMap desde donde los pxeles se copiarn en sphere, por lo que este cdigo tiene el efecto de mover el rectngulo un pxel a la derecha en textureMap. Volviendo a la representacin visual, tras varios ciclos de animacin, el rectngulo de origen se habr movido varios pxeles hacia la derecha, tal y como se muestra a continuacin:
Este cambio constante y gradual en la ubicacin desde la que se copian los pxeles es la clave en la animacin. Con el movimiento lento y continuo de la ubicacin de origen hacia la derecha, la imagen que se muestra en la pantalla en sphere parecer deslizarse continuamente hacia la izquierda. Por este motivo, es necesario que la imagen de origen (textureMap) tenga dos copias de la fotografa de la superficie de la luna. Debido a que el rectngulo se mueve continuamente hacia derecha, la mayor parte del tiempo no lo hace sobre una sola fotografa de la luna, sino que se superponen las dos fotografas.
258
2 Con el movimiento lento del rectngulo de origen hacia la derecha, existe un problema. Finalmente el rectngulo
llegar al borde derecho de textureMap y no dispondr de pxeles de la fotografa de la luna para copiar en sphere:
El cdigo comprueba si sourceX (borde izquierdo del rectngulo) ha alcanzado la mitad de textureMap. Si es as, vuelve a restablecer sourceX a 0, movindolo de nuevo hacia el borde izquierdo de textureMap y volviendo a iniciar el ciclo:
3 Con el valor adecuado y calculado de sourceX, el paso final en la creacin de la animacin consiste en copiar los
nuevos pxeles del rectngulo de origen en sphere. El cdigo que realiza esta operacin es muy similar al que llen en un principio sphere (descrito anteriormente); en este caso la nica diferencia es que en la llamada al constructor new Rectangle(), el borde izquierdo del rectngulo se sita en sourceX:
sphere.bitmapData.copyPixels(textureMap, new Rectangle(sourceX, 0, sphere.width, sphere.height), new Point(0, 0));
Recuerde que este cdigo se llama repetidamente, cada 15 milisegundos. Debido a que la ubicacin del rectngulo de origen se desplaza continuamente y los pxeles se copian en sphere, la apariencia en pantalla es que la imagen de la fotografa de la luna representada mediante sphere se desliza constantemente. Es decir, la luna parece girar de forma continua.
259
Se debe tener en cuenta que dado que MoonSphere es un objeto de visualizacin (se basa en la clase Sprite), la mscara se puede aplicar directamente a la instancia de MoonSphere utilizando su propiedad heredada mask.
Ocultar simplemente las partes de la fotografa utilizando una mscara con forma de crculo no es suficiente para crear un efecto de esfera giratoria con un aspecto realista. Debido al modo en que se tom la fotografa de la superficie lunar, sus dimensiones no son proporcionales; las partes de la imagen que se encuentran ms hacia la parte superior o inferior de la imagen estn ms distorsionadas y expandidas en comparacin con las partes del ecuador. Para distorsionar la apariencia de la fotografa para hacerla parecer tridimensional, utilizaremos un filtro de mapa de desplazamiento. Un filtro de mapa de desplazamiento es un tipo de filtro que se usa para distorsionar una imagen. En este caso, la fotografa de la luna se distorsionar para hacerla ms realista, contrayendo la parte superior e inferior de la imagen horizontalmente, mientras el centro se deja sin cambio. Suponiendo que el filtro funcione en una parte con forma de cuadrado de la fotografa, la contraccin de la parte superior e inferior pero no del centro convertir el cuadrado en un crculo. Un efecto indirecto de la animacin de esta imagen distorsionada es que el centro de la imagen parece moverse ms lejos en la distancia de pxeles real que las reas cercanas a la parte superior e inferior, lo que crea la ilusin de que el crculo es realmente un objeto tridimensional (una esfera). El siguiente cdigo se utiliza para crear el filtro de mapa de desplazamiento denominado displaceFilter:
var displaceFilter:DisplacementMapFilter; displaceFilter = new DisplacementMapFilter(fisheyeLens, new Point(radius, 0), BitmapDataChannel.RED, BitmapDataChannel.GREEN, radius, 0);
260
El primer parmetro, fisheyeLens, se conoce como la imagen del mapa; en este caso se trata de un objeto BitmapData que se crea mediante programacin. La creacin de esta imagen se describe en Creacin de una imagen de mapa de bits estableciendo valores de pxel en la pgina 260. Los dems parmetros describen la posicin en la imagen filtrada en la que se debe aplicar el filtro, qu canales de color se utilizarn para controlar el efecto de desplazamiento y hasta qu punto afectarn al desplazamiento. Una vez creado el filtro de mapa de desplazamiento, se aplica a sphere, an en el mtodo imageLoadComplete():
sphere.filters = [displaceFilter];
La imagen final, con mscara y filtro de mapa de desplazamiento aplicados, presenta el siguiente aspecto:
Con cada ciclo de la animacin de rotacin de la luna, el contenido de BitmapData de la esfera se sobrescribe con una nueva instantnea de los datos de la imagen de origen. No obstante, el filtro no necesita volver a aplicarse cada vez. Esto se debe a que el filtro se aplica en la instancia de Bitmap (el objeto de visualizacin) en lugar de en los datos del mapa de bits (informacin del pxel sin procesar). Recuerde que la instancia de Bitmap no son los datos de mapa de bits reales; se trata de un objeto de visualizacin que muestra los datos de mapa de bits en pantalla. Para utilizar una analoga, una instancia de Bitmap es como el proyector de diapositivas que se utiliza para visualizar diapositivas fotogrficas en una pantalla y un objeto BitmapData es como la diapositiva real que se puede presentar mediante un proyector. Es posible aplicar un filtro directamente a un objeto BitmapData, lo que sera comparable a dibujar directamente en una diapositiva fotogrfica para alterar la imagen. Tambin se puede aplicar un filtro a cualquier objeto de visualizacin, incluyendo una instancia de Bitmap; esto sera como colocar un filtro frente a la lente del proyector de diapositivas para distorsionar el resultado que se muestra en pantalla (sin que la diapositiva original se vea alterada). Debido a que se puede acceder a los datos de mapa de bits mediante la propiedad bitmapData de una instancia de Bitmap, el filtro podra haberse aplicado directamente en los datos de mapa bits sin procesar. Sin embargo, en este caso resulta lgico aplicar el filtro al objeto de visualizacin Bitmap en lugar de a los datos de mapa de bits. Para obtener informacin detallada sobre el uso del filtro de mapa de desplazamiento en ActionScript, consulte Aplicacin de filtros a objetos de visualizacin en la pgina 267.
261
Por lo tanto, para utilizar el filtro de mapa de desplazamiento para crear un efecto de esfera, el ejemplo necesita la imagen del mapa adecuada; una imagen con fondo gris y un crculo relleno con un degradado de un solo color (rojo) que pase horizontalmente de un tono oscuro a claro, tal y como se muestra a continuacin:
Debido a que nicamente se utiliza un filtro y una imagen del mapa en este ejemplo, la imagen del mapa slo se crea una sola vez, en el mtodo imageLoadComplete() (es decir, cuando la imagen externa termina de cargarse). La imagen del mapa, denominada fisheyeLens, se crea llamando al mtodo createFisheyeMap() de la clase MoonSphere:
var fisheyeLens:BitmapData = createFisheyeMap(radius);
Dentro del mtodo createFisheyeMap(), la imagen del mapa se dibuja un pxel cada vez utilizando el mtodo setPixel() de la clase BitmapData. El cdigo completo para el mtodo createFisheyeMap() se incluye a continuacin, seguido de un anlisis paso a paso sobre su funcionamiento:
private function createFisheyeMap(radius:int):BitmapData { var diameter:int = 2 * radius; var result:BitmapData = new BitmapData(diameter, diameter, false, 0x808080); // Loop through the pixels in the image one by one for (var i:int = 0; i < diameter; i++) { for (var j:int = 0; j < diameter; j++) { // Calculate the x and y distances of this pixel from // the center of the circle (as a percentage of the radius). var pctX:Number = (i - radius) / radius; var pctY:Number = (j - radius) / radius; // Calculate the linear distance of this pixel from // the center of the circle (as a percentage of the radius). var pctDistance:Number = Math.sqrt(pctX * pctX + pctY * pctY); // If the current pixel is inside the circle,
262
// set its color. if (pctDistance < 1) { // Calculate the appropriate color depending on the // distance of this pixel from the center of the circle. var red:int; var green:int; var blue:int; var rgb:uint; red = 128 * (1 + 0.75 * pctX * pctX * pctX / (1 - pctY * pctY)); green = 0; blue = 0; rgb = (red << 16 | green << 8 | blue); // Set the pixel to the calculated color. result.setPixel(i, j, rgb); } } } return result; }
En primer lugar, cuando se llama al mtodo ste recibe un parmetro, radius, que indica el radio de la imagen de forma circular que se va a crear. A continuacin, el cdigo crea el objeto BitmapData en el que se dibujar el crculo. Dicho objeto, llamado result, se transmite finalmente como el valor devuelto del mtodo. Tal y como se muestra en el siguiente fragmento de cdigo, la instancia de BitmapData result se crea con una anchura y una altura similares al dimetro del crculo, sin transparencia (false para el tercer parmetro) y rellena previamente con el color 0x808080 (gris medio):
var result:BitmapData = new BitmapData(diameter, diameter, false, 0x808080);
A continuacin, el cdigo utiliza dos bucles para repetir cada pxel de la imagen. El bucle exterior recorre todas las columnas de la imagen de izquierda a derecha (utilizando la variable i para representar la posicin horizontal del pxel que se est manipulando en ese momento), mientras que el bucle interior recorre todos los pxeles de la columna actual desde la parte superior a la inferior (con la variable j que representa la posicin vertical del pxel actual). El cdigo de los bucles (donde se omite el contenido del bucle interior) se muestra a continuacin:
for (var i:int = 0; i < diameter; i++) { for (var j:int = 0; j < diameter; j++) { ... } }
A medida que los bucles recorren los pxeles uno por uno, en cada pxel se calcula un valor (el valor del color del pxel en la imagen del mapa). Este proceso consta de cuatro pasos:
1 El cdigo calcula la distancia del pxel actual desde el centro del crculo a travs del eje x (i - radius). Dicho valor
se divide por el radio para hacerlo un porcentaje del radio en lugar de una distancia absoluta ((i - radius) / radius). Ese valor del porcentaje se almacena en una variable denominadapctX y el valor equivalente para el eje y se calcula y almacena en la variable pctY, tal y como se indica en este cdigo:
var pctX:Number = (i - radius) / radius; var pctY:Number = (j - radius) / radius;
263
2 Utilizado una frmula trigonomtrica estndar, el teorema de Pitgoras, la distancia lineal entre el centro del
crculo y el punto actual se calcula a partir de pctX y pctY. Dicho valor se almacena en una variable denominada pctDistance, tal y como se muestra a continuacin:
var pctDistance:Number = Math.sqrt(pctX * pctX + pctY * pctY);
3 A continuacin, el cdigo comprueba si el porcentaje de distancia es inferior a 1 (lo que significa el 100% del radio;
es decir, si el pxel que se considera est en el radio del crculo). Si el pxel se encuentra dentro del crculo, se la asigna un valor de color calculado (se omite aqu, pero se describe en el paso 4); de lo contrario, no sucede nada ms con ese pxel, de forma que su color se deja como gris medio predeterminado:
if (pctDistance < 1) { ... }
4 Para los pxeles que se encuentren dentro del crculo, se calcula un valor de color. El color final ser una tonalidad
de rojo que comprende desde negro (0% rojo) en el borde izquierdo del crculo hasta rojo claro (100%) en el borde derecho del crculo. El valor de color se calcula en un principio en tres partes (rojo, verde y azul), tal y como se indica a continuacin:
red = 128 * (1 + 0.75 * pctX * pctX * pctX / (1 - pctY * pctY)); green = 0; blue = 0;
Se debe tener en cuenta que nicamente la parte roja del color (variable red) dispone realmente de un valor. Los valores de azul y verde (variables green y blue) se muestran aqu para mayor claridad, pero se pueden omitir. El objetivo de este mtodo es crear un crculo que incluya un degradado de rojo, por lo que los valores de verde o azul no son necesarios. Una vez que se determinen los tres valores de color independientes, se combinan en un solo valor de color entero utilizando un algoritmo estndar de desplazamiento de bits, tal y como se muestra en este cdigo:
rgb = (red << 16 | green << 8 | blue);
Finalmente, con el valor de color calculado, dicho valor se asigna al pxel actual utilizando el mtodo setPixel() del objeto BitmapData de result, tal y como se indica a continuacin:
result.setPixel(i, j, rgb);
264
Descripcin
Las imgenes cargadas se descodifican cuando se accede a los datos de la imagen. Utilice esta poltica para descodificar imgenes ms pequeas. Esta poltica tambin se puede utilizar cuando la aplicacin no confa en transiciones y efectos complejos.
ImageDecodingPolicy.ON_LOAD
Asincrnico
Las imgenes cargadas se descodifican durante la carta, antes de que se distribuya el evento COMPLETE. Ideal para imgenes de mayor tamao (superiores a 10 MP). Cuando desarrolle aplicaciones mviles basadas en AIR con transiciones de pgina, utilice esta poltica de carga de mapas de bits para que el rendimiento percibido de la aplicacin sea mejor.
Nota: si el archivo que se est cargando es una imagen de mapa de bits y la poltica de descodificacin utilizada es ON_LOAD, la imagen se descodifica de forma asncrona antes de que se distribuya el evento COMPLETE. El siguiente cdigo muestra el uso de la clase ImageDecodingPolicy:
var loaderContext:LoaderContext = new LoaderContext(); loaderContext.imageDecodingPolicy = ImageDecodingPolicy.ON_LOAD var loader:Loader = new Loader(); loader.load(new URLRequest("http://www.adobe.com/myimage.png"), loaderContext);
An se puede utilizar la descodificacin ON_DEMAND con los mtodos Loader.load() y Loader.loadBytes(). Sin embargo, todos los dems mtodos que obtengan un objeto LoaderContext como argumento, omitirn todos los valores ImageDecodingPolicy transmitidos. En el siguiente ejemplo se muestra la diferencia en la descodificacin de una imagen de mapa de bits de forma sincrnica y asncrona:
265
public class AsyncTest extends Sprite { private var loaderContext:LoaderContext; private var loader:Loader; private var urlRequest:URLRequest; public function AsyncTest() { //Load the image synchronously loaderContext = new LoaderContext(); //Default behavior. loaderContext.imageDecodingPolicy = ImageDecodingPolicy.ON_DEMAND; loader = new Loader(); loadImageSync(); //Load the image asynchronously loaderContext = new LoaderContext(); loaderContext.imageDecodingPolicy = ImageDecodingPolicy.ON_LOAD; loader = new Loader(); loadImageASync(); } private function loadImageASync():void{ trace("Loading image asynchronously..."); urlRequest = new URLRequest("http://www.adobe.com/myimage.png"); urlRequest.useCache = false; loader.load(urlRequest, loaderContext); loader.contentLoaderInfo.addEventListener (Event.COMPLETE, onAsyncLoadComplete);
266
} private function onAsyncLoadComplete(event:Event):void{ trace("Async. Image Load Complete"); } private function loadImageSync():void{ trace("Loading image synchronously..."); urlRequest = new URLRequest("http://www.adobe.com/myimage.png"); urlRequest.useCache = false; loader.load(urlRequest, loaderContext); loader.contentLoaderInfo.addEventListener (Event.COMPLETE, onSyncLoadComplete); } private function onSyncLoadComplete(event:Event):void{ trace("Sync. Image Load Complete"); } } }
Para ver una demostracin del efecto de las distintas polticas de descodificacin, consulte Thibaud Imbert: Asynchronous bitmap decoding in the Adobe Flash runtimes
267
lados opuestos. Este efecto crea la apariencia de borde tridimensional. El efecto se suele utilizar para botones alzados o cincelados y grficos similares.
Convolucin Distorsin de los pxeles de una imagen obtenida combinando el valor de cada pxel con los valores de algunos o todos sus vecinos en diferentes proporciones. Desplazamiento Movimiento, o deslizamiento, de los pxeles de una imagen a una nueva posicin. Matrix Cuadrcula de nmeros utilizada para realizar determinados clculos matemticos aplicando los nmeros de
Ms temas de ayuda
Paquete flash.filters flash.display.DisplayObject.filters flash.display.BitmapData.applyFilter()
268
Crear un filtro
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior Para crear un objeto de filtro, basta con llamar al mtodo constructor de la clase de filtro seleccionada. Por ejemplo, para crear un objeto DropShadowFilter, se usara el siguiente cdigo:
import flash.filters.DropShadowFilter; var myFilter:DropShadowFilter = new DropShadowFilter();
Aunque no se muestra aqu, el constructor DropShadowFilter() (como todos los constructores de clases de filtros) acepta varios parmetros opcionales que se pueden utilizar para personalizar la apariencia del efecto de filtro.
Aplicacin de un filtro
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior Una vez construido un objeto de filtro, es posible aplicarlo a un objeto de visualizacin o a un objeto BitmapData; la forma de aplicarlo depende del objeto al que se vaya a aplicar. Aplicacin de un filtro a un objeto de visualizacin Los efectos de filtro se aplican a los objetos de visualizacin mediante la propiedad filters. Dicha propiedad filters de los objetos de visualizacin es una instancia de Array cuyos elementos son los objetos de filtro aplicados al objeto de visualizacin. Para aplicar un nico filtro a un objeto de visualizacin, se debe crear la instancia de filtro, aadirla a una instancia de Array y asignar ese objeto Array a la propiedad filters del objeto de visualizacin:
269
import flash.display.Bitmap; import flash.display.BitmapData; import flash.filters.DropShadowFilter; // Create a bitmapData object and render it to screen var myBitmapData:BitmapData = new BitmapData(100,100,false,0xFFFF3300); var myDisplayObject:Bitmap = new Bitmap(myBitmapData); addChild(myDisplayObject); // Create a DropShadowFilter instance. var dropShadow:DropShadowFilter = new DropShadowFilter(); // Create the filters array, adding the filter to the array by passing it as // a parameter to the Array() constructor. var filtersArray:Array = new Array(dropShadow); // Assign the filters array to the display object to apply the filter. myDisplayObject.filters = filtersArray;
Si se desea asignar varios filtros al objeto, basta con aadir todos los filtros a la instancia de Array antes de asignarla a la propiedad filters. Se pueden aadir varios objetos a un elemento Array pasndolos como parmetros a su constructor. Por ejemplo, el siguiente cdigo aplica un filtro de bisel y otro de iluminado al objeto de visualizacin creado con anterioridad:
import flash.filters.BevelFilter; import flash.filters.GlowFilter; // Create the filters and add them to an array. var bevel:BevelFilter = new BevelFilter(); var glow:GlowFilter = new GlowFilter(); var filtersArray:Array = new Array(bevel, glow); // Assign the filters array to the display object to apply the filter. myDisplayObject.filters = filtersArray;
Es posible crear un conjunto que contiene los filtros utilizando el constructor new Array() (segn se muestra en los ejemplos anteriores) o se puede emplear la sintaxis literal de Array, encerrando los filtros entre corchetes ([]). Por ejemplo, esta lnea de cdigo:
var filters:Array = new Array(dropShadow, blur);
Al aplicar varios filtros a objetos de visualizacin, la aplicacin se lleva a cabo de forma acumulativa y secuencial. Por ejemplo, si un conjunto de filtros tiene dos elementos, un filtro de bisel aadido en primer lugar y un filtro de sombra en segundo, el filtro de sombra se aplicar tanto al filtro de bisel como al objeto de visualizacin. Esto se debe a que el filtro de sombra est en segundo lugar en el conjunto de filtros. Para aplicar filtros de forma no acumulativa, es necesario aplicar cada filtro a una nueva copia del objeto de visualizacin. Si slo se est aplicando un filtro o unos pocos a un objeto de visualizacin, es posible crear la instancia del filtro y asignarlo al objeto en una nica sentencia. Por ejemplo, la siguiente lnea de cdigo aplica un filtro de desenfoque a un objeto de visualizacin llamado myDisplayObject:
myDisplayObject.filters = [new BlurFilter()];
270
El cdigo anterior crea una instancia de Array utilizando su sintaxis literal (con corchetes), crea una instancia de BlurFilter como elemento de Array y asigna dicho Array a la propiedad filters del objeto de visualizacin llamado myDisplayObject. Eliminacin de filtros de un objeto de visualizacin Eliminar todos los filtros de un objeto de visualizacin es tan sencillo como asignar un valor nulo a la propiedad filters:
myDisplayObject.filters = null;
Si se han aplicado varios filtros a un objeto y se desea eliminar solamente uno de ellos, es necesario seguir una serie de pasos para cambiar el conjunto de la propiedad filters. Para obtener ms informacin, consulte Posibles problemas al trabajar con filtros en la pgina 270. Aplicacin de un filtro a un objeto BitmapData Para aplicar un filtro a un objeto BitmapData es necesario utilizar el mtodo applyFilter() del objeto BitmapData:
var rect:Rectangle = new Rectangle(); var origin:Point = new Point(); myBitmapData.applyFilter(sourceBitmapData, rect, origin, new BlurFilter());
El mtodo applyFilter() aplica un filtro a un objeto BitmapData de origen, dando lugar a una nueva imagen filtrada. Este mtodo no modifica la imagen original. En vez de eso, el resultado de la aplicacin del filtro a la imagen original se almacena en la instancia de BitmapData en la que se llama al mtodo applyFilter().
271
Cambio de filtros en tiempo de ejecucin Si un objeto de visualizacin ya tiene aplicados uno o varios filtros, no podr cambiar este grupo de filtros agregando o eliminando filtros en el conjunto de la propiedad filters. En su lugar, para modificar el grupo de filtros aplicados o aadir otros nuevos, debe aplicar los cambios en un conjunto diferente y, a continuacin, asignar dicho conjunto a la propiedad filters del objeto de visualizacin correspondiente a los filtros que se aplicarn al objeto. El modo ms sencillo de realizar esta tarea consiste en leer el conjunto de la propiedad filters en una variable Array y aplicar las modificaciones en este conjunto temporal. A continuacin, se puede volver a asignar este conjunto a la propiedad filters del objeto de visualizacin. En los casos ms complejos, es posible que sea necesario mantener un conjunto maestro de filtros diferente. Los cambios se aplicarn a este conjunto maestro para despus asignarlo a la propiedad filters del objeto de visualizacin tras cada modificacin. Aadir un filtro adicional El siguiente cdigo demuestra el proceso de aadir un filtro adicional a un objeto de visualizacin que ya tiene aplicados uno o varios filtros. Inicialmente se aplica un filtro de iluminado al objeto de visualizacin llamado myDisplayObject; luego, cuando se hace clic en el objeto, se llama a la funcin addFilters(). Mediante esta funcin se aplican dos filtros ms a:myDisplayObject:
import flash.events.MouseEvent; import flash.filters.*; myDisplayObject.filters = [new GlowFilter()]; function addFilters(event:MouseEvent):void { // Make a copy of the filters array. var filtersCopy:Array = myDisplayObject.filters; // Make desired changes to the filters (in this case, adding filters). filtersCopy.push(new BlurFilter()); filtersCopy.push(new DropShadowFilter()); // Apply the changes by reassigning the array to the filters property. myDisplayObject.filters = filtersCopy; } myDisplayObject.addEventListener(MouseEvent.CLICK, addFilters);
Eliminacin de un filtro de un grupo de filtros Si un objeto de visualizacin tiene aplicados varios filtros y desea eliminar uno de ellos y seguir aplicando los dems, cpielos en un conjunto temporal, elimine de ste el filtro que desee y vuelva a asignar el conjunto temporal a la propiedad filters del objeto de visualizacin. En la seccin Recuperacin de valores y eliminacin de elementos de conjunto en la pgina 32 se describen varias formas de eliminar uno o varios elementos de un conjunto. La forma ms sencilla consiste en eliminar el filtro situado al principio del objeto (el ltimo filtro que se le ha aplicado). Se puede utilizar el mtodo pop() de la clase Array para eliminar el filtro del conjunto:
272
// Example of removing the top-most filter from a display object // named "filteredObject". var tempFilters:Array = filteredObject.filters; // Remove the last element from the Array (the top-most filter). tempFilters.pop(); // Apply the new set of filters to the display object. filteredObject.filters = tempFilters;
De igual modo, para eliminar el filtro situado al final (el primero aplicado al objeto) se puede utilizar el mismo cdigo, substituyendo el mtodo shift() de la clase Array en lugar del mtodo pop(). Para eliminar un filtro del centro de un conjunto de filtros (suponiendo que el conjunto tenga ms de dos filtros), utilice el mtodo splice(). Es preciso conocer el ndice (la posicin en el conjunto) del filtro que se desee eliminar. Por ejemplo, con el siguiente cdigo se elimina el segundo filtro (el del ndice 1) de un objeto de visualizacin:
// Example of removing a filter from the middle of a stack of filters // applied to a display object named "filteredObject". var tempFilters:Array = filteredObject.filters; // Remove the second filter from the array. It's the item at index 1 // because Array indexes start from 0. // The first "1" indicates the index of the filter to remove; the // second "1" indicates how many elements to remove. tempFilters.splice(1, 1); // Apply the new set of filters to the display object. filteredObject.filters = tempFilters;
Determinacin del ndice de un filtro Es preciso saber qu filtro que se va a eliminar del conjunto, de forma que se pueda identificar el ndice correspondiente. Debe conocer (por el modo en que est diseada la aplicacin) o calcular el ndice del filtro que se va a eliminar. El mejor enfoque consiste en disear la aplicacin de forma que el filtro que se desee eliminar se encuentre siempre en la misma posicin en el grupo de filtros. Por ejemplo, si existe un nico objeto de visualizacin que tiene aplicados un filtro de convolucin y otro de sombra (en este orden) y desea eliminar este ltimo y mantener el anterior, el filtro se debe situar en una posicin conocida (la superior) de forma que se pueda determinar con antelacin el mtodo de Array que hay que utilizar (en este caso, Array.pop() para eliminar el filtro de sombra). Si el filtro que desea eliminar siempre es de un tipo especfico, pero no se sita siempre en la misma posicin del grupo de filtros, puede comprobar el tipo de datos de cada filtro del conjunto para determinar cul hay que eliminar. Por ejemplo, el siguiente cdigo identifica el filtro de iluminado dentro de un grupo de filtros y lo elimina de ste.
273
// Example of removing a glow filter from a set of filters, where the //filter you want to remove is the only GlowFilter instance applied // to the filtered object. var tempFilters:Array = filteredObject.filters; // Loop through the filters to find the index of the GlowFilter instance. var glowIndex:int; var numFilters:int = tempFilters.length; for (var i:int = 0; i < numFilters; i++) { if (tempFilters[i] is GlowFilter) { glowIndex = i; break; } } // Remove the glow filter from the array. tempFilters.splice(glowIndex, 1); // Apply the new set of filters to the display object. filteredObject.filters = tempFilters;
En un caso ms complejo, por ejemplo, cuando el filtro que se va a eliminar se selecciona en tiempo de ejecucin, la mejor solucin consiste en crear un copia persistente e independiente del conjunto de filtros que sirve como la lista maestra de filtros. Cada vez que modifique el grupo de filtros, debe cambiar la lista maestra y, a continuacin, aplicar el conjunto de filtros como la propiedad filters del objeto de visualizacin. Por ejemplo, en el siguiente listado de cdigo se aplican varios filtros de convolucin a un objeto de visualizacin para crear diferentes efectos visuales y, en un punto posterior de la aplicacin, se elimina uno de estos filtros y se mantienen los dems. En este caso, el cdigo conserva una copia maestra del conjunto de filtros, as como una referencia al filtro que se va a eliminar. La identificacin y eliminacin del filtro especfico es un proceso similar al anterior, excepto que en lugar de realizar una copia temporal del conjunto de filtros, se manipula la copia maestra y se aplica despus al objeto de visualizacin.
274
// // // //
Example of removing a filter from a set of filters, where there may be more than one of that type of filter applied to the filtered object, and you only want to remove one.
// A master list of filters is stored in a separate, // persistent Array variable. var masterFilterList:Array; // At some point, you store a reference to the filter you // want to remove. var filterToRemove:ConvolutionFilter; // ... assume the filters have been added to masterFilterList, // which is then assigned as the filteredObject.filters: filteredObject.filters = masterFilterList; // ... later, when it's time to remove the filter, this code gets called: // Loop through the filters to find the index of masterFilterList. var removeIndex:int = -1; var numFilters:int = masterFilterList.length; for (var i:int = 0; i < numFilters; i++) { if (masterFilterList[i] == filterToRemove) { removeIndex = i; break; } } if (removeIndex >= 0) { // Remove the filter from the array. masterFilterList.splice(removeIndex, 1); // Apply the new set of filters to the display object. filteredObject.filters = masterFilterList; }
En este enfoque (cuando se compara una referencia a un filtro almacenado con los elementos del conjunto de filtros para determinar el filtro que se va a eliminar), se debe crear una copia independiente de conjunto de filtros el cdigo no funciona si se compara la referencia al filtro almacenado con los elementos de un conjunto temporal copiado a partir de la propiedad filters del objeto de visualizacin. El motivo es que al asignar un conjunto a la propiedad filters, el motor de ejecucin realiza internamente una copia de cada objeto de filtro del conjunto. Y son estas copias (en lugar de los objetos originales) las que se aplican al objeto de visualizacin, de forma que al leer la propiedad filters en un conjunto temporal, ste contiene referencias a los objetos de filtro copiados en lugar de las referencias a los objetos de filtro originales. En consecuencia, si en el ejemplo anterior se intenta determinar el ndice de filterToRemove por comparacin con los filtros de un conjunto de filtros temporal, no se obtendr ninguna coincidencia.
275
Filtros y transformaciones de objetos Ninguna regin filtrada (una sombra, por ejemplo) que se encuentre fuera del recuadro de delimitacin rectangular de un objeto de visualizacin se considera parte de la superficie a efectos de la deteccin de colisiones (determinar si una instancia se solapa o corta con otra instancia). Dado que los mtodos de deteccin de colisiones de la clase DisplayObject se basan en vectores, no es posible llevar a cabo esta operacin sobre un resultado que es un mapa de bits. Por ejemplo, si se aplica un filtro de bisel a una instancia de botn, la deteccin de colisiones no estar disponible en la parte biselada de la instancia. Los filtros no son compatibles con el escalado, la rotacin ni el sesgo. Si el objeto de visualizacin al que se le ha aplicado un filtro es escalado (si scaleX y scaleY no tienen un valor de 100%), el efecto de filtro no se escalar con la instancia. Esto quiere decir que la forma original de la instancia rotar, se escalar o sesgar, pero el filtro no lo har junto con la instancia. Se puede animar una instancia con un filtro para crear efectos realistas o anidar instancias y usar la clase BitmapData para animar filtros y as lograr este efecto. Filtros y objetos de mapas de bits Al aplicar un filtro a un objeto BitmapData, la propiedad cacheAsBitmap toma automticamente el valor true. De este modo, el filtro se aplica en realidad a la copia del objeto en lugar de al original. Esta copia se coloca a continuacin en la visualizacin principal (sobre el objeto original) tan cerca como sea posible del pxel ms cercano. Si los lmites del mapa de bits original cambian, la copia del mapa de bits con el filtro se vuelve a crear de nuevo en lugar de estirarla o distorsionarla. Si se quitan todos los filtros de un objeto de visualizacin, se restablece el valor que la propiedad cacheAsBitmap tena antes de aplicarse el filtro.
Filtro de biselado (clase BevelFilter) Filtro de desenfoque (clase BlurFilter) Filtro de sombra (clase DropShadowFilter) Filtro de iluminado (clase GlowFilter) Filtro de bisel degradado (clase GradientBevelFilter) Filtro de iluminado degradado (clase GradientGlowFilter) Filtro de matriz de colores (clase ColorMatrixFilter) Filtro de convolucin (clase ConvolutionFilter) Filtro de mapa de desplazamiento (clase DisplacementMapFilter) Filtro de sombreado (clase ShaderFilter)
276
Los seis primeros son filtros sencillos que se pueden utilizar para crear un efecto especfico con posibilidades de personalizacin limitadas del efecto disponible. Todos ellos se pueden aplicar mediante ActionScript, adems de poderse aplicar a objetos en Flash Professional desde el panel Filtros. Por lo tanto, incluso si se usa ActionScript para aplicar filtros, se puede utilizar la interfaz visual, si se dispone de Flash Professional, para probar de forma rpida los distintos filtros y configuraciones y, de ese modo, probar la mejor forma de lograr el efecto deseado. Los ltimos cuatro filtros slo estn disponibles en ActionScript. Estos filtros (matriz de colores, convolucin, mapa de desplazamiento y sombreado) son mucho ms flexibles en los tipos de efectos para cuya creacin se pueden utilizar. En lugar de ser optimizados para un nico efecto, ofrecen potencia y flexibilidad. Por ejemplo, seleccionando distintos valores para su matriz, el filtro de convolucin se puede utilizar para crear efectos de desenfoque, relieve, nitidez, bsqueda de bordes de color, transformaciones y mucho ms. Cada uno de ellos, ya sea sencillo o complejo, se puede personalizar usando sus propiedades. En general, existen dos posibilidades a la hora de definir las propiedades de un filtro. Todos los filtros permiten establecer sus propiedades pasando los valores de los parmetros al constructor del objeto de filtro. Como alternativa, tanto si se definen las propiedades del filtro pasando parmetros como si no, es posible ajustar los filtros ms adelante estableciendo valores para las propiedades del objeto de filtro. En la mayor parte de los listados de cdigo, las propiedades se definen directamente para que el ejemplo sea ms fcilmente comprensible. No obstante, se suele poder obtener el mismo resultado con menos lneas de cdigo pasando los valores como parmetros en el constructor del objeto de filtro. Para obtener ms informacin sobre cada filtro, sus propiedades y sus parmetros de constructor, consulte el paquete flash.filters en Referencia de ActionScript 3.0 para la plataforma de Adobe Flash.
Filtro de bisel
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior La clase BevelFilter permite aadir un borde tridimensional en bisel al objeto filtrado. Este filtro hace que las esquinas o bordes duros del objeto adquieran una apariencia cincelada o biselada. Las propiedades de la clase BevelFilter permiten personalizar la apariencia del bisel. Se pueden definir los colores de iluminacin y sombra, el desenfoque de los bordes del bisel, los ngulos de biselado y la colocacin de los bordes del bisel; incluso se puede crear un efecto extractor. En el siguiente ejemplo se carga una imagen externa y se le aplica un filtro de bisel.
277
// Load an image onto the Stage. var imageLoader:Loader = new Loader(); var url:String = "http://www.helpexamples.com/flash/images/image3.jpg"; var urlReq:URLRequest = new URLRequest(url); imageLoader.load(urlReq); addChild(imageLoader); // Create the bevel filter and set filter properties. var bevel:BevelFilter = new BevelFilter(); bevel.distance = 5; bevel.angle = 45; bevel.highlightColor = 0xFFFF00; bevel.highlightAlpha = 0.8; bevel.shadowColor = 0x666666; bevel.shadowAlpha = 0.8; bevel.blurX = 5; bevel.blurY = 5; bevel.strength = 5; bevel.quality = BitmapFilterQuality.HIGH; bevel.type = BitmapFilterType.INNER; bevel.knockout = false; // Apply filter to the image. imageLoader.filters = [bevel];
Filtro de desenfoque
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior La clase BlurFilter difumina o desenfoca un objeto de visualizacin y su contenido. Los efectos de desenfoque resultan tiles para dar la impresin de que un objeto no est bien enfocado o para simular un movimiento rpido, como en el desenfoque por movimiento. Si se define la propiedad quality del filtro de desenfoque en un nivel bajo, se puede simular un efecto de lente ligeramente desenfocada. Si la propiedad quality se establece en un nivel alto, da lugar a un efecto de desenfoque suave similar a un desenfoque gaussiano. En el siguiente ejemplo se crea un objeto circular usando el mtodo drawCircle() de la clase Graphics y se le aplica un efecto de desenfoque:
278
import flash.display.Sprite; import flash.filters.BitmapFilterQuality; import flash.filters.BlurFilter; // Draw a circle. var redDotCutout:Sprite = new Sprite(); redDotCutout.graphics.lineStyle(); redDotCutout.graphics.beginFill(0xFF0000); redDotCutout.graphics.drawCircle(145, 90, 25); redDotCutout.graphics.endFill(); // Add the circle to the display list. addChild(redDotCutout); // Apply the blur filter to the rectangle. var blur:BlurFilter = new BlurFilter(); blur.blurX = 10; blur.blurY = 10; blur.quality = BitmapFilterQuality.MEDIUM; redDotCutout.filters = [blur];
Filtro de sombra
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior Las sombras dan la impresin de que existe una fuente de luz independiente situada sobre el objeto de destino. La posicin e intensidad de esta fuente de luz se puede modificar para originar toda una gama de distintos efectos de sombra. La clase DropShadowFilter usa un algoritmo similar al del filtro de desenfoque. La principal diferencia es que el filtro de sombra tiene unas pocas propiedades ms que se pueden modificar para simular los distintos atributos de la fuente de luz (como alfa, color, desplazamiento y brillo). El filtro de sombra tambin permite aplicar opciones de transformacin personalizadas sobre el estilo de la sombra, incluidas la sombra interior o exterior y el modo extractor (tambin conocido como silueta). El siguiente cdigo crea una un objeto Sprite cuadrado y le aplica un filtro de sombra:
279
import flash.display.Sprite; import flash.filters.DropShadowFilter; // Draw a box. var boxShadow:Sprite = new Sprite(); boxShadow.graphics.lineStyle(1); boxShadow.graphics.beginFill(0xFF3300); boxShadow.graphics.drawRect(0, 0, 100, 100); boxShadow.graphics.endFill(); addChild(boxShadow); // Apply the drop shadow filter to the box. var shadow:DropShadowFilter = new DropShadowFilter(); shadow.distance = 10; shadow.angle = 25; // You can also set other properties, such as the shadow color, // alpha, amount of blur, strength, quality, and options for // inner shadows and knockout effects. boxShadow.filters = [shadow];
Filtro de iluminado
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior La clase GlowFilter aplica un efecto de iluminacin a los objetos de visualizacin, de forma que parece que bajo el objeto brilla una luz que lo ilumina suavemente. El filtro de iluminado es similar al del sombra, pero incluye propiedades para modificar la distancia, el ngulo y el color de la fuente de luz con las que es posible lograr diversos efectos. GlowFilter tambin dispone de varias opciones para modificar el estilo de la iluminacin, entre ellos el brillo interior y exterior y el modo extractor. El siguiente cdigo crea una cruz usando la clase Sprite y le aplica un filtro de iluminado:
280
import flash.display.Sprite; import flash.filters.BitmapFilterQuality; import flash.filters.GlowFilter; // Create a cross graphic. var crossGraphic:Sprite = new Sprite(); crossGraphic.graphics.lineStyle(); crossGraphic.graphics.beginFill(0xCCCC00); crossGraphic.graphics.drawRect(60, 90, 100, 20); crossGraphic.graphics.drawRect(100, 50, 20, 100); crossGraphic.graphics.endFill(); addChild(crossGraphic); // Apply the glow filter to the cross shape. var glow:GlowFilter = new GlowFilter(); glow.color = 0x009922; glow.alpha = 1; glow.blurX = 25; glow.blurY = 25; glow.quality = BitmapFilterQuality.MEDIUM; crossGraphic.filters = [glow];
281
import flash.display.Shape; import flash.filters.BitmapFilterQuality; import flash.filters.GradientBevelFilter; // Draw a rectangle. var box:Shape = new Shape(); box.graphics.lineStyle(); box.graphics.beginFill(0xFEFE78); box.graphics.drawRect(100, 50, 90, 200); box.graphics.endFill(); // Apply a gradient bevel to the rectangle. var gradientBevel:GradientBevelFilter = new GradientBevelFilter(); gradientBevel.distance = 8; gradientBevel.angle = 225; // opposite of 45 degrees gradientBevel.colors = [0xFFFFCC, 0xFEFE78, 0x8F8E01]; gradientBevel.alphas = [1, 0, 1]; gradientBevel.ratios = [0, 128, 255]; gradientBevel.blurX = 8; gradientBevel.blurY = 8; gradientBevel.quality = BitmapFilterQuality.HIGH; // Other properties let you set the filter strength and set options // for inner bevel and knockout effects. box.filters = [gradientBevel]; // Add the graphic to the display list. addChild(box);
282
// Create a new Shape instance. var shape:Shape = new Shape(); // Draw the shape. shape.graphics.beginFill(0xFF0000, 100); shape.graphics.moveTo(0, 0); shape.graphics.lineTo(100, 0); shape.graphics.lineTo(100, 100); shape.graphics.lineTo(0, 100); shape.graphics.lineTo(0, 0); shape.graphics.endFill(); // Position the shape on the Stage. addChild(shape); shape.x = 100; shape.y = 100; // Define a gradient glow. var gradientGlow:GradientGlowFilter = new GradientGlowFilter(); gradientGlow.distance = 0; gradientGlow.angle = 45; gradientGlow.colors = [0x000000, 0xFF0000]; gradientGlow.alphas = [0, 1]; gradientGlow.ratios = [0, 255]; gradientGlow.blurX = 10; gradientGlow.blurY = 10; gradientGlow.strength = 2; gradientGlow.quality = BitmapFilterQuality.HIGH; gradientGlow.type = BitmapFilterType.OUTER; // Define functions to listen for two events. function onClick(event:MouseEvent):void { gradientGlow.strength++; shape.filters = [gradientGlow]; } function onMouseMove(event:MouseEvent):void { gradientGlow.blurX = (stage.mouseX / stage.stageWidth) * 255; gradientGlow.blurY = (stage.mouseY / stage.stageHeight) * 255; shape.filters = [gradientGlow]; } stage.addEventListener(MouseEvent.CLICK, onClick); stage.addEventListener(MouseEvent.MOUSE_MOVE, onMouseMove);
283
count:Number = 1; distance:Number = 8; angleInDegrees:Number = 225; // opposite of 45 degrees colors:Array = [0xFFFFCC, 0xFEFE78, 0x8F8E01]; alphas:Array = [1, 0, 1]; ratios:Array = [0, 128, 255]; blurX:Number = 8; blurY:Number = 8; strength:Number = 1; quality:Number = BitmapFilterQuality.HIGH; type:String = BitmapFilterType.INNER; knockout:Boolean = false;
// Draw the rectangle background for the traffic light. var box:Shape = new Shape(); box.graphics.lineStyle(); box.graphics.beginFill(0xFEFE78); box.graphics.drawRect(100, 50, 90, 200); box.graphics.endFill(); // Draw the 3 circles for the three lights. var stopLight:Shape = new Shape(); stopLight.graphics.lineStyle(); stopLight.graphics.beginFill(0xFF0000); stopLight.graphics.drawCircle(145,90,25); stopLight.graphics.endFill(); var cautionLight:Shape = new Shape(); cautionLight.graphics.lineStyle(); cautionLight.graphics.beginFill(0xFF9900); cautionLight.graphics.drawCircle(145,150,25); cautionLight.graphics.endFill(); var goLight:Shape = new Shape(); goLight.graphics.lineStyle(); goLight.graphics.beginFill(0x00CC00); goLight.graphics.drawCircle(145,210,25); goLight.graphics.endFill(); // Add the graphics to the display list. addChild(box);
284
addChild(stopLight); addChild(cautionLight); addChild(goLight); // Apply a gradient bevel to the traffic light rectangle. var gradientBevel:GradientBevelFilter = new GradientBevelFilter(distance, angleInDegrees, colors, alphas, ratios, blurX, blurY, strength, quality, type, knockout); box.filters = [gradientBevel]; // Create the inner shadow (for lights when off) and glow // (for lights when on). var innerShadow:DropShadowFilter = new DropShadowFilter(5, 45, 0, 0.5, 3, 3, 1, 1, true, false); var redGlow:GlowFilter = new GlowFilter(0xFF0000, 1, 30, 30, 1, 1, false, false); var yellowGlow:GlowFilter = new GlowFilter(0xFF9900, 1, 30, 30, 1, 1, false, false); var greenGlow:GlowFilter = new GlowFilter(0x00CC00, 1, 30, 30, 1, 1, false, false); // Set the starting state of the lights (green on, red/yellow off). stopLight.filters = [innerShadow]; cautionLight.filters = [innerShadow]; goLight.filters = [greenGlow]; // Swap the filters based on the count value. function trafficControl(event:TimerEvent):void { if (count == 4) { count = 1; } switch (count) { case 1: stopLight.filters = [innerShadow]; cautionLight.filters = [yellowGlow]; goLight.filters = [innerShadow]; break; case 2: stopLight.filters = [redGlow]; cautionLight.filters = [innerShadow]; goLight.filters = [innerShadow]; break; case 3: stopLight.filters = [innerShadow]; cautionLight.filters = [innerShadow]; goLight.filters = [greenGlow]; break; } count++; } // Create a timer to swap the filters at a 3 second interval. var timer:Timer = new Timer(3000, 9); timer.addEventListener(TimerEvent.TIMER, trafficControl); timer.start();
285
Filtro de convolucin
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior La clase ConvolutionFilter se puede utilizar para aplicar una amplia gama de transformaciones grficas, como efectos de desenfoque, deteccin de bordes, nitidez, relieve y biselado, a los objetos de visualizacin o a los objetos BitmapData. Conceptualmente, el filtro de convolucin recorre los pxeles de la imagen de origen de uno en uno y determina su color final basndose en el valor de cada pxel y de los que lo rodean. Una matriz, especificada como un conjunto de valores numricos, indica la intensidad con la que cada uno de los pxeles circundantes afecta al valor final. A modo de ejemplo, se puede tomar el tipo de matriz usado con mayor frecuencia, la matriz de tres por tres, que consta de nueve valores:
N N N N P N N N N
Si el filtro de convolucin se aplica a un pxel determinado, ste consulta el valor de color del pxel en s ("P" en el ejemplo), adems de los valores de los pxeles que lo rodean (llamados "N" en el ejemplo). No obstante, al definir los valores de la matriz, se especifica la prioridad que algunos pxeles tendrn a la hora de afectar a la imagen resultante. Por ejemplo, la siguiente matriz, aplicada mediante un filtro de convolucin, dejar la imagen exactamente igual que estaba:
0 0 0 0 1 0 0 0 0
La razn por la que la imagen no se ve modificada es porque el valor del pxel original tiene una fuerza relativa de 1 para determinar el color final del pxel, mientras que todos los que lo rodean tienen una fuerza relativa de 0, lo que significa que sus colores no afectan a la imagen final. Del mismo modo, la siguiente matriz har que los pxeles de una imagen se desplacen un pxel hacia la izquierda:
0 0 0 0 0 0 0 1 0
286
Hay que tener en cuenta que, en este caso, el pxel en s no tiene ningn efecto sobre el valor final del pxel mostrado en esa posicin en la imagen final, ya que slo se usa el valor del pxel de la derecha para determinar el valor resultante de ese pxel. En ActionScript, la matriz se crea como una combinacin de una instancia de Array que contiene los valores y dos propiedades que especifican el nmero de filas y columnas de la matriz. En el siguiente ejemplo se carga una imagen y, una vez cargada, se le aplica un filtro de convolucin utilizando la matriz del listado anterior:
// Load an image onto the Stage. var loader:Loader = new Loader(); var url:URLRequest = new URLRequest("http://www.helpexamples.com/flash/images/image1.jpg"); loader.load(url); this.addChild(loader); function applyFilter(event:MouseEvent):void { // Create the convolution matrix. var matrix:Array = [0, 0, 0, 0, 0, 1, 0, 0, 0]; var convolution:ConvolutionFilter = new ConvolutionFilter(); convolution.matrixX = 3; convolution.matrixY = 3; convolution.matrix = matrix; convolution.divisor = 1; loader.filters = [convolution]; } loader.addEventListener(MouseEvent.CLICK, applyFilter);
Algo que no resulta obvio en este cdigo es el efecto que se produce al utilizar valores diferentes a 0 y 1 en la matriz. Por ejemplo, la misma matriz con el nmero 8 en lugar de 1 en la posicin de la derecha, realiza la misma accin (desplazar los pxeles a la izquierda) y, adems, afecta a los colores de la imagen, hacindolos 8 veces ms brillantes. Esto se debe a que el color final de los pxeles se calcula multiplicando los valores de matriz por los colores de los pxeles originales, sumando los valores y dividiendo por el valor de la propiedad divisor del filtro. Hay que tener en cuenta que en el cdigo de ejemplo, la propiedad divisor tiene el valor 1. En general, si se desea que el brillo de los colores permanezca aproximadamente igual que en la imagen original, el divisor debe ser igual a la suma de los valores de la matriz. De este modo, en el caso de una matriz cuyos valores suman 8 y el divisor vale 1, la imagen resultante ser aproximadamente 8 veces ms brillante que la original. Si bien el efecto de esta matriz no es demasiado apreciable, es posible utilizar otros valores en la matriz para crear diversos efectos. A continuacin se ofrecen varios conjuntos estndar de valores de matriz con los que obtener distintos efectos mediante una matriz de tres por tres:
287
Cabe destacar que en la mayor parte de estos efectos el divisor es 1. Esto se debe a que los valores negativos de la matriz, sumandos a los positivos, dan un valor de 1 (0 en el caso de la deteccin de bordes, pero el valor de la propiedad divisor no puede ser 0).
Punto del mapa: la posicin de la imagen filtrada en la que se aplicar la esquina superior izquierda del filtro de
desplazamiento. Se puede usar este valor para aplicar el filtro slo a una parte de la imagen.
Componente X: el canal de color de la imagen del mapa que afectar a la posicin x de los pxeles. Componente Y: el canal de color de la imagen del mapa que afectar a la posicin y de los pxeles. Escala X: un valor multiplicador que especifica la intensidad del desplazamiento en el eje x. Escala Y: un valor multiplicador que especifica la intensidad del desplazamiento en el eje y. Modo de filtro: determina la operacin que se debe realizar en los espacios vacos dejados por los pxeles
desplazados. Las opciones, definidas como constantes en la clase DisplacementMapFilterMode, son mostrar los pxeles originales (modo de filtro IGNORE), cruzar los pxeles del otro lado de la imagen (modo de filtro WRAP, que es el predeterminado), usar el pxel desplazado ms cercano (modo de filtro CLAMP) o rellenar los espacios con un color (modo de filtro COLOR). Para entender el funcionamiento del filtro de mapa de desplazamiento, se puede considerar el siguiente ejemplo. En el cdigo que aparece a continuacin se carga una imagen y, cuando termina la carga, se centra en el escenario y se le aplica un filtro de mapa de desplazamiento que hace que los pxeles de toda la imagen se desplacen horizontalmente hacia la izquierda.
288
// Load an image onto the Stage. var loader:Loader = new Loader(); var url:URLRequest = new URLRequest("http://www.helpexamples.com/flash/images/image3.jpg"); loader.load(url); this.addChild(loader); var mapImage:BitmapData; var displacementMap:DisplacementMapFilter; // This function is called when the image finishes loading. function setupStage(event:Event):void { // Center the loaded image on the Stage. loader.x = (stage.stageWidth - loader.width) / 2; loader.y = (stage.stageHeight - loader.height) / 2; // Create the displacement map image. mapImage = new BitmapData(loader.width, loader.height, false, 0xFF0000); // Create the displacement filter. displacementMap = new DisplacementMapFilter(); displacementMap.mapBitmap = mapImage; displacementMap.mapPoint = new Point(0, 0); displacementMap.componentX = BitmapDataChannel.RED; displacementMap.scaleX = 250; loader.filters = [displacementMap]; } loader.contentLoaderInfo.addEventListener(Event.COMPLETE, setupStage);
Mapa de bits del mapa: el mapa de bits del desplazamiento es una nueva instancia de BitmapData creada por el
cdigo. Sus dimensiones coinciden con las de la imagen cargada (de modo que el desplazamiento se aplica a toda la imagen). Tiene un relleno slido de pxeles rojos.
Punto del mapa: este valor est ajustado al punto 0, 0, lo que hace que el desplazamiento se aplique a toda la imagen. Componente X: este valor est ajustado a la constante BitmapDataChannel.RED, lo que significa que el valor rojo
del mapa de bits del mapa determinar la cantidad de desplazamiento de los pxeles (cunto se movern) en el eje x.
Escala X: este valor est ajustado a 250. La cantidad total de desplazamiento (teniendo en cuenta que la imagen del
mapa es completamente roja) slo movera la imagen una distancia muy pequea (aproximadamente medio pxel), de modo que si este valor se ajustase a 1, la imagen slo se desplazara 0,5 pxeles horizontalmente. Al ajustarlo a 250, la imagen se mueve aproximadamente 125 pxeles.
289
Esta configuracin hace que los pxeles de la imagen filtrada se desplacen 250 pxeles hacia la izquierda. La direccin (izquierda o derecha) y la cantidad de desplazamiento se basan en el valor de color de los pxeles de la imagen del mapa. Conceptualmente, el filtro recorre de uno en uno los pxeles de la imagen filtrada (al menos los pxeles de la regin en la que se aplica el filtro, que, en este caso, son todos) y lleva a cabo el siguiente proceso con cada pxel:
1 Buscan el pxel correspondiente en la imagen del mapa. Por ejemplo, cuando el filtro calcula la cantidad de
desplazamiento para el pxel de la esquina superior izquierda de la imagen filtrada, consulta el pxel de la esquina superior izquierda de la imagen del mapa.
2 Determinan el valor del canal de color especificado en el pxel del mapa. En este caso, el canal de color del
componente x es el rojo, de modo que el filtro comprueba qu valor tiene el canal rojo de la imagen del mapa en el pxel en cuestin. Dado que la imagen del mapa es de color rojo slido, el canal rojo del pxel es 0xFF, 255. Este ser el valor que se use como desplazamiento.
3 Comparan el valor de desplazamiento con el valor "medio" (127, que es el valor intermedio entre 0 y 255). Si el valor
de desplazamiento es menor que el valor medio, el pxel se desplaza en direccin positiva (hacia la derecha para el desplazamiento en el eje x y hacia abajo para el desplazamiento en el eje y). Por otro lado, si el valor de desplazamiento es superior al valor medio (como en el ejemplo), el pxel se desplaza en direccin negativa (hacia la izquierda para el desplazamiento en el eje x y hacia arriba para el desplazamiento en el eje y). Para ser ms precisos, el filtro resta a 127 el valor de desplazamiento y el resultado (positivo o negativo) es la cantidad relativa de desplazamiento que se aplica.
4 Finalmente, determinan la cantidad de desplazamiento real calculando qu porcentaje del desplazamiento
completo representa el valor del desplazamiento relativo. En este caso, el rojo slido significa un desplazamiento del 100%. Ese porcentaje se multiplica por el valor de escala x o escala y a fin de establecer el nmero de pxeles de desplazamiento que se aplicar. En este ejemplo, la cantidad de desplazamiento equivale a 100% veces un multiplicador de 250 (aproximadamente 125 pxeles a la izquierda). Dado que no se han especificado valores para el componente y la escala y, se utilizan los valores predeterminados (que no causan ningn desplazamiento), por eso la imagen no se mueve en direccin vertical. En el ejemplo se utiliza el modo de filtro predeterminado, WRAP, de modo que cuando los pxeles se desplazan hacia la izquierda, el espacio vaco de la derecha se llena con los pxeles que se han desplazado fuera del borde izquierdo de la imagen. Se puede experimentar con este valor para ver los distintos efectos. Por ejemplo, si se aade la siguiente lnea a la parte del cdigo en la que se definen las propiedades del desplazamiento (antes de la lnea loader.filters = [displacementMap]), la imagen tendr la apariencia de haber sido arrastrada por el escenario:
displacementMap.mode = DisplacementMapFilterMode.CLAMP;
A continuacin se muestra un ejemplo ms complejo, con un listado que utiliza un mapa de desplazamiento para crear un efecto de lupa sobre una imagen:
290
import import import import import import import import import import import import
flash.display.Bitmap; flash.display.BitmapData; flash.display.BitmapDataChannel; flash.display.GradientType; flash.display.Loader; flash.display.Shape; flash.events.MouseEvent; flash.filters.DisplacementMapFilter; flash.filters.DisplacementMapFilterMode; flash.geom.Matrix; flash.geom.Point; flash.net.URLRequest;
// Create the gradient circles that will together form the // displacement map image var radius:uint = 50; var type:String = GradientType.LINEAR; var redColors:Array = [0xFF0000, 0x000000]; var blueColors:Array = [0x0000FF, 0x000000]; var alphas:Array = [1, 1]; var ratios:Array = [0, 255]; var xMatrix:Matrix = new Matrix(); xMatrix.createGradientBox(radius * 2, radius * 2); var yMatrix:Matrix = new Matrix(); yMatrix.createGradientBox(radius * 2, radius * 2, Math.PI / 2); var xCircle:Shape = new Shape(); xCircle.graphics.lineStyle(0, 0, 0); xCircle.graphics.beginGradientFill(type, redColors, alphas, ratios, xMatrix); xCircle.graphics.drawCircle(radius, radius, radius); var yCircle:Shape = new Shape(); yCircle.graphics.lineStyle(0, 0, 0); yCircle.graphics.beginGradientFill(type, blueColors, alphas, ratios, yMatrix); yCircle.graphics.drawCircle(radius, radius, radius); // Position the circles at the bottom of the screen, for reference. this.addChild(xCircle); xCircle.y = stage.stageHeight - xCircle.height; this.addChild(yCircle); yCircle.y = stage.stageHeight - yCircle.height; yCircle.x = 200; // Load an image onto the Stage. var loader:Loader = new Loader(); var url:URLRequest = new URLRequest("http://www.helpexamples.com/flash/images/image1.jpg"); loader.load(url); this.addChild(loader); // Create the map image by combining the two gradient circles. var map:BitmapData = new BitmapData(xCircle.width, xCircle.height, false, 0x7F7F7F); map.draw(xCircle); var yMap:BitmapData = new BitmapData(yCircle.width, yCircle.height, false, 0x7F7F7F); yMap.draw(yCircle); map.copyChannel(yMap, yMap.rect, new Point(0, 0), BitmapDataChannel.BLUE, BitmapDataChannel.BLUE);
291
yMap.dispose(); // Display the map image on the Stage, for reference. var mapBitmap:Bitmap = new Bitmap(map); this.addChild(mapBitmap); mapBitmap.x = 400; mapBitmap.y = stage.stageHeight - mapBitmap.height; // This function creates the displacement map filter at the mouse location. function magnify():void { // Position the filter. var filterX:Number = (loader.mouseX) - (map.width / 2); var filterY:Number = (loader.mouseY) - (map.height / 2); var pt:Point = new Point(filterX, filterY); var xyFilter:DisplacementMapFilter = new DisplacementMapFilter(); xyFilter.mapBitmap = map; xyFilter.mapPoint = pt; // The red in the map image will control x displacement. xyFilter.componentX = BitmapDataChannel.RED; // The blue in the map image will control y displacement. xyFilter.componentY = BitmapDataChannel.BLUE; xyFilter.scaleX = 35; xyFilter.scaleY = 35; xyFilter.mode = DisplacementMapFilterMode.IGNORE; loader.filters = [xyFilter]; } // This function is called when the mouse moves. If the mouse is // over the loaded image, it applies the filter. function moveMagnifier(event:MouseEvent):void { if (loader.hitTestPoint(loader.mouseX, loader.mouseY)) { magnify(); } } loader.addEventListener(MouseEvent.MOUSE_MOVE, moveMagnifier);
292
El cdigo genera primero dos crculos degradados, que se combinan para formar la imagen del mapa de desplazamiento. El crculo rojo crea el desplazamiento en el eje x (xyFilter.componentX = BitmapDataChannel.RED), y el azul crea el desplazamiento en el eje y (xyFilter.componentY = BitmapDataChannel.BLUE). Para entender mejor la apariencia de la imagen del mapa de desplazamiento, el cdigo aade los crculos originales y el crculo combinado que sirve de imagen del mapa en la parte inferior de la pantalla.
A continuacin, el cdigo carga una imagen y, a medida que se mueve el ratn, aplica el filtro de desplazamiento a la parte de la imagen que se encuentra bajo ste. Los crculos degradados que se utilizan como imagen del mapa de desplazamiento hacen que la regin desplazada se aleje del puntero. Hay que tener en cuenta que las regiones grises del mapa de desplazamiento no causan ningn movimiento. El color gris es 0x7F7F7F. Los canales rojo y azul de esa tonalidad de gris coinciden exactamente con la tonalidad media de esos canales de color, de manera que no hay desplazamiento en las zonas grises de la imagen del mapa. Del mismo modo, en el centro del crculo tampoco hay desplazamiento. Si bien el color de esa regin no es gris, los canales rojo y azul de ese color son idnticos a los canales rojo y azul del gris medio y, puesto que el rojo y el azul son los colores que causan el desplazamiento, no se produce ninguno.
Filtro de sombreado
Flash Player 10 y posterior, Adobe AIR 1.5 y posterior La clase ShaderFilter permite utilizar un efecto de filtro personalizado definido como sombreado de Pixel Bender. Dado que el efecto de filtro se escribe como un sombreado de Pixel Bender, el efecto se puede personalizar completamente. El contenido filtrado se pasa al sombreado en forma de entrada de imagen y el resultado de la operacin del sombreado se convierte en el resultado del filtro. Nota: el filtro Shader est disponible en ActionScript a partir de Flash Player 10 y Adobe AIR 1.5. Para aplicar un filtro de sombreado a un objeto, primero debe crear una instancia de Shader que represente al sombreado de Pixel Bender que se va a utilizar. Para obtener informacin detallada sobre el procedimiento de creacin de una instancia de Shader y el modo de especificar los valores de los parmetros y las imgenes de entrada, consulte Trabajo con sombreados de Pixel Bender en la pgina 302. Al utilizar un sombreado a modo de filtro, es preciso recordar tres cosas:
El sombreado se debe definir de forma que acepte al menos una imagen de entrada.
293
El objeto filtrado (el objeto de visualizacin o BitmapData al que se aplica el filtro) se pasa al sombreado como el
primer valor de imagen de entrada. Por este motivo, no se debe especificar manualmente un valor para la primera imagen de entrada.
Si el sombreado define varias imgenes de entrada, las entradas adicionales se deben especificar manualmente (es
decir, es preciso establecer la propiedad input de cualquier instancia de ShaderInput que pertenezca a la instancia de Shader). Una vez disponga de un objeto Shader para el sombreado, cree una instancia de ShaderFilter. Este es el objeto de filtro real que se utiliza como cualquier otro filtro. Para crear una clase ShaderFilter que utilice un objeto Shader, llame al constructor de ShaderFilter() y pase el objeto Shader en forma de argumento, tal y como se muestra en este listado:
var myFilter:ShaderFilter = new ShaderFilter(myShader);
Para ver un ejemplo completo del uso de un filtro de sombreado, consulte Uso de un sombrado como filtro en la pgina 320.
294
Archivo com/example/programmingas3/filterWorkbench/FilterWorkbenchController.as
Descripcin Clase que proporciona la principal funcionalidad de la aplicacin, incluido el cambio de contenido al que se aplican los filtros y la aplicacin de filtros al contenido. Interfaz que define los mtodos comunes implementados por cada una de las clases Factory de los filtros. Esta interfaz define la funcionalidad comn que utiliza la clase FilterWorkbenchController para interactuar con cada clase Factory de los filtros. Conjunto de clases, cada una de las cuales implementa la interfaz IFilterFactory. Cada una de estas clases proporciona la funcionalidad de crear y definir valores para un nico tipo de filtro. Los paneles de propiedad de filtro de la aplicacin utilizan estas clases Factory para crear instancias de sus filtros especficos, los cuales son recuperados y aplicados al contenido de la imagen por la clase FilterWorkbenchController.
com/example/programmingas3/filterWorkbench/IFilterFactory.as
En la carpeta com/example/programmingas3/filterWorkbench/: BevelFactory.as BlurFactory.as ColorMatrixFactory.as ConvolutionFactory.as DropShadowFactory.as GlowFactory.as GradientBevelFactory.as GradientGlowFactory.as com/example/programmingas3/filterWorkbench/IFilterPanel.as
Interfaz que define los mtodos comunes implementados por las clases que, a su vez, definen los paneles de interfaz de usuario utilizados para manipular los valores de filtro en la aplicacin. Clase de utilidad que incluye un mtodo para convertir un valor de color numrico a un formato de cadena hexadecimal. Clase que funciona como un objeto de valor, combinando en un nico objeto los tres valores (color, alfa y proporcin) asociados a cada color en las clases GradientBevelFilter y GradientGlowFilter.
com/example/programmingas3/filterWorkbench/ColorStringFormatter.as
com/example/programmingas3/filterWorkbench/GradientColor.as
Interfaz de usuario (Flex) FilterWorkbench.mxml El archivo principal que define la interfaz de usuario de la aplicacin. Clase que proporciona la funcionalidad para la interfaz de usuario principal de la aplicacin; esta clase se utiliza como la clase de cdigo subyacente para el archivo MXML de la aplicacin.
flexapp/FilterWorkbench.as
295
Archivo En la carpeta flexapp/filterPanels: BevelPanel.mxml BlurPanel.mxml ColorMatrixPanel.mxml ConvolutionPanel.mxml DropShadowPanel.mxml GlowPanel.mxml GradientBevelPanel.mxml GradientGlowPanel.mxml flexapp/ImageContainer.as
Descripcin Conjunto de componentes MXML que proporciona la funcionalidad en cada panel utilizado para ajustar las opciones para un filtro nico.
Un objeto de visualizacin que funciona como contenedor para la imagen cargada de la pantalla. Procesador de celdas personalizado que se utiliza para cambiar el color de fondo de una celda en el componente DataGrid. Control personalizado que define un cuadro combinado que permite ajustar la calidad en varios paneles de filtros. Control personalizado que define un cuadro combinado que permite ajustar el tipo en varios paneles de filtros.
flexapp/controls/BGColorCellRenderer.as
flexapp/controls/QualityComboBox.as
flexapp/controls/TypeComboBox.as
Interfaz de usuario (Flash) FilterWorkbench.fla El archivo principal que define la interfaz de usuario de la aplicacin. Clase que proporciona la funcionalidad para la interfaz de usuario principal de la aplicacin; esta clase se utiliza como la clase de documento para el archivo FLA de la aplicacin. Conjunto de clases que proporciona la funcionalidad para cada panel utilizado para ajustar las opciones para un filtro nico. Para cada clase, existe adems un smbolo MovieClip asociado en la biblioteca del archivo FLA principal de la aplicacin, cuyo nombre coincide con el de la clase (por ejemplo, el smbolo BlurPanel est relacionado con la clase definida en BlurPanel.as). Los componentes que conforman la interfaz de usuario se ubican y designan de acuerdo con estos smbolos.
flashapp/FilterWorkbench.as
En la carpeta flashapp/filterPanels: BevelPanel.as BlurPanel.as ColorMatrixPanel.as ConvolutionPanel.as DropShadowPanel.as GlowPanel.as GradientBevelPanel.as GradientGlowPanel.as flashapp/ImageContainer.as
Un objeto de visualizacin que funciona como contenedor para la imagen cargada de la pantalla. Procesador de celdas personalizado que se utiliza para cambiar el color de fondo de una celda en el componente DataGrid.
flashapp/BGColorCellRenderer.as
296
Archivo flashapp/ButtonCellRenderer.as
Descripcin Procesador de celdas personalizado que se utiliza para incluir un componente de botn en una celda del componente DataGrid.
Contenido de imagen filtrado com/example/programmingas3/filterWorkbench/ImageType.as Esta clase sirve como objeto de valor que contiene el tipo y el URL del archivo de imagen nica en el que la aplicacin puede cargar y aplicar los filtros. La clase tambin incluye un conjunto de constantes que representan los archivos de imagen disponibles. Imgenes y otro contenido visual al que se aplican los filtros en la aplicacin.
Bisel (flash.filters.BevelFilter) Desenfoque (flash.filters.BlurFilter) Matriz de colores (flash.filters.ColorMatrixFilter) Convolucin (flash.filters.ConvolutionFilter) Sombra (flash.filters.DropShadowFilter) Iluminado (flash.filters.GlowFilter) Bisel degradado (flash.filters.GradientBevelFilter) Iluminado degradado (flash.filters.GradientGlowFilter)
297
Tras seleccionar una imagen y el filtro que se le va a aplicar, la aplicacin muestra un panel con una serie de controles para el ajuste de las propiedades especficas del filtro elegido. Por ejemplo, en la siguiente imagen aparece la aplicacin con el filtro de bisel seleccionado:
La vista previa se actualiza en tiempo real conforme se ajustan las propiedades del filtro. Tambin es posible aplicar varios filtros. Para ello, personalice un filtro, haga clic en el botn Aplicar, personalice otro filtro y vuelva a hacer clic en dicho botn, y as sucesivamente. A continuacin se describen algunas funciones y limitaciones de los paneles de filtro de la aplicacin:
El filtro de matriz de colores incluye un grupo de controles que permiten manipular de forma directa las
propiedades de imagen comunes, tales como el brillo, el contraste, la saturacin y el matiz. Asimismo, es posible especificar valores personalizados de la matriz de colores.
El filtro de convolucin, disponible slo con ActionScript, incluye un conjunto de valores de matriz de convolucin
utilizados comnmente, al tiempo que es posible especificar valores personalizados. No obstante, aunque la clase ConvolutionFilter acepta matrices de cualquier tamao, la aplicacin Filter Workbench utiliza una matriz fija de 3 x 3, el tamao de filtro que se utiliza con ms frecuencia.
298
Cada vez que se cambia el valor de una propiedad en el panel, el cdigo de ste llama al mtodo apropiado de la clase de fbrica. Cada clase de fbrica incluye mtodos especficos utilizados por el panel para crear la instancia de filtro apropiada. Por ejemplo, al seleccionar el filtro de desenfoque, la aplicacin crea una instancia de BlurFactory. La clase BlurFactory incluye un mtodo modifyFilter() que acepta tres parmetros: blurX, blurY, y quality, los cuales se utilizan conjuntamente para crear la instancia de BlurFilter deseada:
private var _filter:BlurFilter; public function modifyFilter(blurX:Number = 4, blurY:Number = 4, quality:int = 1):void { _filter = new BlurFilter(blurX, blurY, quality); dispatchEvent(new Event(Event.CHANGE)); }
Por otro lado, al seleccionar el filtro de convolucin se obtiene una mayor flexibilidad y, en consecuencia, es posible controlar un mayor nmero de propiedades. En la clase ConvolutionFactory se llama al siguiente cdigo cuando se selecciona un valor diferente en el panel del filtro:
private var _filter:ConvolutionFilter; public function modifyFilter(matrixX:Number = 0, matrixY:Number = 0, matrix:Array = null, divisor:Number = 1.0, bias:Number = 0.0, preserveAlpha:Boolean = true, clamp:Boolean = true, color:uint = 0, alpha:Number = 0.0):void { _filter = new ConvolutionFilter(matrixX, matrixY, matrix, divisor, bias, preserveAlpha, clamp, color, alpha); dispatchEvent(new Event(Event.CHANGE)); }
Observe en cada caso que, cuando se modifican los valores del filtro, el objeto Factory distribuye un evento Event.CHANGE para comunicar a los detectores que los valores del filtro han cambiado. La clase FilterWorkbenchController, responsable de aplicar los filtros al contenido filtrado, detecta dicho evento a fin de determinar cundo es necesario recuperar una nueva copia del filtro y volver a aplicarla al contenido filtrado. La clase FilterWorkbenchController no necesita conocer los detalles especficos de la clase de fbrica de cada filtro, slo saber que el filtro ha cambiado y poder acceder a una copia del mismo. Para que esto sea posible, la aplicacin incluye una interfaz, IFilterFactory, que define el comportamiento que debe tener una clase de fbrica de filtro para que la instancia de FilterWorkbenchController de la aplicacin pueda cumplir su cometido. IFilterFactory define el mtodo getFilter() utilizado en la clase FilterWorkbenchController:
function getFilter():BitmapFilter;
Observe que la definicin del mtodo de interfaz getFilter() especifica que devuelve una instancia de BitmapFilter en lugar de un tipo de filtro especfico. La clase BitmapFilter no define ningn tipo especfico de filtro, sino que se trata de la clase de base a partir de la cual se crean todas las clases de filtro. Cada clase de fbrica de filtro define una implementacin especfica del mtodo getFilter() en la cual se devuelve una referencia al objeto de filtro creado. Por ejemplo, aqu se muestra una versin abreviada del cdigo fuente de la clase ConvolutionFactory:
299
public class ConvolutionFactory extends EventDispatcher implements IFilterFactory { // ------- Private vars ------private var _filter:ConvolutionFilter; ... // ------- IFilterFactory implementation ------public function getFilter():BitmapFilter { return _filter; } ... }
En la implementacin de la clase ConvolutionFactory del mtodo getFilter() se devuelve una instancia de ConvolutionFilter, aunque esto no lo sabrn necesariamente los objetos que llamen a getFilter() segn la definicin del mtodo getFilter() que sigue ConvolutionFactory, debe devolver una instancia de BitmapFilter, que podra ser una instancia de cualquiera de las clases de filtro de ActionScript.
Con esta informacin, la instancia de controlador carga el archivo designado y, a continuacin, lo almacena en una variable de instancia denominada _currentTarget:
private var _currentTarget:DisplayObject; private function targetLoadComplete(event:Event):void { ... _currentTarget = _loader.content; ... }
Cuando se selecciona un filtro, la aplicacin llama al mtodo setFilter() de la instancia de controlador, ofreciendo al controlador una referencia al objeto de fbrica de filtro pertinente, el cual se almacena una variable de instancia denominada _filterFactory.
300
private var _filterFactory:IFilterFactory; public function setFilter(factory:IFilterFactory):void { ... _filterFactory = factory; _filterFactory.addEventListener(Event.CHANGE, filterChange); }
Observe que, tal y como se ha descrito anteriormente, la instancia de controlador no conoce el tipo especfico de datos de la instancia de fbrica de filtro que se le facilita; slo sabe que el objeto implementa la instancia de IFilterFactory, lo que significa que incluye un mtodo getFilter() y distribuye un evento change (Event.CHANGE) cuando se modifica el filtro. Cuando se cambian las propiedades de un filtro en su panel correspondiente, la instancia de controlador detecta que el filtro se ha modificado a travs del evento change de la fbrica del filtro, evento que llama al mtodo filterChange() de la instancia de controlador. Este mtodo, a su vez, llama al mtodo applyTemporaryFilter():
private function filterChange(event:Event):void { applyTemporaryFilter(); } private function applyTemporaryFilter():void { var currentFilter:BitmapFilter = _filterFactory.getFilter(); // Add the current filter to the set temporarily _currentFilters.push(currentFilter); // Refresh the filter set of the filter target _currentTarget.filters = _currentFilters; // Remove the current filter from the set // (This doesn't remove it from the filter target, since // the target uses a copy of the filters array internally.) _currentFilters.pop(); }
La tarea de aplicar el filtro al objeto de visualizacin se produce en el mtodo applyTemporaryFilter(). En primer lugar, el controlador recupera una referencia al objeto de filtro llamando al mtodo getFilter() de la fbrica de filtro.
var currentFilter:BitmapFilter = _filterFactory.getFilter();
La instancia de controlador incluye una variable de instancia de Array, denominada _currentFilters, que es un conjunto en el cual almacena todos los filtros aplicados al objeto de visualizacin. El siguiente paso consiste en aadir el filtro recin actualizado a dicho conjunto:
_currentFilters.push(currentFilter);
A continuacin, el cdigo asigna el conjunto de filtros a la propiedad filters del objeto de visualizacin, la cual aplica en realidad los filtros a la imagen:
_currentTarget.filters = _currentFilters;
Por ltimo, dado que este filtro recin aadido sigue siendo el filtro "de trabajo", conviene no aplicarlo de forma permanente al objeto de visualizacin, por lo que se elimina del conjunto _currentFilters:
301
_currentFilters.pop();
La eliminacin del filtro no afecta al objeto de visualizacin filtrado, ya que ste realiza una copia del conjunto de filtros cuando se asigna a la propiedad filters y utiliza este conjunto interno en lugar del original. Por este motivo, los cambios realizados en el conjunto de filtros no afectan al objeto de visualizacin hasta que dicho conjunto se vuelve a asignar a su propiedad filters.
302
Ms temas de ayuda
Centro de tecnologa de Adobe Pixel Bender (en ingls) Gua del desarrollador de Pixel Bender (en ingls) Referencia de Pixel Bender (en ingls) flash.display.Shader flash.filters.ShaderFilter Conceptos bsicos de Pixel Bender para Flash (en ingls) Conceptos bsicos de Pixel Bender para Flex (en ingls)
303
Filtro
Un sombreado tambin se puede ejecutar en modo autnomo. Con el uso del modo autnomo se accede directamente al resultado de un sombreado en lugar de especificar previamente su uso previsto. Se puede acceder al resultado como datos de imagen o datos binarios o numricos. No es necesario que los datos sean de imagen. De este modo puede proporcionar a un sombreado un conjunto de datos como entrada. El sombreado procesa los datos y puede acceder a los datos de resultado que devuelve. la compatibilidad con Pixel Bender existe a partir de Flash Player 10 y Adobe AIR 1.5. Los rellenos, filtros y mezclas de Pixel Bender no se admiten en el procesamiento con GPU. En los dispositivos mviles, los sombreados de Pixel Bender no se ejecutan con el procesamiento con CPU. Sin embargo, el rendimiento no est al mismo nivel que en un equipo de escritorio. Es posible que muchos programas de sombreado slo se ejecuten en unos pocos fotogramas por segundo. Conceptos y trminos importantes La siguiente lista de referencia contiene trminos importantes que aparecern al crear y utilizar sombreados de Pixel Bender:
Ncleo Para Pixel Bender, un ncleo es lo mismo que un sombreado. Con el uso de Pixel Bender, el cdigo define un
ncleo, que define una sola funcin que se ejecuta en cada uno de los pxeles de una imagen individualmente.
Cdigo de bytes de Pixel Bender Cuando se compila un ncleo de Pixel Bender, se transforma en un cdigo de bytes de Pixel Bender. Al cdigo de bytes se accede y se ejecuta en tiempo de ejecucin. Lenguaje Pixel Bender Lenguaje de programacin utilizado para crear un ncleo de Pixel Bender. Kit de herramientas de Pixel Bender Aplicacin que se emplea para crear un archivo de cdigo de bytes de Pixel Bender desde el cdigo fuente del lenguaje. El kit de herramientas permite escribir, probar y compilar cdigo fuente de Pixel Bender. Sombreado En este documento, un sombreado es un conjunto de funcionalidad escrito en el lenguaje Pixel Bender. Un cdigo del sombreado crea un efecto visual o realiza un clculo. En cualquier caso, el sombreado devuelve un conjunto de datos (generalmente los pxeles de una imagen). El sombreado realiza la misma operacin en cada punto de datos, con la nica diferencia de las coordenadas del pxel de salida. El sombreado no se escribe en ActionScript. Se escribe en el lenguaje Pixel Bender y se compila en el cdigo de bytes de Pixel Bender. Se puede incorporar a un archivo SWF en tiempo de compilacin o cargarse como archivo externo en tiempo de ejecucin. En cualquier caso se puede acceder al mismo en ActionScript creando un objeto Shader y vinculando este objeto al cdigo de bytes del sombreado. Entrada de sombreado Entrada compleja, generalmente datos de imagen de mapa de bits, que se proporciona a un
sombreado para su uso en sus clculos. Para cada variable de entrada definida en un sombreado, se utiliza un solo valor (es decir, una sola imagen o conjunto de datos binarios) para la ejecucin competa del sombreado.
Parmetro de sombreado Un solo valor (o conjunto limitado de valores) que se proporciona a un sombreado para su
uso en sus clculos. Cada valor de parmetro se define para una sola ejecucin del sombreado y el mismo valor se emplea en toda la ejecucin. Ejecucin de los ejemplos de cdigo Puede que desee probar las listas de cdigo de ejemplo que se proporcionan. Para probar el cdigo hay que ejecutarlo y ver los resultados en el archivo SWF creado. Todos los ejemplos crean contenido utilizando la API de dibujo, que utiliza o se modifica mediante el efecto de sombreado.
304
La mayor parte de los listados del cdigo de ejemplo incluyen dos partes. Una parte es el cdigo fuente de Pixel Bender para el sombreado utilizado en el ejemplo. En primer lugar debe utilizar el kit de herramientas de Pixel Bender para compilar el cdigo fuente en un archivo de cdigo de bytes de Pixel Bender. Siga estos pasos para crear el archivo de cdigo de bytes de Pixel Bender:
1 Abra el kit de herramientas de Adobe Pixel Bender. Si es necesario, en el men Build (Compilacin), seleccione
Turn on Flash Player warnings and errors (Activar errores y avisos de Flash Player).
2 Copie el listado de cdigo de Pixel Bender y pguelo en el panel de editor de cdigo de su kit de herramientas. 3 En el men File (Archivo), seleccione Export kernel filter for Flash Player (Exportar filtro de ncleo para Flash
Player).
4 Guarde el archivo de cdigo de bytes de Pixel Bender en el mismo directorio que el documento Flash. El nombre
del archivo debe coincidir con el nombre especificado en la descripcin del ejemplo. La parte de ActionScript de todos los ejemplos se escribe como un archivo de clase. Para probar el ejemplo en Flash Professional:
1 Cree un documento de Flash vaco y gurdelo en el equipo. 2 Cree un nuevo archivo de ActionScript y gurdelo en el mismo directorio que el documento de Flash. El nombre
del archivo debe coincidir con el nombre de la clase del listado de cdigo. Por ejemplo, si el listado de cdigo define una clase denominada MyApplication, use el nombre MyApplication.as para guardar el archivo de ActionScript.
3 Copie el listado de cdigo en el archivo de ActionScript y guarde el archivo. 4 En el documento de Flash, haga clic en una parte vaca del escenario o espacio de trabajo para activar el inspector
Ver el resultado del ejemplo en el panel de previsualizacin. En el captulo Cmo utilizar ejemplos de ActionScript en la pgina 1117 se explican de forma ms detallada estas tcnicas para la comprobacin de listados de cdigo.
305
El cdigo ActionScript puede acceder a un sombreado creado por el kit de herramientas de Adobe Pixel Bender (un archivo .pbj) de dos formas diferentes:
Cargado en tiempo de ejecucin: el archivo de sombreado se puede cargar como un activo externo a travs de un
objeto URLLoader. Esta tcnica es similar a cargar un activo externo, como un archivo de texto. En el siguiente ejemplo se muestra la carga de un archivo de cdigo de bytes de sombreado en tiempo de ejecucin y su vinculacin a una instancia de Shader:
var loader:URLLoader = new URLLoader(); loader.dataFormat = URLLoaderDataFormat.BINARY; loader.addEventListener(Event.COMPLETE, onLoadComplete); loader.load(new URLRequest("myShader.pbj")); var shader:Shader; function onLoadComplete(event:Event):void { // Create a new shader and set the loaded data as its bytecode shader = new Shader(); shader.byteCode = loader.data; // You can also pass the bytecode to the Shader() constructor like this: // shader = new Shader(loader.data); // do something with the shader }
Incorporado en el archivo SWF: el archivo de sombreado se puede incorporar en el archivo SWF en tiempo de
compilacin a travs de la etiqueta de metadatos [Embed]. La etiqueta de metadatos [Embed] slo est disponible si utiliza el SDK de Flex para compilar el archivo SWF. El parmetro [Embed] de la etiqueta source seala al archivo de sombreado y su parmetro mimeType es "application/octet-stream", tal y como se muestra en este ejemplo:
[Embed(source="myShader.pbj", mimeType="application/octet-stream")] var MyShaderClass:Class; // ... // create a shader and set the embedded shader as its bytecode var shader:Shader = new Shader(); shader.byteCode = new MyShaderClass(); // You can also pass the bytecode to the Shader() constructor like this: // var shader:Shader = new Shader(new MyShaderClass()); // do something with the shader
En cualquier caso, se vincula el cdigo de bytes de sombreado sin procesar (la propiedad URLLoader.data o una instancia de la clase de datos [Embed]) a la instancia de Shader. Como se muestra en el ejemplo anterior, el cdigo de bytes se puede asignar a la instancia de Shader de dos modos diferentes. Puede transferir el cdigo de bytes de sombreado como un argumento al constructor Shader(). Tambin puede establecerlo como la propiedad byteCode de la instancia de Shader. Una vez que se ha creado un sombreado de Pixel Bender y se ha vinculado a un objeto Shader, el sombreado se puede utilizar para crear efectos de formas diferentes. Se puede utilizar como filtro, modo de mezcla, relleno de mapa de bits o para la reproduccin autnoma de mapas de bits u otros datos. La propiedad data del objeto Shader se puede utilizar para acceder a los metadatos del sombreado, especificar imgenes de entrada y establecer valores de parmetro.
306
El objeto ShaderData creado para dicho sombreado se genera con las propiedades y valores siguientes:
namespace (String): "Adobe::Example" vendor (String): "Bob Jones" version (String): "1" description (String): "Crea una versin de la imagen especificada con el brillo especificado"
Debido a que las propiedades de metadatos se aaden dinmicamente al objeto ShaderData, el bucle for..in se puede utilizar para examinar el objeto ShaderData. Esta tcnica permite determinar si el sombreado contiene metadatos y cules son los valores de stos. Adems de las propiedades de metadatos, los objetos ShaderData pueden contener propiedades que representan entradas y parmetros definidos en el sombreado. Al utilizar un bucle for..in para examinar un objeto ShaderData, es necesario comprobar los tipos de datos de cada propiedad para determinar si la propiedad es una entrada (una instancia de ShaderInput), un parmetro (una instancia de ShaderParameter) o un valor de metadatos (una instancia de String). El ejemplo siguiente muestra cmo utilizar un bucle for..in para examinar las propiedades dinmicas de la propiedad data de un sombreado. Cada valor de metadatos se aade a una instancia de Vector denominada metadata. Es necesario tener en cuenta que en este ejemplo se asume que ya se ha creado una instancia de Shader denominada myShader:
var shaderData:ShaderData = myShader.data; var metadata:Vector.<String> = new Vector.<String>(); for (var prop:String in shaderData) { if (!(shaderData[prop] is ShaderInput) && !(shaderData[prop] is ShaderParameter)) { metadata[metadata.length] = shaderData[prop]; } } // do something with the metadata
307
Para obtener una versin de este ejemplo que tambin extrae entradas y parmetros de sombreado, consulte Identificacin de entradas y parmetros de sombreado en la pgina 307. Para obtener ms informacin sobre las propiedades de entrada y parmetro, consulte Especificacin de valores de entrada y parmetro de sombreado en la pgina 307.
308
shaderData:ShaderData = myShader.data; inputs:Vector.<ShaderInput> = new Vector.<ShaderInput>(); parameters:Vector.<ShaderParameter> = new Vector.<ShaderParameter>(); metadata:Vector.<String> = new Vector.<String>();
for (var prop:String in shaderData) { if (shaderData[prop] is ShaderInput) { inputs[inputs.length] = shaderData[prop]; } else if (shaderData[prop] is ShaderParameter) { parameters[parameters.length] = shaderData[prop]; } else { metadata[metadata.length] = shaderData[prop]; } } // do something with the inputs or properties
Cada objeto ShaderInput tiene una propiedad input que se utiliza para establecer el valor de la entrada. La propiedad input se establece como una instancia de BitmapData para especificar datos de imagen. La propiedad input tambin se puede establecer como BitmapData o Vector.<Number> instancia para especificar datos binarios o numricos. Para obtener informacin detallada y conocer las restricciones relativas a la utilizacin de una instancia de BitmapData o Vector.<Number> como entrada, consulte el listado ShaderInput.input en Referencia de ActionScript 3.0 para la plataforma de Adobe Flash.
309
Adems de la propiedad input, el objeto ShaderInput presenta propiedades que se pueden utilizar para determinar el tipo de imagen que espera la entrada. Entre estas propiedades se incluyen width, height y channels. Cada objeto ShaderInput tambin tiene una propiedad index que resulta til para determinar si se debe proporcionar un valor explcito para la entrada. Si un sombreado espera ms entradas de las establecidas automticamente, se debern establecer valores para dichas entradas. Para obtener informacin detallada sobre las diferentes formas de utilizar un sombreado, y si los valores de entrada se establecen automticamente, consulte Uso de un sombreado en la pgina 312.
Para establecer un valor (o varios valores) para el parmetro, cree un conjunto ActionScript que contenga el valor o los valores y asgnela a la propiedad value del objeto ShaderParameter. La propiedad value se define como una instancia de Array porque es posible que un solo parmetro de sombreado requiera varios valores. Incluso si el parmetro de sombreado espera nicamente un solo valor, este valor se debe incluir en un objeto Array para asignarlo a la propiedad ShaderParameter.value. El listado siguiente muestra cmo establecer un solo valor con la propiedad value:
myShader.data.brightness.value = [75];
Si el cdigo fuente de Pixel Bender del sombreado define un valor predeterminado para el parmetro, se crear un conjunto que contendr el valor o los valores predeterminados y se asignar a la propiedad value del ShaderParameter al crear el objeto Shader. Una vez que se ha asignado un conjunto a la propiedad value (incluso si se trata del conjunto predeterminado), se podr modificar el valor de parmetro cambiando el valor del elemento de conjunto. No es necesario crear un conjunto nuevo y asignarlo a la propiedad value. En el ejemplo siguiente se muestra cmo establecer un valor de parmetro de sombreado en ActionScript. En este ejemplo el sombrado define el parmetro color. El parmetro color se declara como una variable float4 en el cdigo fuente de Pixel Bender, por lo que se trata de un conjunto de cuatro nmeros de coma flotante. En el ejemplo, el valor del parmetro color cambia continuamente, y cada vez que cambia el sombreado se utiliza para dibujar un rectngulo de color en la pantalla. El resultado es un cambio de color animado. Nota: el cdigo de este ejemplo fue escrito por Ryan Taylor. Gracias Ryan por compartir este ejemplo. Para obtener informacin sobre el trabajo de Ryan, consulte www.boostworthy.com/. El cdigo ActionScript se centra en tres mtodos:
init(): en el mtodo init() el cdigo carga el archivo de cdigo de bytes de Pixel Bender que contiene el
310
Tambin se crea una instancia de Sprite denominada texture. En el mtodo renderShader(), el cdigo dibuja el resultado del sombreado en texture una sola vez por fotograma.
onEnterFrame(): el mtodo onEnterFrame() se llama una vez en cada fotograma, lo que crea el efecto de
animacin. En este mtodo, el cdigo establece el valor del parmetro del sombreado en el color nuevo y, a continuacin, llama al mtodo renderShader() para dibujar el resultado del sombreado como un rectngulo.
renderShader(): en el mtodo renderShader(), el cdigo llama al mtodo Graphics.beginShaderFill() para especificar un relleno de sombreado. A continuacin, dibuja un rectngulo cuyo relleno viene definido por la salida del sombreado (el color generado). Para obtener ms informacin sobre la utilizacin de un sombreado de este modo, consulte Uso de un sombreado como relleno de dibujo en la pgina 313.
A continuacin se incluye el cdigo de ActionScript de este ejemplo. Utilice esta clase como clase principal de aplicacin para un proyecto slo ActionScript en Flex, o bien, como la clase de documento para el archivo FLA en la herramienta de edicin de Flash Professional:
package { import import import import import import
public class ColorFilterExample extends Sprite { private const DELTA_OFFSET:Number = Math.PI * 0.5; private var loader:URLLoader; private var shader:Shader; private var texture:Sprite; private var delta:Number = 0; public function ColorFilterExample() { init(); } private function init():void { loader = new URLLoader(); loader.dataFormat = URLLoaderDataFormat.BINARY; loader.addEventListener(Event.COMPLETE, onLoadComplete); loader.load(new URLRequest("ColorFilter.pbj")); } private function onLoadComplete(event:Event):void { shader = new Shader(loader.data); texture = new Sprite(); addChild(texture); addEventListener(Event.ENTER_FRAME, onEnterFrame); }
311
private function onEnterFrame(event:Event):void { shader.data.color.value[0] = 0.5 + Math.cos(delta - DELTA_OFFSET) * 0.5; shader.data.color.value[1] = 0.5 + Math.cos(delta) * 0.5; shader.data.color.value[2] = 0.5 + Math.cos(delta + DELTA_OFFSET) * 0.5; // The alpha channel value (index 3) is set to 1 by the kernel's default // value. This value doesn't need to change. delta += 0.1; renderShader(); } private function renderShader():void { texture:graphics.clear(); texture.graphics.beginShaderFill(shader); texture.graphics.drawRect(0, 0, stage.stageWidth, stage.stageHeight); texture.graphics.endFill(); } } }
A continuacin se incluye el cdigo fuente del ncleo del sombreado ColorFilter, que se utiliza para crear el archivo de cdigo de bytes ColorFilter.pbj de Pixel Bender:
<languageVersion : 1.0;> kernel ColorFilter < namespace : "boostworthy::Example"; vendor : "Ryan Taylor"; version : 1; description : "Creates an image where every pixel has the specified color value."; > { output pixel4 result; parameter float4 color < minValue:float4(0, 0, 0, 0); maxValue:float4(1, 1, 1, 1); defaultValue:float4(0, 0, 0, 1); >; void evaluatePixel() { result = color; } }
Si utiliza un sombreado cuyos parmetros no estn documentados, podr determinar cuntos elementos y de qu tipo se deben incluir en el conjunto si comprueba la propiedad type del objeto ShaderParameter. La propiedad type indica el tipo de datos del parmetro como se define en el propio sombreado. Para obtener una lista del nmero y tipo de elementos que espera cada tipo de parmetro, consulte el listado de la propiedad ShaderParameter.value en la referencia del lenguaje.
312
Cada objeto ShaderParameter tambin tiene una propiedad index que indica la ubicacin adecuada del parmetro en el orden de los parmetros del sombreado. Adems de estas propiedades, los objetos ShaderParameter pueden presentar propiedades adicionales que contienen valores de metadatos proporcionados por el autor del sombreado. Por ejemplo, el autor puede especificar los valores de metadatos mnimo, mximo y predeterminado para un parmetro determinado. Los valores de metadatos que el autor especifica se aaden al objeto ShaderParameter como propiedades dinmicas. Para examinar estas propiedades, utilice el bucle for..in para recorrer las propiedades dinmicas del objeto ShaderParameter e identificar sus metadatos. El ejemplo siguiente muestra cmo utilizar un bucle for..in para identificar los metadatos de un objeto ShaderParameter. Cada valor de metadatos se aade a una instancia de Vector denominada metadata. Tenga en cuenta que este ejemplo asume que las instancias de Shader myShader ya estn creadas, y que tienen un parmetro brightness:
var brightness:ShaderParameter = myShader.data.brightness; var metadata:Vector.<String> = new Vector.<String>(); for (var prop:String in brightness) { if (brightness[prop] is String) { metadata[metadata.length] = brightness[prop]; } } // do something with the metadata
Uso de un sombreado
Flash Player 10 y posterior, Adobe AIR 1.5 y posterior Una vez que un sombreado de Pixel Bender est disponible en ActionScript como un objeto Shader, se puede utilizar de varias formas:
Relleno de dibujo de sombreado: el sombreado define la parte de relleno de una forma dibujada con la API de
dibujo
Modo de mezcla: el sombreado define la mezcla entre dos objetos de visualizacin solapadas Filtro: el sombreado define un filtro que modifica el aspecto del contenido visual Procesamiento autnomo de sombreados: el procesamiento de sombreados se ejecuta sin especificar el uso
pretendido de la salida. El sombreado se puede ejecutar opcionalmente en el fondo, y estar disponible cuando el procesamiento se complete. Esta tcnica se puede utilizar para generar datos de mapa de bits y procesar datos no visuales.
313
Cuando se utiliza un sombreado como relleno de dibujo, se establecen todos los valores de la imagen de entrada y los valores de parmetro que requiere el sombreado. En el siguiente ejemplo se muestra el uso de un sombreado como relleno de dibujo. En este ejemplo, el sombreado crea un degradado de tres puntos. Este degradado tiene tres colores, cada uno de ellos en cada punto de un tringulo, con una mezcla de degradado entre los mismos. Asimismo, los colores giran para crear un efecto de color giratorio animado.
Nota: Petri Leskinen ha escrito el cdigo de este ejemplo. Gracias Petri por compartir este ejemplo. Para ver ms ejemplos y tutoriales de Petri, consulte http://pixelero.wordpress.com/. El cdigo de ActionScript se encuentra en tres mtodos:
init(): el mtodo init() se llama cuando se carga la aplicacin. En este mtodo, el cdigo establece los valores iniciales para los objetos Point que representan los puntos del tringulo. El cdigo tambin crea una instancia de Sprite denominada canvas. Posteriormente, en updateShaderFill(), el cdigo dibuja el resultado del sombreado en canvas una vez por fotograma. Finalmente, el cdigo carga el archivo de cdigo de bytes del sombreado. onLoadComplete(): en el mtodo onLoadComplete() el cdigo crea el objeto Shader denominado shader.
Tambin establece los valores de parmetro iniciales. Finalmente, el cdigo aade el mtodo updateShaderFill() como detector para el evento enterFrame, lo que significa que se llama una vez por fotograma para crear un efecto de animacin.
314
updateShaderFill(): el mtodo updateShaderFill() se llama una vez en cada fotograma, lo que crea el efecto de animacin. En este mtodo, el cdigo calcula y define los valores de los parmetros de sombreado. A continuacin el cdigo llama al mtodo beginShaderFill() para crear un relleno de sombreado y llama a otros mtodos de la API de dibujo para dibujar el resultado de sombreado en un tringulo.
A continuacin se incluye el cdigo ActionScript de este ejemplo. Utilice esta clase como clase principal de aplicacin para un proyecto slo ActionScript en Flex, o bien, como la clase de documento para el archivo FLA en Flash Professional:
package { import import import import import import import
public class ThreePointGradient extends Sprite { private var canvas:Sprite; private var shader:Shader; private var loader:URLLoader; private var topMiddle:Point; private var bottomLeft:Point; private var bottomRight:Point; private var colorAngle:Number = 0.0; private const d120:Number = 120 / 180 * Math.PI; // 120 degrees in radians
public function ThreePointGradient() { init(); } private function init():void { canvas = new Sprite(); addChild(canvas); var size:int = 400; topMiddle = new Point(size / 2, 10); bottomLeft = new Point(0, size - 10); bottomRight = new Point(size, size - 10); loader = new URLLoader(); loader.dataFormat = URLLoaderDataFormat.BINARY; loader.addEventListener(Event.COMPLETE, onLoadComplete); loader.load(new URLRequest("ThreePointGradient.pbj")); } private function onLoadComplete(event:Event):void { shader = new Shader(loader.data);
315
shader.data.point1.value = [topMiddle.x, topMiddle.y]; shader.data.point2.value = [bottomLeft.x, bottomLeft.y]; shader.data.point3.value = [bottomRight.x, bottomRight.y]; addEventListener(Event.ENTER_FRAME, updateShaderFill); } private function updateShaderFill(event:Event):void { colorAngle += .06; var c1:Number = 1 / 3 + 2 / 3 * Math.cos(colorAngle); var c2:Number = 1 / 3 + 2 / 3 * Math.cos(colorAngle + d120); var c3:Number = 1 / 3 + 2 / 3 * Math.cos(colorAngle - d120); shader.data.color1.value = [c1, c2, c3, 1.0]; shader.data.color2.value = [c3, c1, c2, 1.0]; shader.data.color3.value = [c2, c3, c1, 1.0]; canvas.graphics.clear(); canvas.graphics.beginShaderFill(shader); canvas.graphics.moveTo(topMiddle.x, topMiddle.y); canvas.graphics.lineTo(bottomLeft.x, bottomLeft.y); canvas.graphics.lineTo(bottomRight.x, bottomLeft.y); canvas.graphics.endFill(); } } }
Este es el cdigo fuente del ncleo del sombreado ThreePointGradient, que se utiliza para crear el archivo de cdigo de bytes ThreePointGradient.pbj de Pixel Bender:
<languageVersion : 1.0;> kernel ThreePointGradient < namespace : "Petri Leskinen::Example"; vendor : "Petri Leskinen"; version : 1; description : "Creates a gradient fill using three specified points and colors."; > { parameter float2 point1 // coordinates of the first point < minValue:float2(0, 0); maxValue:float2(4000, 4000); defaultValue:float2(0, 0); >; parameter float4 color1 // color at the first point, opaque red by default < defaultValue:float4(1.0, 0.0, 0.0, 1.0); >; parameter float2 point2 // coordinates of the second point
316
< minValue:float2(0, 0); maxValue:float2(4000, 4000); defaultValue:float2(0, 500); >; parameter float4 color2 // color at the second point, opaque green by default < defaultValue:float4(0.0, 1.0, 0.0, 1.0); >; parameter float2 point3 // coordinates of the third point < minValue:float2(0, 0); maxValue:float2(4000, 4000); defaultValue:float2(0, 500); >; parameter float4 color3 // color at the third point, opaque blue by default < defaultValue:float4(0.0, 0.0, 1.0, 1.0); >; output pixel4 dst; void evaluatePixel() { float2 d2 = point2 - point1; float2 d3 = point3 - point1; // transformation to a new coordinate system // transforms point 1 to origin, point2 to (1, 0), and point3 to (0, 1) float2x2 mtrx = float2x2(d3.y, -d2.y, -d3.x, d2.x) / (d2.x * d3.y - d3.x * d2.y); float2 pNew = mtrx * (outCoord() - point1); // repeat the edge colors on the outside pNew.xy = clamp(pNew.xy, 0.0, 1.0); // set the range to 0.0 ... 1.0 // interpolating the output color or alpha value dst = mix(mix(color1, color2, pNew.x), color3, pNew.y); } }
Nota: si se utiliza un relleno de sombreado durante la representacin con la unidad de procesamiento de grficos (GPU), el rea rellena se colorear en cian. Para obtener ms informacin sobre el dibujo de formas utilizando la API de dibujo, consulte Uso de la API de dibujo en la pgina 219.
317
Cuando se utiliza un sombreado como modo de mezcla, el sombreado se debe definir con dos entradas como mnimo. Tal y como muestra el ejemplo, en el cdigo no se definen los valores de entrada. Sin embargo, las dos imgenes mezcladas se utilizan automticamente como entradas del sombreado. La imagen en primer plano se establece como segunda imagen. (Este es el objeto de visualizacin al que se aplica el modo de mezcla.) Una imagen de primer plano se crea adoptando un compuesto de todos los pxeles detrs del cuadro delimitador de la imagen de primer plano. Esta imagen se establece como la primera imagen de entrada. Si se utiliza un sombreado que espera ms de dos entradas, se proporciona un valor para todas las entradas posteriores a las dos primeras. En el siguiente ejemplo se muestra el uso de un sombreado como modo de mezcla. El ejemplo utiliza un modo de mezcla de aclarado basado en la luminosidad. El resultado de la mezcla es que el valor de pxel ms claro de cualquiera de los objetos mezclados pasa a ser el pxel que se muestra. Nota: Mario Klingemann ha escrito el cdigo de este ejemplo. Gracias Mario por compartir este ejemplo. Para obtener ms informacin sobre el trabajo de Mario y consultar su material, visite www.quasimondo.com/. El cdigo de ActionScript importante se encuentra en estos dos mtodos:
init(): el mtodo init() se llama cuando se carga la aplicacin. En este mtodo el cdigo carga el archivo de cdigo de bytes de sombreado. onLoadComplete(): en el mtodo onLoadComplete() el cdigo crea el objeto Shader denominado shader. A
continuacin dibuja tres objetos. El primero, backdrop, es un fondo gris oscuro detrs de los objetos mezclados. El segundo, backgroundShape, es una elipse con degradado verde. El tercer objeto, foregroundShape, es una elipse con degradado naranja. La elipse foregroundShape es el objeto de primer plano de la mezcla. La imagen de fondo de la mezcla est formada por la parte de backdrop y la parte de backgroundShape, que se superponen mediante al cuadro delimitador del objeto foregroundShape. El objeto foregroundShape es el objeto de primer orden en la lista de visualizacin. Se superpone parcialmente a backgroundShape y completamente a backdrop. Debido a este solapamiento, si no se aplica un modo de mezcla, la elipse naranja (foregroundShape) se muestra completamente y parte de la elipse verde (backgroundShape) queda oculta:
318
Sin embargo, cuando se aplica el modo de mezcla, la parte ms clara de la elipse verde se deja ver, ya que es ms clara que la parte de foregroundShape que se solapa con ella:
Este es el cdigo de ActionScript de este ejemplo. Utilice esta clase como clase principal de aplicacin para un proyecto slo ActionScript en Flex, o bien, como la clase de documento para el archivo FLA en Flash Professional:
package { import import import import import import import import import import import
flash.display.BlendMode; flash.display.GradientType; flash.display.Graphics; flash.display.Shader; flash.display.Shape; flash.display.Sprite; flash.events.Event; flash.geom.Matrix; flash.net.URLLoader; flash.net.URLLoaderDataFormat; flash.net.URLRequest;
public class LumaLighten extends Sprite { private var shader:Shader; private var loader:URLLoader; public function LumaLighten() { init(); } private function init():void { loader = new URLLoader(); loader.dataFormat = URLLoaderDataFormat.BINARY; loader.addEventListener(Event.COMPLETE, onLoadComplete); loader.load(new URLRequest("LumaLighten.pbj")); }
private function onLoadComplete(event:Event):void { shader = new Shader(loader.data); var backdrop:Shape = new Shape(); var g0:Graphics = backdrop.graphics; g0.beginFill(0x303030);
319
g0.drawRect(0, 0, 400, 200); g0.endFill(); addChild(backdrop); var backgroundShape:Shape = new Shape(); var g1:Graphics = backgroundShape.graphics; var c1:Array = [0x336600, 0x80ff00]; var a1:Array = [255, 255]; var r1:Array = [100, 255]; var m1:Matrix = new Matrix(); m1.createGradientBox(300, 200); g1.beginGradientFill(GradientType.LINEAR, c1, a1, r1, m1); g1.drawEllipse(0, 0, 300, 200); g1.endFill(); addChild(backgroundShape); var foregroundShape:Shape = new Shape(); var g2:Graphics = foregroundShape.graphics; var c2:Array = [0xff8000, 0x663300]; var a2:Array = [255, 255]; var r2:Array = [100, 255]; var m2:Matrix = new Matrix(); m2.createGradientBox(300, 200); g2.beginGradientFill(GradientType.LINEAR, c2, a2, r2, m2); g2.drawEllipse(100, 0, 300, 200); g2.endFill(); addChild(foregroundShape); foregroundShape.blendShader = shader; foregroundShape.blendMode = BlendMode.SHADER; } } }
Este es el cdigo fuente del ncleo del sombreado LumaLighten, que se utiliza para crear el archivo de cdigo de bytes LumaLighten.pbj de Pixel Bender:
320
<languageVersion : 1.0;> kernel LumaLighten < namespace : "com.quasimondo.blendModes"; vendor : "Quasimondo.com"; version : 1; description : "Luminance based lighten blend mode"; > { input image4 background; input image4 foreground; output pixel4 dst; const float3 LUMA = float3(0.212671, 0.715160, 0.072169); void evaluatePixel() { float4 a = sampleNearest(foreground, outCoord()); float4 b = sampleNearest(background, outCoord()); float luma_a = a.r * LUMA.r + a.g * LUMA.g + a.b * LUMA.b; float luma_b = b.r * LUMA.r + b.g * LUMA.g + b.b * LUMA.b; dst = luma_a > luma_b ? a : b; } }
Para obtener ms informacin sobre el uso de los modos de mezcla, consulte Aplicacin de modos de mezcla en la pgina 182. Nota: cuando se ejecuta un programa de sombreado de Pixel Bender como mezcla en Flash Player o AIR, las funciones de muestra y outCoord() se comportan de forma distinta que en otros contextos. En una mezcla, una funcin de muestra siempre devuelve el pxel actual que est evaluando el sombreador. Por ejemplo, no se puede aadir un desplazamiento a outCoord() para obtener una muestra de un pxel vecino. Del mismo modo, si utiliza la funcin outCoord() fuera de una funcin de muestra, sus coordenadas siempre se calcularn como 0. Por ejemplo, no se puede utilizar la posicin de un pxel para influir en la combinacin de las imgenes mezcladas.
321
Si se utiliza una sombreado como filtro, el sombreado se debe definir con una entrada como mnimo. Tal y como muestra el ejemplo, en el cdigo no se establece el valor de entrada. Sin embargo, el objeto de visualizacin filtrado u objeto BitmapData se define como imagen de entrada. Si se emplea un sombreado que espera varias entradas, indique un valor para todas las entradas que no sean la primera. En algunos casos, un filtro cambia las dimensiones de la imagen original. Por ejemplo, un efecto tpico de sombra paralela aade pxeles adicionales que contienen la sombra que se agrega a la imagen. Si se utiliza un sombreado que cambia las dimensiones de la imagen, establezca las propiedades leftExtension, rightExtension, topExtension y bottomExtension para indicar el grado de cambio de tamao deseado de la imagen. El siguiente ejemplo muestra el uso de un sombreado como filtro. El filtro de este ejemplo invierte los valores del canal rojo, verde y azul de una imagen. El resultado en la versin negativa de la imagen. Nota: el sombreado que utiliza este ejemplo es el ncleo de Pixel Bender invertRGB.pbk que se incluye en el kit de herramientas del lenguaje. Puede cargar el cdigo fuente para el ncleo desde el directorio de instalacin del kit de herramientas de Pixel Bender. Compile el cdigo fuente y guarde el archivo de cdigo de bytes en el mismo directorio que el cdigo fuente. El cdigo de ActionScript importante se encuentra en estos dos mtodos:
init(): el mtodo init() se llama cuando se carga la aplicacin. En este mtodo el cdigo carga el archivo de cdigo de bytes de sombreado. onLoadComplete(): en el mtodo onLoadComplete() el cdigo crea el objeto Shader denominado shader. Crea
y dibuja el contenido de un objeto denominado target. El objeto target es un rectngulo relleno con un color de degradado lineal que es rojo en la parte izquierda, amarillo-verde en el centro y azul claro en la parte derecha. El objeto no filtrado presenta el siguiente aspecto:
Cuando se aplica el filtro los colores se invierten y el rectngulo presenta el siguiente aspecto:
322
El sombreado que utiliza este ejemplo es el ncleo de Pixel Bender de ejemplo invertRGB.pbk, incluido en el kit de herramientas del lenguaje. El cdigo fuente est disponible en el archivo invertRGB.pbk en el directorio de instalacin del kit de herramientas de Pixel Bender. Compile el cdigo fuente y guarde el archivo de cdigo de bytes con el nombre invertRGB.pbj en el mismo directorio que el cdigo fuente de ActionScript. Este es el cdigo de ActionScript de este ejemplo. Utilice esta clase como clase principal de aplicacin para un proyecto slo ActionScript en Flex, o bien, como la clase de documento para el archivo FLA en Flash Professional:
package { import import import import import import import import import import import
flash.display.GradientType; flash.display.Graphics; flash.display.Shader; flash.display.Shape; flash.display.Sprite; flash.filters.ShaderFilter; flash.events.Event; flash.geom.Matrix; flash.net.URLLoader; flash.net.URLLoaderDataFormat; flash.net.URLRequest;
public class InvertRGB extends Sprite { private var shader:Shader; private var loader:URLLoader; public function InvertRGB() { init(); } private function init():void { loader = new URLLoader(); loader.dataFormat = URLLoaderDataFormat.BINARY; loader.addEventListener(Event.COMPLETE, onLoadComplete); loader.load(new URLRequest("invertRGB.pbj")); }
323
shader = new Shader(loader.data); var target:Shape = new Shape(); addChild(target); var g:Graphics = target.graphics; var c:Array = [0x990000, 0x445500, 0x007799]; var a:Array = [255, 255, 255]; var r:Array = [0, 127, 255]; var m:Matrix = new Matrix(); m.createGradientBox(w, h); g.beginGradientFill(GradientType.LINEAR, c, a, r, m); g.drawRect(10, 10, w, h); g.endFill(); var invertFilter:ShaderFilter = new ShaderFilter(shader); target.filters = [invertFilter]; } } }
Para obtener ms informacin sobre la aplicacin de filtros, consulte Creacin y aplicacin de filtros en la pgina 268.
Procesamiento de datos que no son de imagen: en el modo autnomo, puede optar por transmitir datos numricos
o binarios arbitrarios al sombreado en lugar de datos de imagen de mapa de bits. Puede optar por que el resultado del sombreado se devuelva como datos binarios o numricos adems de como datos de imagen de mapa de bits.
Procesamiento en segundo plano: cuando un sombreado se ejecuta en modo autnomo, de forma predeterminada
se hace asncronicamente. Esto significa que el sombreado se ejecuta en segundo plano mientras la aplicacin contina en ejecucin y el cdigo se notifica cuando finaliza el procesamiento del sombreado. Puede utilizar un sombreado que tarde ms tiempo en ejecutarse y no bloquee la interfaz de usuario de la aplicacin u otro procesamiento mientras que el sombreado se est ejecutando. Puede utilizar un objeto ShaderJob para ejecuta un sombreado en modo autnomo. En primer lugar cree un objeto ShaderJob y vinclelo al objeto Shader que representa el sombreado que se va a ejecutar:
var job:ShaderJob = new ShaderJob(myShader);
A continuacin, se establecen todos los valores de parmetro o entrada que espera el sombreado. Si est ejecutando el sombreado en segundo plano, tambin se registra un detector para el evento complete del objeto ShaderJob. El detector se llama cuando el sombreado finaliza su tarea:
324
A continuacin, se crea un objeto en el que se escribe el resultado de la operacin de sombreado cuando finaliza la operacin. Ese objeto se asigna a la propiedad target del objeto ShaderJob:
var jobResult:BitmapData = new BitmapData(100, 75); job.target = jobResult;
Asigne una instancia de BitmapData a la propiedad target si est utilizando ShaderJob para realizar el procesamiento de imagen. Si va a procesar datos numricos o binarios, asigne un objeto ByteArray o instancia de Vector.<Number> a la propiedad target. En este caso, debe establecer las propiedades width y height del objeto ShaderJob para que especifiquen la cantidad de datos de salida en el objeto target. Nota: se pueden establecer las propiedades shader, target,width y height del objeto ShaderJob en un paso transmitiendo argumentos al constructor ShaderJob(), del siguiente modo:var job:ShaderJob = new
ShaderJob(myShader, myTarget, myWidth, myHeight);
Cuando est listo para ejecutar el sombreado, puede llamar al mtodo start() del objeto ShaderJob:
job.start();
De forma predeterminada, la llamada a start() hace que ShaderJob se ejecute asincrnicamente. En ese caso, la ejecucin del programa contina inmediatamente con la siguiente lnea de cdigo en lugar de esperar a que termine el sombreado. Una vez terminada la operacin del sombreado, el objeto ShaderJob llama a sus detectores de eventos complete, notificndoles que se ha finalizado. En este punto (es decir, en el cuerpo del detector de eventos complete) el objeto target contiene el resultado de la operacin de sombreado. Nota: en lugar de utilizar el objeto de propiedad target, puede recuperar el resultado del sombreado directamente del objeto de evento que se transmite al mtodo detector. El objeto de evento es una instancia de ShaderEvent. El objeto ShaderEvent tiene tres propiedades que se pueden utilizar para acceder al resultado, dependiendo del tipo de datos del objeto que se establezca como propiedad target: ShaderEvent.bitmapData, ShaderEvent.byteArray y ShaderEvent.vector. De forma alternativa, puede pasar un argumento true al mtodo start(). En ese caso, la operacin de sombreado se ejecuta sincrnicamente. Todo el cdigo (incluyendo la interaccin con la interfaz de usuario y cualquier otro evento) se detiene mientras se ejecuta el sombreado. Cuando el sombreado finaliza, el objeto target contiene el resultado del proceso y el programa contina con la siguiente lnea de cdigo.
job.start(true);
325
fotograma es como una instantnea de la animacin en el tiempo; cuando se reproduce rpidamente la secuencia de los fotogramas, se crea el efecto de animacin.
Lnea de tiempo Representacin metafrica de una serie de fotogramas que forman una secuencia de animacin de un
clip de pelcula. La lnea de tiempo de un objeto MovieClip es equivalente a la lnea de tiempo de la herramienta de edicin Flash.
326
Cabeza lectora Marcador que identifica la ubicacin (fotograma) en la lnea de tiempo que se est mostrando en un momento determinado.
Nota: no se puede acceder a las instancias secundarias colocadas en el escenario en la herramienta de edicin de Flash por cdigo del constructor de una instancia principal, ya que no se han creado en ese punto en la ejecucin del cdigo. Antes de acceder al valor secundario, el principal debe crear la instancia secundaria por cdigo o acceder con retraso a la funcin callback que detecta el valor secundario para que distribuya el evento Event.ADDED_TO_STAGE. Aunque se conservan algunos mtodos y propiedades de la clase MovieClip de ActionScript 2.0, otros han cambiado. Todas las propiedades que empiezan por un carcter de subrayado han cambiado de nombre. Por ejemplo, las propiedades _width y _height son ahora width y height, mientras que las propiedades _xscale y _yscale son ahora scaleX y scaleY. Para obtener una lista completa de las propiedades y mtodos de la clase MovieClip, consulte Referencia de ActionScript 3.0 para la plataforma de Adobe Flash .
327
la bicicleta no se mover (su animacin no se reproducir). El movimiento de la bicicleta puede empezar a travs de alguna interaccin del usuario. Por ejemplo, si hubiera un botn denominado startButton, el cdigo siguiente en un fotograma clave de la lnea de tiempo principal lo hara de forma que al hacer clic en el botn se reproduce la animacin:
// This function will be called when the button is clicked. It causes the // bicycle animation to play. function playAnimation(event:MouseEvent):void { bicycle.play(); } // Register the function as a listener with the button. startButton.addEventListener(MouseEvent.CLICK, playAnimation);
328
En la reproduccin normal, si un clip de pelcula contiene ms de un fotograma, se reproducir indefinidamente; es decir, que volver al fotograma 1 si avanza ms all del ltimo fotograma. Al utilizar prevFrame() o nextFrame(), este comportamiento no se produce automticamente (llamar a prevFrame() cuando la cabeza lectora est en el Fotograma 1 no mueve la cabeza lectora al ltimo fotograma). La condicin if del ejemplo anterior comprueba si la cabeza lectora ha retrocedido al primer fotograma y la avanza hasta el ltimo fotograma, creando un bucle continuo del clip de pelcula que se reproduce hacia atrs.
329
330
De este modo, se activan los campos Clase y Clase base. De manera predeterminada, el campo Clase se llena con el nombre del smbolo, eliminando los espacios (por ejemplo, un smbolo denominado "Tree House" se convertira en "TreeHouse"). Para especificar que el smbolo debe utilizar una clase personalizada para su comportamiento, hay que escribir el nombre completo de la clase, incluido el paquete, en este campo. Si se desea crear instancias del smbolo en ActionScript y no es necesario aadir ningn comportamiento adicional, se puede dejar el nombre de la clase tal cual. El valor predeterminado del campo Clase base es flash.display.MovieClip. Si se desea que el smbolo ample la funcionalidad de otra clase de cliente, se puede especificar el nombre de la clase, siempre y cuando dicha clase ample la clase Sprite (o MovieClip).
4 Presione el botn Aceptar para guardar los cambios.
Si Flash no encuentra un archivo de ActionScript externo con una definicin para la clase especificada (por ejemplo, si no se necesita un comportamiento adicional para el smbolo), se muestra una advertencia: No se pudo encontrar una definicin de esta clase en la ruta de clases, por lo que se generar una automticamente en el archivo SWF al exportar. Se puede pasar por alto esta advertencia si el smbolo de la biblioteca no requiere funcionalidad exclusiva ms all de la funcionalidad de la clase MovieClip. Si no se proporciona una clase para el smbolo, Flash crear una clase para el smbolo equivalente a la siguiente:
package { import flash.display.MovieClip; public class ExampleMovieClip extends MovieClip { public function ExampleMovieClip() { } } }
331
Si se desea aadir funcionalidad de ActionScript adicional al smbolo, hay que aadir las propiedades y mtodos adecuados a la estructura de cdigo. Por ejemplo, sea un smbolo de clip de pelcula que contiene un crculo con una anchura de 50 pxeles y una altura de 50 pxeles, y se especifica que el smbolo debe exportarse para ActionScript con una clase denominada Circle. El siguiente cdigo, incluido en un archivo Circle.as, ampla la clase MovieClip y proporciona al smbolo los mtodos adicionales getArea() y getCircumference():
package { import flash.display.MovieClip; public class Circle extends MovieClip { public function Circle() { } public function getArea():Number { // The formula is Pi times the radius squared. return Math.PI * Math.pow((width / 2), 2); } public function getCircumference():Number { // The formula is Pi times the diameter. return Math.PI * width; } } }
El cdigo siguiente, colocado en un fotograma clave en el Fotograma 1 del documento de Flash, crear una instancia del smbolo y la mostrar en pantalla:
var c:Circle = new Circle(); addChild(c); trace(c.width); trace(c.height); trace(c.getArea()); trace(c.getCircumference());
Este cdigo muestra la creacin de instancias basada en ActionScript como una alternativa a arrastrar activos individuales al escenario. Crea un crculo que tiene todas las propiedades de un clip de pelcula, adems de los mtodos personalizados definidos en la clase Circle. Es un ejemplo muy bsico: el smbolo de la biblioteca puede especificar varias propiedades y mtodos en su clase. La creacin de instancias basada en ActionScript es eficaz, ya que permite crear de forma dinmica grandes cantidades de instancias, una tarea tediosa si tuviera que realizarse manualmente. Tambin es flexible, pues permite personalizar las propiedades de cada instancia a medida que se crea. Para comprobar ambas ventajas, utilice un bucle para crear de forma dinmica varias instancias de Circle. Con el smbolo y la clase Circle descritos previamente en la biblioteca del documento Flash, coloque el cdigo siguiente en un fotograma clave en el Fotograma 1:
332
import flash.geom.ColorTransform; var totalCircles:uint = 10; var i:uint; for (i = 0; i < totalCircles; i++) { // Create a new Circle instance. var c:Circle = new Circle(); // Place the new Circle at an x coordinate that will space the circles // evenly across the Stage. c.x = (stage.stageWidth / totalCircles) * i; // Place the Circle instance at the vertical center of the Stage. c.y = stage.stageHeight / 2; // Change the Circle instance to a random color c.transform.colorTransform = getRandomColor(); // Add the Circle instance to the current timeline. addChild(c); } function getRandomColor():ColorTransform { // Generate random values for the red, green, and blue color channels. var red:Number = (Math.random() * 512) - 255; var green:Number = (Math.random() * 512) - 255; var blue:Number = (Math.random() * 512) - 255; // Create and return a ColorTransform object with the random colors. return new ColorTransform(1, 1, 1, 1, red, green, blue, 0); }
Esto ilustra la forma de crear y personalizar mltiples instancias de un smbolo rpidamente mediante cdigo. La posicin de cada instancia se modifica en funcin del recuento actual dentro del bucle y cada instancia recibe un color aleatorio mediante la propiedad transform (que hereda Circle a travs de la ampliacin de la clase MovieClip).
un documento de Flash) para aadir la instancia de Loader a la lista de visualizacin. Una vez finalizado, el cdigo tiene el siguiente aspecto:
var request:URLRequest = new URLRequest("http://www.[yourdomain].com/externalSwf.swf"); var loader:Loader = new Loader() loader.load(request); addChild(loader);
333
Este mismo cdigo se puede utilizar para cargar un archivo de imagen externo como una imagen JPEG, GIF o PNG especificando el URL del archivo de imagen en lugar del URL del archivo SWF. Un archivo SWF, a diferencia de un archivo de imagen, puede contener cdigo ActionScript. Por lo tanto, aunque el proceso de carga de un archivo SWF puede ser idntico a la carga de una imagen, al cargar un archivo SWF externo, tanto el SWF que realiza la carga como el SWF cargado deben residir en el mismo entorno limitado de seguridad si Flash Player o AIR van a reproducir el archivo SWF y ActionScript se va a emplear para comunicarse de cualquier forma con el archivo SWF externo. Adems, si el archivo SWF externo contiene clases que comparten el mismo espacio de nombres que las clases del archivo SWF que realiza la carga, es posible que sea necesario crear un nuevo dominio de aplicacin para el archivo SWF cargado a fin de evitar conflictos de espacio de nombres. Para obtener ms informacin sobre las consideraciones de seguridad y de dominio de aplicacin, consulte Trabajo con dominios de aplicacin en la pgina 142 y Carga de contenido en la pgina 1077. Cuando el archivo SWF externo se carga correctamente, se puede acceder a l a travs de la propiedad Loader.content. Si el archivo SWF externo se publica para ActionScript 3.0, ser un objeto MovieClip o Sprite, en funcin de la clase que ample.
El cdigo ActionScript 3.0 puede cargar un archivo SWF escrito en ActionScript 1.0 2.0. Si un archivo SWF de
ActionScript 1.0 2.0 se carga correctamente, el objeto cargado (propiedad Loader.content ) es un objeto AVM1Movie. Una instancia de AVM1Movie no es lo mismo que una instancia de MovieClip. Es un objeto de visualizacin que, a diferencia de un clip de pelcula, no incluye propiedades ni mtodos relacionados con la lnea de tiempo. El archivo SWF AVM2 principal no tendr acceso a las propiedades, mtodos ni objetos del objeto AVM1Movie cargado.
Los archivos SWF escritos en ActionScript 1.0 2.0 no pueden cargar archivos SWF escritos en ActionScript 3.0.
Esto significa que los archivos SWF creados en Flash 8 o Flex Builder 1.5 o versiones anteriores no pueden cargar archivos SWF de ActionScript 3.0. La nica excepcin a esta regla es que un archivo SWF de ActionScript 2.0 puede sustituirse a s mismo por un archivo SWF de ActionScript 3.0, siempre y cuando el archivo SWF de ActionScript 2.0 no haya cargado ningn elemento en ninguno de sus niveles. Para ello, el archivo SWF de ActionScript 2.0 debe realizar una llamada a loadMovieNum(), pasando un valor 0 al parmetro level.
En general, los archivos SWF escritos en ActionScript 1.0 2.0 se deben migrar si van a funcionar de forma
conjunta con los archivos SWF escritos en ActionScript 3.0. Por ejemplo, supongamos que se ha creado un reproductor de medios utilizando ActionScript 2.0. El reproductor carga distinto contenido que tambin se cre utilizando ActionScript 2.0. No es posible crear nuevo contenido en ActionScript 3.0 y cargarlo en el reproductor de medios. Es necesario migrar el reproductor de vdeo a ActionScript 3.0.
334
No obstante, si se crea un reproductor de medios en ActionScript 3.0, dicho reproductor puede realizar cargas sencillas del contenido de ActionScript 2.0. En la siguiente tabla se resumen las limitaciones de las versiones anteriores de Flash Player en lo referente a la carga de nuevo contenido y a la ejecucin de cdigo, as como las limitaciones relativas a la reutilizacin de scripts entre archivos SWF escritos en distintas versiones de ActionScript.
Funcionalidad admitida Puede cargar archivos SWF publicados para Contiene esta AVM Ejecuta archivos SWF escritos en ActionScript Flash Player 7 7 y versiones anteriores AVM1 1.0 y 2.0 Flash Player 8 8 y versiones anteriores AVM1 1.0 y 2.0 Flash Player 9 y 10 9 (o 10) y versiones anteriores AVM1 y AVM2 1.0, 2.0 y 3.0
En la siguiente tabla, Funcionalidad admitida hace referencia al contenido que se ejecuta en Flash Player 9 o posterior. El contenido ejecutado en Flash Player 8 o versiones anteriores puede cargar, mostrar, ejecutar y reutilizar scripts nicamente de ActionScript 1.0 y 2.0.
Funcionalidad admitida Contenido creado en ActionScript 1.0 y 2.0 Contenido creado en ActionScript 3.0 ActionScript 1.0 y 2.0, y ActionScript 3.0
Puede cargar contenido y ejecutar cdigo en Slo ActionScript 1.0 y 2.0 contenido creado en Puede reutilizar contenido de scripts creado en Slo ActionScript 1.0 y 2.0 (ActionScript 3.0 a travs de conexin local)
Carga de un archivo SWF mediante Loader.load() Creacin dinmica de un smbolo de la biblioteca exportado para ActionScript Control de la reproduccin de MovieClip en el cdigo ActionScript
Antes de comenzar, se debe que tener en cuenta que los archivos SWF que se van a ejecutar en Flash Player se deben ubicar en el mismo entorno limitado de seguridad. Para obtener ms informacin, consulte Entornos limitados de seguridad en la pgina 1061.
335
Para obtener los archivos de aplicacin para esta muestra, descargue las muestras de Flash Professional. Los archivos de la aplicacin RuntimeAssetsExplorer se encuentran en la carpeta Samples/RuntimeAssetsExplorer. La aplicacin consta de los siguientes archivos:
Archivo RuntimeAssetsExample.mxml o RuntimeAssetsExample.fla RuntimeAssetsExample.as GeometricAssets.as Clase de documento para la aplicacin de Flash (FLA). Una clase de ejemplo que implementa la interfaz de RuntimeAsset. Un archivo FLA vinculado a la clase GeometricAssets (la clase de documento del archivo FLA), que contiene smbolos exportados para ActionScript. Una interfaz que define los mtodos necesarios que se esperan de todos los archivos SWF de activos de tiempo de ejecucin que se cargarn en el contenedor del explorador. La clase del smbolo de la biblioteca con la forma de un cuadro giratorio. La clase del smbolo de la biblioteca con la forma de una estrella giratoria. Descripcin La interfaz de usuario de la aplicacin para Flex (MXML) o Flash (FLA).
GeometricAssets.fla
com/example/programmingas3/runtimeassetexplorer/RuntimeLibrary.as
com/example/programmingas3/runtimeassetexplorer/AnimatingBox.as
com/example/programmingas3/runtimeassetexplorer/AnimatingStar.as
336
Crear una clase para el archivo SWF de biblioteca de activos Crear clases para activos individuales contenidos en la biblioteca Crear los activos grficos reales Asociar los elementos grficos a las clases y publicar el archivo SWF de biblioteca
Crear una clase para implementar la interfaz RuntimeLibrary A continuacin, se crear la clase GeometricAssets que implementar la interfaz de RuntimeLibrary. sta ser la clase de documento del archivo FLA. El cdigo para esta clase es muy similar a la interfaz RuntimeLibrary. Se diferencian en que en la definicin de clase el mtodo getAssets() no tiene cuerpo de mtodo.
package { import flash.display.Sprite; import com.example.programmingas3.runtimeassetexplorer.RuntimeLibrary; public class GeometricAssets extends Sprite implements RuntimeLibrary { public function GeometricAssets() { } public function getAssets():Array { return [ "com.example.programmingas3.runtimeassetexplorer.AnimatingBox", "com.example.programmingas3.runtimeassetexplorer.AnimatingStar" ]; } } }
Si se tuviera que crear una segunda biblioteca de tiempo de ejecucin, se creara otro archivo FLA basado en otra clase (por ejemplo, AnimationAssets) que proporcionara su propia implementacin de getAssets(). Creacin de clases para cada activo de MovieClip En este ejemplo, simplemente se ampla la clase MovieClip sin aadir ninguna funcionalidad a los activos personalizados. El siguiente cdigo de AnimatingStar equivale al de AnimatingBox:
package com.example.programmingas3.runtimeassetexplorer { import flash.display.MovieClip; public class AnimatingStar extends MovieClip { public function AnimatingStar() { } } }
337
Publicacin de la biblioteca Ahora se conectarn los activos basados en MovieClip con la nueva clase; para ello, se crear un nuevo archivo FLA y se introducir GeometricAssets en el campo Clase de documento del inspector de propiedades. Para este ejemplo, se crearn dos formas muy bsicas que utilizan una interpolacin de la lnea de tiempo para girar en el sentido de las agujas del reloj a travs de 360 fotogramas. Los smbolos animatingBox y animatingStar estn configurados en Exportar para ActionScript y tienen como valor del campo Clase las rutas de clases respectivas especificadas en la implementacin de getAssets(). La clase base predeterminada de flash.display.MovieClip se conserva, ya que se va a crear una subclase de los mtodos estndar de MovieClip. Despus de establecer la configuracin de exportacin del smbolo, hay que publicar el archivo FLA para obtener la primera biblioteca de tiempo de ejecucin. Este archivo SWF podra cargarse en otro archivo SWF AVM2, y los smbolos AnimatingBox y AnimatingStar estaran disponibles para el nuevo archivo SWF.
En este mtodo, la variable rl representa el archivo SWF cargado. El cdigo llama al mtodo getAssets() del archivo SWF cargado, que obtiene la lista de activos disponibles, y los utiliza para llenar un componente ComboBox con una lista de activos disponibles llamando al mtodo populateDropDown(). Este mtodo almacena la ruta de clase completa de cada activo. Si se hace clic en el botn Aadir de la interfaz de usuario se activa el mtodo addAsset():
private { var var var ... } function addAsset():void className:String = assetNameCbo.selectedItem.data; AssetClass:Class = getDefinitionByName(className) as Class; mc:MovieClip = new AssetClass();
que obtiene la ruta de clase del activo que est seleccionado actualmente en el ComboBox (assetNameCbo.selectedItem.data) y utiliza la funcin getDefinitionByName() (del paquete flash.utils) para obtener una referencia a la clase del activo para crear una nueva instancia de dicho activo.
338
Ms temas de ayuda
Paquete fl.motion
distintos estados y tiempos. Produce un efecto por el cual el primer estado evoluciona suavemente hacia el segundo. Se utiliza para mover un objeto de visualizacin en el escenario, as como para agrandarlo, encogerlo, girarlo, difuminarlo o cambiar su color con el paso del tiempo.
339
De forma predeterminada, Flash asigna automticamente un nombre a la instancia del objeto de visualizacin cuya interpolacin de movimiento se est creando (si an no tiene ningn nombre de instancia). Cuando se vuelve a utilizar ActionScript creado por Flash en una animacin propia, se puede conservar el nombre que genera Flash automticamente para la interpolacin, o bien, se puede sustituir por un nombre diferente. Si cambia el nombre de la interpolacin, debe asegurarse de que lo hace tambin en todo el script. Como alternativa, en Flash es posible asignar un nombre de su eleccin y asignarlo al objeto de destino de la interpolacin de movimiento. Posteriormente, cree la interpolacin de movimiento y copie el script. Puede utilizar la nomenclatura que desee, pero es importante que todos los objetos Motion del cdigo ActionScript tengan un nombre exclusivo.
340
Descripcin de la animacin
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior, requiere Flash CS3 o posterior El mtodo addPropertyArray() de la clase MotionBase aade un conjunto de valores para describir cada propiedad interpolada. Potencialmente, el conjunto contiene un elemento de conjunto en cada fotograma clave de la interpolacin de movimiento. A menudo, algunos conjuntos contienen menos elementos que el nmero total de fotogramas clave de la interpolacin de movimiento. Esta situacin se produce cuando el ltimo valor del conjunto no cambia en los fotogramas restantes. Si la longitud del argumento del conjunto es superior a la propiedad duration del objeto Motion, addPropertyArray() ajusta el valor de la propiedad duration en consecuencia. No aade fotogramas clave a las propiedades aadidas previamente. Los fotogramas clave recin aadidos se conservan en los fotogramas adicionales de la animacin. Las propiedades x e y del objeto Motion describen la posicin variable del objeto interpolado a medida que se ejecuta la animacin. Estas coordenadas son los valores que, con toda probabilidad, cambiarn en cada fotograma clave si cambia la posicin del objeto de visualizacin. Puede aadir propiedades de movimiento adicionales con el mtodo addPropertyArray(). Por ejemplo, puede aadir los valores scaleX y scaleY si el objeto interpolado cambia de tamao. Aada los valores scewX y skewY si se sesga. Aada la propiedad rotationConcat si se gira. Utilice el mtodo addPropertyArray() para definir las siguientes propiedades de interpolacin:
x y z
posicin horizontal del punto de transformacin del objeto en el espacio de coordenadas de su elemento principal posicin vertical del punto de transformacin del objeto en el espacio de coordenadas de su elemento principal posicin de profundidad (eje z) del punto de transformacin del objeto en el espacio de coordenadas de su elemento principal escala horizontal (en forma de porcentaje) del objeto aplicada desde el punto de transformacin escala vertical (en forma de porcentaje) del objeto aplicada desde el punto de transformacin ngulo de sesgado horizontal (en grados) del objeto de destino aplicado desde el punto de transformacin ngulo de sesgado vertical (en grados) del objeto de destino aplicado desde el punto de transformacin rotacin del objeto alrededor del eje x desde su orientacin original rotacin del objeto alrededor del eje y desde su orientacin original valores de rotacin (eje z) del objeto en el movimiento relativo a la orientacin anterior (segn se aplica desde el punto de transformacin)
useRotationConcat si se establece, hace que el objeto de destino gire cuando addPropertyArray() proporciona datos de
movimiento
blendMode matrix3D
valor de la clase BlendMode que especifica la mezcla de colores del objeto con grficos subyacentes propiedad matrix3D (si existe en el fotograma clave). Se utiliza para interpolaciones 3D; si se usa, todas las propiedades de transformacin anteriores se omiten rotacin del objeto alrededor del eje z (en grados) desde su orientacin original relativa al contendor principal 3D. Se utiliza en interpolaciones 3D para sustituir a rotationConcat
rotationZ
341
Las propiedades que se aaden en el script generado automticamente dependen de las propiedades asignadas a la interpolacin de movimiento en Flash. Es posible aadir, eliminar o modificar algunas de estas propiedades al personalizar su propia versin del script. El siguiente cdigo asigna valores a las propiedades de una interpolacin de movimiento llamada __motion_Wheel. En este caso, el objeto de visualizacin interpolado no cambia de posicin, sino que gira sobre s mismo en los 29 fotogramas de la interpolacin de movimiento. Los diversos valores asignados al conjunto rotationConcat definen la rotacin. El resto de valores de las propiedades de la interpolacin de movimiento no varan.
__motion_Wheel = new Motion(); __motion_Wheel.duration = 29; __motion_Wheel.addPropertyArray("x", [0]); __motion_Wheel.addPropertyArray("y", [0]); __motion_Wheel.addPropertyArray("scaleX", [1.00]); __motion_Wheel.addPropertyArray("scaleY", [1.00]); __motion_Wheel.addPropertyArray("skewX", [0]); __motion_Wheel.addPropertyArray("skewY", [0]); __motion_Wheel.addPropertyArray("rotationConcat", [ 0,-13.2143,-26.4285,-39.6428,-52.8571,-66.0714,-79.2857,-92.4999,-105.714, -118.929,-132.143,-145.357,-158.571,-171.786,-185,-198.214,-211.429,-224.643, -237.857,-251.071,-264.286,-277.5,-290.714,-303.929,-317.143,-330.357, -343.571,-356.786,-370 ] ); __motion_Wheel.addPropertyArray("blendMode", ["normal"]);
En el siguiente ejemplo, el objeto de visualizacin llamado Leaf_1 se mueve por el escenario. Sus conjuntos de propiedades x e y contienen distintos valores en cada uno de los 100 fotogramas de la animacin. Adems, el objeto gira alrededor de su eje z a medida que se mueve por el escenario. Los distintos elementos del conjunto de la propiedad rotationZ determinan la rotacin.
__motion_Leaf_1 = new MotionBase(); __motion_Leaf_1.duration = 100; __motion_Symbol1_4.addPropertyArray("y", [ 0,5.91999,11.84,17.76,23.68,29.6,35.52,41.44,47.36,53.28,59.2,65.12,71.04, 76.96,82.88,88.8,94.72,100.64,106.56,112.48,118.4,124.32,130.24,136.16,142.08, 148,150.455,152.909,155.364,157.818,160.273,162.727,165.182,167.636,170.091, 172.545,175,177.455,179.909,182.364,184.818,187.273,189.727,192.182,194.636, 197.091,199.545,202,207.433,212.865,218.298,223.73,229.163,234.596,240.028, 245.461,250.893,256.326,261.759,267.191,272.624,278.057,283.489, 288.922,294.354,299.787,305.22,310.652,316.085,321.517,326.95,330.475,334, 337.525,341.05,344.575,348.1,351.625,355.15,358.675,362.2,365.725,369.25, 372.775,376.3,379.825,383.35,386.875,390.4,393.925,397.45,400.975,404.5, 407.5,410.5,413.5,416.5,419.5,422.5,425.5 ] ); __motion_Symbol1_4.addPropertyArray("scaleX", [1.00]); __motion_Symbol1_4.addPropertyArray("scaleY", [1.00]); __motion_Symbol1_4.addPropertyArray("skewX", [0]); __motion_Symbol1_4.addPropertyArray("skewY", [0]); __motion_Symbol1_4.addPropertyArray("z", [ 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
342
] ); __motion_Symbol1_4.addPropertyArray("rotationX", [64.0361]); __motion_Symbol1_4.addPropertyArray("rotationY", [41.9578]); __motion_Symbol1_4.addPropertyArray("rotationZ", [ -18.0336,-17.5536,-17.0736,-16.5936,-16.1136,-15.6336,-15.1536,-14.6736, -14.1936,-13.7136,-13.2336,-12.7536,-12.2736,-11.7936,-11.3136,-10.8336, -10.3536,-9.8736,-9.3936,-8.9136,-8.4336,-7.9536,-7.4736,-6.9936,-6.5136, -6.0336,-7.21542,-8.39723,-9.57905,-10.7609,-11.9427,-13.1245,-14.3063, -15.4881,-16.67,-17.8518,-19.0336,-20.2154,-21.3972,-22.5791,-23.7609, -24.9427,-26.1245,-27.3063,-28.4881,-29.67,-30.8518,-32.0336,-31.0771, -30.1206,-29.164,-28.2075,-27.251,-26.2945,-25.338,-24.3814,-23.4249, -22.4684,-21.5119,-20.5553,-19.5988,-18.6423,-17.6858,-16.7293,-15.7727 -14.8162,-13.8597,-12.9032,-11.9466,-10.9901,-10.0336,-10.9427,-11.8518, -12.7609,-13.67,-14.5791,-15.4881,-16.3972,-17.3063,-18.2154,-19.1245, -20.0336,-20.9427,-21.8518,-22.7609,-23.67,-24.5791,-25.4881,-26.3972, -27.3063,-28.2154,-29.1245,-30.0336,-28.3193,-26.605,-24.8907,-23.1765, -21.4622,-19.7479,-18.0336 ] ); __motion_Symbol1_4.addPropertyArray("blendMode", ["normal"]);
Aadir filtros
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior, requiere Flash CS3 o posterior Si el objeto de destino de una interpolacin de movimiento contiene filtros, stos se aaden con los mtodos initFilters() y addFilterPropertyArray() de la clase Motion.
343
Aadir filtros
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior, requiere Flash CS3 o posterior El mtodo addFilterPropertyArray() describe las propiedades de un filtro inicializado con los siguientes argumentos:
1 El primer argumento identifica un filtro por su ndice. El ndice hace referencia a la posicin del nombre del filtro
Con una llamada previa a initFilters(), las siguientes llamadas a addFilterPropertyArray() asignan un valor de 5 a las propiedades blurX y blurY de DropShadowFilter. El elemento DropShadowFilter es el primero (ndice 0) del conjunto de filtros inicializados:
__motion_Box.addFilterPropertyArray(0, "blurX", [5]); __motion_Box.addFilterPropertyArray(0, "blurY", [5]);
Las siguientes tres llamadas asignan valores a las propiedades de calidad, alfa y color de GlowFilter, el segundo elemento (ndice 1) del conjunto de filtros inicializados:
__motion_Box.addFilterPropertyArray(1, "quality", [BitmapFilterQuality.LOW]); __motion_Box.addFilterPropertyArray(1, "alpha", [1.00]); __motion_Box.addFilterPropertyArray(1, "color", [0xff0000]);
Las siguientes cuatro llamadas asignan valores a las propiedades shadowAlpha, shadowColor, highlightAlpha y highlightColor de BevelFilter, el tercer elemento (ndice 2) del conjunto de filtros inicializados:
__motion_Box.addFilterPropertyArray(2, __motion_Box.addFilterPropertyArray(2, __motion_Box.addFilterPropertyArray(2, __motion_Box.addFilterPropertyArray(2, "shadowAlpha", [1.00]); "shadowColor", [0x000000]); "highlightAlpha", [1.00]); "highlightColor", [0xffffff]);
344
__motion_Leaf_1.initFilters(["flash.filters.ColorMatrix"], [0], -1, -1); __motion_Leaf_1.addFilterPropertyArray(0, "adjustColorBrightness", [0], -1, -1); __motion_Leaf_1.addFilterPropertyArray(0, "adjustColorContrast", [0], -1, -1); __motion_Leaf_1.addFilterPropertyArray(0, "adjustColorSaturation", [ 0,-0.589039,1.17808,-1.76712,-2.35616,-2.9452,-3.53424,-4.12328, -4.71232,-5.30136,-5.89041, 6.47945,-7.06849,-7.65753,-8.24657, -8.83561,-9.42465,-10.0137,-10.6027,-11.1918,11.7808,-12.3699, -12.9589,-13.5479,-14.137,-14.726,-15.3151,-15.9041,-16.4931, 17.0822,-17.6712,-18.2603,-18.8493,-19.4383,-20.0274,-20.6164, -21.2055,-21.7945,22.3836,-22.9726,-23.5616,-24.1507,-24.7397, -25.3288,-25.9178,-26.5068,-27.0959,27.6849,-28.274,-28.863,-29.452, -30.0411,-30.6301,-31.2192,-31.8082,-32.3973,32.9863,-33.5753, -34.1644,-34.7534,-35.3425,-35.9315,-36.5205,-37.1096,-37.6986, 38.2877,-38.8767,-39.4657,-40.0548,-40.6438,-41.2329,-41.8219, -42.411,-43 ], -1, -1); __motion_Leaf_1.addFilterPropertyArray(0, "adjustColorHue", [ 0,0.677418,1.35484,2.03226,2.70967,3.38709,4.06451,4.74193,5.41935, 6.09677,6.77419,7.45161,8.12903,8.80645,9.48387,10.1613,10.8387,11.5161, 12.1935,12.871,13.5484,14.2258,14.9032,15.5806,16.2581,16.9355,17.6129, 18.2903,18.9677,19.6452,20.3226,21,22.4286,23.8571,25.2857,26.7143,28.1429, 29.5714,31,32.4286,33.8571,35.2857,36.7143,38.1429,39.5714,41,42.4286,43.8571, 45.2857,46.7143,48.1429,49.5714,51,54,57,60,63,66,69,72,75,78,81,84,87, 90,93,96,99,102,105,108,111,114 ], -1, -1);
Utilice el mtodo addTarget() de la clase AnimatorFactory para asociar el objeto de destino con su interpolacin de movimiento. El cdigo ActionScript copiado desde Flash comenta la lnea addTarget() y no especifica ningn nombre de instancia:
// __animFactory_Wheel.addTarget(<instance name goes here>, 0);
En su copia, especifique el objeto de visualizacin que se asociar con la interpolacin de movimiento. En el siguiente ejemplo, los destinos se especifican como greenWheel y redWheel:
345
Puede asociar varios objetos de visualizacin con la misma interpolacin de movimiento llamando varias veces a
addTarget().
346
Ms temas de ayuda
Paquete fl.ik
347
Conceptos y trminos importantes La siguiente lista de referencias contiene trminos importantes que resultan relevantes para esta funcin:
Esqueleto Cadena cinemtica formada por huesos y uniones que se utiliza en animacin por ordenador para simular movimientos con realismo. Hueso Segmento rgido de un esqueleto (anlogo al hueso de un esqueleto animal) Cinemtica inversa (IK) Proceso por el cual se determinan los parmetros de un objeto flexible unido denominado
la articulacin de un animal.
Motor de fsica Se utiliza un paquete de algoritmos relacionados con la fsica para proporcionar acciones reales de
animacin.
Muelle Cualidad de un hueso que se mueve y reacciona cuando el hueso principal se mueve y posteriormente disminuye de forma incremental con el tiempo.
348
En tiempo de ejecucin, la rueda gira asociada a la interpolacin de movimiento __motion_Wheel descrita en Descripcin de la animacin en la pgina 340. Un objeto IKMover inicia y controla el movimiento del eje. En la siguiente figura se muestran dos instantneas del esqueleto del eje asociado a la rueda giratoria en distintos fotogramas de la rotacin.
Obtiene informacin sobre el esqueleto y sus componentes Crea una instancia del objeto IKMover Mueve el eje junto con la rotacin de la rueda
import fl.ik.* var var var var tree:IKArmature = IKManager.getArmatureByName("Axle"); bone:IKBone = tree.getBoneByName("ikBone2"); endEffector:IKJoint = bone.tailJoint; pos:Point = endEffector.position;
var ik:IKMover = new IKMover(endEffector, pos); ik.limitByDistance = true; ik.distanceLimit = 0.1; ik.limitByIteration = true; ik.iterationLimit = 10; Wheel.addEventListener(Event.ENTER_FRAME, frameFunc); function frameFunc(event:Event) { if (Wheel != null) { var mat:Matrix = Wheel.transform.matrix; var pt = new Point(90, 0); pt = mat.transformPoint(pt); ik.moveTo(pt); } }
349
IKArmature: describe el esqueleto, una estructura en rbol formada por huesos y uniones. Se debe crear con Flash
Professional.
IKManager: clase contenedora de todos los esqueletos IK del documento. Se debe crear con Flash Professional. IKBone: segmento de un esqueleto IK IKJoint: conexin entre dos huesos IK IKMover: inicia y controla el movimiento IK de los esqueletos
Para obtener informacin detallada y completa sobre estas clases, consulte el paquete ik.
De forma similar, el siguiente cdigo utiliza el mtodo getBoneByName() de la clase IKArmature para asignar a la variable IKBone el valor del hueso ikBone2.
var bone:IKBone = tree.getBoneByName("ikBone2");
La unin de cola del hueso ikBone2 es la parte del esqueleto que se une a la rueda giratoria. La siguiente lnea declara la variable endEffector y le asigna la propiedad tailjoint del hueso ikBone2:
var endEffector:IKJoint = home.tailjoint;
En este ejemplo, pos corresponde a la posicin de la unin al final del eje, donde se conecta con la rueda. El valor original de esta variable se obtiene a partir de la propiedad position del objeto IKJoint.
350
Las propiedades de la clase IKMover permiten limitar el movimiento de un esqueleto. Puede limitar el movimiento basado en la distancia, en las iteraciones o en el tiempo del movimiento. Las siguientes parejas de propiedades refuerzan estos lmites. La pareja consta de una valor booleano que indica si el movimiento est limitado y un entero que especifica dicho lmite:
Propiedad booleana
limitByDistance:Boolean
Propiedad de entero
distanceLimit:int
Lmite establecido Establece la distancia mxima (en pxeles) que se mueve el motor IK en cada iteracin. Especifica el nmero mximo de iteraciones que realiza el motor IK en cada movimiento. Establece el tiempo mximo (en milisegundos) asignado al motor IK para realizar el movimiento.
limitByIteration:Boolean
iterationLimit:int
limitByTime:Boolean
timeLimit:int
De forma predeterminada, todos los valores booleanos se establecen en false, por lo que el movimiento no se limita a no ser que se defina explcitamente un valor booleano como true. Para aplicar un lmite, establezca la propiedad adecuada en true y despus especifique un valor para la propiedad de entero correspondiente. Si establece el lmite en un valor sin definir su propiedad Boolean correspondiente, el lmite se obviar. En este caso, el motor IK sigue moviendo el objeto hasta llegar a otro lmite o a la posicin de destino del objeto IKMover. En el siguiente ejemplo, la distancia mxima del movimiento del esqueleto se establece en 0,1 pxeles por iteracin. El nmero mximo de iteraciones de cada movimiento se establece en diez.
ik.limitByDistance = true; ik.distanceLimit = 0.1; ik.limitByIteration = true; ik.iterationLimit = 10;
Desplazamiento de un esqueleto IK
Flash Player 10 y posterior, Adobe AIR 1.5 y posterior, requiere Flash CS4 o posterior El objeto IKMover mueve el eje dentro del detector de eventos de la rueda. En cada evento enterFrame de la rueda, se calcula una nueva posicin de destino para el esqueleto. Si se utiliza su mtodo moveTo(), el objeto IKMover mueve la unin de cola hasta su posicin de destino o tan lejos como lo permitan las limitaciones definidas por las propiedades limitByDistance, limitByIteration y limitByTime.
Wheel.addEventListener(Event.ENTER_FRAME, frameFunc); function frameFunc(event:Event) { if (Wheel != null) { var mat:Matrix = Wheel.transform.matrix; var pt = new Point(90,0); pt = mat.transformPoint(pt); ik.moveTo(pt); } }
351
Uso de muelles
Flash Player 10 y posterior, Adobe AIR 1.5 y posterior, requiere Flash CS5 o posterior La cinemtica inversa de Flash Professional CS5 admite muelles de hueso. El muelle de hueso se puede establecer durante la edicin y los atributos del muelle del hueso se pueden aadir o modificar en tiempo de ejecucin. El muelle es una propiedad del hueso y sus uniones. Cuenta con dos atributos: IKJoint.springStrength, que establece la cantidad de muelle y IKJoint.springDamping, que aade resistencia al valor de intensidad y afecta al grado de descomposicin del muelle. La intensidad del muelle es un valor porcentual desde 0 (totalmente rgido, predeterminado) a 100 (muy suelto y controlado por fsica). Los huesos con muelle reaccionan al movimiento de su unin. Si no se activa ninguna otra traslacin (rotacin, x o y), los valores del muelle no se aplicarn. La atenuacin del muelle es un valor porcentual desde 0 (sin resistencia, predeterminado) a 100 (mucha atenuacin). La atenuacin cambia la cantidad de tiempo que transcurre entre el movimiento inicial del hueso y su vuelta a la posicin de reposo. Se puede verificar si los muelles estn habilitados para un objeto IKArmature comprobando su propiedad
IKArmature.springsEnabled. Las dems propiedades y mtodos del muelle pertenecen a los objetos IKJoint
independientes. Se puede habilitar una unin para la rotacin angular y traslacin a lo largo de los ejes x e y. Se puede situar un ngulo del muelle de la unin de rotacin con IKJoint.setSpringAngle y una posicin del muelle de la unin de traslacin con IKJoint.setSpringPt. Este ejemplo selecciona un hueso por nombre e identifica su valor tailJoint. El cdigo prueba el esqueleto para ver si los muelles estn habilitados y posteriormente establece las propiedades del muelle para la unin.
var arm:IKArmature = IKManager.getArmatureAt(0); var bone:IKBone = arm.getBoneByName("c"); var joint:IKJoint = bone.tailJoint; if (arm.springsEnabled) { joint.springStrength = 50; //medium spring strength joint.springDamping = 10; //light damping resistance if (joint.hasSpringAngle) { joint.setSpringAngle(30); //set angle for rotational spring } }
Uso de eventos IK
Flash Player 10 y posterior, Adobe AIR 1.5 y posterior, requiere Flash CS4 o posterior La clase IKEvent permite crear un objeto de evento que contenga informacin sobre eventos IK. La informacin de IKEvent describe un movimiento que ha finalizado por haberse superado el tiempo especificado, la distancia o el lmite de iteraciones. El siguiente cdigo muestra un detector de eventos y un controlador para realizar el seguimiento de los eventos de lmite de tiempo. Este controlador de eventos informa sobre el tiempo, la distancia, el nmero de iteraciones y las propiedades de unin de un evento activado cuando se supera el lmite de tiempo de IKMover.
352
var ikmover:IKMover = new IKMover(endjoint, pos); ikMover.limitByTime = true; ikMover.timeLimit = 1000; ikmover.addEventListener(IKEvent.TIME_LIMIT, timeLimitFunction); function timeLimitFunction(evt:IKEvent):void { trace("timeLimit hit"); trace("time is " + evt.time); trace("distance is " + evt.distance); trace("iterationCount is " + evt.iterationCount); trace("IKJoint is " + evt.joint.name); }
353
de profundidad y distancia.
Proyeccin Produccin de una imagen 2D de un objeto de mayores dimensiones; los mapas en proyeccin 3D sealan a un plano 2D. Rotacin Cambio de la orientacin (y a menudo de la posicin) de un objeto moviendo todos los puntos incluidos en
coordenadas cartesianas x, y y z.
Vrtice Punto de esquina. Malla con textura Cualquier punto que defina un objeto en el espacio 3D.
354
Mapeado UV Una forma de aplicar una textura o mapa de bits a una superficie 3D. El mapeado UV asigna valores a
las coordenadas de una imagen como porcentajes del eje (U) horizontal y el eje (V) vertical.
Valor T Factor de escala para determinar el tamao de un objeto 3D conforme el objeto se acerca o se aleja del punto
de vista actual.
Tcnica "culling" Representacin, o no, de superficies, con una direccin de trazado especfica. Con el uso de la tcnica
"culling" se pueden ocultar superficies que no se encuentran visibles en el punto de vista actual.
(0,0,0)
C B
Direcciones positivas de los ejes x, y y z en el sistema de coordenadas 3D de ActionScript. A. Eje + Z B. Origen C. +Eje X D. +Eje Y
355
Nota: se debe tener en cuenta que Flash Player y AIR siempre representan 3D en capas. Esto significa que si el objeto A est delante del objeto B en la lista de visualizacin, Flash Player o AIR siempre representan A delante de B independientemente de los valores del eje z de los dos objetos. Para resolver este conflicto entre el orden de la lista de visualizacin y el orden del eje z, utilice el mtodo transform.getRelativeMatrix3D() para guardar y posteriormente reordenar las capas de los objetos de visualizacin 3D. Para obtener ms informacin, consulte Uso de objetos Matrix3D para reordenar la visualizacin en la pgina 364. Las siguientes clases de ActionScript admiten las nuevas funciones relacionadas con 3D:
1 La clase flash.display.DisplayObject contiene la propiedad z y nuevas propiedades de escala y rotacin para
manipular objetos de visualizacin en el espacio 3D. El mtodo DisplayObject.local3DToGlobal() ofrece una forma sencilla de proyectar geometra 3D en un plano 2D.
2 La clase flash.geom.Vector3D se puede utilizar como estructura de datos para administrar puntos 3D. Tambin
escala y traslacin.
4 La clase flash.geom.PerspectiveProjection controla los parmetros para el mapeado de geometra 3D en una vista 2D.
visualizacin utilizando las propiedades x, y y z de los objetos, o bien, estableciendo propiedades de rotacin y escala mediante la clase DisplayObject. Se puede obtener un movimiento ms complejo utilizando el objeto DisplayObject.transform.matrix3D. El objeto DisplayObject.transform.perspectiveProjection personaliza el modo en que los objetos de visualizacin se dibujan en perspectiva 3D. Utilice este enfoque cuando desee animar objetos 3D que consten de planos fundamentalmente. Los ejemplos de este enfoque incluyen galeras de imgenes 3D u objetos de animacin 2D organizados en un espacio 3D.
2 Generacin de tringulos 2D a partir de geometra 3D y representacin de estos tringulos con texturas. Para
utilizar este enfoque, en primer lugar debe definir y administrar datos sobre objetos 3D y posteriormente convertir estos datos en tringulos 2D para la representacin. Las texturas de mapa de bits se pueden asignar a estos tringulos y a continuacin los tringulos se dibujan en un objeto graphics utilizando el mtodo Graphics.drawTriangles(). Los ejemplos de este enfoque incluyen la carga de datos del modelo 3D desde un archivo y la representacin del modelo en pantalla, o bien, la generacin y el dibujo de terreno 3D como mallas de tringulo.
356
Estos valores, as como las propiedades que se derivan de los mismos, se pueden ver en la propiedad matrix3D del objeto Transform de la hoja:
var leafMatrix:Matrix3D = leaf.transform.matrix3D;
Para obtener informacin sobre las propiedades del objeto Transform, consulte la clase Transform. Para obtener informacin sobre las propiedades del objeto Matrix3D, consulte la clase Matrix3D.
357
La siguiente figura muestra los dos cuadrados cuando se incrementa la propiedad rotationY del contenedor de los cuadrados para girarlos en el eje y. Con la rotacin del contenedor, u objeto de visualizacin principal, de los dos cuadrados giran ambos cuadrados:
container.rotationY += 10;
En la siguiente figura se muestra qu sucede cuando se establece la propiedad rotationX del contenedor de los cuadrados. Con ello se giran los cuadrados en el eje x.
En la siguiente figura se muestra qu sucede cuando se incrementa la propiedad rotationZ del contenedor de los cuadrados. Con ello se giran los cuadrados en el eje z.
358
Con la modificacin del valor de fieldOfView, cambia automticamente el valor de focalLength y viceversa, ya que son interdependientes. La frmula utilizada para calcular focalLength dado el valor de fieldOfView es la siguiente:
focalLength = stageWidth/2 * (cos(fieldOfView/2) / sin(fieldOfView/2)
Campo visual
Flash Player 10 y posterior, Adobe AIR 1.5 y posterior Con la manipulacin de la propiedad fieldOfView de la clase PerspectiveProjection, puede hacer que un objeto de visualizacin 3D que se acerca al espectador parezca ms grande y que un objeto que se aleja del espectador parezca ms pequeo. La propiedad fieldOfView especifica un ngulo entre 0 y 180 grados que determina la intensidad de la proyeccin en perspectiva. Cuanto mayor es el valor, mayor es la distorsin aplicada a un objeto de visualizacin que se mueve por su eje z. Un valor fieldOfView bajo implica un ajuste de escala muy pequeo y hace que objeto slo parezca moverse ligeramente hacia atrs en el espacio. Un valor fieldOfView alto causa ms distorsin y la apariencia de mayor movimiento. El valor mximo de 179,9999... tiene como resultado un efecto de lente de cmara "ojo de pez" extremo. El valor mximo de fieldOfView es 179.9999... y el mnimo es de 0,00001... Exactamente 0 y 180 son valores no permitidos.
Centro de proyeccin
Flash Player 10 y posterior, Adobe AIR 1.5 y posterior La propiedad projectionCenter representa el punto de fuga en la proyeccin en perspectiva. Se aplica como desplazamiento en el punto de registro predeterminado (0,0) en la esquina superior izquierda del escenario. Cuando un objeto parece alejarse del espectador, se sesga hacia el punto de fuga y finalmente desaparece. Imagine un pasillo infinitamente largo. Cuando mira el pasillo hacia delante, los bordes de las paredes convergen en un punto de fuga hacia el final del pasillo.
359
Si el punto de fuga est en el centro del escenario, el pasillo desaparece hacia un punto en el centro. El valor predeterminado de la propiedad projectionCenter es el centro del escenario. Si, por ejemplo, desea que los elementos aparezcan en la parte izquierda del escenario y un rea 3D a la derecha, establezca projectionCenter en un punto en la derecha del escenario para que ese sea el punto de fuga del rea de visualizacin 3D.
Distancia focal
Flash Player 10 y posterior, Adobe AIR 1.5 y posterior La propiedad focalLength representa la distancia entre el origen del punto de vista (0,0,0) y la ubicacin del objeto de visualizacin en su eje z. Una distancia focal larga es como una lente telefoto con una vista estrecha y distancias comprimidas entre objetos. Una distancia focal corta es como una lente gran angular, con la que se obtiene una vista amplia con mucha distorsin. La distancia focal media se aproxima a lo que v el ojo humano. Generalmente el valor focalLength se vuelve a calcular de forma dinmica durante la transformacin de perspectiva conforme se mueve el objeto de visualizacin, aunque se puede establecer de forma explcita.
Estos son los valores que se utilizan si no crea su propio objeto PerspectiveProjection. Puede crear una instancia de su propio objeto PerspectiveProjection con el fin realizar una modificacin propia de projectionCenter y fieldOfView. En este caso, los valores predeterminados del objeto recin creado son los siguientes, en funcin del tamao del escenario predeterminado de 500 por 500:
360
3 Se aaden detectores de eventos para eventos de ratn que llaman a controladores que modifican el componente
projectionCenter de forma que ste siga la ubicacin del objeto center.
4 Se crean cuatro cuadros de estilo Accordion que forman las paredes del espacio en perspectiva.
Cuando pruebe este ejemplo, ProjectionDragger.swf, arrastre el crculo alrededor de las distintas ubicaciones. El punto de fuga sigue el crculo, situndose donde lo coloque. Observe los cuadros que delimitan la extensin del espacio y aplique la distorsin cuando aleje el centro de proyeccin del centro del escenario. Para obtener los archivos de la aplicacin de este ejemplo, consulte www.adobe.com/go/learn_programmingAS3samples_flash_es. Los archivos de la aplicacin ProjectionDragger se encuentran en la carpeta Samples/ProjectionDragger.
package { import flash.display.Sprite; import flash.display.Shape; import flash.geom.Point; import flash.events.*; public class ProjectionDragger extends Sprite { private var center : Sprite; private var boxPanel:Shape; private var inDrag:Boolean = false; public function ProjectionDragger():void { createBoxes(); createCenter(); } public function createCenter():void { var centerRadius:int = 20; center = new Sprite(); // circle center.graphics.lineStyle(1, 0x000099); center.graphics.beginFill(0xCCCCCC, 0.5); center.graphics.drawCircle(0, 0, centerRadius); center.graphics.endFill(); // cross hairs center.graphics.moveTo(0, centerRadius); center.graphics.lineTo(0, -centerRadius); center.graphics.moveTo(centerRadius, 0); center.graphics.lineTo(-centerRadius, 0); center.x = 175; center.y = 175; center.z = 0; this.addChild(center); center.addEventListener(MouseEvent.MOUSE_DOWN, startDragProjectionCenter); center.addEventListener(MouseEvent.MOUSE_UP, stopDragProjectionCenter); center.addEventListener( MouseEvent.MOUSE_MOVE, doDragProjectionCenter); root.transform.perspectiveProjection.projectionCenter = new Point(center.x,
361
center.y); } public function createBoxes():void { // createBoxPanel(); var boxWidth:int = 50; var boxHeight:int = 50; var numLayers:int = 12; var depthPerLayer:int = 50; // var boxVec:Vector.<Shape> = new Vector.<Shape>(numLayers); for (var i:int = 0; i < numLayers; i++) { this.addChild(createBox(150, 50, (numLayers - i) * depthPerLayer, boxWidth, 0xCCCCFF)); this.addChild(createBox(50, 150, (numLayers - i) * depthPerLayer, boxWidth, 0xFFCCCC)); this.addChild(createBox(250, 150, (numLayers - i) * depthPerLayer, boxWidth, 0xCCFFCC)); this.addChild(createBox(150, 250, (numLayers - i) * depthPerLayer, boxWidth, 0xDDDDDD)); }
public function createBox(xPos:int = 0, yPos:int = 0, zPos:int = 100, w:int = 50, h:int = 50, color:int = 0xDDDDDD):Shape { var box:Shape = new Shape(); box.graphics.lineStyle(2, 0x666666); box.graphics.beginFill(color, 1.0); box.graphics.drawRect(0, 0, w, h); box.graphics.endFill(); box.x = xPos; box.y = yPos; box.z = zPos; return box; } public function startDragProjectionCenter(e:Event) { center.startDrag(); inDrag = true;
362
} public function doDragProjectionCenter(e:Event) { if (inDrag) { root.transform.perspectiveProjection.projectionCenter = new Point(center.x, center.y); } } public function stopDragProjectionCenter(e:Event) { center.stopDrag(); root.transform.perspectiveProjection.projectionCenter = new Point(center.x, center.y); inDrag = false; } } }
Transformaciones 3D complejas
Flash Player 10 y posterior, Adobe AIR 1.5 y posterior La clase Matrix3D permite transformar puntos 3D en un espacio de coordenadas o mapear puntos 3D de un espacio de coordenadas a otro. Para utilizar la clase Matrix3D no es necesario conocer las matemticas de matrices. La mayora de las operaciones comunes de transformacin se pueden controlar utilizando los mtodos de la clase. No tiene que preocuparse por establecer o calcular de forma explcita los valores de todos los elementos de la matriz. Una vez establecida la propiedad z de un objeto de visualizacin en un valor numrico, puede recuperar la matriz de transformacin del objeto utilizando la propiedad Matrix3D del objeto Transform del objeto de visualizacin:
var leafMatrix:Matrix3D = this.transform.matrix3D;
Puede utilizar los mtodos del objeto Matrix3D para realizar la traslacin, rotacin, escala y proyeccin en perspectiva del objeto de visualizacin. Utilice la clase Vector3D con sus propiedades x, y, y z para administrar puntos 3D. Tambin puede representar un vector espacial en fsica, que cuenta con una direccin y una magnitud. Los mtodos de la clase Vector3D permiten realizar clculos comunes con vectores espaciales como, por ejemplo, clculos de producto escalar, producto cruzado y suma. Nota: la clase Vector3D no se relaciona con la clase Vector de ActionScript. La clase Vector3D contiene propiedades y mtodos para definir y manipular puntos 3D, mientras que la clase Vector admite conjuntos de objetos con tipo.
363
public class Matrix3DTransformsExample extends Sprite { private var rect1:Shape; private var rect2:Shape; public function Matrix3DTransformsExample():void { var pp:PerspectiveProjection = this.transform.perspectiveProjection; pp.projectionCenter = new Point(275,200); this.transform.perspectiveProjection = pp; rect1 = new Shape(); rect1.x = -70; rect1.y = -40; rect1.z = 0; rect1.graphics.beginFill(0xFF8800); rect1.graphics.drawRect(0,0,50,80); rect1.graphics.endFill();
364
addChild(rect1); rect2 = new Shape(); rect2.x = 20; rect2.y = -40; rect2.z = 0; rect2.graphics.beginFill(0xFF0088); rect2.graphics.drawRect(0,0,50,80); rect2.graphics.endFill(); addChild(rect2); doTransforms(); } private function doTransforms():void { rect1.rotationX = 15; rect1.scaleX = 1.2; rect1.x += 100; rect1.y += 50; rect1.rotationZ = 10; var matrix:Matrix3D = rect2.transform.matrix3D; matrix.appendRotation(15, Vector3D.X_AXIS); matrix.appendScale(1.2, 1, 1); matrix.appendTranslation(100, 50, 0); matrix.appendRotation(10, Vector3D.Z_AXIS); rect2.transform.matrix3D = matrix; } } }
En el mtodo doTransforms() el primer bloque de cdigo utiliza las propiedades DisplayObject para cambiar la rotacin, escala y posicin de una forma de rectngulo. El segundo bloque de cdigo utiliza los mtodos de la clase Matrix3D para realizar las mismas transformaciones. La principal ventaja del uso del mtodo Matrix3D es que todos los clculos se realizan en la matriz en primer lugar. Despus se aplican al objeto de visualizacin slo una vez, cuando se establece su propiedad transform.matrix3D. La definicin de las propiedades DisplayObject hace que el cdigo fuente resulte un poco ms sencillo de leer. No obstante, cada vez que se establece una propiedad de escala o rotacin, esto causa varios clculos y cambia varias propiedades del objeto de visualizacin. Si el cdigo aplica las mismas transformaciones completas a los objetos de visualizacin varias veces, guarde el objeto Matrix3D como una variable y posteriormente vuelva a aplicarlo una y otra vez.
365
Para garantizar que la disposicin en capas de los objetos de visualizacin 3D se corresponde con las profundidades relativas de los objetos, utilice un enfoque como el siguiente:
1 Utilice el mtodo getRelativeMatrix3D() del objeto Transform para obtener los ejes z relativos de los objetos
de visualizacin 3D secundarios.
2 Use el mtodo removeChild() para eliminar los objetos de la lista de visualizacin. 3 Ordene los objetos de visualizacin en funcin de sus valores de eje z. 4 Utilice el mtodo addChild() para volver a aadir los elementos secundarios a la lista de visualizacin en orden
inverso. Este reordenamiento garantiza que los objetos se muestren conforme a sus ejes z relativos. El siguiente cdigo muestra la correcta visualizacin de las seis caras de un cuadro 3D. Reordena las caras del cuadro tras haber aplicado las rotaciones:
public var faces:Array; . . . public function ReorderChildren() { for(var ind:uint = 0; ind < 6; ind++) { faces[ind].z = faces[ind].child.transform.getRelativeMatrix3D(root).position.z; this.removeChild(faces[ind].child); } faces.sortOn("z", Array.NUMERIC | Array.DESCENDING); for (ind = 0; ind < 6; ind++) { this.addChild(faces[ind].child); } }
Para obtener los archivos de la aplicacin para esta muestra, vaya a www.adobe.com/go/learn_programmingAS3samples_flash_es. Los archivos de la aplicacin se encuentran en la carpeta Samples/ReorderByZ.
366
El primer parmetro de drawTriangles() es el nico necesario: el parmetro vertices. Este parmetro es un vector de nmeros que define las coordenadas mediante las que se dibujan los tringulos. Cada tres conjuntos de coordenadas (seis nmeros) se representa un trazado del tringulo. Sin el parmetro indices, la longitud del vector siempre debe ser un factor de seis, ya que cada tringulo requiere tres pares de coordenadas(tres conjuntos de dos valores x/y). Por ejemplo:
graphics.beginFill(0xFF8000); graphics.drawTriangles( Vector.<Number>([ 10,10, 100,10, 10,100, 110,10, 110,100, 20,100]));
Ninguno de estos tringulos comparte puntos, pero si lo hicieran, el segundo parmetro drawTriangles(), indices, podra utilizarse para volver a usar los valores en el vector vertices para varios tringulos. Al utilizar el parmetro indices, se debe tener en cuenta que los valores indices son ndices de punto, y no ndices que se relacionan directamente con los elementos del conjunto vertices. Es decir, un ndice del vector vertices tal y como se define mediante indices es realmente el verdadero ndice dividido por 2. Para el tercer punto de un vector vertices utilice, por ejemplo, un valor indices de 2, aunque el primer valor numrico de ese punto comience en el ndice vectorial de 4. Por ejemplo, combine dos tringulos para que compartan el borde diagonal utilizando el parmetro indices:
graphics.beginFill(0xFF8000); graphics.drawTriangles( Vector.<Number>([10,10, 100,10, 10,100, 100,100]), Vector.<int>([0,1,2, 1,3,2]));
Se debe tener en cuenta que aunque ahora se haya dibujado un cuadrado utilizando dos tringulos, slo se especificaron cuatro puntos en el vector vertices. Con el uso de indices, los dos puntos compartidos por los dos tringulos se volvern a utilizar para cada tringulo. Con ello se reduce el recuento total de vrtices de 6 (12 nmeros) a 4 (8 nmeros):
Esta tcnica resulta til con mallas de tringulo ms grandes donde varios tringulos comparten la mayora de los puntos. Todos los rellenos se pueden aplicar a tringulos. Los rellenos se aplican a la malla de tringulo resultante tal y como se hara en cualquier otra forma.
367
Superficie bidimensional donde se utiliza un punto de fuga y tres objetos tridimensionales ajustados con un mapa de bits
Mapeado UV
Flash Player 10 y posterior, Adobe AIR 1.5 y posterior Una vez que comience a trabajar con texturas, desear utilizar el parmetro uvtData de drawTriangles(). Este parmetro permite configurar el mapeado UV para rellenos de mapa de bits. El mapeado UV es un mtodo para aplicar textura a los objetos. Se basa en dos valores: un valor U horizontal (x) y un valor V vertical (y). En lugar de basarse en valores de pxel, se basan en porcentajes. 0 U y 0 V representan la parte superior izquierda de una imagen y 1 U y 1 V la parte inferior derecha:
A los vectores de un tringulo se les puede proporcionar coordenadas UV para asociarse con las ubicaciones respectivas en una imagen:
368
Los vrtices del tringulo se mueven y el mapa de bits se distorsiona para mantener igual los valores UV para un punto individual
Debido a que las transformaciones 3D de ActionScript se aplican al tringulo asociado con el mapa de bits, la imagen del mapa de bits se aplica al tringulo en funcin de los valores UV. Por lo tanto, en lugar de utilizar clculos de matriz, establezca o ajuste los valores UV para crear un efecto tridimensional. El mtodo Graphics.drawTriangles() tambin acepta una parte de informacin opcional para transformaciones tridimensionales: el valor T. El valor T en uvtData representa la perspectiva 3D, o ms concretamente, el factor de escala del vrtice asociado. El mapeado UVT aade una correccin de la perspectiva al mapeado UV. Por ejemplo, si un objeto se coloca en un espacio 3D alejado del punto de vista de forma que parezca ser un 50% de su tamao original, el valor T del objeto podra ser 0,5. Debido a que los tringulos se dibujan para representar objetos en el espacio 3D, sus ubicaciones en el eje z determinan sus valores T. La ecuacin que determina el valor T es la siguiente:
T = focalLength/(focalLength + z);
En esta ecuacin, focalLength representa una distancia focal o ubicacin de "pantalla" calculada que determina la cantidad de perspectiva que se ofrece en la vista.
A B C
Distancia focal y valor z A. Punto de vista B. pantalla C. Objeto 3D D. valor focalLength E. valor z
369
El valor de T se utiliza para realizar un ajuste de escala de formas bsicas para hacerlas parecer ms alejadas en la distancia. Suele ser el valor utilizado para convertir puntos 3D en puntos 2D. En el caso de datos UVT, tambin se utiliza para escalar un mapa de bits entre los puntos en un tringulo con perspectiva. Cuando se definen valores UVT, el valor T sigue directamente los valores UV definidos para un vrtice. Con la inclusin de T, cada tres valores en el parmetro uvtData (U, V y T) coinciden con cada dos valores del parmetro vertices (x e y). Slo con los valores UV, uvtData.length == vertices.length. Con la inclusin de un valor T, uvtData.length = 1.5*vertices.length. En el siguiente ejemplo se muestra un plano giratorio en un espacio 3D utilizando datos UVT. Este ejemplo utiliza una imagen llamada ocean.jpg y una clase auxiliar, ImageLoader, para cargar la imagen ocean.jpg de modo que se pueda asignar al objeto BitmapData. A continuacin se muestra el cdigo fuente de la clase ImageLoader (guarde este cdigo en un archivo denominado ImageLoader.as):
package { import flash.display.* import flash.events.*; import flash.net.URLRequest; public class ImageLoader extends Sprite { public var url:String; public var bitmap:Bitmap; public function ImageLoader(loc:String = null) { if (loc != null){ url = loc; loadImage(); } } public function loadImage():void{ if (url != null){ var loader:Loader = new Loader(); loader.contentLoaderInfo.addEventListener(Event.COMPLETE, onComplete); loader.contentLoaderInfo.addEventListener(IOErrorEvent.IO_ERROR, onIoError); var req:URLRequest = new URLRequest(url); loader.load(req); } } private function onComplete(event:Event):void { var loader:Loader = Loader(event.target.loader); var info:LoaderInfo = LoaderInfo(loader.contentLoaderInfo); this.bitmap = info.content as Bitmap; this.dispatchEvent(new Event(Event.COMPLETE)); } private function onIoError(event:IOErrorEvent):void { trace("onIoError: " + event); } } }
Y a continuacin se muestra el cdigo ActionScript que utiliza tringulos, mapeado UV y valores T para hacer que la imagen parezca que est rotando y encogindose hacia un punto de fuga. Guarde este cdigo en un archivo denominado Spinning3dOcean.as:
370
package { import flash.display.* import flash.events.*; import flash.utils.getTimer; public class Spinning3dOcean extends Sprite { // plane vertex coordinates (and t values) var x1:Number = -100,y1:Number = -100,z1:Number = 0,t1:Number = 0; var x2:Number = 100,y2:Number = -100,z2:Number = 0,t2:Number = 0; var x3:Number = 100,y3:Number = 100,z3:Number = 0,t3:Number = 0; var x4:Number = -100,y4:Number = 100,z4:Number = 0,t4:Number = 0; var focalLength:Number = 200; // 2 triangles for 1 plane, indices will always be the same var indices:Vector.<int>; var container:Sprite; var bitmapData:BitmapData; // texture var imageLoader:ImageLoader; public function Spinning3dOcean():void { indices = new Vector.<int>(); indices.push(0,1,3, 1,2,3); container = new Sprite(); // container to draw triangles in container.x = 200; container.y = 200; addChild(container); imageLoader = new ImageLoader("ocean.jpg"); imageLoader.addEventListener(Event.COMPLETE, onImageLoaded); } function onImageLoaded(event:Event):void { bitmapData = imageLoader.bitmap.bitmapData; // animate every frame addEventListener(Event.ENTER_FRAME, rotatePlane); } function rotatePlane(event:Event):void { // rotate vertices over time var ticker = getTimer()/400; z2 = z3 = -(z1 = z4 = 100*Math.sin(ticker)); x2 = x3 = -(x1 = x4 = 100*Math.cos(ticker)); // calculate t values
371
t1 t2 t3 t4
= = = =
+ + + +
// determine triangle vertices based on t values var vertices:Vector.<Number> = new Vector.<Number>(); vertices.push(x1*t1,y1*t1, x2*t2,y2*t2, x3*t3,y3*t3, x4*t4,y4*t4); // set T values allowing perspective to change // as each vertex moves around in z space var uvtData:Vector.<Number> = new Vector.<Number>(); uvtData.push(0,0,t1, 1,0,t2, 1,1,t3, 0,1,t4); // draw container.graphics.clear(); container.graphics.beginBitmapFill(bitmapData); container.graphics.drawTriangles(vertices, indices, uvtData); } } }
Para probar este ejemplo, guarde los dos archivos de clase en el mismo directorio que una imagen llamada ocean.jpg. Puede ver cmo se transforma el mapa de bits original para que parezca que se aleja en la distancia y gira en un espacio 3D.
Tcnica "culling"
Flash Player 10 y posterior, Adobe AIR 1.5 y posterior La tcnica "culling" es el proceso que determina qu superficies de un objeto tridimensional no debe representar el procesador porque estn ocultas desde el punto de vista actual. En el espacio 3D, la superficie de la parte posterior de un objeto tridimensional queda oculta desde el punto de vista:
A B
La parte posterior de un objeto 3D se oculta desde el punto de vista. A. Punto de vista B. Objeto 3D C. Parte posterior de un objeto tridimensional
Los tringulos siempre se representan independientemente de su tamao, forma o posicin. La tcnica "culling" garantiza que Flash Player o AIR representen los objetos 3D correctamente. Asimismo, para guardar los ciclos de representacin, a veces se desea que el procesador omita algunos tringulos. Pongamos como ejemplo un cubo giratorio en el espacio. En un momento dado, nunca ver ms de tres caras del cubo, ya que las caras ocultas estarn frente a la otra direccin del otro lado del cubo. Debido a que estas caras no se van a ver, el procesador no debe dibujarlas. Sin "culling", Flash o AIR representan tanto las caras frontales como las posteriores.
372
Por lo tanto, el mtodo Graphics.drawTriangles() tiene un cuarto parmetro para establecer un valor de "culling":
public function drawTriangles(vertices:Vector.<Number>, indices:Vector.<int> = null, uvtData:Vector.<Number> = null, culling:String = "none"):void
El parmetro de "culling" es un valor de la clase de enumeracin TriangleCulling: TriangleCulling.NONE, TriangleCulling.POSITIVE y TriangleCulling.NEGATIVE. Estos valores son dependientes de la direccin del trazado del tringulo que define la superficie del objeto. La API de ActionScript para determinar el valor "culling" da por hecho que todos los tringulos exteriores de una forma 3D se dibujan con la misma direccin de trazado. Cuando una cara del tringulo cambia de direccin, la direccin del trazado tambin se modifica. En este momento, al tringulo se le puede aplicar el proceso de "culling" (eliminarse de la representacin). Por lo tanto, un valor TriangleCulling de POSITIVE elimina tringulos con una direccin de trazado positiva (en el sentido de las agujas del reloj). Un valor TriangleCulling de NEGATIVE elimina tringulos con una direccin de trazado negativa (en sentido contrario a las agujas del reloj). En el caso de un cubo, mientras que las caras frontales tienen una direccin de trazado positiva, las posteriores cuentan con una direccin de trazado negativa:
Cubo sin ajustar para mostrar la direccin de trazado. Cuando se ajusta, se invierte la direccin de trazado de la cara posterior
Para ver cmo funciona la tcnica "culling", comience con el ejemplo anterior de Mapeado UV en la pgina 367, establezca el parmetro de "culling" del mtododrawTriangles() en TriangleCulling.NEGATIVE:
container.graphics.drawTriangles(vertices, indices, uvtData, TriangleCulling.NEGATIVE);
373
Uso de la clase TextField en la pgina 375 Uso de Flash Text Engine en la pgina 400 Uso de Text Layout Framework en la pgina 430
Conceptos y trminos importantes La siguiente lista de referencia contiene trminos importantes relacionados con el control de texto:
Hojas de estilos en cascada Sintaxis estndar para especificar estilos y formato para contenido estructurado con
aplicacin.
374
Texto HTML Contenido de texto introducido en un campo de texto mediante cdigo ActionScript que incluye
cdigo ActionScrip.
Espaciado manual Ajuste del espaciado entre pares de caracteres para que el espaciado de las palabras sea ms
de base del texto, la altura de la parte superior de los caracteres, el tamao de los trazos descendentes (la parte de algunas letras minsculas que se extiende por debajo de la lnea de base), etc.
Espaciado entre caracteres Ajuste del espaciado entre grupos de letras o bloques de texto para aumentar o disminuir la densidad y hacer el texto ms legible.
375
Ms temas de ayuda
Asignacin de formatos de texto en la pgina 383 Visualizacin de texto HTML en la pgina 377 Aplicacin de hojas de estilos en cascada en la pgina 383
Visualizacin de texto
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior Aunque las herramientas de edicin como Adobe Flex Builder y Flash Professional proporcionan varias opciones para visualizar texto, como componentes relacionados con texto o herramientas de texto, la principal manera de mostrar texto mediante programacin es utilizar un campo de texto.
376
Tipos de texto
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior El tipo de texto de un campo de texto se caracteriza por su origen:
Texto dinmico
El texto dinmico incluye contenido que se carga desde un origen externo, como un archivo de texto, un archivo XML o incluso un servicio web remoto.
Texto de entrada
El texto de entrada es cualquier texto introducido por un usuario o texto dinmico que un usuario puede editar. Se puede establecer una hoja de estilos para aplicar formato al texto de entrada o utilizar la clase flash.text.TextFormat para asignar propiedades al campo de texto para el contenido de la entrada. Para obtener ms informacin, consulte Captura de entradas de texto en la pgina 381.
Texto esttico
El texto esttico slo se crea mediante Flash Professional. Con ActionScript 3.0 no se pueden crear instancias de texto esttico. Sin embargo, se pueden usar clases de ActionScript como StaticText y TextSnapshot para manipular instancias de texto esttico existentes. Para obtener ms informacin, consulte Trabajo con texto esttico en la pgina 389.
Tambin se puede asignar a la propiedad text un valor de una variable definida en el script, tal y como se muestra en el siguiente ejemplo:
package { import flash.display.Sprite; import flash.text.*; public class TextWithImage extends Sprite { private var myTextBox:TextField = new TextField(); private var myText:String = "Hello World"; public function TextWithImage() { addChild(myTextBox); myTextBox.text = myText; } } }
377
Como alternativa, se puede asignar a la propiedad text un valor de una variable remota. Existen tres opciones para cargar valores de texto desde orgenes remotos:
Las clases flash.net.URLLoader y flash.net.URLRequest cargan variables para el texto desde una ubicacin local o
remota.
El atributo FlashVars est incorporado en la pgina HTML que aloja el archivo SWF y puede incluir valores para
variables de texto.
Flash Player y AIR admiten un subconjunto de etiquetas y entidades HTML para la propiedad htmlText. La descripcin de la propiedad flash.text.TextField.htmlText en Referencia de ActionScript 3.0 proporciona informacin detallada sobre las etiquetas y entidades HTML admitidas. Una vez designado el contenido mediante la propiedad htmlText, puede utilizar hojas de estilos o la etiqueta textformat para administrar el formato del contenido. Para obtener ms informacin, consulte Formato de texto en la pgina 383.
378
package { import flash.display.Sprite; import flash.text.*; public class TextWithImage extends Sprite { private var myTextBox:TextField; private var myText:String = "<p>This is <b>some</b> content to <i>test</i> and <i>see</i></p><p><img src='eye.jpg' width='20' height='20'></p><p>what can be rendered.</p><p>You should see an eye image and some <u>HTML</u> text.</p>"; public function TextWithImage() { myTextBox.width = 200; myTextBox.height = 200; myTextBox.multiline = true; myTextBox.wordWrap = true; myTextBox.border = true; addChild(myTextBox); myTextBox.htmlText = myText; } } }
379
package { import flash.display.Sprite; import flash.text.*; import flash.events.MouseEvent; public class TextScrollExample extends Sprite { private var myTextBox:TextField = new TextField(); private var myText:String = "Hello world and welcome to the show. It's really nice to meet you. Take your coat off and stay a while. OK, show is over. Hope you had fun. You can go home now. Don't forget to tip your waiter. There are mints in the bowl by the door. Thank you. Please come again."; public function TextScrollExample() { myTextBox.text = myText; myTextBox.width = 200; myTextBox.height = 50; myTextBox.multiline = true; myTextBox.wordWrap = true; myTextBox.background = true; myTextBox.border = true; var format:TextFormat = new TextFormat(); format.font = "Verdana"; format.color = 0xFF0000; format.size = 10; myTextBox.defaultTextFormat = format; addChild(myTextBox); myTextBox.addEventListener(MouseEvent.MOUSE_DOWN, mouseDownScroll); } public function mouseDownScroll(event:MouseEvent):void { myTextBox.scrollV++; } } }
380
Seleccin de texto
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior El valor de la propiedad flash.text.TextField.selectable es true de forma predeterminada y se puede seleccionar texto mediante programacin a travs del mtodo setSelection(). Por ejemplo, se puede establecer texto especfico de un campo de texto que se debe seleccionar cuando el usuario haga clic en el campo de texto:
var myTextField:TextField = new TextField(); myTextField.text = "No matter where you click on this text field the TEXT IN ALL CAPS is selected."; myTextField.autoSize = TextFieldAutoSize.LEFT; addChild(myTextField); addEventListener(MouseEvent.CLICK, selectText); function selectText(event:MouseEvent):void { myTextField.setSelection(49, 65); }
Del mismo modo, si se desea que se seleccione texto de un campo como el texto que se mostrar inicialmente, se debe crear una funcin de controlador de eventos a la que se llama cuando se aade texto a la lista de visualizacin.
Se puede aplicar una coleccin de propiedades de objeto TextFormat a la seleccin para modificar el aspecto del texto. Para obtener ms informacin sobre la aplicacin de una coleccin de propiedades de TextFormat a texto seleccionado, consulte Formato de rangos de texto en un campo de texto en la pgina 386.
381
flash.display.Sprite; flash.display.Stage; flash.text.*; flash.events.*; Sprite new TextField(); = new TextField(); your text here.";
public class CaptureUserInput extends { private var myTextBox:TextField = private var myOutputBox:TextField private var myText:String = "Type public function CaptureUserInput() { captureText(); }
382
myTextBox.text = myText; myTextBox.addEventListener(TextEvent.TEXT_INPUT, textInputCapture); } public function textInputCapture(event:TextEvent):void { var str:String = myTextBox.text; createOutputBox(str); } public function createOutputBox(str:String):void { myOutputBox.background = true; myOutputBox.x = 200; addChild(myOutputBox); myOutputBox.text = str; } } }
La propiedad restrict es algo ms compleja, ya que es necesario especificar qu caracteres puede escribir el usuario en un campo de entrada de texto. Se pueden permitir letras, nmeros o intervalos de letras, nmeros y caracteres especficos. El cdigo siguiente permite al usuario escribir nicamente letras maysculas (y no nmeros ni caracteres especiales) en el campo de texto:
myTextBox.restrict = "A-Z";
ActionScript 3.0 utiliza guiones para definir rangos y caracteres ^ para definir caracteres excluidos. Para obtener ms informacin sobre cmo definir restricciones en un campo de entrada de texto, consulte la entrada sobre la propiedad flash.text.TextField.restrict en la Referencia de ActionScript 3.0.
383
Formato de texto
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior Existen varias opciones para aplicar formato a la visualizacin del texto mediante programacin. Se pueden establecer propiedades directamente en la instancia de TextField; por ejemplo, las propiedades TextFIeld.thickness, TextField.textColor y TextField.textHeight .O bien, se puede designar el contenido del campo de texto mediante la propiedad htmlText y utilizar las etiquetas HTML admitidas, como b, i y u. Pero tambin se pueden aplicar objetos TextFormat a campos de texto que contienen texto sin formato u objetos StyleSheet a campos de texto que contienen la propiedad htmlText . El uso de objetos TextFormat y StyleSheet proporciona el mayor control y la mayor uniformidad de la apariencia del texto en toda la aplicacin. Es posible definir un objeto TextFormat o StyleSheet y aplicarlo a diversos campos de texto de la aplicacin o a todos ellos.
El mtodo TextField.setTextFormat() slo afecta al texto que ya se ha visualizado en el campo de texto. Si cambia el contenido del objeto TextField, la aplicacin tendr que volver a llamar al mtodo TextField.setTextFormat() para aplicar de nuevo el formato. Tambin se puede establecer la propiedad defaultTextFormat de TextField para especificar el formato que se debe utilizar para el texto introducido por el usuario.
384
La clase flash.text.StyleSheet administra estilos CSS. La clase StyleSheet reconoce un conjunto limitado de propiedades CSS. Para ver una lista detallada de propiedades de estilos admitidas por la clase StyleSheet, consulte la entrada de flash.textStylesheet en la Referencia de ActionScript 3.0. Tal y como se indica en el ejemplo siguiente, se pueden crear hojas de estilos CSS en el cdigo y aplicar dichos estilos a texto HTML mediante un objeto StyleSheet:
var style:StyleSheet = new StyleSheet(); var styleObj:Object = new Object(); styleObj.fontSize = "bold"; styleObj.color = "#FF0000"; style.setStyle(".darkRed", styleObj); var tf:TextField = new TextField(); tf.styleSheet = style; tf.htmlText = "<span class = 'darkRed'>Red</span> apple"; addChild(tf);
Tras crear un objeto StyleSheet, el cdigo de ejemplo crea un objeto simple para almacenar un conjunto de propiedades de declaracin de estilos. Posteriormente llama al mtodo StyleSheet.setStyle(), que aade el nuevo estilo a la hoja de estilos con el nombre ".darkred". Por ltimo, aplica el formato de la hoja de estilos asignando el objeto StyleSheet a la propiedad styleSheet. Para que los estilos CSS surtan efecto, la hoja de estilos debe aplicarse al objeto TextField antes de establecer la propiedad htmlText. Nota: por diseo, los campos de texto con hojas de estilos no se pueden editar. Si se dispone de un campo de entrada de texto y se le asigna una hoja de estilos, el campo muestra las propiedades de la hoja de estilos, pero el campo de texto no permitir a los usuarios escribir texto nuevo en l. Asimismo, las siguientes API de ActionScript no se pueden utilizar en un campo de texto con una hoja de estilos asignada:
385
El mtodo StyleSheet.parseCSS() convierte una cadena que contiene datos CSS en declaraciones de estilo del objeto StyleSheet. En el siguiente ejemplo se muestra cmo leer un archivo CSS externo y aplicar sus declaraciones de estilo a un objeto TextField. En primer lugar, ste es el contenido del archivo CSS que se va a cargar, denominado example.css:
p { font-family: Times New Roman, Times, _serif; font-size: 14; } h1 { font-family: Arial, Helvetica, _sans; font-size: 20; font-weight: bold; } .bluetext { color: #0000CC; }
A continuacin se muestra el cdigo ActionScript de una clase que carga el archivo example.css y aplica los estilos al contenido de TextField:
package { import import import import import import import
public class CSSFormattingExample extends Sprite { var loader:URLLoader; var field:TextField; var exampleText:String = "<h1>This is a headline</h1>" + "<p>This is a line of text. <span class='bluetext'>" + "This line of text is colored blue.</span></p>"; public function CSSFormattingExample():void { field = new TextField(); field.width = 300;
386
field.autoSize = TextFieldAutoSize.LEFT; field.wordWrap = true; addChild(field); var req:URLRequest = new URLRequest("example.css"); loader = new URLLoader(); loader.addEventListener(Event.COMPLETE, onCSSFileLoaded); loader.load(req); } public function onCSSFileLoaded(event:Event):void { var sheet:StyleSheet = new StyleSheet(); sheet.parseCSS(loader.data); field.styleSheet = sheet; field.htmlText = exampleText; } } }
Una vez cargados los datos CSS, se ejecuta el mtodo onCSSFileLoaded() y se llama al mtodo StyleSheet.parseCSS() para transferir las declaraciones de estilo al objeto StyleSheet.
387
Los caracteres de las fuentes incorporadas se suavizan, por lo que sus bordes parecen ms lisos, especialmente en
textos grandes.
Se puede girar textos con fuentes incorporadas. El texto de una fuente incorporada se puede convertir en transparente o semitransparente. Se puede utilizar el estilo CSS de kerning (ajuste entre caracteres) con fuentes incorporadas.
La mayor limitacin del uso de fuentes incorporadas es que aumentan el tamao del archivo o el tiempo de descarga de la aplicacin. El mtodo preciso de incorporar un archivo de fuente en el archivo SWF de la aplicacin vara de un entorno de desarrollo a otro. Tras incorporar una fuente, es necesario comprobar que un objeto TextField utiliza la fuente incorporada correcta:
Establezca el valor de la propiedad embedFonts del objeto TextField en true. Cree un objeto TextFormat, establezca su propiedad fontFamily en el nombre de la fuente incorporada y aplique
el objeto TextFormat al objeto TextField. Al especificar una fuente incorporada, la propiedad fontFamily slo debe contener un nico nombre; no se puede utilizar una lista de nombres de fuentes delimitados por comas.
Si se utilizan estilos CSS para definir fuentes de objetos TextField o componentes, hay que establecer la propiedad
CSS font-family en el nombre de la fuente incorporada. Si se desea especificar una fuente incorporada, la propiedad font-familydebe contener un solo nombre, no una lista de nombres. Incorporacin de una fuente en Flash La herramienta de edicin de Flash permite incorporar prcticamente cualquier fuente que est instalada en el sistema, incluidas las fuentes TrueType y las fuentes Postscript de tipo 1. Existen varias formas de incorporar fuentes en una aplicacin, entre las que se incluyen:
Establecer las propiedades de fuente y estilo de un objeto TextField en el escenario y hacer clic en la casilla de
verificacin Fuentes incorporadas.
388
Crear un smbolo de fuente y hacer referencia al mismo. Crear y utilizar una biblioteca compartida en tiempo de ejecucin que contenga smbolos de fuente incorporados.
Para obtener detalles sobre cmo incorporar fuentes en aplicaciones, consulte "Incorporacin de fuentes para campos de texto dinmico o de entrada" en Uso de Flash. Incorporacin de una fuente en Flex Existen varias formas de incorporar fuentes en una aplicacin Flex, entre las que se incluyen:
Utilizar la etiqueta de metadatos [Embed] en un script Uso de la declaracin de estilos @font-face Establezca una clase para la fuente y utilice la etiqueta [Embed] para incorporarla.
En una aplicacin Flex slo se pueden incorporar directamente fuentes TrueType. Las fuentes que estn en otro formato, como las PostScript de tipo 1, se pueden incorporar primero en un archivo SWF de Flash Professional mediante la herramienta de edicin de Flash y, posteriormente, ese archivo SWF se puede usar en la aplicacin Flex. Para obtener ms informacin sobre la utilizacin de fuentes en Flex incorporadas desde archivos SWF, consulte la Gua del desarrollador de Flex 4.
Ms temas de ayuda
Peter deHaan: Embedding fonts (Incorporacin de fuentes; en ingls) Divillysausages.com: AS3 Font embedding masterclass
389
var format:TextFormat = new TextFormat(); format.color = 0x336699; format.size = 48; format.font = "myFont"; var myText:TextField = new TextField(); myText.embedFonts = true; myText.autoSize = TextFieldAutoSize.LEFT; myText.antiAliasType = AntiAliasType.ADVANCED; myText.defaultTextFormat = format; myText.selectable = false; myText.mouseEnabled = true; myText.text = "Hello World"; addChild(myText); myText.addEventListener(MouseEvent.CLICK, clickHandler); function clickHandler(event:Event):void { var myAntiAliasSettings = new CSMSettings(48, 0.8, -0.8); var myAliasTable:Array = new Array(myAntiAliasSettings); TextRenderer.setAdvancedAntiAliasingTable("myFont", FontStyle.ITALIC, TextColorType.DARK_COLOR, myAliasTable); }
390
for (var i = 0; i < this.numChildren; i++) { var displayitem:DisplayObject = this.getChildAt(i); if (displayitem instanceof StaticText) { trace("a static text field is item " + i + " on the display list"); var myFieldLabel:StaticText = StaticText(displayitem); trace("and contains the text: " + myFieldLabel.text); } }
Una vez que se tiene una referencia a un campo de texto esttico, se pueden usar las propiedades de ese campo en ActionScript 3.0. El cdigo siguiente se adjunta a un fotograma de la lnea de tiempo y presupone que una variable denominada myFieldLabel est asignada a una referencia de texto esttico. Un campo de texto dinmico denominado myField se coloca con respecto a los valores x e y de myFieldLabel y vuelve a mostrar el valor de myFieldLabel.
var myField:TextField = new TextField(); addChild(myField); myField.x = myFieldLabel.x; myField.y = myFieldLabel.y + 20; myField.autoSize = TextFieldAutoSize.LEFT; myField.text = "and " + myFieldLabel.text
La clase TextSnapshot resulta til para obtener el texto de campos de texto esttico de un archivo SWF cargado, si se desea utilizar el texto como un valor en otra parte de una aplicacin.
391
Ampliacin de la clase TextField Cargar y aplicar un archivo CSS externo Convertir estilos de CSS en objetos TextFormat Utilizar la clase TextLineMetrics para obtener informacin sobre el tamao de la visualizacin de texto
Para obtener los archivos de la aplicacin para esta muestra, vaya a www.adobe.com/go/learn_programmingAS3samples_flash_es. Los archivos de la aplicacin News Layout se encuentran en la carpeta Samples/NewsLayout. La aplicacin consta de los siguientes archivos:
Archivo NewsLayout.mxml o NewsLayout.fla com/example/programmingas3/ne wslayout/StoryLayoutComponent.a s com/example/programmingas3/ne wslayout/StoryLayout.as com/example/programmingas3/ne wslayout/FormattedTextField.as com/example/programmingas3/ne wslayout/HeadlineTextField.as com/example/programmingas3/ne wslayout/MultiColumnTextField.as story.css Una clase UIComponent de Flex que coloca la instancia de StoryLayout. Descripcin La interfaz de usuario de la aplicacin para Flex (MXML) o Flash (FLA).
La clase principal de ActionScript que dispone todos los componentes de una noticia para mostrarla.
Una subclase de la clase FormattedTextField que ajusta el tamao de las fuentes a una anchura deseada. Una clase de ActionScript que divide el texto en dos o ms columnas.
392
p { font-family: Georgia, "Times New Roman", Times, _serif; font-size: 12; leading: 2; text-align: justify; indent: 24; } h1 { font-family: Verdana, Arial, Helvetica, _sans; font-size: 20; font-weight: bold; color: #000099; text-align: left; } h2 { font-family: Verdana, Arial, Helvetica, _sans; font-size: 16; font-weight: normal; text-align: left; }
La tcnica usada para leer el archivo CSS externo es la misma que la descrita en Carga de un archivo CSS externo en la pgina 384. Cuando el archivo CSS se ha cargado, la aplicacin ejecuta el mtodo onCSSFileLoaded(), tal y como se muestra a continuacin.
public function onCSSFileLoaded(event:Event):void { this.sheet = new StyleSheet(); this.sheet.parseCSS(loader.data); h1Format = getTextStyle("h1", this.sheet); if (h1Format == null) { h1Format = getDefaultHeadFormat(); } h2Format = getTextStyle("h2", this.sheet); if (h2Format == null) { h2Format = getDefaultHeadFormat(); h2Format.size = 16; } pFormat = getTextStyle("p", this.sheet); if (pFormat == null) { pFormat = getDefaultTextFormat(); pFormat.size = 12; } displayText(); }
El mtodo onCSSFileLoaded() crea un objeto StyleSheet y hace que analice los datos CSS de entrada. El texto principal de la historia se muestra en un objeto MultiColumnTextField que puede utilizar un objeto StyleSheet directamente. No obstante, los campos de titular usan la clase HeadlineTextField, que utiliza un objeto TextFormat para su formato.
393
El mtodo onCSSFileLoaded() llama dos veces a getTextStyle() para convertir una declaracin de estilos CSS en un objeto TextFormat para utilizarlo con cada uno de los dos objetos HeadlineTextField.
public function getTextStyle(styleName:String, ss:StyleSheet):TextFormat { var format:TextFormat = null; var style:Object = ss.getStyle(styleName); if (style != null) { var colorStr:String = style.color; if (colorStr != null && colorStr.indexOf("#") == 0) { style.color = colorStr.substr(1); } format = new TextFormat(style.fontFamily, style.fontSize, style.color, (style.fontWeight == "bold"), (style.fontStyle == "italic"), (style.textDecoration == "underline"), style.url, style.target, style.textAlign, style.marginLeft, style.marginRight, style.indent, style.leading); if (style.hasOwnProperty("letterSpacing")) { format.letterSpacing = style.letterSpacing; } } return format; }
Los nombres de propiedad y el significado de los valores de propiedad difieren entre las declaraciones de estilos CSS y los objetos TextFormat. El mtodo getTextStyle() traduce los valores de propiedades CSS en los valores que espera el objeto TextFormat.
394
public function displayText():void { headlineTxt = new HeadlineTextField(h1Format); headlineTxt.wordWrap = true; headlineTxt.x = this.paddingLeft; headlineTxt.y = this.paddingTop; headlineTxt.width = this.preferredWidth; this.addChild(headlineTxt); headlineTxt.fitText(this.headline, 1, true); subtitleTxt = new HeadlineTextField(h2Format); subtitleTxt.wordWrap = true; subtitleTxt.x = this.paddingLeft; subtitleTxt.y = headlineTxt.y + headlineTxt.height; subtitleTxt.width = this.preferredWidth; this.addChild(subtitleTxt); subtitleTxt.fitText(this.subtitle, 2, false); storyTxt = new MultiColumnText(this.numColumns, 20, this.preferredWidth, 400, true, this.pFormat); storyTxt.x = this.paddingLeft; storyTxt.y = subtitleTxt.y + subtitleTxt.height + 10; this.addChild(storyTxt); storyTxt.text = this.content; ...
Cada uno de los campos se coloca bajo el anterior estableciendo su propiedad y en un valor igual al de la propiedad y del campo anterior ms su altura. Este clculo dinmico de la posicin es necesario, ya que los objetos HeadlineTextField y MultiColumnTextField pueden modificar su altura para ajustarla a su contenido.
395
public function fitText(msg:String, maxLines:uint = 1, toUpper:Boolean = false, targetWidth:Number = -1):uint { this.text = toUpper ? msg.toUpperCase() : msg; if (targetWidth == -1) { targetWidth = this.width; } var pixelsPerChar:Number = targetWidth / msg.length; var pointSize:Number = Math.min(MAX_POINT_SIZE, Math.round(pixelsPerChar * 1.8 * maxLines)); if (pointSize < 6) { // the point size is too small return pointSize; } this.changeSize(pointSize); if (this.numLines > maxLines) { return shrinkText(--pointSize, maxLines); } else { return growText(pointSize, maxLines); } } public function growText(pointSize:Number, maxLines:uint = 1):Number { if (pointSize >= MAX_POINT_SIZE) { return pointSize; } this.changeSize(pointSize + 1); if (this.numLines > maxLines) { // set it back to the last size this.changeSize(pointSize); return pointSize; } else { return growText(pointSize + 1, maxLines); }
396
} public function shrinkText(pointSize:Number, maxLines:uint=1):Number { if (pointSize <= MIN_POINT_SIZE) { return pointSize; } this.changeSize(pointSize); if (this.numLines > maxLines) { return shrinkText(pointSize - 1, maxLines); } else { return pointSize; } }
El mtodo HeadlineTextField.fitText() utiliza una tcnica recursiva sencilla para ajustar el tamao de la fuente. En primer lugar calcula un nmero de pxeles por carcter en el texto y con ese dato calcula un tamao de punto inicial. A continuacin cambia el tamao de la fuente y comprueba si el texto se ha ajustado para crear un nmero de lneas de texto superior al mximo. Si hay demasiadas lneas, llama al mtodo shrinkText() para reducir el tamao de fuente y lo intenta de nuevo. Si no hay demasiadas lneas, llama al mtodo growText() para aumentar el tamao de fuente y lo intenta de nuevo. El proceso se detiene en el punto en el que, al aumentar un punto el tamao de fuente, se crearn demasiadas lneas.
Todos los objetos TextField se aaden al conjunto y a la lista de visualizacin con el mtodo addChild().
397
Siempre que cambien las propiedades text o styleSheet del objeto StoryLayout, se llama al mtodo layoutColumns() para volver a mostrar el texto. El mtodo layoutColumns() llama al mtodo getOptimalHeight() method, para calcular la altura en pxeles necesaria para ajustar todo el texto en la anchura de diseo especificada.
public function getOptimalHeight(str:String):int { if (field.text == "" || field.text == null) { return this.preferredHeight; } else { this.linesPerCol = Math.ceil(field.numLines / this.numColumns); var metrics:TextLineMetrics = field.getLineMetrics(0); this.lineHeight = metrics.height; var prefHeight:int = linesPerCol * this.lineHeight; return prefHeight + 4; } }
En primer lugar, el mtodo getOptimalHeight() calcula la anchura de cada columna. Posteriormente se establece la anchura y la propiedad htmlText del primer objeto TextField en el conjunto. El mtodo getOptimalHeight() utiliza ese primer objeto TextField para descubrir el nmero total de lneas ajustadas en el texto y, a partir de ese nmero, determina cuntas lneas debe haber en cada columna. Posteriormente llama al mtodo TextField.getLineMetrics() para recuperar un objeto TextLineMetrics que contiene detalles sobre el tamao del texto en la primera lnea. La propiedad TextLineMetrics.height representa la altura total de una lnea de texto, en pxeles, incluidos los valores ascendente, descendente y de interlineado. La altura ptima para el objeto MultiColumnTextField es la altura de lnea multiplicada por el nmero de lneas por columna, ms 4 para tener en cuenta el borde de dos pxeles que hay por encima y por debajo de un objeto TextField. A continuacin se muestra el cdigo del mtodo layoutColumns():
public function layoutColumns():void { if (this._text == "" || this._text == null) { return; } var field:TextField = fieldArray[0] as TextField; field.text = this._text; field.setTextFormat(this.format); this.preferredHeight = this.getOptimalHeight(field); var remainder:String = this._text; var fieldText:String = ""; var lastLineEndedPara:Boolean = true; var indent:Number = this.format.indent as Number; for (var i:int = 0; i < fieldArray.length; i++) {
398
field = this.fieldArray[i] as TextField; field.height = this.preferredHeight; field.text = remainder; field.setTextFormat(this.format); var lineLen:int; if (indent > 0 && !lastLineEndedPara && field.numLines > 0) { lineLen = field.getLineLength(0); if (lineLen > 0) { field.setTextFormat(this.firstLineFormat, 0, lineLen); } } field.x = i * (colWidth + gutter); field.y = 0; remainder = ""; fieldText = ""; var linesRemaining:int = field.numLines; var linesVisible:int = Math.min(this.linesPerCol, linesRemaining); for (var j:int = 0; j < linesRemaining; j++) { if (j < linesVisible) { fieldText += field.getLineText(j); } else { remainder +=field.getLineText(j); } } field.text = fieldText; field.setTextFormat(this.format); if (indent > 0 && !lastLineEndedPara) { lineLen = field.getLineLength(0); if (lineLen > 0) { field.setTextFormat(this.firstLineFormat, 0, lineLen); } } var lastLine:String = field.getLineText(field.numLines - 1); var lastCharCode:Number = lastLine.charCodeAt(lastLine.length - 1);
399
if (lastCharCode == 10 || lastCharCode == 13) { lastLineEndedPara = true; } else { lastLineEndedPara = false; } if ((this.format.align == TextFormatAlign.JUSTIFY) && (i < fieldArray.length - 1)) { if (!lastLineEndedPara) { justifyLastLine(field, lastLine); } } } }
Una vez establecida la propiedad preferredHeight al llamar al mtodo getOptimalHeight(), el mtodo layoutColumns() recorre los objetos TextField y establece la altura de cada uno de ellos en el valor de preferredHeight. Posteriormente el mtodo layoutColumns() distribuye a cada campo las lneas de texto suficientes para que no se produzca desplazamiento en ningn campo y el texto de cada campo empiece donde acab el texto del campo anterior. Si el estilo de alineacin del texto est establecido en "justify" (justificado), se llama al mtodo justifyLastLine() para justificar la ltima lnea del texto de un campo. De lo contrario, esa ltima lnea se tratar como una lnea de final de prrafo y no se justificar.
400
Ms temas de ayuda
Paquete flash.text.engine
TextElement/GraphicElement/GroupElement: incluyen el contenido de una instancia de TextBlock. ElementFormat: especifica los atributos de formato para el contenido de una instancia de TextBlock. TextBlock - componente fundamental para crear un prrafo de texto. TextLine: una lnea de texto creada a partir de TextBlock
Para mostrar el texto, cree un objeto TextElement a partir de una cadena y usando un objeto ElementFormat para especificar las caractersticas de formato. Asigne TextElement a la propiedad content de un objeto TextBlock. Las lneas de texto que se van a mostrar se crean llamando al mtodo TextBlock.createTextLine(). El mtodo createTextLine() devuelve un objeto TextLine que contiene parte de la cadena que se ajustar en la anchura especificada. Llame al mtodo varias veces hasta que a toda la cadena se le haya aplicado el formato en lneas. Cuando no haya ms lneas que crear, a la propiedad textLineCreationResult del objeto se le asigna el valor: TextLineCreationResult.COMPLETE. Para mostrar las lneas, adalas a la lista de visualizacin (con los valores de posicin x e y apropiados). Por ejemplo, el cdigo siguiente utiliza estas clases de FTE para mostrar el texto "Hello World! This is Flash Text Engine!", usando el formato y los valores de fuente predeterminados. En este sencillo ejemplo, nicamente se crea una sola lnea de texto.
401
package { import flash.text.engine.*; import flash.display.Sprite; public class HelloWorldExample extends Sprite { public function HelloWorldExample() { var str = "Hello World! This is Flash Text Engine!"; var format:ElementFormat = new ElementFormat(); var textElement:TextElement = new TextElement(str, format); var textBlock:TextBlock = new TextBlock(); textBlock.content = textElement; var textLine1:TextLine = textBlock.createTextLine(null, 300); addChild(textLine1); textLine1.x = 30; textLine1.y = 30; } } }
Los parmetros para createTextLine() especifican la lnea a partir de la que comienza la nueva lnea y su anchura en pxeles. La lnea a partir de la que comienza la nueva lnea suele ser la anterior pero, en caso de que sea la primera lnea, es null.
402
public class GraphicElementExample extends Sprite { public function GraphicElementExample() { var str:String = "Beware of Dog!"; var triangle:Shape = new Shape(); triangle.graphics.beginFill(0xFF0000, 1); triangle.graphics.lineStyle(3); triangle.graphics.moveTo(30, 0); triangle.graphics.lineTo(60, 50); triangle.graphics.lineTo(0, 50); triangle.graphics.lineTo(30, 0); triangle.graphics.endFill(); var format:ElementFormat = new ElementFormat(); format.fontSize = 20; var graphicElement:GraphicElement = new GraphicElement(triangle, triangle.width, triangle.height, format); var textBlock:TextBlock = new TextBlock(); textBlock.content = graphicElement; var textLine1:TextLine = textBlock.createTextLine(null, triangle.width); textLine1.x = 50; textLine1.y = 110; addChild(textLine1); var textElement:TextElement = new TextElement(str, format); textBlock.content = textElement; var textLine2 = textBlock.createTextLine(null, 300); addChild(textLine2); textLine2.x = textLine1.x - 30; textLine2.y = textLine1.y + 15; } } }
Se puede crear un objeto GroupElement para crear un grupo de objetos TextElement, GraphicElement y otros objetos de tipo GroupElement. GroupElement se puede asignar a la propiedad content de un objeto TextBlock. El parmetro pasado al constructor GroupElement() es un Vector, que apunta a los elementos de texto, grficos y grupo que conforman el grupo. El ejemplo siguiente agrupa dos elementos grficos y un elemento de texto y los asigna como una unidad a un bloque de texto.
403
public class GroupElementExample extends Sprite { public function GroupElementExample() { var str:String = "Beware of Alligators!"; var triangle1:Shape = new Shape(); triangle1.graphics.beginFill(0xFF0000, 1); triangle1.graphics.lineStyle(3); triangle1.graphics.moveTo(30, 0); triangle1.graphics.lineTo(60, 50); triangle1.graphics.lineTo(0, 50); triangle1.graphics.lineTo(30, 0); triangle1.graphics.endFill(); var triangle2:Shape = new Shape(); triangle2.graphics.beginFill(0xFF0000, 1); triangle2.graphics.lineStyle(3); triangle2.graphics.moveTo(30, 0); triangle2.graphics.lineTo(60, 50); triangle2.graphics.lineTo(0, 50); triangle2.graphics.lineTo(30, 0); triangle2.graphics.endFill(); var format:ElementFormat = new ElementFormat(); format.fontSize = 20; var graphicElement1:GraphicElement = new GraphicElement(triangle1, triangle1.width, triangle1.height, format); var textElement:TextElement = new TextElement(str, format); var graphicElement2:GraphicElement = new GraphicElement(triangle2, triangle2.width, triangle2.height, format); var groupVector:Vector.<ContentElement> = new Vector.<ContentElement>(); groupVector.push(graphicElement1, textElement, graphicElement2); var groupElement = new GroupElement(groupVector); var textBlock:TextBlock = new TextBlock(); textBlock.content = groupElement; var textLine:TextLine = textBlock.createTextLine(null, 800); addChild(textLine); textLine.x = 100; textLine.y = 200; } } }
404
Reemplazo de texto
Flash Player 10 y posterior, Adobe AIR 1.5 y posterior Se puede reemplazar texto en una instancia de TextBlock llamando a TextElement.replaceText() para reemplazar el texto del elemento TextElement que asign a la propiedad TextBlock.content. En el ejemplo siguiente se utiliza repaceText() para insertar texto al principio de la lnea, aadir texto al final de la lnea y reemplazar texto en medio de la lnea.
package { import flash.text.engine.*; import flash.display.Sprite; public class ReplaceTextExample extends Sprite { public function ReplaceTextExample() { var str:String = "Lorem ipsum dolor sit amet"; var fontDescription:FontDescription = new FontDescription("Arial"); var format:ElementFormat = new ElementFormat(fontDescription); format.fontSize = 14; var textElement:TextElement = new TextElement(str, format); var textBlock:TextBlock = new TextBlock(); textBlock.content = textElement; createLine(textBlock, 10); textElement.replaceText(0, 0, "A text fragment: "); createLine(textBlock, 30); textElement.replaceText(43, 43, "..."); createLine(textBlock, 50); textElement.replaceText(23, 28, "(ipsum)"); createLine(textBlock, 70); } function createLine(textBlock:TextBlock, y:Number):void { var textLine:TextLine = textBlock.createTextLine(null, 300); textLine.x = 10; textLine.y = y; addChild(textLine); } } }
El mtodo replaceText() reemplaza el texto especificado por los parmetros beginIndex y endIndex con el texto que especifica el parmetro newText. Si los valores de los parmetros beginIndex y endIndex son los mismos, replaceText() inserta el texto especificado en esa ubicacin. De lo contrario, reemplaza los caracteres especificados mediante beginIndex y endIndex con el nuevo texto.
405
public class EventHandlerExample extends Sprite { var textBlock:TextBlock = new TextBlock(); public function EventHandlerExample():void { var str:String = "I'll change color if you click me."; var fontDescription:FontDescription = new FontDescription("Arial"); var format:ElementFormat = new ElementFormat(fontDescription, 18); var textElement = new TextElement(str, format); textBlock.content = textElement; createLine(textBlock); } private function createLine(textBlock:TextBlock):void { var textLine:TextLine = textBlock.createTextLine(null, 500); textLine.x = 30; textLine.y = 30; addChild(textLine); textLine.addEventListener("mouseOut", mouseOutHandler); textLine.addEventListener("mouseOver", mouseOverHandler); textLine.addEventListener("click", clickHandler); } private function mouseOverHandler(event:MouseEvent):void { Mouse.cursor = "button"; } private function mouseOutHandler(event:MouseEvent):void { Mouse.cursor = "arrow"; } function clickHandler(event:MouseEvent):void { if(textBlock.firstLine) removeChild(textBlock.firstLine);
406
var newFormat:ElementFormat = textBlock.content.elementFormat.clone(); switch(newFormat.color) { case 0x000000: newFormat.color = 0xFF0000; break; case 0xFF0000: newFormat.color = 0x00FF00; break; case 0x00FF00: newFormat.color = 0x0000FF; break; case 0x0000FF: newFormat.color = 0x000000; break; } textBlock.content.elementFormat = newFormat; createLine(textBlock); } } }
Reflejo de eventos
Flash Player 10 y posterior, Adobe AIR 1.5 y posterior Tambin se pueden reflejar los eventos de un bloque de texto, o de una parte de un bloque de texto, en un distribuidor de eventos. En primer lugar, se crea una instancia de EventDispatcher y se asigna a la propiedad eventMirror de una instancia de TextElement. Si el bloque de texto consta de un solo elemento de texto, el motor de texto refleja los eventos de todo el bloque. Si el bloque de texto est formado por varios elementos de texto, el motor de texto slo refleja los eventos de las instancias de TextElement que tienen establecida la propiedad eventMirror. El texto del siguiente ejemplo consta de tres elementos: la palabra "Click", la palabra "here" y la cadena "to see me in italic". El ejemplo asigna un distribuidor de eventos al segundo elemento de texto, la palabra "here", y aade un detector de eventos, el mtodo clickHandler(). El mtodo clickHandler() aplica al texto formato de cursiva. Asimismo, reemplaza el contenido del tercer elemento de texto para que se lea, "Click here to see me in normal font!".
407
public class EventMirrorExample extends Sprite { var fontDescription:FontDescription = new FontDescription("Helvetica", "bold"); var format:ElementFormat = new ElementFormat(fontDescription, 18); var textElement1 = new TextElement("Click ", format); var textElement2 = new TextElement("here ", format); var textElement3 = new TextElement("to see me in italic! ", format); var textBlock:TextBlock = new TextBlock(); public function EventMirrorExample() { var myEvent:EventDispatcher = new EventDispatcher(); myEvent.addEventListener("click", clickHandler); myEvent.addEventListener("mouseOut", mouseOutHandler); myEvent.addEventListener("mouseOver", mouseOverHandler); textElement2.eventMirror=myEvent; var groupVector:Vector.<ContentElement> = new Vector.<ContentElement>; groupVector.push(textElement1, textElement2, textElement3); var groupElement:GroupElement = new GroupElement(groupVector); textBlock.content = groupElement; createLines(textBlock); } private function clickHandler(event:MouseEvent):void { var newFont:FontDescription = new FontDescription(); newFont.fontWeight = "bold"; var newFormat:ElementFormat = new ElementFormat(); newFormat.fontSize = 18; if(textElement3.text == "to see me in italic! ") { newFont.fontPosture = FontPosture.ITALIC; textElement3.replaceText(0,21, "to see me in normal font! "); } else { newFont.fontPosture = FontPosture.NORMAL; textElement3.replaceText(0, 26, "to see me in italic! "); } newFormat.fontDescription = newFont; textElement1.elementFormat = newFormat; textElement2.elementFormat = newFormat; textElement3.elementFormat = newFormat; createLines(textBlock); }
408
private function mouseOverHandler(event:MouseEvent):void { Mouse.cursor = "button"; } private function mouseOutHandler(event:MouseEvent):void { Mouse.cursor = "arrow"; } private function createLines(textBlock:TextBlock):void { if(textBlock.firstLine) removeChild (textBlock.firstLine); var textLine:TextLine = textBlock.createTextLine (null, 300); textLine.x = 15; textLine.y = 20; addChild (textLine); } } }
Las funciones mouseOverHandler() y mouseOutHandler() cambian el cursor a un cursor de botn cuando se encuentra sobre la palabra "here" y le devuelven la forma de flecha cuando no lo est.
Formato de texto
Flash Player 10 y posterior, Adobe AIR 1.5 y posterior A TextBlock es la base para crear lneas de texto. El contenido de TextBlock se asigna a travs del objeto TextElement. Un objeto ElementFormat controla el formato del texto. La clase ElementFormat define propiedades como la alineacin de la lnea de base, el ajuste y espaciado entre caracteres, la rotacin de texto y el tamao, el color y el formato de maysculas de la fuente. Tambin incluye un elemento FontDescription, que se analiza detalladamente en Trabajo con fuentes en la pgina 413.
409
package { import flash.display.Sprite; import flash.text.*; public class ElementFormatExample extends Sprite { private var tb:TextBlock = new TextBlock(); private var te:TextElement; private var ef:ElementFormat; private var fd:FontDescription = new FontDescription(); private var str:String; private var tl:TextLine; public function ElementFormatExample() { fd.fontName = "Garamond"; ef = new ElementFormat(fd); ef.fontSize = 30; ef.color = 0xFF0000; str = "This is flash text"; te = new TextElement(str, ef); tb.content = te; tl = tb.createTextLine(null,600); addChild(tl); } } }
410
En el objeto ElementFormat las caractersticas de lnea de base y alineacin se definen mediante tres propiedades. La propiedad alignmentBaseline establece la lnea de base principal de un objeto TextElement o GraphicElement. Esta lnea de base es la lnea "de ajuste" para el elemento y respecto a su posicin se alinea la lnea de base dominante de todo el texto. La propiedad dominantBaseline especifica cul de las distintas lneas de base del elemento se debe usar, lo que determina la posicin vertical del elemento en la lnea. El valor predeterminado es TextBaseline.ROMAN, pero tambin se pueden establecer como dominantes las lneas de base IDEOGRAPHIC_TOP o IDEOGRAPHIC_BOTTOM. La propiedad baselineShift desplaza la lnea de base un nmero determinado de pxeles a lo largo del eje y. En el caso de texto normal (no rotado), un valor positivo desplaza la lnea de base hacia abajo, mientras que un valor negativo lo hace hacia arriba.
411
Constante AUTO
Valor auto
Descripcin Especifica una rotacin de 90 grados en sentido contrario a las agujas del reloj. Se utiliza normalmente con textos asiticos, para rotar nicamente los pictogramas que necesitan rotarse. No especifica ninguna rotacin. Especifica una rotacin de 180 grados. Especifica una rotacin de 270 grados. Especifica una rotacin de 90 grados en sentido horario.
Para rotar las lneas de texto de un bloque de texto, establezca la propiedad TextBlock.lineRotation antes de llamar al mtodo TextBlock.createTextLine() para crear la lnea de texto. Para rotar los pictogramas incluidos en un bloque de texto o un segmento, establezca la propiedad ElementFormat.textRotation en el nmero de grados que desea girar los pictogramas. Un pictograma es la forma que constituye un carcter o una parte de un carcter que consta de varios pictogramas. Por ejemplo, la letra a y el punto de la i son pictogramas. Rotar pictogramas es relevante en algunos idiomas asiticos en los que puede ser necesario rotar las lneas hasta el sentido vertical, pero no los caracteres incluidos en las lneas. Para obtener informacin sobre la rotacin de texto en idiomas asiticos, consulte Justificacin de texto asitico en la pgina 417. A continuacin se muestra un ejemplo de rotacin tanto de un bloque de texto como de los pictogramas que incluye, tal y como se llevar a cabo con textos asiticos. El ejemplo tambin utiliza una fuente japonesa:
package { import flash.display.Sprite; import flash.text.*; public class RotationExample extends Sprite { private var tb:TextBlock = new TextBlock(); private var te:TextElement; private var ef:ElementFormat; private var fd:FontDescription = new FontDescription(); private var str:String; private var tl:TextLine; public function RotationExample() { fd.fontName = "MS Mincho"; ef = new ElementFormat(fd); ef.textRotation = TextRotation.AUTO; str = "This is rotated Japanese text"; te = new TextElement(str, ef); tb.lineRotation = TextRotation.ROTATE_90; tb.content = te; tl = tb.createTextLine(null,600); addChild(tl); } } }
412
413
414
415
package { import flash.display.Sprite; import flash.text.*; public class FontDescriptionCloneExample extends Sprite { private var tb:TextBlock = new TextBlock(); private var te:TextElement; private var ef1:ElementFormat; private var ef2:ElementFormat; private var fd1:FontDescription = new FontDescription(); private var fd2:FontDescription; public function FontDescriptionCloneExample() { fd1.fontName = "Garamond"; ef1 = new ElementFormat(fd); var str:String = "This is flash text"; te = new TextElement(str, ef); tb.content = te; var tx1:TextLine = tb.createTextLine(null,600); addChild(tx1); fd2 = (fd1.locked) ? fd1.clone() : fd1; fd2.fontName = "Arial"; ef2 = (ef1.locked) ? ef1.clone() : ef1; ef2.fontDescription = fd2; tb.content.elementFormat = ef2; var tx2:TextLine = tb.createTextLine(null,600); addChild(tx2); } } }
416
La propiedad lineJustfication de la clase SpaceJustifier permite controlar la justificacin de las lneas de un bloque de texto. La clase LineJustification define constantes que se pueden usar para especificar una opcin de justificacin: ALL_BUT_LAST justifica todas las lneas de texto excepto la ltima; ALL_INCLUDING_LAST justifica todo el texto, incluyendo la ltima lnea; UNJUSTIFIED, que es el valor predeterminado, deja el texto sin justificar. Para justificar texto, establezca la propiedad lineJustification en una instancia de la clase SpaceJustifier y asigne dicha instancia a la propiedad textJustifier de una instancia de TextBlock. En el ejemplo siguiente se crea un prrafo en el que todas las lneas de texto estn justificadas, excepto la ltima.
package { import flash.text.engine.*; import flash.display.Sprite; public class JustifyExample extends Sprite { public function JustifyExample() { var str:String = "Lorem ipsum dolor sit amet, consectetur adipisicing elit, " + "sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut " + "enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut " + "aliquip ex ea commodo consequat."; var format:ElementFormat = new ElementFormat(); var textElement:TextElement=new TextElement(str,format); var spaceJustifier:SpaceJustifier=new SpaceJustifier("en",LineJustification.ALL_BUT_LAST); var textBlock:TextBlock = new TextBlock(); textBlock.content=textElement; textBlock.textJustifier=spaceJustifier; createLines(textBlock); } private function createLines(textBlock:TextBlock):void { var yPos=20; var textLine:TextLine=textBlock.createTextLine(null,150); while (textLine) { addChild(textLine); textLine.x=15; yPos+=textLine.textHeight+2; textLine.y=yPos; textLine=textBlock.createTextLine(textLine,150); } } } }
Para modificar el espaciado entre las letras y entre las palabras, la propiedad SpaceJustifier.letterspacing se establece entrue. Activando el espaciado entre las letras se puede reducir la aparicin de antiestticos espacios entre las palabras, lo que a veces ocurre con la justificacin simple.
417
lado cuando se rota la lnea. El valor AUTO rota 90 grados en sentido contrario al de las agujas del reloj slo los pictogramas de anchura completa y los anchos, segn lo determinen las propiedades Unicode del pictograma. El ejemplo siguiente muestra un bloque vertical de texto en japons y lo justifica utilizando la opcin PUSH_IN_KINSOKU.
package { import import import import
public class EastAsianJustifyExample extends Sprite { public function EastAsianJustifyExample() { var Japanese_txt:String = String.fromCharCode( 0x5185, 0x95A3, 0x5E9C, 0x304C, 0x300C, 0x653F, 0x5E9C, 0x30A4, 0x30F3, 0x30BF, 0x30FC, 0x30CD, 0x30C3, 0x30C8, 0x30C6, 0x30EC, 0x30D3, 0x300D, 0x306E, 0x52D5, 0x753B, 0x914D, 0x4FE1, 0x5411, 0x3051, 0x306B, 0x30A2, 0x30C9, 0x30D3, 0x30B7, 0x30B9, 0x30C6, 0x30E0, 0x30BA, 0x793E, 0x306E) var textBlock:TextBlock = new TextBlock(); var font:FontDescription = new FontDescription(); var format:ElementFormat = new ElementFormat(); format.fontSize = 12; format.color = 0xCC0000; format.textRotation = TextRotation.AUTO; textBlock.baselineZero = TextBaseline.IDEOGRAPHIC_CENTER; var eastAsianJustifier:EastAsianJustifier = new EastAsianJustifier("ja", LineJustification.ALL_BUT_LAST); eastAsianJustifier.justificationStyle = JustificationStyle.PUSH_IN_KINSOKU; textBlock.textJustifier = eastAsianJustifier; textBlock.lineRotation = TextRotation.ROTATE_90; var linePosition:Number = this.stage.stageWidth - 75; if (Capabilities.os.search("Mac OS") > -1) // set fontName: Kozuka Mincho Pro R
418
font.fontName = String.fromCharCode(0x5C0F, 0x585A, 0x660E, 0x671D) + " Pro R"; else font.fontName = "Kozuka Mincho Pro R"; textBlock.content = new TextElement(Japanese_txt, format); var previousLine:TextLine = null; while (true) { var textLine:TextLine = textBlock.createTextLine(previousLine, 200); if (textLine == null) break; textLine.y = 20; textLine.x = linePosition; linePosition -= 25; addChild(textLine); previousLine = textLine; } } } }
VAY VAY VY A
A. Kerning.OFF B. TrackingRight=5, Kerning.OFF C. TrackingRight=-5, Kerning.OFF D. Kerning.ON E. TrackingRight=-5, Kerning.ON F. TrackingRight=-5, Kerning.ON
419
var ef1:ElementFormat = new ElementFormat(); ef1.kerning = Kerning.OFF; var ef2:ElementFormat = new ElementFormat(); ef2.kerning = Kerning.ON; ef2.trackingLeft = 0.8; ef2.trackingRight = 0.8; var ef3:ElementFormat = new ElementFormat(); ef3.trackingRight = -0.2;
Tabulaciones
Flash Player 10 y posterior, Adobe AIR 1.5 y posterior Para establecer tabulaciones en un bloque de texto, dichas tabulaciones se definen creando instancias de la clase TabStop. Los parmetros pasados al constructor TabStop() especifican cmo se alinea el texto con respecto a la tabulacin. Estos parmetros especifican la posicin de la tabulacin y, para la alineacin decimal, el valor respecto al que realizarla, expresado como una cadena. Normalmente, este valor es un punto decimal, pero tambin podr ser una coma, un smbolo de dlar o el smbolo del yen o el euro, por ejemplo. La siguiente lnea de cdigo crea una tabulacin denominada tab1.
var tab1:TabStop = new TabStop(TabAlignment.DECIMAL, 50, ".");
Una vez creadas las tabulaciones para un bloque de texto, se asignan a la propiedad tabStops de una instancia de TextBlock. Debido a que la propiedad tabStops requiere un vector, primero debe crearse un vector y despus aadirle las tabulaciones. El vector permite asignarle un juego de tabulaciones al bloque de texto. En el siguiente ejemplo se crea una instancia de Vector<TabStop> y se aade un conjunto de objetos TabStop. A continuacin se asignan las tabulaciones a la propiedad tabStops de una instancia de TextBlock.
var tabStops:Vector.<TabStop> = new Vector.<TabStop>(); tabStops.push(tab1, tab2, tab3, tab4); textBlock.tabStops = tabStops
Para obtener ms informacin sobre los vectores, consulte Trabajo con conjuntos en la pgina 25. El ejemplo siguiente muestra los efectos que se obtienen con las distintas opciones de alineacin de TabStop.
420
package { import flash.text.engine.*; import flash.display.Sprite; public class TabStopExample extends Sprite { public function TabStopExample() { var format:ElementFormat = new ElementFormat(); format.fontDescription = new FontDescription("Arial"); format.fontSize = 16; var tabStops:Vector.<TabStop> = new Vector.<TabStop>(); tabStops.push( new TabStop(TabAlignment.START, 20), new TabStop(TabAlignment.CENTER, 140), new TabStop(TabAlignment.DECIMAL, 260, "."), new TabStop(TabAlignment.END, 380)); var textBlock:TextBlock = new TextBlock(); textBlock.content = new TextElement( "\tt1\tt2\tt3\tt4\n" + "\tThis line aligns on 1st tab\n" + "\t\t\t\tThis is the end\n" + "\tThe following fragment centers on the 2nd tab:\t\t\n" + "\t\tit's on me\t\t\n" + "\tThe following amounts align on the decimal point:\n" + "\t\t\t45.00\t\n" + "\t\t\t75,320.00\t\n" + "\t\t\t6,950.00\t\n" + "\t\t\t7.01\t\n", format); textBlock.tabStops = tabStops; var yPosition:Number = 60; var previousTextLine:TextLine = null; var textLine:TextLine; var i:int; for (i = 0; i < 10; i++) { textLine = textBlock.createTextLine(previousTextLine, 1000, 0); textLine.x = 20; textLine.y = yPosition; addChild(textLine); yPosition += 25; previousTextLine = textLine; } } } }
421
StoryLayout.as es el script del controlador de este ejemplo. Establece el contenido, lee la informacin de estilo de una hoja de estilos externa y asigna estos estilos a objetos ElementFormat. Posteriormente crea el titular, el subttulo y los elementos de texto de varias columnas.
package com.example.programmingas3.newslayout { import flash.display.Sprite; import flash.text.StyleSheet; import flash.text.engine.*; import import import import import flash.events.Event; flash.net.URLRequest; flash.net.URLLoader; flash.display.Sprite; flash.display.Graphics;
public class StoryLayout extends Sprite { public var headlineTxt:HeadlineTextField; public var subtitleTxt:HeadlineTextField; public var storyTxt:MultiColumnText; public var sheet:StyleSheet; public var h1_ElFormat:ElementFormat; public var h2_ElFormat:ElementFormat; public var p_ElFormat:ElementFormat; private var loader:URLLoader; public public public public var var var var paddingLeft:Number; paddingRight:Number; paddingTop:Number; paddingBottom:Number;
public var preferredWidth:Number; public var preferredHeight:Number; public var numColumns:int; public var bgColor:Number = 0xFFFFFF;
422
public var headline:String = "News Layout Example"; public var subtitle:String = "This example formats text like a newspaper page using the Flash Text Engine API. "; public var rawTestData:String = "From the part Mr. Burke took in the American Revolution, it was natural that I should consider him a friend to mankind; and as our acquaintance commenced on that ground, it would have been more agreeable to me to have had cause to continue in that opinion than to change it. " + "At the time Mr. Burke made his violent speech last winter in the English Parliament against the French Revolution and the National Assembly, I was in Paris, and had written to him but a short time before to inform him how prosperously matters were going on. Soon after this I saw his advertisement of the Pamphlet he intended to publish: As the attack was to be made in a language but little studied, and less understood in France, and as everything suffers by translation, I promised some of the friends of the Revolution in that country that whenever Mr. Burke's Pamphlet came forth, I would answer it. This appeared to me the more necessary to be done, when I saw the flagrant misrepresentations which Mr. Burke's Pamphlet contains; and that while it is an outrageous abuse on the French Revolution, and the principles of Liberty, it is an imposition on the rest of the world. " + "I am the more astonished and disappointed at this conduct in Mr. Burke, as (from the circumstances I am going to mention) I had formed other expectations. " + "I had seen enough of the miseries of war, to wish it might never more have existence in the world, and that some other mode might be found out to settle the differences that should occasionally arise in the neighbourhood of nations. This certainly might be done if Courts were disposed to set honesty about it, or if countries were enlightened enough not to be made the dupes of Courts. The people of America had been bred up in the same prejudices against France, which at that time characterised the people of England; but experience and an acquaintance with the French Nation have most effectually shown to the Americans the falsehood of those prejudices; and I do not believe that a more cordial and confidential intercourse exists between any two countries than between America and France. "; public function StoryLayout(w:int = 400, h:int = 200, cols:int = 3, padding:int = 10):void { this.preferredWidth = w; this.preferredHeight = h; this.numColumns = cols; this.paddingLeft = padding; this.paddingRight = padding; this.paddingTop = padding; this.paddingBottom = padding; var req:URLRequest = new URLRequest("story.css"); loader = new URLLoader(); loader.addEventListener(Event.COMPLETE, onCSSFileLoaded); loader.load(req); } public function onCSSFileLoaded(event:Event):void { this.sheet = new StyleSheet(); this.sheet.parseCSS(loader.data); // convert headline styles to ElementFormat objects h1_ElFormat = getElFormat("h1", this.sheet);
423
h1_ElFormat.typographicCase = TypographicCase.UPPERCASE; h2_ElFormat = getElFormat("h2", this.sheet); p_ElFormat = getElFormat("p", this.sheet); displayText(); } public function drawBackground():void { var h:Number = this.storyTxt.y + this.storyTxt.height + this.paddingTop + this.paddingBottom; var g:Graphics = this.graphics; g.beginFill(this.bgColor); g.drawRect(0, 0, this.width + this.paddingRight + this.paddingLeft, h); g.endFill(); } /** * Reads a set of style properties for a named style and then creates * a TextFormat object that uses the same properties. */ public function getElFormat(styleName:String, ss:StyleSheet):ElementFormat { var style:Object = ss.getStyle(styleName); if (style != null) { var colorStr:String = style.color; if (colorStr != null && colorStr.indexOf("#") == 0) { style.color = colorStr.substr(1); } var fd:FontDescription = new FontDescription( style.fontFamily, style.fontWeight, FontPosture.NORMAL, FontLookup.DEVICE, RenderingMode.NORMAL, CFFHinting.NONE); var format:ElementFormat = new ElementFormat(fd, style.fontSize, style.color, 1, TextRotation.AUTO, TextBaseline.ROMAN, TextBaseline.USE_DOMINANT_BASELINE, 0.0, Kerning.ON, 0.0, 0.0, "en", BreakOpportunity.AUTO, DigitCase.DEFAULT, DigitWidth.DEFAULT, LigatureLevel.NONE, TypographicCase.DEFAULT); if (style.hasOwnProperty("letterSpacing")) {
424
format.trackingRight = style.letterSpacing; } } return format; } public function displayText():void { headlineTxt = new HeadlineTextField(h1_ElFormat,headline,this.preferredWidth); headlineTxt.x = this.paddingLeft; headlineTxt.y = 40 + this.paddingTop; headlineTxt.fitText(1); this.addChild(headlineTxt); subtitleTxt = new HeadlineTextField(h2_ElFormat,subtitle,this.preferredWidth); subtitleTxt.x = this.paddingLeft; subtitleTxt.y = headlineTxt.y + headlineTxt.height; subtitleTxt.fitText(2); this.addChild(subtitleTxt); storyTxt = new MultiColumnText(rawTestData, this.numColumns, 20, this.preferredWidth, this.preferredHeight, p_ElFormat); storyTxt.x = this.paddingLeft; storyTxt.y = subtitleTxt.y + subtitleTxt.height + 10; this.addChild(storyTxt); drawBackground(); } } }
FormattedTextBlock.as se emplea como clase base para la creacin de bloques de texto. Tambin incluye funciones de utilidad para cambiar el tamao de fuente y las maysculas o minsculas.
package com.example.programmingas3.newslayout { import flash.text.engine.*; import flash.display.Sprite; public class FormattedTextBlock extends Sprite { public var tb:TextBlock; private var te:TextElement; private var ef1:ElementFormat; private var textWidth:int; public var totalTextLines:int; public var blockText:String; public var leading:Number = 1.25; public var preferredWidth:Number = 720; public var preferredHeight:Number = 100; public function FormattedTextBlock(ef:ElementFormat,txt:String, colW:int = 0) { this.textWidth = (colW==0) ? preferredWidth : colW; blockText = txt; ef1 = ef; tb = new TextBlock();
425
tb.textJustifier = new SpaceJustifier("en",LineJustification.UNJUSTIFIED,false); te = new TextElement(blockText,this.ef1); tb.content = te; this.breakLines(); } private function breakLines() { var textLine:TextLine = null; var y:Number = 0; var lineNum:int = 0; while (textLine = tb.createTextLine(textLine,this.textWidth,0,true)) { textLine.x = 0; textLine.y = y; y += this.leading*textLine.height; this.addChild(textLine); } for (var i:int = 0; i < this.numChildren; i++) { TextLine(this.getChildAt(i)).validity = TextLineValidity.STATIC; } this.totalTextLines = this.numChildren; } private function rebreakLines() { this.clearLines(); this.breakLines(); } private function clearLines() { while(this.numChildren) { this.removeChildAt(0); } }
426
public function changeSize(size:uint=12):void { if (size > 5) { var ef2:ElementFormat = ef1.clone(); ef2.fontSize = size; te.elementFormat = ef2; this.rebreakLines(); } } public function changeCase(newCase:String = "default"):void { var ef2:ElementFormat = ef1.clone(); ef2.typographicCase = newCase; te.elementFormat = ef2; } } }
HeadlineTextBlock.as ampla la clase FormattedTextBlock y se utiliza para crear titulares. Incluye una funcin para ajustar texto con un espacio definido en la pgina.
package com.example.programmingas3.newslayout { import flash.text.engine.*; public class HeadlineTextField extends FormattedTextBlock { public static var MIN_POINT_SIZE:uint = 6; public static var MAX_POINT_SIZE:uint = 128; public function HeadlineTextField(te:ElementFormat,txt:String,colW:int = 0) { super(te,txt); } public function fitText(maxLines:uint = 1, targetWidth:Number = -1):uint { if (targetWidth == -1) { targetWidth = this.width; } var pixelsPerChar:Number = targetWidth / this.blockText.length; var pointSize:Number = Math.min(MAX_POINT_SIZE, Math.round(pixelsPerChar * 1.8 * maxLines)); if (pointSize < 6) { // the point size is too small return pointSize; } this.changeSize(pointSize); if (this.totalTextLines > maxLines)
427
{ return shrinkText(--pointSize, maxLines); } else { return growText(pointSize, maxLines); } } public function growText(pointSize:Number, maxLines:uint = 1):Number { if (pointSize >= MAX_POINT_SIZE) { return pointSize; } this.changeSize(pointSize + 1); if (this.totalTextLines > maxLines) { // set it back to the last size this.changeSize(pointSize); return pointSize; } else { return growText(pointSize + 1, maxLines); } } public function shrinkText(pointSize:Number, maxLines:uint=1):Number { if (pointSize <= MIN_POINT_SIZE) { return pointSize; } this.changeSize(pointSize); if (this.totalTextLines > maxLines) { return shrinkText(pointSize - 1, maxLines); } else { return pointSize; } } } }
MultiColumnText.as gestiona el formato del texto con un diseo de varias columnas. Muestra el uso flexible de un objeto TextBlock como base para crear, dar formato y situar lneas de texto.
428
package com.example.programmingas3.newslayout { import flash.display.Sprite; import flash.text.engine.*; public class MultiColumnText extends Sprite { private var tb:TextBlock; private var te:TextElement; private var numColumns:uint = 2; private var gutter:uint = 10; private var leading:Number = 1.25; private var preferredWidth:Number = 400; private var preferredHeight:Number = 100; private var colWidth:int = 200; public function MultiColumnText(txt:String = "",cols:uint = 2, gutter:uint = 10, w:Number = 400, h:Number = 100, ef:ElementFormat = null):void { this.numColumns = Math.max(1, cols); this.gutter = Math.max(1, gutter); this.preferredWidth = w; this.preferredHeight = h; this.setColumnWidth(); var field:FormattedTextBlock = new FormattedTextBlock(ef,txt,this.colWidth); var totLines:int = field.totalTextLines; field = null; var linesPerCol:int = Math.ceil(totLines/cols); tb = new TextBlock(); te = new TextElement(txt,ef); tb.content = te; var textLine:TextLine = null; var x:Number = 0; var y:Number = 0; var i:int = 0; var j:int = 0; while (textLine = tb.createTextLine(textLine,this.colWidth,0,true)) { textLine.x = Math.floor(i/(linesPerCol+1))*(this.colWidth+this.gutter); textLine.y = y; y += this.leading*textLine.height;
429
j++; if(j>linesPerCol) { y = 0; j = 0; } i++; this.addChild(textLine); } } private function setColumnWidth():void { this.colWidth = Math.floor( (this.preferredWidth ((this.numColumns - 1) * this.gutter)) / this.numColumns); } } }
430
Texto bidireccional, texto vertical y unos 30 scripts de escritura, incluyendo rabe, hebreo, chino, japons, coreano,
tailands, lao y vietnamita, entre otros.
Seleccin, edicin y flujo de texto en varias columnas y contenedores vinculados. Texto vertical, Tate-Chu-Yoko (texto vertical con horizontal) y justificador para la tipografa del este asitico. Controles tipogrficos entre los que se incluyen ajuste entre caracteres, ligaduras, formato tipogrfico de
maysculas y minsculas, caja de dgitos, anchura de dgitos y guiones discrecionales.
Cortar, copiar, pegar, deshacer y gestos de ratn y teclado estndar para edicin. APIs para el desarrollador para manipular contenido de texto, diseo y marcado y crear componentes de texto
personalizados.
Compatibilidad slida con la lista, incluyendo marcadores personalizados y formatos de numeracin. Imgenes en lnea y reglas de posicionamiento.
TLF es una biblioteca de ActionScript 3.0 incorporada en Flash Text Engine (FTE) introducido en Flash Player 10. A FTE se puede acceder mediante el paquete flash.text.engine, que forma parte de la Interfaz de programacin de aplicaciones (API) de Flash Player 10. Sin embargo, la API de Flash Player ofrece un acceso de muy bajo nivel al motor de texto, lo que significa que algunas tareas pueden requerir una enorme cantidad de cdigo. TLF encapsula el cdigo de bajo nivel en APIs ms sencillas. TLF tambin ofrece una arquitectura conceptual que organiza los bloques de creacin bsicos definidos por FTE en un sistema que sea ms fcil de utilizar. A diferencia de FTE, TLF no se basa en Flash Player. Se trata de una biblioteca de componentes independiente escrita en ActionScript 3.0 en su totalidad. Debido a que la arquitectura se puede ampliar, tambin se puede personalizar para entorno especficos. Tanto Flash Professional como el SDK de Flex incluyen componentes que se basan en el marco TLF.
431
Ms temas de ayuda
Aplicacin de marcado TLF "Flow"
Latinos (ingls, espaol, francs, vietnamita, etc) Griego, cirlico, armenio, georgiano y etope rabe y hebreo Ideogramas de Han y Kana (chino, japons y coreano) y Hangul Johab (coreano) Thai, Lao y Khmer Devanagari, Bengali, Gurmukhi, Malayalam, Telugu, Tamil, Gujarati, Oriya, Kannada y tibetano Tifinagh, Yi, Cherokee, alfabeto silbico canadiense, Deseret, Shavian, Vai, Tagalog, Hanunoo, Buhid y Tagbanwa
432
Clases de formato y estructuras de datos Clases de representacin Clases de interaccin con el usuario
Clases de representacin
Los siguientes paquetes contienen las clases de representacin para TLF:
Estructuracin del texto con TLF en la pgina 436 y Formato de texto con TLF en la pgina 440.
2 Cree uno o varios contenedores de objetos de visualizacin vinculados para el texto. Para obtener ms informacin,
433
3 Asocie el texto en las estructuras de datos con los contenedores y establezca las opciones de edicin y
desplazamiento. Para obtener ms informacin, consulte Activacin de las operaciones para deshacer, editar y seleccin de texto con TLF en la pgina 443.
4 Cree un controlador de eventos para volver a transmitir el texto como respuesta a los eventos de cambio de tamao
(resize) (u otros). Para obtener ms informacin, consulte Control de eventos con TLF en la pgina 443.
flash.display.Sprite; flash.display.StageAlign; flash.display.StageScaleMode; flash.events.Event; flash.geom.Rectangle; flashx.textLayout.compose.StandardFlowComposer; flashx.textLayout.container.ContainerController; flashx.textLayout.container.ScrollPolicy; flashx.textLayout.conversion.TextConverter; flashx.textLayout.elements.TextFlow; flashx.textLayout.formats.TextLayoutFormat;
public class TLFNewsLayout extends Sprite { private var hTextFlow:TextFlow; private var headContainer:Sprite; private var headlineController:ContainerController; private var hContainerFormat:TextLayoutFormat; private private private private var var var var bTextFlow:TextFlow; bodyTextContainer:Sprite; bodyController:ContainerController; bodyTextContainerFormat:TextLayoutFormat;
private const headlineMarkup:String = "<flow:TextFlow xmlns:flow='http://ns.adobe.com/textLayout/2008'><flow:p textAlign='center'><flow:span fontFamily='Helvetica' fontSize='18'>TLF News Layout Example</flow:span><flow:br/><flow:span fontFamily='Helvetica' fontSize='14'>This example formats text like a newspaper page with a headline, a subtitle, and multiple columns</flow:span></flow:p></flow:TextFlow>"; private const bodyMarkup:String = "<flow:TextFlow xmlns:flow='http://ns.adobe.com/textLayout/2008' fontSize='12' textIndent='10' marginBottom='15' paddingTop='4' paddingLeft='4'><flow:p marginBottom='inherit'><flow:span>There are many </flow:span><flow:span fontStyle='italic'>such</flow:span><flow:span> lime-kilns in that tract of country, for the purpose of burning the white marble which composes a large part of the substance of the hills. Some of them, built years ago, and long deserted, with weeds growing in the vacant round of the interior, which is open to the sky, and grass and wild-flowers rooting themselves into the chinks of the stones, look already like relics of antiquity, and may yet be overspread with the lichens of centuries to come. Others, where the lime-burner still feeds his
434
daily and nightlong fire, afford points of interest to the wanderer among the hills, who seats himself on a log of wood or a fragment of marble, to hold a chat with the solitary man. It is a lonesome, and, when the character is inclined to thought, may be an intensely thoughtful occupation; as it proved in the case of Ethan Brand, who had mused to such strange purpose, in days gone by, while the fire in this very kiln was burning.</flow:span></flow:p><flow:p marginBottom='inherit'><flow:span>The man who now watched the fire was of a different order, and troubled himself with no thoughts save the very few that were requisite to his business. At frequent intervals, he flung back the clashing weight of the iron door, and, turning his face from the insufferable glare, thrust in huge logs of oak, or stirred the immense brands with a long pole. Within the furnace were seen the curling and riotous flames, and the burning marble, almost molten with the intensity of heat; while without, the reflection of the fire quivered on the dark intricacy of the surrounding forest, and showed in the foreground a bright and ruddy little picture of the hut, the spring beside its door, the athletic and coal-begrimed figure of the lime-burner, and the half-frightened child, shrinking into the protection of his father's shadow. And when again the iron door was closed, then reappeared the tender light of the halffull moon, which vainly strove to trace out the indistinct shapes of the neighboring mountains; and, in the upper sky, there was a flitting congregation of clouds, still faintly tinged with the rosy sunset, though thus far down into the valley the sunshine had vanished long and long ago.</flow:span></flow:p></flow:TextFlow>"; public function TLFNewsLayout() { //wait for stage to exist addEventListener(Event.ADDED_TO_STAGE, onAddedToStage); } private function onAddedToStage(evtObj:Event):void { removeEventListener(Event.ADDED_TO_STAGE, onAddedToStage); stage.scaleMode = StageScaleMode.NO_SCALE; stage.align = StageAlign.TOP_LEFT; // Headline text flow and flow composer hTextFlow = TextConverter.importToFlow(headlineMarkup, TextConverter.TEXT_LAYOUT_FORMAT); // initialize the headline container and controller objects headContainer = new Sprite(); headlineController = new ContainerController(headContainer); headlineController.verticalScrollPolicy = ScrollPolicy.OFF; hContainerFormat = new TextLayoutFormat(); hContainerFormat.paddingTop = 4; hContainerFormat.paddingRight = 4; hContainerFormat.paddingBottom = 4; hContainerFormat.paddingLeft = 4; headlineController.format = hContainerFormat; hTextFlow.flowComposer.addController(headlineController); addChild(headContainer); stage.addEventListener(flash.events.Event.RESIZE, resizeHandler); // Body text TextFlow and flow composer bTextFlow = TextConverter.importToFlow(bodyMarkup, TextConverter.TEXT_LAYOUT_FORMAT); // The body text container is below, and has three columns bodyTextContainer = new Sprite();
435
bodyController = new ContainerController(bodyTextContainer); bodyTextContainerFormat = new TextLayoutFormat(); bodyTextContainerFormat.columnCount = 3; bodyTextContainerFormat.columnGap = 30; bodyController.format = bodyTextContainerFormat; bTextFlow.flowComposer.addController(bodyController); addChild(bodyTextContainer); resizeHandler(null); } private function resizeHandler(event:Event):void { const verticalGap:Number = 25; const stagePadding:Number = 16; var stageWidth:Number = stage.stageWidth - stagePadding; var stageHeight:Number = stage.stageHeight - stagePadding; var headlineWidth:Number = stageWidth; var headlineContainerHeight:Number = stageHeight; // Initial compose to get height of headline after resize headlineController.setCompositionSize(headlineWidth, headlineContainerHeight); hTextFlow.flowComposer.compose(); var rect:Rectangle = headlineController.getContentBounds(); headlineContainerHeight = rect.height; // Resize and place headline text container // Call setCompositionSize() again with updated headline height headlineController.setCompositionSize(headlineWidth, headlineContainerHeight ); headlineController.container.x = stagePadding / 2; headlineController.container.y = stagePadding / 2; hTextFlow.flowComposer.updateAllControllers(); // Resize and place body text container var bodyContainerHeight:Number = (stageHeight - verticalGap headlineContainerHeight); bodyController.format = bodyTextContainerFormat; bodyController.setCompositionSize(stageWidth, bodyContainerHeight ); bodyController.container.x = (stagePadding/2); bodyController.container.y = (stagePadding/2) + headlineContainerHeight + verticalGap; bTextFlow.flowComposer.updateAllControllers(); } } }
La clase TLFNewsLayout utiliza dos contenedores de texto. Un contenedor muestra un titular y subttulo y el otro muestra el texto de cuerpo de tres columnas. Para que resulte ms fcil, el texto se codifica en el ejemplo como texto de marcado TLF. La variable headlineMarkup contiene el titular y el subttulo y la variable bodyMarkup incluye el texto principal. Para obtener ms informacin sobre TLF Markup, consulte Estructuracin del texto con TLF en la pgina 436. Tras la inicializacin, la funcin onAddedToStage() importa el texto del titular en un objeto TextFlow, que es la estructura de datos principal de TLF:
hTextFlow = TextConverter.importToFlow(headlineMarkup, TextConverter.TEXT_LAYOUT_FORMAT);
436
A continuacin, se crea un objeto Sprite para el contenedor y un controlador se crea y se asocia con el contenedor:
headContainer = new Sprite(); headlineController = new ContainerController(headContainer);
El controlador se inicializa para establecer el formato, el desplazamiento y otras opciones. El controlador contiene geometra que define los lmites del contenedor al que se transmite el texto. Un objeto TextLayoutFormat contiene la opciones de formato:
hContainerFormat = new TextLayoutFormat();
El controlador se asigna al compositor de flujo y la funcin aade el contenedor a la lista de visualizacin. La visualizacin y composicin real de los contenedores se difiere al mtodo resizeHandler(). La misma secuencia de pasos se lleva a cabo para inicializar el objeto TextFlow del cuerpo. El mtodo resizeHandler() mide el espacio disponible para procesar los contenedores y calculan su tamao en consecuencia. Una llamada inicial al mtodo compose() permite el clculo de la altura adecuada del contenedor del titular. El mtodo resizeHandler() puede situar y mostrar el contenedor del titular con el mtodo updateAllControllers(). Finalmente, el mtodo resizeHandler() utiliza el amao del contenedor del titular para determinar la ubicacin del contenedor del texto principal.
Jerarqua de TextFlow
437
textflow Div
Elemento raz del marcado. Divisin en un elemento TextFlow. Puede contener un grupo de prrafos. Prrafo.
TextFlow DivElement
a, tcy, span, img, tab, br, ParagraphElement g tcy, span, img, tab, br, g LinkElement TCYElement
a tcy
Vnculo.
Extensin de texto horizontal (utilizada en un a, span, img, tab, br, g elemento TextFlow vertical). Extensin de texto en un prrafo. Imagen de un prrafo. Carcter de tabulacin Carcter de salto. Utilizado para finalizar una lnea de un prrafo; el texto continuar en la siguiente lnea, pero permanece en el mismo prrafo. Define los atributos de formato utilizados por TextLayoutFormat los vnculos de estado normal. Define los atributos de formato utilizados para los vnculos de estado activo, cuando el ratn est presionado sobre un vnculo. TextLayoutFormat
linkNormalFormat
TextLayoutFormat
linkActiveFormat
TextLayoutFormat
linkHoverFormat
Define los atributos de formato utilizados TextLayoutFormat para los vnculos al pasar por encima con el ratn, cuando ste se encuentra dentro de los lmites (desplazamiento sobre) un vnculo. Elemento de lista. Debe estar dentro de un elemento de lista. Una lista. Las listas se pueden anidar o situar de forma adyacente entre s. Los distintos esquemas de numeracin o etiquetado se pueden aplicar a los elementos de lista. Elemento de grupo. Se utiliza para agrupar elementos en un prrafo. Permite anidar elementos bajo el nivel de prrafo. div, li, list, p
TextLayoutFormat
li
ListItemElement
list
ListElement
438
Ms temas de ayuda
Marcado de listas de TLF 2.0 Objetos SubParagraphGroupElements y typeName de TLF 2.0
Las listas se pueden anidar en otras listas, tal y como se muestra en el ejemplo siguiente:
<flow:list paddingRight="24" paddingLeft="24"> <flow:li>Item 1</flow:li> <flow:list paddingRight="24" paddingLeft="24"> <flow:li>Item 1a</flow:li> <flow:li>Item 1b</flow:li> <flow:li>Item 1c</flow:li> </flow:list> <flow:li>Item 2</flow:li> <flow:li>Item 3</flow:li> </flow:list>
Para personalizar el tipo de marcador en la lista, utilice la propiedad listStyleType de ListElement. Esta propiedad puede ser cualquier valor definido por la clase ListStyleType (por ejemplo, check, circle, decimal y box). En el siguiente ejemplo se crean listas con distintos tipos de marcador y un incremento del contador personalizado:
<flow:list paddingRight="24" paddingLeft="24" listStyleType="upperAlpha"> <flow:li>upperAlpha item</flow:li> <flow:li>another</flow:li> </flow:list> <flow:list paddingRight="24" paddingLeft="24" listStyleType="lowerAlpha"> <flow:li>lowerAlpha item</flow:li> <flow:li>another</flow:li> </flow:list> <flow:list paddingRight="24" paddingLeft="24" listStyleType="upperRoman"> <flow:li>upperRoman item</flow:li> <flow:li>another</flow:li> </flow:list> <flow:list paddingRight="24" paddingLeft="24" listStyleType="lowerRoman"> <flow:listMarkerFormat> <!-- Increments the list by 2s rather than 1s. --> <flow:ListMarkerFormat counterIncrement="ordered 2"/> </flow:listMarkerFormat> <flow:li>lowerRoman item</flow:li> <flow:li>another</flow:li> </flow:list>
La clase ListMarkerFormat se emplea para definir el contador. Adems de definir el incremento de un contador, tambin es posible personalizar el contador, restablecindolo con la propiedad counterReset. Se puede personalizar ms el aspecto de los marcadores de las listas con el uso de las propiedades beforeContent y afterContent de ListMarkerFormat. Estas propiedades se aplican al contenido que aparece antes y despus del contenido del marcador. En el siguiente ejemplo se aade la cadena XX antes del marcador y YY despus del mismo:
439
<flow:list listStyleType="upperRoman" paddingLeft="36" paddingRight="24"> <flow:listMarkerFormat> <flow:ListMarkerFormat fontSize="16" beforeContent="XX" afterContent="YY" counterIncrement="ordered -1"/> </flow:listMarkerFormat> <flow:li>Item 1</flow:li> <flow:li>Item 2</flow:li> <flow:li>Item 3</flow:li> </flow:list>
La propia propiedad content puede definir ms las personalizaciones del formato del marcador En el siguiente ejemplo se muestra un marcador numeral Roman ordenado y en maysculas:
<flow:list listStyleType="disc" paddingLeft="96" paddingRight="24"> <flow:listMarkerFormat> <flow:ListMarkerFormat fontSize="16" beforeContent="Section " content="counters(ordered,"*",upperRoman)" afterContent=": "/> </flow:listMarkerFormat> <flow:li>Item 1</li> <flow:li>Item 2</li> <flow:li>Item 3</li> </flow:list>
Tal y como se muestra en el ejemplo anterior, la propiedad content tambin puede insertar un sufijo: una cadena que aparece tras el marcador, pero antes de afterContent. Para insertar esta cadena al proporcionar contenido XML en el flujo, ajuste la cadena en las entradas HTML "e; en lugar de comillas ("<string>").
Ms temas de ayuda
Marcado de listas de TLF 2.0
440
<flow:TextFlow version="2.0.0" xmlns:flow="http://ns.adobe.com/textLayout/2008" fontSize="14" textIndent="15" paddingTop="4" paddingLeft="4" fontFamily="Times New Roman">
Los valores vlidos para las propiedades de margen son un nmero (en pxeles), auto o inherit. El valor predeterminado es auto, lo que significa que se calcula automticamente y se establece en 0, para todos los elementos excepto ListElement. Para ListElements, auto es 0 excepto en la parte de inicio de la lista donde se utiliza el valor de la propiedad listAutoPadding. El valor predeterminado de listAutoPadding es 40, lo que proporciona a las listas una sangra predeterminada. Las propiedades de margen no se heredan de forma predeterminada. Los valores auto e inherit son constantes definidas por la clase FormatValue. Las propiedades de margen pueden ser valores negativos.
Ms temas de ayuda
Cambios de margen en TLF 2.0 (en ingls)
441
Herencia de formato
Flash Player 10 y posterior, Adobe AIR 1.5 y posterior Los formatos se heredan mediante la jerarqua de flujo de texto. Si se asigna una instancia de TextLayoutFormat a una instancia de FlowElement con elementos secundarios, la arquitectura inicia un proceso denominado cascada. Durante una cascada, la arquitectura examina de forma sucesiva cada nodo de la jerarqua que hereda de FlowElement. Posteriormente determina si asignar los valores heredados a cada propiedad de formato. Durante la cascada se aplican las siguientes reglas:
1 Los valores de propiedad se heredan nicamente de un ascendiente inmediato (denominado a veces elemento
principal).
2 Los valores de propiedad slo se heredan si una propiedad an no tiene un valor (es decir, el valor es undefined).. 3 Algunos atributos no heredan valores si son undefined, a no ser que el valor del atributo se establezca
especficamente en inherit o como constante flashx.textLayout.formats.FormatValue.INHERIT. Por ejemplo, si el valor fontSize es establece para un contenedor a nivel de TextFlow, la configuracin aplica todos los contenedores en TextFlow. Es decir, los valores caen en cascada hacia abajo en la jerarqua del flujo de texto. No obstante, puede sustituir el valor de un contenedor determinado asignando un nuevo valor directamente al contenedor. Como contraejemplo, si se establece el valor backgroundColor en el nivel de TextFlow, los elementos secundarios de TextFlow no heredan ese valor. La propiedad backgroundColor no hereda de su elemento principal durante una cascada. Para omitir este comportamiento, establezca la propiedad marginLeft de cada elemento secundario en flashx.textLayout.formats.FormatValue.INHERIT.. Para obtener ms informacin, consulte la clase TextLayoutFormat en la Referencia de ActionScript 3.0 para la plataforma de Adobe Flash.
442
Tanto la importacin como la exportacin son procedimientos sencillos. Se llama al mtodo export() o importToFlow(); ambos forman parte de la clase TextFilter. Los dos mtodos son estticos, lo que significa que se llaman en la clase TextFilter en lugar de en una instancia de la clase TextFilter. Las clases del paquete flashx.textLayout.conversion proporciona una flexibilidad considerable en la que el usuario opta por almacenar el texto. Por ejemplo, si el texto se almacena en una base de datos, se puede importar en la arquitectura para su visualizacin. Posteriormente se pueden utilizar las clases del paquete flashx.textLayout.edit para cambiar el texto y exportar de nuevo el texto modificado a la base de datos. Para obtener ms informacin, consulte la case flashx.textLayout.conversion en la Referencia de ActionScript 3.0 para la plataforma de Adobe Flash.
443
Todas las instancias de TextFlow disponen de un objeto correspondiente que implementa la interfaz IFlowComposer. A este objeto IFlowComposer se puede acceder mediante la propiedad TextFlow.flowComposer. Se puede llamar a mtodos definidos mediante la interfaz IFlowComposer a travs de esta propiedad. Estos mtodos permiten asociar el texto con uno o varios contenedores y preparan el texto para su visualizacin en un contenedor. Un contenedor es simplemente una instancia de la clase Sprite, que es una subclase de la clase DisplayObjectContainer. Ambas clases forman parte de la API de la lista de visualizacin de Flash Player. Un contenedor es una forma ms avanzada del rectngulo de delimitacin utilizado con la clase TextLineFactory. Al igual que sucede con el rectngulo de delimitacin, un contenedor limita el rea donde aparecern las instancias de TextLine. A diferencia de un rectngulo de delimitacin, un contenedor dispone de un objeto controller correspondiente. El controlador administra el desplazamiento, composicin, vinculacin, formato y control de eventos para un contenedor o conjunto de contenedores. Cada contenedor cuenta con un objeto controlador correspondiente que es una instancia de la clase ContainerController del paquete flashx.textLayout.container. Para mostrar texto, cree un objeto controlador para administrar y asociarlo con el compositor de flujo. Una vez asociado el contenedor, debe componer el texto antes de que pueda visualizarse. Por lo tanto, los contenedores disponen de dos estados: composicin y visualizacin. La composicin del texto es el proceso de conversin del texto desde la jerarqua de flujo de texto en instancias de TextLine y el clculo de la forma en que esas instancias se ajustan al contenedor. La visualizacin es el proceso de actualizacin de la lista de visualizacin de Flash Player. Para obtener ms informacin, consulte IFlowComposer, StandardFlowComposer y ContainerController en Referencia de ActionScript 3.0 para la plataforma de Adobe Flash.
Activacin de las operaciones para deshacer, editar y seleccin de texto con TLF
Flash Player 9.0 y posterior, Adobe AIR 1.0 y posterior La capacidad de seleccionar o editar texto se controla en el nivel de TextFlow. Todas las instancias de la clase TextFlow disponen de un administrador de interaccin asociado. Se puede acceder al administrador de interaccin del objeto TextFlow mediante la propiedad TextFlow.interactionManager del objeto. Para activar la seleccin, asigne una instancia de la clase SelectionManager a la propiedad interactionManager. Para activar tanto la seleccin como la edicin, asigne una instancia de la clase EditManager en lugar de una instancia de la clase SelectionManager. Para habilitar las operaciones de deshacer, cree una instancia de la clase UndoManager e inclyala como argumento al llamar al constructor para EditManager. La clase UndoManager permite mantener un historial de las actividades de edicin ms recientes del usuario y permite al usuario deshacer y rehacer ediciones especficas. Estas tres clases forman parte del paquete de edicin. Para obtener ms informacin, consulte SelectionManager, EditManager y UndoManager en Referencia de ActionScript 3.0 para la plataforma de Adobe Flash.
444
Antes de que comience una operacin y una vez finalizada una operacin. Si cambia el estado de un objeto FlowElement. Cuando se completa una operacin de composicin.
Para obtener ms informacin, consulte la clase flashx.textLayout.events en la Referencia de ActionScript 3.0 para la plataforma de Adobe Flash.
Ms temas de ayuda
Eventos FlowElement y LinkElement y EventMirrors de TLF
Los valores vlidos de la propiedad float son left, right, start, end y none. La clase Float define estas constantes. El valor predeterminado es none. La propiedad clearFloats resulta til cuando se desea ajustar la posicin de inicio de los siguientes prrafos que normalmente se ajustan alrededor de la imagen. Por ejemplo, supongamos que se dispone de una imagen que es ms grande que el primer prrafo. Para garantizar que el segundo prrafo comience tras la imagen, establezca la propiedad clearFloats. En el siguiente ejemplo se utiliza una imagen que es ms alta que el texto en el primer prrafo. Para que el segundo prrafo comience tras la imagen en el bloque de texto, en este ejemplo se establece la propiedad clearFloats en el segundo prrafo hasta end.
<flow:p paragraphSpaceAfter="15" >Here is another float, it should show up on the right: <flow:img float="right" height="50" elementHeight="200" width="19" source="../assets/bulldog.jpg"></flow:img>We'll add another paragraph that should clear past it.</flow:p><flow:p clearFloats="end" >This should appear after the previous float on the right.</flow:p>
Los valores vlidos de la propiedad clearFloats son left, right, end, start, none, y both. La clase ClearFloats define estas constantes. Tambin se puede definir la propiedad clearFloats como inherit, que es una constante definida por la clase FormatValue. El valor predeterminado es none.
Ms temas de ayuda
Cuadros flotantes de TLF (en ingls)
445
Ms temas de ayuda
Paquete flash.media flash.events.SampleDataEvent
Cargar un archivo de sonido externo como, por ejemplo, un archivo mp3 en el archivo SWF. Incorporar la informacin de sonido en el archivo SWF directamente cuando se est creando. Capturar el audio desde un micrfono incorporado al equipo del usuario. Transmitir audio desde un servidor. Generar y reproducir audio dinmicamente.
Al cargar datos de sonido desde un archivo de sonido externo, se puede iniciar la reproduccin del principio del archivo de sonido mientras se cargan los restantes datos. Aunque hay varios formatos de archivo de sonido que se utilizan para codificar audio digital, ActionScript 3.0, Flash Player y AIR admiten archivos de sonido almacenados en formato MP3. No pueden cargar ni reproducir directamente archivos de sonido con otros formatos, como WAV o AIFF.
446
Al trabajar con sonido en ActionScript, es probable que se utilicen varias clases del paquete flash.media. La clase Sound se utiliza para acceder a la informacin de audio mediante la carga de un archivo de sonido o la asignacin de una funcin a un evento que muestrea los datos de sonido y posteriormente se inicia la reproduccin. Una vez iniciada la reproduccin de un sonido, Flash Player y AIR proporcionan acceso a un objeto SoundChannel. Puesto que un archivo de audio que se ha cargado puede ser uno de varios sonidos que se reproducen en el ordenador de un usuario, cada sonido que se reproduce utiliza su propio objeto SoundChannel; la salida combinada de todos los objetos SoundChannel mezclados es lo que se reproduce realmente a travs de los altavoces del ordenador. La instancia de SoundChannel se utiliza para controlar las propiedades del sonido y detener su reproduccin. Por ltimo, si se desea controlar el audio combinado, la clase SoundMixer permite controlar la salida mezclada. Asimismo, se pueden utilizar otras muchas clases para realizar tareas ms especficas cuando se trabaja con sonido en ActionScript; para ms informacin sobre todas las clases relacionadas con el sonido, consulte Aspectos bsicos de la arquitectura de sonido en la pgina 446. Conceptos y trminos importantes La siguiente lista de referencia contiene trminos importantes utilizados:
Amplitud Distancia de un punto de la forma de onda del sonido desde la lnea cero o de equilibrio. Velocidad de bits Cantidad de datos que se codifican o se transmiten en cada segundo de un archivo de sonido. En los
archivos MP3, la velocidad suele expresarse en miles de bits por segundo (kbps). Una velocidad superior suele implicar una onda de sonido de mayor calidad.
Almacenamiento en bfer Recepcin y almacenamiento de los datos de sonido antes de que se reproduzcan. mp3 MPEG-1 Audio Layer 3, o MP 3, es un formato de compresin de sonido conocido. Desplazamiento lateral Posicin de una seal de audio entre los canales izquierdo y derecho de un campo de sonido
estreo.
Pico Punto ms alto de una forma de onda. Velocidad de muestreo Define el nmero de muestras por segundo que se toman de una seal de audio analgica para
crear una seal digital. La velocidad de muestra del audio de CD estndar es de 44,1 kHz o 44.100 muestras por segundo.
Transmisin Proceso de reproduccin del principio de un archivo de sonido o de vdeo mientras se descargan los datos
Archivos de sonido externos cargados en tiempo de ejecucin Recursos de sonido incorporados en el archivo SWF de la aplicacin Datos de sonido de un micrfono conectado al sistema del usuario Datos de sonido transmitidos desde un servidor multimedia remoto, como Flash Media Server
447
Datos de sonido generados dinmicamente mediante el uso del controlador de eventos sampleData.
Los datos de sonido se pueden cargar completamente antes de su reproduccin, o bien se pueden transmitirse, es decir, se pueden reproducir mientras se estn cargando. Las clases de sonido de ActionScript 3.0 admiten archivos de sonido que se almacenan en formato mp3. No pueden cargar ni reproducir directamente archivos de sonido con otros formatos, como WAV o AIFF. No obstante, cuando se comienza con Flash Player 9.0.115.0, los archivos de audio AAC se pueden cargar y reproducir utilizando la clase NetStream. Se trata de la misma tcnica que se utiliza para cargar y reproducir contenido de vdeo. Para obtener ms informacin sobre esta tcnica, consulte Trabajo con vdeo en la pgina 478. Adobe Flash Professional permite importar archivos de sonido WAV o AIFF e incorporarlos en los archivos SWF de la aplicacin con formato MP3. La herramienta de edicin de Flash tambin permite comprimir archivos de sonido incorporados para reducir su tamao de archivo, aunque esta reduccin de tamao se compensa con una mejor calidad de sonido. Para ms informacin, consulte Importacin de sonidos en Uso de Flash. La arquitectura de sonido de ActionScript 3.0 utiliza las siguientes clases del paquete flash.media.
Clase flash.media.Sound Descripcin La clase Sound controla la carga del sonido, administra las propiedades de sonido bsicas e inicia la reproduccin de sonido. Cuando una aplicacin reproduce un objeto Sound, se crea un nuevo objeto SoundChannel para controlar la reproduccin. El objeto SoundChannel controla el volumen de los canales de reproduccin izquierdo y derecho del sonido. Cada sonido que se reproduce tiene su propio objeto SoundChannel. La clase SoundLoaderContext especifica cuntos segundos de bfer se utilizarn al cargar un sonido, y si Flash Player o AIR buscan un archivo de poltica en el servidor al cargar un archivo. Un objeto SoundLoaderContext se utiliza como parmetro del mtodo Sound.load(). La clase SoundMixer controla la reproduccin y las propiedades de seguridad que pertenecen a todos los sonidos de una aplicacin. De hecho, se mezclan varios canales de sonido mediante un objeto SoundMixer comn, de manera que los valores de propiedad de dicho objeto afectarn a todos los objetos SoundChannel que se reproducen actualmente. La clase SoundTransform contiene valores que controlan el desplazamiento y el volumen de sonido. Un objeto SoundTransform puede aplicarse a un objeto SoundChannel, al objeto SoundMixer global o a un objeto Microphone, entre otros. Un objeto ID3Info contiene propiedades que representan informacin de metadatos ID3, almacenada a menudo en archivos de sonido MP3. La clase Microphone representa un micrfono u otro dispositivo de entrada de sonido conectado al ordenador del usuario. La entrada de audio de un micrfono puede enrutarse a altavoces locales o enviarse a un servidor remoto. El objeto Microphone controla la ganancia, la velocidad de muestra y otras caractersticas de su propio flujo de sonido.
flash.media.SoundChannel
flash.media.SoundLoaderContext
flash.media.SoundMixer
flash.media.SoundTransform
flash.media.ID3Info
flash.media.Microphone
Cada sonido que se carga y se reproduce necesita su propia instancia de las clases Sound y SoundChannel. La clase SoundMixer global mezcla la salida de varias instancias de SoundChannel durante la reproduccin. Las clases Sound, SoundChannel y SoundMixer no se utilizan para datos de sonido obtenidos de un micrfono o de un servidor de flujo de medios como Flash Media Server.
448
El constructor Sound() acepta un objeto URLRequest como primer parmetro. Cuando se proporciona un valor del parmetro URLRequest, el nuevo objeto Sound empieza a cargar automticamente el recurso de sonido especificado. En todos los casos, excepto en los ms sencillos, la aplicacin debe prestar atencin al progreso de carga del sonido y detectar los posibles errores. Por ejemplo, si el sonido del clic tiene un tamao bastante grande, es posible que no est completamente cargado cuando el usuario haga clic en el botn que activa dicho sonido. Si se intenta reproducir un sonido no cargado, puede producirse un error en tiempo de ejecucin. Resulta ms seguro esperar a que se cargue totalmente el sonido antes de permitir que los usuarios realicen acciones que puedan iniciar la reproduccin de sonidos. El objeto Sound distribuye varios eventos distintos durante el proceso de carga del sonido. La aplicacin puede detectar estos eventos para hacer un seguimiento del progreso de carga y asegurarse de que el sonido se carga por completo antes de reproducirse. En la tabla siguiente se enumeran los eventos que puede distribuir un objeto Sound.
Evento open (Event.OPEN) Descripcin Se distribuye antes de que se inicie la operacin de carga del sonido.
progress (ProgressEvent.PROGRESS) Se distribuye peridicamente durante el proceso de carga del sonido cuando se reciben datos del archivo o del flujo. id3 (Event.ID3) complete (Event.COMPLETE) ioError (IOErrorEvent.IO_ERROR) Se distribuye cuando hay datos ID3 disponibles para un sonido MP3. Se distribuye cuando se han cargado todos los datos del recurso de sonido. Se distribuye cuando no se puede encontrar un archivo de sonido, o bien cuando el proceso de carga se interrumpe antes de que se puedan recibir todos los datos de sonido.
449
En primer lugar, el cdigo de ejemplo crea un nuevo objeto Sound sin asignarle un valor inicial para el parmetro URLRequest. A continuacin, detecta el evento Event.COMPLETE del objeto Sound, que provoca la ejecucin del mtodo onSoundLoaded() cuando se cargan todos los datos de sonido. Despus, llama al mtodo Sound.load() con un nuevo valor URLRequest para el archivo de sonido. El mtodo onSoundLoaded() se ejecuta cuando se completa la carga de sonido. La propiedad target del objeto Event es una referencia al objeto Sound. La llamada al mtodo play() del objeto Sound inicia la reproduccin de sonido.
var s:Sound = new Sound(); s.addEventListener(ProgressEvent.PROGRESS, onLoadProgress); s.addEventListener(Event.COMPLETE, onLoadComplete); s.addEventListener(IOErrorEvent.IO_ERROR, onIOError); var req:URLRequest = new URLRequest("bigSound.mp3"); s.load(req); function onLoadProgress(event:ProgressEvent):void { var loadedPct:uint = Math.round(100 * (event.bytesLoaded / event.bytesTotal)); trace("The sound is " + loadedPct + "% loaded."); } function onLoadComplete(event:Event):void { var localSound:Sound = event.target as Sound; localSound.play(); } function onIOError(event:IOErrorEvent) { trace("The sound could not be loaded: " + event.text); }
En este cdigo se crea primero un objeto Sound y luego se aaden detectores a dicho objeto para los eventos ProgressEvent.PROGRESS y Event.COMPLETE. Una vez que el mtodo Sound.load() se ha llamado y que el archivo de sonido recibe los primeros datos, se produce un evento ProgressEvent.PROGRESS, que activa el mtodo onSoundLoadProgress().
450
El porcentaje de datos de sonido cargados equivale al valor de la propiedad bytesLoaded del objeto ProgressEvent dividido entre el valor de la propiedad bytesTotal. Las mismas propiedades bytesLoaded y bytesTotal tambin estn disponibles en el objeto Sound. El ejemplo anterior muestra mensajes relativos al progreso de carga del sonido, aunque se pueden utilizar fcilmente los valores bytesLoaded y bytesTotal para actualizar los componentes de barra de progreso, como los que se incluyen en la arquitectura Adobe Flex o en la herramienta de edicin Adobe Flash. En este ejemplo tambin se muestra la forma en que una aplicacin puede reconocer un error y responder a l durante la carga de archivos de sonido. Por ejemplo, si no se puede encontrar un archivo de sonido con un nombre determinado, el objeto Sound distribuye un evento Event.IO_ERROR. En el cdigo anterior, se ejecuta el mtodo onIOError(), que muestra un breve mensaje de error cuando se produce un error.
ActionScript. De manera predeterminada, utilizar el nombre del archivo de sonido de este campo. Si el nombre de archivo incluye un punto, como en "DrumSound.mp3", debe cambiarlo por otro como "DrumSound"; ActionScript no permite utilizar un punto en un nombre de clase. El campo Clase base debe mostrar flash.media.Sound.
451
4 Haga clic en OK (Aceptar). Es posible que vea un cuadro de mensaje que indique que no se encontr una definicin
para esta clase en la ruta de clases. Haga clic en Aceptar y contine. Si se introduce una clase cuyo nombre no coincide con el de ninguna de las clases de la ruta de clases de la aplicacin, se genera automticamente una nueva clase que hereda de la clase flash.media.Sound.
5 Para utilizar el sonido incorporado hay que hacer referencia al nombre de clase del sonido en ActionScript. Por
ejemplo, el cdigo siguiente empieza creando una nueva instancia de la clase DrumSound generada automticamente:
var drum:DrumSound = new DrumSound(); var channel:SoundChannel = drum.play();
DrumSound es una subclase de la clase flash.media.Sound, por lo que hereda los mtodos y las propiedades de la clase Sound, incluido el mtodo play() antes mostrado.
Utilizar la etiqueta de metadatos [Embed] en un script Usar la directiva @Embed en MXML para asignar un activo incorporado como una propiedad de un componente,
como Button o SoundEffect.
452
package { import flash.display.Sprite; import flash.media.Sound; import flash.media.SoundChannel; public class EmbeddedSoundExample extends Sprite { [Embed(source="smallSound.mp3")] public var soundClass:Class; public function EmbeddedSoundExample() { var smallSound:Sound = new soundClass() as Sound; smallSound.play(); } } }
Para utilizar el sonido incorporado para establecer una propiedad de un componente Flex, debera convertirse como en instancia de la clase mx.core.SoundAsset en lugar de en una instancia de la clase Sound. Para ver un ejemplo parecido que utilice la clase SoundAsset, consulte Clases de activos incorporados.
453
Mientras sigue la reproduccin, Flash Player y AIR intentan mantener el tamao del bfer de sonido en un valor igual o mayor. Si los datos de sonido se cargan ms rpido que la velocidad de reproduccin, sta continuar sin interrupciones. Sin embargo, si la velocidad de carga de los datos disminuye debido a limitaciones de red, la cabeza lectora podra alcanzar el final del bfer de sonido. Si esto sucede, se suspende la reproduccin, aunque se reanudar automticamente en cuanto se hayan cargado ms datos de sonido. Para determinar si se ha suspendido la reproduccin porque Flash o AIR estn esperando a que se carguen ms datos, se debe utilizar la propiedad Sound.isBuffering.
Cuando se llama a Sound.play(), la aplicacin inicia la llamada al controlador de eventos, solicitando los datos de la muestra de sonido. La aplicacin contina enviando eventos a medida que se reproduce el sonido hasta que se detiene el suministro o se llama a SoundChannel.stop().
454
La latencia del evento vara en funcin de la plataforma y puede cambiar en futuras versiones de Flash Player y AIR. No dependa de una latencia concreta: calclela. Para calcular la latencia, utilice la siguiente frmula:
(SampleDataEvent.position / 44.1) - SoundChannelObject.position
Proporcione de 2048 hasta 8192 muestras a la propiedad data del objeto SampleDataEvent (para cada llamada al controlador de eventos). Para obtener el mejor rendimiento, proporcione tantas muestras como sea posible (hasta 8192). Cuanto menor sea el nmero de muestras, ms probable ser la aparicin de interferencias en la reproduccin. Este comportamiento puede variar en funcin de la plataforma y segn las situaciones; por ejemplo, al cambiar de tamao la ventana del navegador. El cdigo que funciona en una plataforma cuando slo se proporcionan 2048 muestras puede que no funcione tan bien cuando se ejecuta en una plataforma distinta. Si necesita la menor latencia posible, considere la posibilidad de que sea el usuario quien seleccione la cantidad de datos. Si se proporcionan menos de 2048 muestras (por llamada al detector de eventos sampleData), la aplicacin se detiene tras reproducir las muestras restantes. El objeto SoundChannel distribuye entonces un evento SoundComplete.
455
Reproduccin de sonidos
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior Para reproducir un sonido cargado slo hay que llamar al mtodo Sound.play() de un objeto Sound:
var snd:Sound = new Sound(new URLRequest("smallSound.mp3")); snd.play();
Al reproducir sonidos con ActionScript 3.0, se pueden realizar las operaciones siguientes:
Reproducir un sonido desde una posicin de inicio especfica Pausar un sonido y reanudar la reproduccin desde la misma posicin posteriormente Saber exactamente cundo termina de reproducirse un sonido Hacer un seguimiento del progreso de la reproduccin de un sonido Cambiar el volumen o el desplazamiento cuando se reproduce un sonido
Para realizar estas operaciones durante la reproduccin deben utilizarse las clases SoundChannel, SoundMixer y SoundTransform. La clase SoundChannel controla la reproduccin de un solo sonido. La propiedad SoundChannel.position puede considerarse como una cabeza lectora, que indica el punto actual en los datos de sonido que se estn reproduciendo. Cuando una aplicacin llama al mtodo Sound.play(), se crea una nueva instancia de la clase SoundChannel para controlar la reproduccin. La aplicacin puede reproducir un sonido desde una posicin de inicio especfica, pasando dicha posicin en milisegundos como el parmetro startTime del mtodo Sound.play(). Tambin puede especificar un nmero fijo de veces que se repetir el sonido en una sucesin rpida pasando un valor numrico en el parmetro loops del mtodo Sound.play(). Cuando se llama al mtodo Sound.play() con los parmetros startTime y loops, el sonido se reproduce de forma repetida desde el mismo punto de inicio cada vez, tal como se muestra en el cdigo siguiente:
var snd:Sound = new Sound(new URLRequest("repeatingSound.mp3")); snd.play(1000, 3);
En este ejemplo, el sonido se reproduce desde un punto un segundo despus del inicio del sonido, tres veces seguidas.
456
Mientras se reproduce el sonido, la propiedad SoundChannel.position indica el punto del archivo de sonido que se est reproduciendo en ese momento. La aplicacin puede almacenar el valor de posicin antes de detener la reproduccin del sonido, como se indica a continuacin:
var pausePosition:int = channel.position; channel.stop();
Para reanudar la reproduccin del sonido desde el mismo punto en que se detuvo, hay que pasar el valor de la posicin almacenado anteriormente.
channel = snd.play(pausePosition);
Control de la reproduccin
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior Es posible que la aplicacin desee saber cundo se deja de reproducir un sonido para poder iniciar la reproduccin de otro o para limpiar algunos recursos utilizados durante la reproduccin anterior. La clase SoundChannel distribuye un evento Event.SOUND_COMPLETE cuando finaliza la reproduccin de un sonido. La aplicacin puede detectar este evento y adoptar las medidas oportunas como se muestra a continuacin:
import flash.events.Event; import flash.media.Sound; import flash.net.URLRequest; var snd:Sound = new Sound(); var req:URLRequest = new URLRequest("smallSound.mp3"); snd.load(req); var channel:SoundChannel = snd.play(); channel.addEventListener(Event.SOUND_COMPLETE, onPlaybackComplete); public function onPlaybackComplete(event:Event) { trace("The sound has finished playing."); }
La clase SoundChannel no distribuye eventos de progreso durante la reproduccin. Para informar sobre el progreso de la reproduccin, la aplicacin puede configurar su propio mecanismo de sincronizacin y hacer un seguimiento de la posicin de la cabeza lectora del sonido.
457
Para calcular el porcentaje de sonido que se ha reproducido, se puede dividir el valor de la propiedad SoundChannel.position entre la duracin de los datos del sonido que se est reproduciendo:
var playbackPercent:uint = 100 * (channel.position / snd.length);
Sin embargo, este cdigo slo indica porcentajes de reproduccin precisos si los datos de sonido se han cargado completamente antes del inicio de la reproduccin. La propiedad Sound.length muestra el tamao de los datos de sonido que se cargan actualmente, no el tamao definitivo de todo el archivo de sonido. Para hacer un seguimiento del progreso de reproduccin de un flujo de sonido, la aplicacin debe estimar el tamao final de todo el archivo de sonido y utilizar dicho valor en sus clculos. Se puede estimar la duracin final de los datos de sonido mediante las propiedades bytesLoaded y bytesTotal del objeto Sound, de la manera siguiente:
var estimatedLength:int = Math.ceil(snd.length / (snd.bytesLoaded / snd.bytesTotal)); var playbackPercent:uint = 100 * (channel.position / estimatedLength);
El cdigo siguiente carga un archivo de sonido ms grande y utiliza el evento Event.ENTER_FRAME como mecanismo de sincronizacin para mostrar el progreso de la reproduccin. Notifica peridicamente el porcentaje de reproduccin, que se calcula como el valor de la posicin actual dividido entre la duracin total de los datos de sonido:
import flash.events.Event; import flash.media.Sound; import flash.net.URLRequest; var snd:Sound = new Sound(); var req:URLRequest = new URLRequest("http://av.adobe.com/podcast/csbu_dev_podcast_epi_2.mp3"); snd.load(req); var channel:SoundChannel; channel = snd.play(); addEventListener(Event.ENTER_FRAME, onEnterFrame); channel.addEventListener(Event.SOUND_COMPLETE, onPlaybackComplete); function onEnterFrame(event:Event):void { var estimatedLength:int = Math.ceil(snd.length / (snd.bytesLoaded / snd.bytesTotal)); var playbackPercent:uint = Math.round(100 * (channel.position / estimatedLength)); trace("Sound playback is " + playbackPercent + "% complete."); } function onPlaybackComplete(event:Event) { trace("The sound has finished playing."); removeEventListener(Event.ENTER_FRAME, onEnterFrame); }
Una vez iniciada la carga de los datos de sonido, este cdigo llama al mtodo snd.play() y almacena el objeto SoundChannel resultante en la variable channel. A continuacin, aade un detector de eventos a la aplicacin principal para el evento Event.ENTER_FRAME y otro detector de eventos al objeto SoundChannel para el evento Event.SOUND_COMPLETE que se produce cuando finaliza la reproduccin. Cada vez que la aplicacin alcanza un nuevo fotograma en su animacin, se llama al mtodo onEnterFrame(). El mtodo onEnterFrame() estima la duracin total del archivo de sonido segn la cantidad de datos que ya se han cargado, y luego calcula y muestra el porcentaje de reproduccin actual.
458
Cuando se ha reproducido todo el sonido, se ejecuta el mtodo onPlaybackComplete() y se elimina el detector de eventos para el evento Event.ENTER_FRAME, de manera que no intente mostrar actualizaciones de progreso tras el fin de la reproduccin. El evento Event.ENTER_FRAME puede distribuirse muchas veces por segundo. En algunos casos no ser necesario mostrar el progreso de la reproduccin con tanta frecuencia. De ser as, la aplicacin puede configurar su propio mecanismo de sincronizacin con la clase flash.util.Timer; vase Trabajo con fechas y horas en la pgina 1.
459
El entorno limitado de propietario controla la reproduccin local de los sonidos. La aplicacin o el objeto que empieza a reproducir un sonido definen el entorno limitado de propietario. El mtodo SoundMixer.stopAll() detiene los sonidos de todos los objetos SoundChannel que se reproducen en ese momento, siempre y cuando cumplan los criterios siguientes:
Los objetos del mismo entorno limitado de propietario han iniciado los sonidos. Los sonidos proceden de un origen con un archivo de poltica que proporciona acceso al dominio de la aplicacin
o del objeto que llama al mtodo SoundMixer.stopAll(). Sin embargo, en una aplicacin de AIR, el contenido del entorno limitado de seguridad de la aplicacin (contenido instalado con la aplicacin AIR) no est limitado por estas restricciones de seguridad. Para saber si el mtodo SoundMixer.stopAll() detendr realmente todos los sonidos en reproduccin, la aplicacin puede llamar al mtodo SoundMixer.areSoundsInaccessible(). Si el mtodo devuelve un valor true, algunos de los sonidos que se reproducen se encuentran fuera del control del entorno limitado de propietario actual y no se detendrn con el mtodo SoundMixer.stopAll(). El mtodo SoundMixer.stopAll() tambin evita que la cabeza lectora contine para todos los sonidos cargados desde archivos externos. Sin embargo, los sonidos que se incorporan en archivos FLA y se asocian a los fotogramas de la lnea de tiempo con la herramienta de edicin de Flash podran volver a reproducirse si la animacin se desplaza a un nuevo fotograma.
460
Se puede modificar el volumen y el desplazamiento mientras se reproduce un sonido estableciendo las propiedades pan o volume de un objeto SoundTransform y aplicando dicho objeto como propiedad soundTransform de un objeto SoundChannel. Tambin se pueden establecer simultneamente valores globales de volumen y desplazamiento con la propiedad
soundTransform de la clase SoundMixer, como se muestra en el ejemplo siguiente: SoundMixer.soundTransform = new SoundTransform(1, -1);
Adems, se puede utilizar un objeto SoundTransform para establecer los valores de volumen y desplazamiento de un objeto Microphone (vase Captura de entradas de sonido en la pgina 465) y de los objetos Sprite y SimpleButton. En el ejemplo siguiente se alterna el desplazamiento del sonido del canal izquierdo al derecho, y a la inversa, mientras se reproduce el sonido.
import import import import import flash.events.Event; flash.media.Sound; flash.media.SoundChannel; flash.media.SoundMixer; flash.net.URLRequest;
var snd:Sound = new Sound(); var req:URLRequest = new URLRequest("bigSound.mp3"); snd.load(req); var panCounter:Number = 0; var trans:SoundTransform; trans = new SoundTransform(1, 0); var channel:SoundChannel = snd.play(0, 1, trans); channel.addEventListener(Event.SOUND_COMPLETE, onPlaybackComplete); addEventListener(Event.ENTER_FRAME, onEnterFrame); function onEnterFrame(event:Event):void { trans.pan = Math.sin(panCounter); channel.soundTransform = trans; // or SoundMixer.soundTransform = trans; panCounter += 0.05; } function onPlaybackComplete(event:Event):void { removeEventListener(Event.ENTER_FRAME, onEnterFrame); }
Este cdigo se inicia cargando un archivo de sonido y creando un nuevo objeto SoundTransform con el volumen establecido en 1 (volumen mximo) y el desplazamiento establecido en 0 (equilibrio entre los canales izquierdo y derecho). A continuacin, llama al mtodo snd.play() y pasa el objeto SoundTransform como parmetro. Mientras se reproduce el sonido, el mtodo onEnterFrame() se ejecuta repetidamente. El mtodo onEnterFrame() utiliza la funcin Math.sin() para generar un valor entre -1 y 1, rango que corresponde a los valores aceptables de la propiedad SoundTransform.pan. La propiedad pan del objeto SoundTransform se establece en el nuevo valor y, posteriormente, se establece la propiedad soundTransform del canal para utilizar el objeto SoundTransform alterado. Para ejecutar este ejemplo, reemplace el nombre de archivo bigSound.mp3 con el nombre de un archivo MP3 local. A continuacin, ejecute el ejemplo. Escuchar el aumento del volumen del canal izquierdo mientras disminuye el volumen del canal derecho, y viceversa.
461
En este ejemplo podra lograrse el mismo efecto estableciendo la propiedad soundTransform de la clase SoundMixer. Sin embargo, se vera afectado el desplazamiento de todos los sonidos en reproduccin, no solo el sonido que reproduce este objeto SoundChannel.
Este cdigo empieza por crear un objeto Sound e indicarle que detecte el evento Event.ID3. Cuando se cargan los metadatos ID3 del archivo de sonido, se llama al mtodo onID3InfoReceived(). El destino del objeto Event que se pasa al mtodo onID3InfoReceived() es el objeto Sound original, de modo que el mtodo obtiene la propiedad id3 del objeto Sound y luego recorre todas sus propiedades con nombre para trazar sus valores.
462
Los datos de sonido se devuelven como un objeto ByteArray con 512 bytes de datos, cada uno de los cuales contiene un valor de coma flotante que oscila entre -1 y 1. Estos valores representan la amplitud de los puntos de la forma de onda del sonido en reproduccin. Los valores se transmiten en dos grupos de 256; el primer grupo para el canal estreo izquierdo y el segundo para el canal estreo derecho. El mtodo SoundMixer.computeSpectrum() devolver datos del espectro de frecuencias en lugar de datos de forma de onda si el parmetro FFTMode se establece en true. El espectro de frecuencias muestra la amplitud clasificada por la frecuencia de sonido, de menor a mayor. El algoritmo FFT (Fast Fourier Transform) se utiliza para convertir los datos de forma de onda en datos del espectro de frecuencias. Los valores resultantes del espectro de frecuencias oscilan entre 0 y 1,414 aproximadamente (la raz cuadrada de 2). En el siguiente diagrama se comparan los datos devueltos por el mtodo computeSpectrum() cuando el parmetro FFTMode se establece en true y cuando se establece en false. El sonido cuyos datos se han utilizado para este diagrama contiene un sonido alto de contrabajo en el canal izquierdo y un sonido de batera en el canal derecho.
El mtodo computeSpectrum() tambin puede devolver datos que se han vuelto a muestrear a una velocidad inferior. Normalmente, esto genera datos de forma de onda o de frecuencia ms suaves a expensas del detalle. El parmetro stretchFactor controla la velocidad a la que se muestrea el mtodo computeSpectrum(). Cuando el parmetro stretchFactor se establece en 0 (valor predeterminado), los datos de sonido se muestrean a una velocidad de 44,1 kHz. La velocidad se reduce a la mitad en los valores sucesivos del parmetro stretchFactor, de manera que un valor de 1 especifica una velocidad de 22,05 kHz, un valor de 2 especifica una velocidad de 11,025 kHz, etc. El mtodo computeSpectrum() an devuelve 256 bytes en cada canal estreo cuando se utiliza un valor stretchFactor ms alto. El mtodo SoundMixer.computeSpectrum() tiene algunas limitaciones:
Puesto que los datos de sonido de un micrfono o de los flujos RTMP no pasan por el objeto SoundMixer global,
el mtodo SoundMixer.computeSpectrum() no devolver datos de dichas fuentes.
463
Si uno o varios sonidos que se reproducen proceden de orgenes situados fuera del entorno limitado de contenido
actual, las restricciones de seguridad harn que el mtodo SoundMixer.computeSpectrum() genere un error. Para obtener ms detalles sobre las limitaciones de seguridad del mtodo SoundMixer.computeSpectrum(), consulte Consideraciones de seguridad al cargar y reproducir sonidos en la pgina 458 y Acceso a medios cargados como datos en la pgina 1084. Sin embargo, en una aplicacin de AIR, el contenido del entorno limitado de seguridad de la aplicacin (contenido instalado con la aplicacin AIR) no est limitado por estas restricciones de seguridad.
const PLOT_HEIGHT:int = 200; const CHANNEL_LENGTH:int = 256; var snd:Sound = new Sound(); var req:URLRequest = new URLRequest("bigSound.mp3"); snd.load(req); var channel:SoundChannel; channel = snd.play(); addEventListener(Event.ENTER_FRAME, onEnterFrame); snd.addEventListener(Event.SOUND_COMPLETE, onPlaybackComplete); var bytes:ByteArray = new ByteArray(); function onEnterFrame(event:Event):void { SoundMixer.computeSpectrum(bytes, false, 0); var g:Graphics = this.graphics; g.clear(); g.lineStyle(0, 0x6600CC); g.beginFill(0x6600CC); g.moveTo(0, PLOT_HEIGHT); var n:Number = 0; // left channel for (var i:int = 0; i < CHANNEL_LENGTH; i++) { n = (bytes.readFloat() * PLOT_HEIGHT); g.lineTo(i * 2, PLOT_HEIGHT - n); }
464
g.lineTo(CHANNEL_LENGTH * 2, PLOT_HEIGHT); g.endFill(); // right channel g.lineStyle(0, 0xCC0066); g.beginFill(0xCC0066, 0.5); g.moveTo(CHANNEL_LENGTH * 2, PLOT_HEIGHT); for (i = CHANNEL_LENGTH; i > 0; i--) { n = (bytes.readFloat() * PLOT_HEIGHT); g.lineTo(i * 2, PLOT_HEIGHT - n); } g.lineTo(0, PLOT_HEIGHT); g.endFill(); } function onPlaybackComplete(event:Event) { removeEventListener(Event.ENTER_FRAME, onEnterFrame); }
En primer lugar, este ejemplo carga y reproduce un archivo de sonido, y luego detecta el evento Event.ENTER_FRAME que activar el mtodo onEnterFrame() mientras se reproduce el sonido. El mtodo onEnterFrame() se inicia llamando al mtodo SoundMixer.computeSpectrum(), que almacena los datos de forma de onda del sonido en el objeto ByteArray bytes. La forma de onda del sonido se representa con la API de dibujo vectorial. El bucle for recorre los primeros 256 valores de datos; representa el canal estreo izquierdo y dibuja una lnea desde un punto al siguiente con el mtodo Graphics.lineTo(). Un segundo bucle for recorre el siguiente conjunto de 256 valores y los representa en orden inverso esta vez, de derecha a izquierda. Las representaciones de la forma de onda resultante pueden generar un interesante efecto de reflejo de imagen, tal como se muestra en la imagen siguiente.
465
Ms temas de ayuda
Michael Chaize: AIR, Android y el micrfono Christophe Coenraets: Notas de voz para Android
Acceso a un micrfono
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior La clase Microphone no tiene un mtodo constructor. En su lugar, se utiliza el mtodo Microphone.getMicrophone() esttico para obtener una nueva instancia de Microphone, tal como se muestra a continuacin.
var mic:Microphone = Microphone.getMicrophone();
Si se llama al mtodo Microphone.getMicrophone() sin un parmetro, se devuelve el primer dispositivo de entrada de sonido detectado en el sistema del usuario. Un sistema puede tener ms de un dispositivo de entrada de sonido conectado. La aplicacin puede utilizar la propiedad Microphone.names para obtener un conjunto de los nombres de todos los dispositivos de entrada de sonido disponibles. A continuacin, puede llamar al mtodo Microphone.getMicrophone() con un parmetro index que coincide con el valor de ndice del nombre de un dispositivo del conjunto. Es posible que el sistema no tenga conectado un micrfono u otro dispositivo de entrada de sonido. Se puede utilizar la propiedad Microphone.names o el mtodo Microphone.getMicrophone() para comprobar si el usuario tiene un dispositivo de entrada de sonido instalado. Si el usuario no tiene un dispositivo de entrada de sonido instalado, la longitud del conjunto names es cero y el mtodo getMicrophone() devuelve un valor null. Cuando la aplicacin llama al mtodo Microphone.getMicrophone(), Flash Player muestra el cuadro de dilogo Configuracin de Flash Player, que pregunta al usuario si desea que Flash Player acceda a la cmara y al micrfono del sistema. Una vez que el usuario hace clic en el botn Allow (Permitir) o en el botn Deny (Denegar) de este cuadro de dilogo, se distribuye un objeto StatusEvent. La propiedad code de la instancia de StatusEvent indica si se ha permitido o denegado el acceso al micrfono, tal como se muestra en este ejemplo:
466
import flash.media.Microphone; var mic:Microphone = Microphone.getMicrophone(); mic.addEventListener(StatusEvent.STATUS, this.onMicStatus); function onMicStatus(event:StatusEvent):void { if (event.code == "Microphone.Unmuted") { trace("Microphone access was allowed."); } else if (event.code == "Microphone.Muted") { trace("Microphone access was denied."); } }
La propiedad StatusEvent.code contiene "Microphone.Unmuted" si se ha permitido el acceso, o bien "Microphone.Muted" si se ha denegado. la propiedad Microphone.muted se establece en true o false cuando el usuario permite o deniega el acceso al micrfono, respectivamente. Sin embargo, la propiedad muted no se establece en la instancia de Microphone hasta que se haya distribuido el objeto StatusEvent, de manera que la aplicacin tambin debe esperar a que el evento StatusEvent.STATUS se distribuya antes de comprobar la propiedad Microphone.muted. Para que Flash Player pueda mostrar el cuadro de dilogo de configuracin, la aplicacin se debe ser lo suficientemente amplia para mostrarlo (215 por 138 pxeles como mnimo). De lo contrario, el acceso se deniega automticamente. El contenido que se ejecuta en el entorno limitado de la aplicacin de AIR no necesita el permiso de otro usuario para acceder al micrfono. De este modo, los eventos status para silenciar y quitar el silencio del micrfono nunca se distribuyen. El contenido que se ejecuta en AIR fuera del entorno limitado de la aplicacin requiere permiso del usuario, por lo que estos eventos de estado se pueden distribuir.
467
La propiedad de slo lectura activityLevel indica la cantidad de sonido que detecta el micrfono, en una escala
de 0 a 100.
La propiedad silenceLevel especifica la cantidad de sonido necesaria para activar el micrfono y distribuir un
evento ActivityEvent.ACTIVITY. La propiedad silenceLevel tambin utiliza una escala de 0 a 100, y el valor predeterminado es 10.
La propiedad silenceTimeout describe el nmero de milisegundos durante los cuales el nivel de actividad debe
permanecer por debajo del nivel de silencio, hasta que se distribuye un evento ActivityEvent.ACTIVITY para indicar que el micrfono ya est en silencio. El valor predeterminado de silenceTimeout es 2000. Las propiedades Microphone.silenceLevel y Microphone.silenceTimeout son de slo lectura, pero se puede utilizar el mtodo Microphone.setSilenceLevel() para cambiar sus valores.
468
En algunos casos, el proceso de activacin del micrfono cuando se detecta una nueva actividad puede provocar una breve demora. Esas demoras de activacin pueden eliminarse manteniendo el micrfono activo todo el tiempo. La aplicacin puede llamar al mtodo Microphone.setSilenceLevel() con el parmetro silenceLevel establecido en cero para indicar a Flash Player que mantenga el micrfono activo y siga recopilando datos de audio, incluso cuando no se detecten sonidos. Y a la inversa, si se establece el parmetro silenceLevel en 100, se evita que el micrfono est siempre activado. El ejemplo siguiente muestra informacin sobre el micrfono e informa de los eventos de actividad y de estado que distribuye un objeto Microphone:
import flash.events.ActivityEvent; import flash.events.StatusEvent; import flash.media.Microphone; var deviceArray:Array = Microphone.names; trace("Available sound input devices:"); for (var i:int = 0; i < deviceArray.length; i++) { trace(" " + deviceArray[i]); } var mic:Microphone = Microphone.getMicrophone(); mic.gain = 60; mic.rate = 11; mic.setUseEchoSuppression(true); mic.setLoopBack(true); mic.setSilenceLevel(5, 1000); mic.addEventListener(ActivityEvent.ACTIVITY, this.onMicActivity); mic.addEventListener(StatusEvent.STATUS, this.onMicStatus); var micDetails:String = "Sound input device name: " + mic.name + '\n'; micDetails += "Gain: " + mic.gain + '\n'; micDetails += "Rate: " + mic.rate + " kHz" + '\n'; micDetails += "Muted: " + mic.muted + '\n'; micDetails += "Silence level: " + mic.silenceLevel + '\n'; micDetails += "Silence timeout: " + mic.silenceTimeout + '\n'; micDetails += "Echo suppression: " + mic.useEchoSuppression + '\n'; trace(micDetails); function onMicActivity(event:ActivityEvent):void { trace("activating=" + event.activating + ", activityLevel=" + mic.activityLevel); } function onMicStatus(event:StatusEvent):void { trace("status: level=" + event.level + ", code=" + event.code); }
Cuando ejecute el ejemplo anterior, hable al micrfono del sistema o haga ruido, y ver que aparecen las sentencias trace resultantes en una consola o una ventana de depuracin.
469
Es posible reutilizar los bytes de la muestra como audio de reproduccin para un objeto Sound. Si es as, la propiedad rate del objeto Microphone se debe establecer en 44, que es la frecuencia de muestreo que utilizan los objetos Sound. (Tambin se pueden convertir las muestras del micrfono capturadas con una frecuencia ms baja a una frecuencia de 44 kHz necesaria para el objeto Sound.) Asimismo, se debe tener en cuenta que el objeto Microphone captura muestras monofnicas, mientras que el objeto Sound emplea sonido estreo; por lo tanto, se debe escribir cada uno de los bytes capturados por el objeto Microphone en el objeto Sound dos veces. En el siguiente ejemplo se capturan 4 segundos de datos del micrfono y se reproducen utilizando un objeto Sound:
470
const DELAY_LENGTH:int = 4000; var mic:Microphone = Microphone.getMicrophone(); mic.setSilenceLevel(0, DELAY_LENGTH); mic.gain = 100; mic.rate = 44; mic.addEventListener(SampleDataEvent.SAMPLE_DATA, micSampleDataHandler); var timer:Timer = new Timer(DELAY_LENGTH); timer.addEventListener(TimerEvent.TIMER, timerHandler); timer.start(); function micSampleDataHandler(event:SampleDataEvent):void { while(event.data.bytesAvailable) { var sample:Number = event.data.readFloat(); soundBytes.writeFloat(sample); } } var sound:Sound = new Sound(); var channel:SoundChannel; function timerHandler(event:TimerEvent):void { mic.removeEventListener(SampleDataEvent.SAMPLE_DATA, micSampleDataHandler); timer.stop(); soundBytes.position = 0; sound.addEventListener(SampleDataEvent.SAMPLE_DATA, playbackSampleHandler); channel.addEventListener( Event.SOUND_COMPLETE, playbackComplete ); channel = sound.play(); } function playbackSampleHandler(event:SampleDataEvent):void { for (var i:int = 0; i < 8192 && soundBytes.bytesAvailable > 0; i++) { trace(sample); var sample:Number = soundBytes.readFloat(); event.data.writeFloat(sample); event.data.writeFloat(sample); } } function playbackComplete( event:Event ):void { trace( "Playback finished."); }
Para obtener ms informacin sobre la reproduccin de sonidos a partir de los datos de muestra de sonido, consulte Trabajo con sonido generado dinmicamente en la pgina 453.
471
Leer un fuente RSS externa y analizar su contenido XML Crear una clase SoundFacade para simplificar la carga y la reproduccin de archivos de sonido Mostrar el progreso de la reproduccin de sonido Pausar y reanudar la reproduccin de sonido
Para obtener los archivos de la aplicacin para esta muestra, consulte www.adobe.com/go/learn_programmingAS3samples_flash_es. Los archivos de la aplicacin Podcast Player se encuentran en la carpeta Samples/PodcastPlayer. La aplicacin consta de los siguientes archivos:
Archivo PodcastPlayer.mxml o PodcastPlayer.fla comp/example/progra Clase de documento que contiene la lgica de la interfaz de usuario para el reproductor de podcast (slo Flash). mmingas3/podcastplay er/PodcastPlayer.as SoundPlayer.mxml Componente MXML que muestra botones de reproduccin y barras de progreso, y controla la reproduccin del sonido, slo para Flex. Estilos de la interfaz de usuario de la aplicacin (slo Flex). Iconos de aplicacin de estilos a los botones (slo Flex). Descripcin La interfaz de usuario de la aplicacin para Flex (MXML) o Flash (FLA).
main.css images/
comp/example/progra Clase del smbolo de clip de pelcula SoundPlayer que contiene la lgica de la interfaz de usuario para el mmingas3/podcastplay reproductor de sonidos (slo Flash). er/SoundPlayer.as comp/example/progra Procesador de celdas personalizado para visualizar un botn de reproduccin en una celda de cuadrcula de datos mmingas3/podcastplay (slo Flash). er/PlayButtonRenderer. as com/example/program Una clase base que proporciona propiedades y mtodos comunes para las clases RSSChannel y RSSItem. mingas3/podcastplayer /RSSBase.as
472
Archivo
Descripcin
com/example/program Una clase ActionScript que contiene datos sobre un canal RSS. mingas3/podcastplayer /RSSChannel.as com/example/program Una clase ActionScript que contiene datos sobre un elemento RSS. mingas3/podcastplayer /RSSItem.as com/example/program La clase ActionScript principal de la aplicacin. Rene los mtodos y los eventos de las clases Sound y mingas3/podcastplayer SoundChannel, y aade las funciones de pausa y reanudacin de reproduccin. /SoundFacade.as com/example/program Una clase ActionScript que recupera datos de un URL remoto. mingas3/podcastplayer /URLService.as playerconfig.xml Un archivo XML que contiene una lista de las fuentes RSS que representan canales podcast.
comp/example/progra Clase que se utiliza para aplicar formato de fechas fcilmente (slo Flash). mmingas3/utils/DateUt il.as
Cargar archivos de sonido con un objeto Sound, un objeto SoundLoaderContext y la clase SoundMixer Reproducir archivos de sonido con los objetos Sound y SoundChannel Distribuir eventos de progreso de reproduccin Pausar y reanudar la reproduccin del sonido mediante los objetos Sound y SoundChannel ltima modificacin 20/6/2011
473
La clase SoundFacade intenta ofrecer la mayor parte de las funciones de las clase de sonido ActionScript, pero con una menor complejidad. En el cdigo siguiente se muestra la declaracin de clase, las propiedades de clase y el mtodo constructor SoundFacade():
public class SoundFacade extends EventDispatcher { public var s:Sound; public var sc:SoundChannel; public var url:String; public var bufferTime:int = 1000; public public public public public public var var var var var var isLoaded:Boolean = false; isReadyToPlay:Boolean = false; isPlaying:Boolean = false; isStreaming:Boolean = true; autoLoad:Boolean = true; autoPlay:Boolean = true;
public var pausePosition:int = 0; public static const PLAY_PROGRESS:String = "playProgress"; public var progressInterval:int = 1000; public var playTimer:Timer; public function SoundFacade(soundUrl:String, autoLoad:Boolean = true, autoPlay:Boolean = true, streaming:Boolean = true, bufferTime:int = -1):void { this.url = soundUrl; // Sets Boolean values that determine the behavior of this object this.autoLoad = autoLoad; this.autoPlay = autoPlay; this.isStreaming = streaming; // Defaults to the global bufferTime value if (bufferTime < 0) { bufferTime = SoundMixer.bufferTime; } // Keeps buffer time reasonable, between 0 and 30 seconds this.bufferTime = Math.min(Math.max(0, bufferTime), 30000); if (autoLoad) { load(); } }
474
La clase SoundFacade ampla la clase EventDispatcher para que pueda distribuir sus propios eventos. El cdigo de clase declara primero las propiedades de un objeto Sound y un objeto SoundChannel. La clase tambin almacena el valor del URL del archivo de sonido y una propiedad bufferTime que se utilizar al transmitir el sonido. Asimismo, acepta algunos valores de parmetro booleanos que afectan al comportamiento de carga y reproduccin.
El parmetro autoLoad indica al objeto que la carga de sonido debe empezar en cuanto se cree este objeto. El parmetro autoPlay indica que la reproduccin de sonido debe empezar en cuanto se hayan cargado suficientes
datos de sonido. Si se trata de un flujo de sonido, la reproduccin empezar tan pronto como se hayan cargado suficientes datos, segn especifica la propiedad bufferTime.
El parmetro streaming indica que este archivo de sonido puede empezar a reproducirse antes de que haya
finalizado la carga. El parmetro bufferTime se establece de forma predeterminada en un valor de -1. Si el mtodo constructor detecta un valor negativo en el parmetro bufferTime, establece la propiedad bufferTime en el valor de SoundMixer.bufferTime. Esto permite que la aplicacin se establezca de forma predeterminada en el valor SoundMixer.bufferTime global, segn se desee. Si el parmetro autoLoad se establece en true, el mtodo constructor llama inmediatamente al siguiente mtodo
load() para iniciar la carga del archivo de sonido: public function load():void { if (this.isPlaying) { this.stop(); this.s.close(); } this.isLoaded = false; this.s = new Sound(); this.s.addEventListener(ProgressEvent.PROGRESS, onLoadProgress); this.s.addEventListener(Event.OPEN, onLoadOpen); this.s.addEventListener(Event.COMPLETE, onLoadComplete); this.s.addEventListener(Event.ID3, onID3); this.s.addEventListener(IOErrorEvent.IO_ERROR, onIOError); this.s.addEventListener(SecurityErrorEvent.SECURITY_ERROR, onIOError); var req:URLRequest = new URLRequest(this.url); var context:SoundLoaderContext = new SoundLoaderContext(this.bufferTime, true); this.s.load(req, context); }
El mtodo load() crea un nuevo objeto Sound y aade detectores para todos los eventos de sonido importantes. A continuacin, indica al objeto Sound que cargue el archivo de sonido, mediante un objeto SoundLoaderContext para pasar el valor bufferTime. Puesto que se puede cambiar la propiedad url, se puede usar una instancia SoundFacade para reproducir distintos archivos de sonido en secuencia: slo hay que cambiar la propiedad url y llamar al mtodo load() para que se cargue el nuevo archivo de sonido. Los tres siguientes mtodos de deteccin de eventos muestran la forma en que el objeto SoundFacade hace un seguimiento del progreso de carga y decide el momento en que se inicia la reproduccin del sonido:
475
public function onLoadOpen(event:Event):void { if (this.isStreaming) { this.isReadyToPlay = true; if (autoPlay) { this.play(); } } this.dispatchEvent(event.clone()); } public function onLoadProgress(event:ProgressEvent):void { this.dispatchEvent(event.clone()); } public function onLoadComplete(event:Event):void { this.isReadyToPlay = true; this.isLoaded = true; this.dispatchEvent(evt.clone()); if (autoPlay && !isPlaying) { play(); } }
El mtodo onLoadOpen() se ejecuta cuando se inicia la carga de sonido. Si se puede reproducir el sonido en el modo de transmisin, el mtodo onLoadComplete() establece el indicador isReadyToPlay en true inmediatamente. El indicador isReadyToPlay determina si la aplicacin puede empezar a reproducir el sonido, tal vez como respuesta a una accin de usuario, como hacer clic en un botn Reproducir. La clase SoundChannel administra el bfer de los datos de sonido, de modo que no es necesario comprobar explcitamente si se han cargado suficientes datos antes de llamar al mtodo play(). El mtodo onLoadProgress() se ejecuta peridicamente durante el proceso de carga. Distribuye un clon de su objeto ProgressEvent que utilizar el cdigo que usa este objeto SoundFacade. Cuando los datos de sonido se han cargado completamente, se ejecuta el mtodo onLoadComplete() y se llama al mtodo play() para sonidos que no sean de una transmisin de flujo si es necesario. El mtodo play() se muestra a continuacin.
476
public function play(pos:int = 0):void { if (!this.isPlaying) { if (this.isReadyToPlay) { this.sc = this.s.play(pos); this.sc.addEventListener(Event.SOUND_COMPLETE, onPlayComplete); this.isPlaying = true; this.playTimer = new Timer(this.progressInterval); this.playTimer.addEventListener(TimerEvent.TIMER, onPlayTimer); this.playTimer.start(); } } }
El mtodo play() llama al mtodo Sound.play() si el sonido est listo para reproducirse. El objeto SoundChannel resultante se almacena en la propiedad sc. El mtodo play() crea un objeto Timer que se utilizar para distribuir eventos de progreso de reproduccin a intervalos regulares.
El mtodo onPlayTimer() implementa la tcnica de estimacin de tamao descrita en la seccinControl de la reproduccin en la pgina 456. Luego crea una nueva instancia de ProgressEvent con un tipo de evento de SoundFacade.PLAY_PROGRESS, con la propiedad bytesLoaded establecida en la posicin actual del objeto SoundChannel y la propiedad bytesTotal establecida en la duracin estimada de los datos de sonido.
477
public function stop(pos:int = 0):void { if (this.isPlaying) { this.pausePosition = pos; this.sc.stop(); this.playTimer.stop(); this.isPlaying = false; } }
Cuando se llama al mtodo SoundFacade.stop(), ste establece la propiedad pausePosition para que la aplicacin sepa dnde colocar la cabeza lectora si el usuario desea reanudar la reproduccin del mismo sonido. Los mtodos SoundFacade.pause() y SoundFacade.resume() que se muestran a continuacin invocan los mtodos
SoundFacade.stop() y SoundFacade.play() respectivamente y pasan un valor de parmetro pos cada vez. public function pause():void { stop(this.sc.position); } public function resume():void { play(this.pausePosition); }
El mtodo pause() pasa el valor SoundChannel.position al mtodo play(), que almacena dicho valor en la propiedad pausePosition. El mtodo resume() empieza a reproducir de nuevo el mismo sonido con el valor pausePosition como punto inicial.
Almacenar la lista de fuentes e informacin de utilizacin sobre cada episodio de una instancia de SharedObject
que se pueda utilizar la prxima vez que el usuario ejecute la aplicacin.
Permitir que el usuario aada su propia fuente RSS a la lista de canales podcast. Recordar la posicin de la cabeza lectora cuando el usuario detenga o abandone un episodio; de este modo, se puede
reiniciar desde dicho punto la prxima vez que el usuario ejecute la aplicacin.
Descargar archivos MP3 de episodios para escuchar cuando el usuario no est conectado a Internet. aadir funciones de suscripcin que busquen nuevos episodios peridicamente en un canal podcast y actualicen la
lista de episodios de forma automtica.
Aadir funciones de bsqueda y exploracin de emisiones podcast con la API de un servicio de alojamiento de
podcast, como Odeo.com.
478
clase Video: el cuadro de contenido de vdeo clsico en el escenario es una instancia de la clase Video. La clase Video
es un objeto de visualizacin, de manera que se puede manipular con las mismas tcnicas que se aplican a otros objetos similares, como el ajuste de la posicin, la aplicacin de transformaciones, la aplicacin de filtros y modos de mezcla, etc.
StageVideo: la clase Video suele utilizar la representacin y descodificacin con software. Si la aceleracin de
hardware con GPU est disponible en un dispositivo, la aplicacin puede aprovechar la presentacin con aceleracin por hardware cambiando a la clase StageVideo. La API de StageVideo incluye un conjunto de eventos que indican al cdigo cundo alternar entre los objetos StageVideo y Video. El vdeo del escenario impone algunas restricciones menores en la reproduccin de vdeo. Si la aplicacin acepta estas limitaciones, implemente la API de StageVideo. Consulte Directrices y limitaciones en la pgina 520.
Clase NetStream: cuando se carga un archivo de vdeo para que se controle mediante ActionScript, una instancia
de NetStream representa el origen del contenido de vdeo; en este caso, una trasmisin de datos de vdeo. La utilizacin de la instancia de NetStream tambin implica utilizar un objeto NetConnection, que es la conexin al archivo de vdeo, al igual que el tnel con el que se alimentan los datos de vdeo.
Clase Camera: cuando se trabaja con datos de vdeo desde una cmara conectada al equipo del usuario, una
instancia de Camera representa el origen del contenido de vdeo; la cmara del usuario y los datos de vdeo que hace disponibles. Cuando se carga vdeo externo, se puede cargar el archivo desde un servidor web estndar para obtener una descarga progresiva, o bien, se puede trabajar con un flujo de vdeo transmitido por un servidor especializado como Flash Media Server de Adobe.
479
Conceptos y trminos importantes Punto de referencia Marcador que se puede colocar en un instante de tiempo especfico en un archivo de vdeo; por ejemplo, funciona como un marcador para buscar ese instante o proporcionar datos adicionales asociados a dicho momento.
Codificacin Proceso de convertir datos de vdeo en un formato a otro formato; por ejemplo, convertir un vdeo de origen de alta resolucin a un formato adecuado para la transmisin por Internet. Fotograma Segmento individual de informacin de vdeo; cada fotograma es como una imagen esttica que
representa una instantnea de un momento en el tiempo. Si se reproducen fotogramas de forma secuencial a alta velocidad, se crea la ilusin del movimiento.
Fotograma clave Fotograma de vdeo que contiene informacin completa del fotograma. El resto de fotogramas que
siguen a un fotograma clave slo contienen informacin sobre cmo difieren del fotograma clave, en lugar de incluir informacin relativa al fotograma completo.
Metadatos Informacin sobre un archivo de vdeo que se puede incorporar en el archivo de vdeo y recuperarse cuando se haya cargado el vdeo. Descarga progresiva Cuando se transmite un archivo de vdeo desde un servidor web estndar, los datos de vdeo se
cargan mediante la descarga progresiva; es decir, la informacin de vdeo se carga de forma secuencial. Esto presenta la ventaja de que el vdeo puede empezar a reproducirse antes de que se haya descargado todo el archivo; sin embargo, impide poder saltar a una parte del vdeo que no se haya cargado an.
Transmisin Como alternativa a la descarga progresiva, se puede utilizar un servidor de vdeo especial para emitir
vdeo por Internet mediante la tcnica conocida como transmisin de flujo (a veces denominada "transmisin de flujo verdadera"). Con la transmisin de flujo, el ordenador del espectador nunca descarga el vdeo completo a la vez. Para acelerar los tiempos de descarga, el ordenador slo necesita, en cualquier momento, una parte de la informacin de vdeo total. Puesto que un servidor especial controla la transmisin del contenido de vdeo, se puede acceder en todo momento a cualquier parte del vdeo, en lugar de tener que esperar a que se descargue antes de acceder a l.
480
Ms temas de ayuda
Flash Media Server: Supported codecs (Flash Media Server: cdecs compatibles; en ingls) Adobe HTTP Dynamic Streaming (en ingls)
Nota: Flash Player admite todos niveles y perfiles del estndar H.264. Al ajustarse a estas recomendaciones, se asegura la aceleracin de hardware y se obtiene una mejor experiencia de usuario en la mayora de dispositivos. Estas recomendaciones no son obligatorias. Para obtener informacin detallada y la configuracin de codificacin en Adobe Media Encoder CS5, consulte Recommendations for encoding H.264 video for Flash Player 10.1 on mobile devices (http://www.adobe.com/devnet/devices/articles/mobile_video_encoding.html) (Recomendaciones para la codificacin de vdeo H.264 para Flash Player 10.1 en dispositivos mviles; en ingls). Nota: en iOS, solo se puede reproducir vdeo codificado con los cdecs Sorenson Spark y On2 VP6 mediante la clase Video. Es posible reproducir vdeo con codificacin H.264 en el reproductor de vdeo del dispositivo si se abre la URL con el vdeo mediante la funcin flash.net.navigateToURL(). Tambin se puede reproducir vdeo H.264 usando la etiqueta <video> en una pgina HTML visualizada en un objeto StageWebView.
481
Flash Player 9.0.115.0 y versiones posteriores admiten archivos que proceden del formato contenedor MPEG-4 estndar. Estos archivos incluyen F4V, MP4, M4A, MOV, MP4V, 3GP y 3G2, si contienen vdeo H.264 o audio codificado HE-AAC v2, o ambos. H.264 proporciona mayor calidad de vdeo a velocidades de bits inferiores en comparacin con el mismo perfil de codificacin en Sorenson o On2. HE-AAC v2 es una extensin de AAC, un formato de audio estndar definido en el estndar de vdeo MPEG-4. HE-AAC v2 utiliza tcnicas de rplica de banda espectral (SBR) y estreo paramtrico (PS) para aumentar la eficacia de la codificacin a velocidades de bits bajas. En la siguiente tabla se incluyen los cdecs compatibles. Tambin se muestra el formato de archivo SWF correspondiente y las versiones de Flash Player y AIR necesarias para reproducirlos:
Cdec Versin del formato de archivo SWF (primera versin de publicacin admitida) 6 6 Flash Player y AIR (primera versin necesaria para reproduccin)
Flash Player 6, Flash Lite 3 Flash Player 8, Flash Lite 3. nicamente Flash Player 8 y versiones posteriores permiten publicar y reproducir vdeo On2 VP6.
H.264 (MPEG-4 Parte 10) ADPCM MP3 AAC (MPEG-4 Parte 3) Speex (audio) Nellymoser
9 6 6 9 10 6
Flash Player 9 Update 3, AIR 1.0 Flash Player 6, Flash Lite 3 Flash Player 6, Flash Lite 3 Flash Player 9 Update 3, AIR 1.0 Flash Player 10, AIR 1.5 Flash Player 6
ftyp
El cuadro ftyp identifica las funciones que debe admitir un programa para reproducir un formato de archivo concreto.
moov
El cuadro moov es realmente el encabezado de un archivo F4V. Contiene uno o varios de los dems cuadros que a su vez incluyen otros cuadros que definen la estructura de los datos F4V. Un archivo F4V debe incluir nicamente un cuadro moov.
482
mdat
Un cuadro mdat contiene la carga til de datos para el archivo F4V. Un archivo FV contiene nicamente un cuadro mdat. Un cuadro moov tambin puede estar presente en el archivo, ya que el cuadro mdat no se puede interpretar por s mismo. Los archivos F4V admiten enteros multibyte con un orden de bytes bigEndian, en el que el byte ms significativo se produce primero, en la direccin ms baja.
Se pueden utilizar clips de vdeo ms largos en su aplicacin sin que ello ralentice la reproduccin. Los archivos de
vdeo externos utilizan memoria en cach, lo que significa que los archivos de gran tamao se almacenan en pequeas partes y se accede a los mismos de forma dinmica. Por este motivo, los archivos FLV y F4V externos requieren menos memoria que los archivos de vdeo incrustados.
Un archivo de vdeo externo puede tener una velocidad de fotogramas distinta a la del archivo SWF en el que se
reproduce. Por ejemplo, la velocidad de fotogramas del archivo SWF se puede establecer en 30 fotogramas por segundo (fps) y la del vdeo en 21 fps. Esta opcin permite un mejor control del vdeo que el vdeo incorporado, para garantizar una reproduccin del vdeo sin problemas. Asimismo, permite reproducir archivos de vdeo a distintas velocidades de fotogramas sin necesidad de modificar el contenido del archivo SWF existente.
Con los archivos de vdeo externos, la reproduccin de contenido SWF no se interrumpe mientras que el archivo
de vdeo se est cargando. A veces, los archivos de vdeo importados pueden interrumpir la reproduccin de un documento para realizar ciertas funciones, como acceder a una unidad de CD-ROM. Los archivos de vdeo pueden realizar funciones independientemente del contenido SWF, sin que la reproduccin se vea interrumpida.
La subtitulacin de contenido de vdeo es ms fcil con los archivos FLV externos, ya que es posible acceder a los
metadatos del vdeo mediante controladores de eventos.
483
Cargar un archivo de vdeo dinmicamente con las clases NetConnection y NetStream y mostrar el vdeo en un
objeto Video.
Capturar las entradas de la cmara del usuario. Para obtener ms informacin, consulte Trabajo con cmaras en
la pgina 527.
como Flash Media Server 2 de Adobe, transmita el valor null al mtodo connect() para reproducir los archivos de vdeo desde una direccin HTTP o una unidad local. Si se conecta a un servidor, defina este parmetro con el URI de la aplicacin que contiene el archivo de vdeo en el servidor.
var nc:NetConnection = new NetConnection(); nc.connect(null);
2 Cree un objeto NetStream que adopte un objeto NetConnection como parmetro y especifique el archivo de vdeo
que desee cargar. El siguiente fragmento de cdigo conecta un objeto NetStream con la instancia de NetConnection especificada y carga un archivo de vdeo denominado video.mp4 en el mismo directorio que el archivo SWF:
var ns:NetStream = new NetStream(nc); ns.addEventListener(AsyncErrorEvent.ASYNC_ERROR, asyncErrorHandler); ns.play("video.mp4"); function asyncErrorHandler(event:AsyncErrorEvent):void { // ignore error }
484
3 Cree un nuevo objeto Video y asocie el objeto NetStream creado anteriormente utilizando el mtodo
attachNetStream() de la clase Video. A continuacin, se puede aadir el objeto Video a la lista de visualizacin con el mtodo addChild(), tal como se muestra en el fragmento siguiente: var vid:Video = new Video(); vid.attachNetStream(ns); addChild(vid);
Conforme Flash Player ejecuta este cdigo, intenta cargar el archivo de vdeo video.mp4 desde el mismo directorio que su archivo SWF.
Ms temas de ayuda
Flex: Spark VideoPlayer control (en ingls) spark.components.VideoDisplay
ningn efecto.
resume(): reanuda la reproduccin de un flujo de vdeo que se ha detenido. Si el vdeo ya se est reproduciendo, la
Nota: el mtodo stop() no est disponible. Para detener un flujo, se debe pausar la reproduccin y buscar el principio del flujo de vdeo. Nota: el mtodo play() no reanuda la reproduccin; se utiliza para cargar archivos de vdeo. En el ejemplo siguiente se demuestra cmo controlar un vdeo mediante diferentes botones. Para ejecutar el siguiente ejemplo, cree un nuevo documento y aada cuatro instancias de botn al espacio de trabajo (pauseBtn, playBtn, stopBtn y togglePauseBtn):
485
var nc:NetConnection = new NetConnection(); nc.connect(null); var ns:NetStream = new NetStream(nc); ns.addEventListener(AsyncErrorEvent.ASYNC_ERROR, asyncErrorHandler); ns.play("video.flv"); function asyncErrorHandler(event:AsyncErrorEvent):void { // ignore error } var vid:Video = new Video(); vid.attachNetStream(ns); addChild(vid); pauseBtn.addEventListener(MouseEvent.CLICK, pauseHandler); playBtn.addEventListener(MouseEvent.CLICK, playHandler); stopBtn.addEventListener(MouseEvent.CLICK, stopHandler); togglePauseBtn.addEventListener(MouseEvent.CLICK, togglePauseHandler); function pauseHandler(event:MouseEvent):void { ns.pause(); } function playHandler(event:MouseEvent):void { ns.resume(); } function stopHandler(event:MouseEvent):void { // Pause the stream and move the playhead back to // the beginning of the stream. ns.pause(); ns.seek(0); } function togglePauseHandler(event:MouseEvent):void { ns.togglePause(); }
Si se hace clic en la instancia de botn pauseBtn, el archivo de vdeo quedar en pausa. Si el vdeo ya est en pausa, hacer clic en este botn no tendr ningn efecto. Si se hace clic en el botn playBtn, se reanuda la reproduccin de vdeo si sta estaba en pausa anteriormente; de lo contrario, el botn no tendr ningn efecto si el vdeo ya estaba en reproduccin.
486
Los dos cdigos que se desean detectar especficamente son "NetStream.Play.Start" y "NetStream.Play.Stop", que sealan el principio y el final de la reproduccin del vdeo. El siguiente fragmento utiliza una sentencia switch para filtrar estos dos cdigos y rastrear un mensaje:
function statusHandler(event:NetStatusEvent):void { switch (event.info.code) { case "NetStream.Play.Start": trace("Start [" + ns.time.toFixed(3) + " seconds]"); break; case "NetStream.Play.Stop": trace("Stop [" + ns.time.toFixed(3) + " seconds]"); break; } }
Si se detecta el evento netStatus (NetStatusEvent.NET_STATUS), se puede crear un reproductor de vdeo que cargue el vdeo siguiente de una lista de reproduccin una vez que haya terminado de reproducirse el vdeo actual.
487
Activacin del modo de pantalla completa para Flash Player en un navegador Antes de que pueda implementar el modo de pantalla completa para Flash Player en un navegador, actvelo mediante la plantilla de publicacin para su aplicacin. Las plantillas que permiten la pantalla completa incluyen etiquetas <object> y <embed> que contienen un parmetro allowFullScreen. El siguiente ejemplo muestra el parmetro allowFullScreen en una etiqueta <embed>.
<object classid="clsid:D27CDB6E-AE6D-11cf-96B8-444553540000" id="fullScreen" width="100%" height="100%" codebase="http://fpdownload.macromedia.com/get/flashplayer/current/swflash.cab"> ... <param name="allowFullScreen" value="true" /> <embed src="fullScreen.swf" allowFullScreen="true" quality="high" bgcolor="#869ca7" width="100%" height="100%" name="fullScreen" align="middle" play="true" loop="false" quality="high" allowScriptAccess="sameDomain" type="application/x-shockwave-flash" pluginspage="http://www.adobe.com/go/getflashplayer"> </embed> ... </object>
En Flash, seleccione Archivo -> Configuracin de publicacin y en el cuadro de dilogo Configuracin de publicacin, en la ficha HTML, seleccione la plantilla Slo Flash - Permitir pantalla completa. En Flex, asegrese de que la plantilla HTML incluya las etiquetas <object> y <embed> que son compatibles con la pantalla completa. Inicio del modo de pantalla completa Para el contenido de Flash Player que se ejecuta en un navegador, el modo de pantalla completa se inicia para vdeo como respuesta a un clic de ratn o a una pulsacin de tecla. Por ejemplo, el modo de pantalla completa se puede iniciar cuando el usuario hace clic en un botn con la etiqueta de modo de pantalla completa o selecciona un comando Pantalla completa en un men contextual. Para responder al usuario, aada un detector de eventos al objeto en el que sucede la operacin. El siguiente cdigo aade un detector de eventos a un botn en el que el usuario hace clic para introducir el modo de pantalla completa:
var fullScreenButton:Button = new Button(); fullScreenButton.label = "Full Screen"; addChild(fullScreenButton); fullScreenButton.addEventListener(MouseEvent.CLICK, fullScreenButtonHandler); function fullScreenButtonHandler(event:MouseEvent) { stage.displayState = StageDisplayState.FULL_SCREEN; }
El cdigo inicia el modo de pantalla completa estableciendo la propiedad Stage.displayState en StageDisplayState.FULL_SCREEN. Este cdigo escala todo el escenario a modo de pantalla completa con el ajuste de escala de vdeo en proporcin al espacio que ocupa en el escenario. La propiedad fullScreenSourceRect permite especificar un rea concreta del escenario para realizar un ajuste de escala a pantalla completa. En primer lugar, defina el rectngulo que desee escalar a pantalla completa. Despus asgnelo a la propiedad Stage.fullScreenSourceRect. Esta versin de la funcin fullScreenButtonHandler() agrega dos lneas adicionales de cdigo que escalan slo el vdeo a pantalla completa.
488
private function fullScreenButtonHandler(event:MouseEvent) { var screenRectangle:Rectangle = new Rectangle(video.x, video.y, video.width, video.height); stage.fullScreenSourceRect = screenRectangle; stage.displayState = StageDisplayState.FULL_SCREEN; }
Aunque en este ejemplo se invoca un controlador de eventos como respuesta a un clic de ratn, la tcnica de pasar al modo de pantalla completa es la misma tanto para Flash Player como para AIR. Defina el rectngulo que desee escalar y, a continuacin, establezca la propiedad Stage.displayState. Para obtener ms informacin, consulte Referencia de ActionScript 3.0 para la plataforma de Adobe Flash. El siguiente ejemplo completo agrega cdigo que crea la conexin y el objeto NetStream para el vdeo y comienza a reproducirlo.
package { import import import import import import import import import
public class FullScreenVideoExample extends Sprite { var fullScreenButton:Button = new Button(); var video:Video = new Video(); public function FullScreenVideoExample() { var videoConnection:NetConnection = new NetConnection(); videoConnection.connect(null); var videoStream:NetStream = new NetStream(videoConnection); videoStream.client = this; addChild(video); video.attachNetStream(videoStream); videoStream.play("http://www.helpexamples.com/flash/video/water.flv"); fullScreenButton.x = 100;
489
fullScreenButton.y = 270; fullScreenButton.label = "Full Screen"; addChild(fullScreenButton); fullScreenButton.addEventListener(MouseEvent.CLICK, fullScreenButtonHandler); } private function fullScreenButtonHandler(event:MouseEvent) { var screenRectangle:Rectangle = new Rectangle(video.x, video.y, video.width, video.height); stage.fullScreenSourceRect = screenRectangle; stage.displayState = StageDisplayState.FULL_SCREEN; } public function onMetaData(infoObject:Object):void { // stub for callback function } } }
La funcin onMetaData() es una funcin callback para administrar metadatos de vdeo, si existen. Una funcin callback es una funcin que llama el tiempo de ejecucin como respuesta a algn tipo de instancia o evento. En este ejemplo, la funcin onMetaData()es un cdigo auxiliar que cumple con el requisito de proporcionar la funcin. Para obtener ms informacin, consulte Escritura de mtodos callback para metadatos y puntos de referencia en la pgina 491. Cancelacin del modo de pantalla completa Un usuario puede cancelar el modo de pantalla completa introduciendo uno de los mtodos abreviados de teclado como, por ejemplo, la tecla Esc. Para cancelar el modo de pantalla completa en ActionScript, establezca la propiedad Stage.diplayState en StageDisplayState.NORMAL. El cdigo del siguiente ejemplo cancela el modo de pantalla completa cuando se produce el evento netStatus de NetStream.Play.Stop.
videoStream.addEventListener(NetStatusEvent.NET_STATUS, netStatusHandler); private function netStatusHandler(event:NetStatusEvent) { if(event.info.code == "NetStream.Play.Stop") stage.displayState = StageDisplayState.NORMAL; }
Aceleracin de hardware a pantalla completa Cuando se vuelve a escalar un rea rectangular del escenario en modo de pantalla completa, Flash Player o AIR utilizan la aceleracin de hardware, si est disponible y habilitada. El tiempo de ejecucin utiliza el adaptador de vdeo del equipo para agilizar el ajuste de escala del vdeo, o una parte del escenario, al tamao de pantalla competa. En estas circunstancias, las aplicaciones de Flash Player suelen beneficiarse cambiando a la clase StageVideo a partir de la clase Video. Para obtener ms informacin sobre la aceleracin de hardware a pantalla completa, consulte Trabajo con el modo de pantalla completa en la pgina 163. Para obtener ms informacin sobre StageVideo, consulte Uso de la clase StageVideo para la presentacin con aceleracin por hardware en la pgina 518.
490
Puntos de referencia de navegacin: estos puntos se incorporan al flujo de vdeo y al paquete de metadatos al
codificar el archivo de vdeo. Los puntos de referencia de navegacin se utilizan para permitir a los usuarios buscar una parte especificada de un archivo.
Puntos de referencia de evento: los puntos de referencia de evento se incorporan al flujo de vdeo y al paquete de
metadatos FLV al codificar el archivo de vdeo. Se puede escribir cdigo para controlar eventos que se activan en puntos especificados durante la reproduccin de vdeo.
491
Puntos de referencia de ActionScript: se trata de puntos referencia que slo estn disponibles en el componente
FLVPlayback de Flash. Los puntos de referencia de ActionScript son puntos externos que se crean y se accede a ellos con el cdigo de ActionScript. Se puede escribir cdigo para activar estos puntos de referencia en relacin con la reproduccin del vdeo. Estos puntos de referencia son menos precisos que los incorporados (hasta una dcima de segundo), ya que el reproductor de vdeo realiza un seguimiento de los mismos de forma independiente. Si se va a crear una aplicacin en la que se desea que los usuarios naveguen a un punto de referencia, se deben crear e incorporar puntos de referencia al codificar el archivo en lugar de utilizar puntos de referencia de ActionScript. Se recomienda incorporar los puntos de referencia en el archivo FLV, ya que resultan ms precisos. Los puntos de referencia de navegacin crean un fotograma clave en una ubicacin especificada, por lo que se puede utilizar cdigo para desplazar la cabeza lectora del reproductor de vdeo a dicha ubicacin. Se pueden establecer puntos determinados en un archivo de vdeo donde se desee que busquen los usuarios. Por ejemplo, si el vdeo incluyera varios captulos o segmentos, se podra controlar mediante la incorporacin de puntos de referencia de navegacin en el archivo de vdeo. Para ms informacin sobre la codificacin de archivos de vdeo de Adobe con puntos de referencia, consulte "Incorporacin de puntos de referencia" en Uso de Flash. Se puede acceder a parmetros de punto de referencia al escribir cdigo ActionScript. Los parmetros de punto de referencia constituyen una parte del objeto de evento recibido mediante el controlador callback. Para activar determinadas acciones en el cdigo cuando un archivo FLV alcanza un punto de referencia especfico, se utiliza el controlador de eventos NetStream.onCuePoint. Para sincronizar una accin para un punto de referencia en un archivo de vdeo F4V, debe recuperar los datos del punto desde las funciones callback onMetaData() o onXMPData() y activar el punto de referencia utilizando la clase Timer en ActionScript 3.0. Para obtener ms informacin sobre los puntos de referencia F4V, consulte Uso de onXMPData() en la pgina 503. Para obtener ms informacin sobre la administracin de puntos de referencia y metadatos, consulte Escritura de mtodos callback para metadatos y puntos de referencia en la pgina 491.
492
var nc:NetConnection = new NetConnection(); nc.connect(null); var ns:NetStream = new NetStream(nc); ns.addEventListener(AsyncErrorEvent.ASYNC_ERROR, asyncErrorHandler); ns.play("video.flv"); function asyncErrorHandler(event:AsyncErrorEvent):void { trace(event.text); } var vid:Video = new Video(); vid.attachNetStream(ns); addChild(vid);
El cdigo anterior carga un archivo de vdeo local llamado video.flv y detecta la distribucin de asyncError (AsyncErrorEvent.ASYNC_ERROR). Este evento se distribuye cuando se genera una excepcin desde el cdigo asincrnico nativo. En este caso, se distribuye cuando un el archivo de vdeo contiene metadatos o informacin de punto de referencia y no se han definido los detectores apropiados. El cdigo anterior controla el evento asyncError y omite el error si no interesan los metadatos o la informacin de punto de referencia del archivo de vdeo. Si tuviera un archivo FLV con metadatos y varios puntos de referencia, la funcin trace() mostrara los siguientes mensajes de error:
Error Error Error Error #2095: #2095: #2095: #2095: flash.net.NetStream flash.net.NetStream flash.net.NetStream flash.net.NetStream was was was was unable unable unable unable to to to to invoke invoke invoke invoke callback callback callback callback onMetaData. onCuePoint. onCuePoint. onCuePoint.
Los errores se producen porque el objeto NetStream no ha podido encontrar un mtodo callback onMetaData o onCuePoint. Hay varias maneras de definir estos mtodos callback en las aplicaciones.
Ms temas de ayuda
Flash Media Server: Handling metadata in streams (Flash Media Server: Administracin de metadatos en flujos; en ingls)
493
Si se desea detectar los mtodos callback onMetaData o onCuePoint, es necesario definir mtodos para controlarlos, tal y como se muestra en el siguiente fragmento de cdigo:
var customClient:Object = new Object(); customClient.onMetaData = metaDataHandler; function metaDataHandler(infoObject:Object):void { trace("metadata"); }
El cdigo anterior detecta el mtodo callback onMetaData y llama al mtodo metaDataHandler(), que rastrea una cadena. Si el motor de ejecucin de Flash ha detectado un punto de referencia, no se generarn errores aunque se defina el mtodo callback onCuePoint.
Creacin de una clase personalizada y definicin de mtodos para controlar los mtodos callback
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior En el cdigo siguiente se establece la propiedad client del objeto NetStream en una clase personalizada, CustomClient, que define controladores para los mtodos callback:
var nc:NetConnection = new NetConnection(); nc.connect(null); var ns:NetStream = new NetStream(nc); ns.client = new CustomClient(); ns.play("video.flv"); var vid:Video = new Video(); vid.attachNetStream(ns); addChild(vid);
La clase CustomClient define un controlador para el controlador callback onMetaData. Si se ha detectado un punto de referencia y se ha llamado al controlador callback onCuePoint, se distribuir un evento asyncError (AsyncErrorEvent.ASYNC_ERROR) indicando que flash.net.NetStream no ha podido invocar la funcin callback onCuePoint. Para evitar este error, se debe definir un mtodo callback onCuePoint en la clase CustomClient, o bien definir un controlador de eventos para el evento asyncError.
494
Ampliacin de la clase NetStream y adicin de mtodos para controlar los mtodos callback
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior El cdigo siguiente crea una instancia de la clase CustomNetStream, que se define en un listado de cdigo posterior:
var ns:CustomNetStream = new CustomNetStream(); ns.play("video.flv"); var vid:Video = new Video(); vid.attachNetStream(ns); addChild(vid);
En la lista de cdigos siguiente se define la clase CustomNetStream que ampla la clase NetStream y controla la creacin del objeto NetConnection necesario y los mtodos de controlador callback onMetaData y onCuePoint:
package { import flash.net.NetConnection; import flash.net.NetStream; public class CustomNetStream extends NetStream { private var nc:NetConnection; public function CustomNetStream() { nc = new NetConnection(); nc.connect(null); super(nc); } public function onMetaData(infoObject:Object):void { trace("metadata"); } public function onCuePoint(infoObject:Object):void { trace("cue point"); } } }
Si se desea cambiar el nombre de los mtodos onMetaData() y onCuePoint() en la clase CustomNetStream, se podra utilizar el cdigo siguiente:
495
package { import flash.net.NetConnection; import flash.net.NetStream; public class CustomNetStream extends NetStream { private var nc:NetConnection; public var onMetaData:Function; public var onCuePoint:Function; public function CustomNetStream() { onMetaData = metaDataHandler; onCuePoint = cuePointHandler; nc = new NetConnection(); nc.connect(null); super(nc); } private function metaDataHandler(infoObject:Object):void { trace("metadata"); } private function cuePointHandler(infoObject:Object):void { trace("cue point"); } } }
496
package { import flash.net.NetConnection; import flash.net.NetStream; public dynamic class DynamicCustomNetStream extends NetStream { private var nc:NetConnection; public function DynamicCustomNetStream() { nc = new NetConnection(); nc.connect(null); super(nc); } } }
Incluso sin controladores para los controladores callback onMetaData y onCuePoint, no se generan errores, ya que la clase DynamicCustomNetStream es dinmica. Si se desea definir mtodos para los controladores callback onMetaData y onCuePoint, se puede utilizar el cdigo siguiente:
var ns:DynamicCustomNetStream = new DynamicCustomNetStream(); ns.onMetaData = metaDataHandler; ns.onCuePoint = cuePointHandler; ns.play("http://www.helpexamples.com/flash/video/cuepoints.flv"); var vid:Video = new Video(); vid.attachNetStream(ns); addChild(vid); function metaDataHandler(infoObject:Object):void { trace("metadata"); } function cuePointHandler(infoObject:Object):void { trace("cue point"); }
497
Si se llama a los controladores callback onMetaData o onCuePoint y no hay mtodos para controlar la funcin callback, no se generan errores. Para controlar estos controladores callback, hay que crear mtodos onMetaData() y onCuePoint() en el cdigo, tal como se muestra en el siguiente fragmento de cdigo:
function onMetaData(infoObject:Object):void { trace("metadata"); } function onCuePoint(infoObject:Object):void { trace("cue point"); }
En el siguiente ejemplo se utiliza un sencillo bucle for..in para repetir todas las propiedades del parmetro infoObject que recibe la funcin onCuePoint(). Llama a la funcin trace() para que aparezca un mensaje cuando reciba los datos de punto de referencia:
498
var nc:NetConnection = new NetConnection(); nc.connect(null); var ns:NetStream = new NetStream(nc); ns.client = this; ns.play("video.flv"); var vid:Video = new Video(); vid.attachNetStream(ns); addChild(vid); function onCuePoint(infoObject:Object):void { var key:String; for (key in infoObject) { trace(key + ": " + infoObject[key]); } }
Este cdigo utiliza una de las distintas tcnicas para configurar el objeto en el que se ejecuta el mtodo callback. Tambin puede utilizar otras tcnicas; para obtener ms informacin, consulte Escritura de mtodos callback para metadatos y puntos de referencia en la pgina 491.
Uso de OnMetaData()
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior Los metadatos incluyen informacin sobre el archivo de vdeo, como la duracin, anchura, altura y velocidad de fotogramas. La informacin de metadatos que se aade al archivo de vdeo depende del software que se utilice para codificar el archivo de vdeo.
499
var nc:NetConnection = new NetConnection(); nc.connect(null); var ns:NetStream = new NetStream(nc); ns.client = this; ns.play("video.flv"); var vid:Video = new Video(); vid.attachNetStream(ns); addChild(vid); function onMetaData(infoObject:Object):void { var key:String; for (key in infoObject) { trace(key + ": " + infoObject[key]); } }
Si el vdeo no tiene sonido, la informacin de metadatos relativa al audio (como audiodatarate) devuelve undefined, ya que no se ha aadido informacin de audio a los metadatos durante la codificacin. En el cdigo anterior, no se muestra la informacin de punto de referencia. Para ver los metadatos del punto de referencia, se puede utilizar la siguiente funcin que muestra de forma sucesiva los elementos en una clase Object:
500
function traceObject(obj:Object, indent:uint = 0):void { var indentString:String = ""; var i:uint; var prop:String; var val:*; for (i = 0; i < indent; i++) { indentString += "\t"; } for (prop in obj) { val = obj[prop]; if (typeof(val) == "object") { trace(indentString + " " + prop + ": [Object]"); traceObject(val, indent + 1); } else { trace(indentString + " " + prop + ": " + val); } } }
Mediante el fragmento de cdigo anterior para rastrear el parmetro infoObject del mtodo onMetaData(), se crea la salida siguiente:
width: 320 audiodatarate: 96 audiocodecid: 2 videocodecid: 4 videodatarate: 400 canSeekToEnd: true duration: 16.334 audiodelay: 0.038 height: 213 framerate: 15 cuePoints: [Object] 0: [Object] parameters: [Object] lights: beginning name: point1 time: 0.418 type: navigation 1: [Object] parameters: [Object] lights: middle name: point2 time: 7.748 type: navigation 2: [Object] parameters: [Object] lights: end name: point3 time: 16.02 type: navigation
501
El siguiente ejemplo muestra los metadatos para un vdeo MP4. Se da por hecho que existe un objeto llamado metaDataOut, en el que se escriben los metadatos.
package { import import import import import import import import
public class onMetaDataExample extends Sprite { var video:Video = new Video(); public function onMetaDataExample():void { var videoConnection:NetConnection = new NetConnection(); videoConnection.connect(null); var videoStream:NetStream = new NetStream(videoConnection); videoStream.client = this; addChild(video); video.x = 185; video.y = 5; video.attachNetStream(videoStream); videoStream.play("video.mp4"); videoStream.addEventListener(NetStatusEvent.NET_STATUS, netStatusHandler); } public function onMetaData(infoObject:Object):void { for(var propName:String in infoObject) { metaDataOut.appendText(propName + "=" + infoObject[propName] + "\n"); } } private function netStatusHandler(event:NetStatusEvent):void { if(event.info.code == "NetStream.Play.Stop") stage.displayState = StageDisplayState.NORMAL; } } }
502
moovposition=731965 height=352 avclevel=21 videocodecid=avc1 duration=2.36 width=704 videoframerate=25 avcprofile=88 trackinfo=[object Object]
Uso del objeto information La siguiente tabla muestra los posibles valores para los metadatos de vdeo que se transmiten a la funcin callback onMetaData() en el objeto que reciben:
Parmetro aacaot avclevel avcprofile audiocodecid Descripcin Tipo de objeto de audio AAC; se admiten 0, 1 2. Nmero de nivel AVC IDC como, por ejemplo, 10, 11, 20, 21, etc. Nmero de perfil AVC como, por ejemplo, 55, 77, 100, etc. Cadena que indica el cdec de audio (tcnica de codificacin/descodificacin) utilizado; por ejemplo, .Mp3 o mp4a Nmero que indica la velocidad a la que se ha codificado el audio, expresada en kilobytes por segundo. Nmero que indica el tiempo del archivo FLV correspondiente al "tiempo 0" del archivo FLV original. Es necesario demorar ligeramente el contenido del vdeo para sincronizarlo correctamente con el audio. Un valor booleano que es true si el archivo FLV se codifica con un fotograma clave en el ltimo fotograma, lo que permite buscar hasta el final de un clip de pelcula de descarga progresiva. Es false si el archivo FLV no se codifica con un fotograma clave en el ltimo fotograma. Conjunto de objetos, uno en cada punto de referencia incorporado en el archivo FLV. El valor es undefined si el archivo FLV no contiene ningn punto de referencia. Cada objeto tiene las siguientes propiedades:
audiodatarate audiodelay
canSeekToEnd
cuePoints
duration framerate altura seekpoints etiquetas
type: cadena que especifica el tipo de punto de referencia como "navigation" o "event". name: cadena que indica el nombre del punto de referencia. time: nmero que indica el tiempo del punto de referencia en segundos, con una precisin de tres decimales (milisegundos). parameters: objeto opcional que tiene pares nombre-valor designados por el usuario durante la creacin
de los puntos de referencia. Nmero que especifica la duracin del archivo de vdeo, en segundos. Nmero que especifica la velocidad de fotogramas del archivo FLV. Nmero que especifica la altura del archivo FLV, en pxeles. Conjunto que incluye los fotogramas clave disponibles como marcas horarias en milisegundos. Opcional. Conjunto de pares clave-valor que representa la informacin en el tomo ilst, que es el equivalente de las etiquetas ID3 para archivos MP4. iTunes utiliza estas etiquetas. Se puede utilizar para mostrar ilustraciones, si est disponible. Objeto que proporciona informacin sobre todas las pistas del archivo MP4, incluyendo su ID de descripcin de ejemplo. Cadena que es la versin de cdec que se utiliz para codificar el vdeo; por ejemplo, avc1 o VP6F.
trackinfo
videocodecid,
503
Descripcin Nmero que especifica la velocidad de datos de vdeo del archivo FLV. Velocidad de fotogramas del vdeo MP4. Nmero que especifica la anchura del archivo FLV, en pxeles.
Uso de onXMPData()
Flash Player 10 y posterior, Adobe AIR 1.5 y posterior La funcin callback onXMPData() recibe informacin especfica de Adobe Extensible Metadata Platform (XMP) incorporada en el archivo de vdeo Adobe F4V o FLV. Los metadatos XMP incluyen puntos de referencia, as como otros metadatos de vdeo. La compatibilidad con metadatos XMP se incorpora a partir de Flash Player 10 y Adobe AIR 1.5 y se admite en versiones posteriores. En el siguiente ejemplo se procesan datos del punto de referencia en los metadatos XMP:
504
public class onXMPDataExample extends Sprite { public function onXMPDataExample():void { var videoConnection:NetConnection = new NetConnection(); videoConnection.connect(null); var videoStream:NetStream = new NetStream(videoConnection); videoStream.client = this; var video:Video = new Video(); addChild(video); video.attachNetStream(videoStream); videoStream.play("video.f4v"); } public function onMetaData(info:Object):void { trace("onMetaData fired"); } public function onXMPData(infoObject:Object):void { trace("onXMPData Fired\n"); //trace("raw XMP =\n"); //trace(infoObject.data); var cuePoints:Array = new Array(); var cuePoint:Object; var strFrameRate:String; var nTracksFrameRate:Number; var strTracks:String = ""; var onXMPXML = new XML(infoObject.data); // Set up namespaces to make referencing easier var xmpDM:Namespace = new Namespace("http://ns.adobe.com/xmp/1.0/DynamicMedia/"); var rdf:Namespace = new Namespace("http://www.w3.org/1999/02/22-rdf-syntax-ns#"); for each (var it:XML in onXMPXML..xmpDM::Tracks) {
505
var strTrackName:String = it.rdf::Bag.rdf::li.rdf::Description.@xmpDM::trackName; var strFrameRateXML:String = it.rdf::Bag.rdf::li.rdf::Description.@xmpDM::frameRate; strFrameRate = strFrameRateXML.substr(1,strFrameRateXML.length); nTracksFrameRate = Number(strFrameRate); strTracks += it; } var onXMPTracksXML:XML = new XML(strTracks); var strCuepoints:String = ""; for each (var item:XML in onXMPTracksXML..xmpDM::markers) { strCuepoints += item; } trace(strCuepoints); } } }
Para un breve archivo de vdeo denominado startrekintro.f4v, este ejemplo produce las siguientes lneas de trazado. Las lneas muestran los datos del punto de referencia para los puntos de referencia de evento y navegacin en los metadatos XMP:
506
onMetaData fired onXMPData Fired <xmpDM:markers xmlns:xmp="http://ns.adobe.com/xap/1.0/" xmlns:xmpDM="http://ns.adobe.com/xmp/1.0/DynamicMedia/" xmlns:stDim="http://ns.adobe.com/xap/1.0/sType/Dimensions#" xmlns:xmpMM="http://ns.adobe.com/xap/1.0/mm/" xmlns:stEvt="http://ns.adobe.com/xap/1.0/sType/ResourceEvent#" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:rdf="http://www.w3.org/1999/02/22-rdfsyntax-ns#" xmlns:x="adobe:ns:meta/"> <rdf:Seq> <rdf:li> <rdf:Description xmpDM:startTime="7695905817600" xmpDM:name="Title1" xmpDM:type="FLVCuePoint" xmpDM:cuePointType="Navigation"> <xmpDM:cuePointParams> <rdf:Seq> <rdf:li xmpDM:key="Title" xmpDM:value="Star Trek"/> <rdf:li xmpDM:key="Color" xmpDM:value="Blue"/> </rdf:Seq> </xmpDM:cuePointParams> </rdf:Description> </rdf:li> <rdf:li> <rdf:Description xmpDM:startTime="10289459980800" xmpDM:name="Title2" xmpDM:type="FLVCuePoint" xmpDM:cuePointType="Event"> <xmpDM:cuePointParams> <rdf:Seq> <rdf:li xmpDM:key="William Shatner" xmpDM:value="First Star"/> <rdf:li xmpDM:key="Color" xmpDM:value="Light Blue"/> </rdf:Seq> </xmpDM:cuePointParams> </rdf:Description> </rdf:li> </rdf:Seq> </xmpDM:markers> onMetaData fired
Nota: en los datos XMP, el tiempo se almacena como ticks DVA en lugar de en segundos. Para calcular la hora del punto de referencia, divida la hora de inicio entre la velocidad de fotogramas. Por ejemplo, la hora de inicio de 7695905817600 dividida entre una velocidad de fotogramas de 254016000000 es igual a 30:30. Para ver los metadatos XMP completos sin formato, lo que incluye la velocidad de fotogramas, elimine los identificadores de comentarios (//s) que preceden a la segunda y tercera sentencia trace() al principio de la funcin onXMPData(). Para obtener ms informacin sobre XMP, consulte:
partners.adobe.com/public/developer/xmp/topic.html www.adobe.com/devnet/xmp/
507
508
Evento NetStream.Play.Start NetStream.Play.Stop NetStream.Play.Complete NetStream.SeekStart.Notify NetStream.Seek.Notify NetStream.Unpause.Notify NetStream.Unpause.Notify NetStream.Play.Transition NetStream.Play.TransitionComplete NetStream.Buffer.Full NetStream.Buffer.Flush NetStream.Buffer.Empty
Flujo RTMP S S S S S S S S S S S S
El objeto NetStreamInfo asociado a una instancia de NetStream tambin almacena los ltimos metadatos y los objetos de datos XMP que se encontraron en los medios. Cuando los medios se reproducen mediante flujo HTTP, NetStream.Play.Start, NetStream.Play.Stop y NetStream.Play.Complete no se distribuyen, ya que la aplicacin cuenta con un control total del flujo de medios. Un reproductor de vdeo debe sintetizar y distribuir estos eventos para los flujos HTTP. Del mismo modo, NetStream.Play.Transition y NetStream.Play.TransitionComplete no se distribuyen para ninguna descarga progresiva ni medio HTTP. El cambio de velocidad de bits dinmica es una funcin de RTMP. Si un reproductor de vdeo que utiliza un flujo HTTP admite una funcin similar, el reproductor puede sintetizar y distribuir eventos de transicin.
Ms temas de ayuda
Adobe Developer Connection: Measuring video consumption in Flash (Medicin del consumo de vdeo en Flash; en ingls)
509
package com.adobe.example { import flash.events.NetDataEvent; import flash.events.NetMonitorEvent; import flash.events.NetStatusEvent; import flash.net.NetMonitor; import flash.net.NetStream; public class NetStreamEventMonitor { private var netmon:NetMonitor; private var heartbeat:Timer = new Timer( 5000 ); public function NetStreamEventMonitor() { //Create NetMonitor object netmon = new NetMonitor(); netmon.addEventListener( NetMonitorEvent.NET_STREAM_CREATE, newNetStream ); //Start the heartbeat timer heartbeat.addEventListener( TimerEvent.TIMER, onHeartbeat ); heartbeat.start(); } //On new NetStream private function newNetStream( event:NetMonitorEvent ):void { trace( "New Netstream object"); var stream:NetStream = event.netStream; stream.addEventListener(NetDataEvent.MEDIA_TYPE_DATA, onStreamData); stream.addEventListener(NetStatusEvent.NET_STATUS, onStatus); } //On data events from a NetStream object private function onStreamData( event:NetDataEvent ):void { var netStream:NetStream = event.target as NetStream; trace( "Data event from " + netStream.info.uri + " at " + event.timestamp ); switch( event.info.handler ) { case "onMetaData": //handle metadata; break; case "onXMPData": //handle XMP; break; case "onPlayStatus": //handle NetStream.Play.Complete case "onImageData": //handle image break; case "onTextData": //handle text break; default: //handle other events
510
} } //On status events from a NetStream object private function onStatus( event:NetStatusEvent ):void { trace( "Status event from " + event.target.info.uri + " at " + event.target.time ); //handle status events } //On heartbeat timer private function onHeartbeat( event:TimerEvent ):void { var streams:Vector.<NetStream> = netmon.listStreams(); for( var i:int = 0; i < streams.length; i++ ) { trace( "Heartbeat on " + streams[i].info.uri + " at " + streams[i].time ); //handle heartbeat event } } } }
511
Tipo Mime: vdeo/x-flv Extensin de archivo: .flv Parmetros necesarios: ninguno Parmetros opcionales: ninguno Consideraciones de codificacin: los archivos FLV son binarios; algunas aplicaciones pueden necesitar establecer
el subtipo application/octet-stream.
512
Actualizar una cabeza lectora segn el progreso de reproduccin de un archivo de vdeo Detectar y analizar los metadatos de un archivo de vdeo Controlar cdigos especficos en un objeto NetStream Cargar, reproducir, pausar y detener un archivo FLV cargado dinmicamente Cambiar el tamao de un objeto Video en la lista de visualizacin segn los metadatos del objeto NetStream
Para obtener los archivos de la aplicacin de este ejemplo, consulte www.adobe.com/go/learn_programmingAS3samples_flash_es. Los archivos de la aplicacin Video Jukebox se encuentran en la carpeta Samples/VideoJukebox. La aplicacin consta de los siguientes archivos:
Archivo VideoJukebox.fla o VideoJukebox.mxml VideoJukebox.as playlist.xml Clase que proporciona la funcionalidad principal de la aplicacin. Archivo que muestra los archivos de vdeo que se cargarn en el jukebox de vdeo. Descripcin Archivo principal de la aplicacin Flex (MXML) o Flash (FLA).
Este cdigo se coloca en el constructor de la clase VideoJukebox para que el archivo se cargue antes de ejecutar otro cdigo. En cuanto el archivo XML termine de cargarse, se llama al mtodo xmlCompleteHandler(), que analiza el archivo externo en un objeto XML, tal como se muestra en el cdigo siguiente:
513
El objeto XML playlist contiene el cdigo XML sin procesar del archivo externo, mientras que videosXML es un objeto XMLList que slo incluye los nodos de vdeo. En el siguiente fragmento se muestra un archivo playlist.xml de ejemplo:
<videos> <video url="video/caption_video.flv" /> <video url="video/cuepoints.flv" /> <video url="video/water.flv" /> </videos>
Por ltimo, el mtodo xmlCompleteHandler() llama al mtodo main(), que configura las diferentes instancias de componente de la lista de reproduccin, as como los objetos NetConnection y NetStream, que se utilizan para cargar los archivos FLV externos.
El mtodo buttonClickHandler() utiliza una sentencia switch para determinar la instancia de Button en la que se ha hecho clic, tal como se muestra en el cdigo siguiente:
514
private function buttonClickHandler(event:MouseEvent):void { switch (event.currentTarget) { case playButton: ns.resume(); break; case pauseButton: ns.togglePause(); break; case stopButton: ns.pause(); ns.seek(0); break; case backButton: playPreviousVideo(); break; case forwardButton: playNextVideo(); break; } }
A continuacin, aada una instancia de Slider a la lista de visualizacin y asgnele el nombre volumeSlider. En el cdigo siguiente se establece la propiedad liveDragging de la instancia de Slider en true y se define un detector de eventos para el evento change de dicha instancia:
volumeSlider.value = volumeTransform.volume; volumeSlider.minimum = 0; volumeSlider.maximum = 1; volumeSlider.snapInterval = 0.1; volumeSlider.tickInterval = volumeSlider.snapInterval; volumeSlider.liveDragging = true; volumeSlider.addEventListener(SliderEvent.CHANGE, volumeChangeHandler);
Aada una instancia de ProgressBar a la lista de visualizacin y asgnele el nombre positionBar. Establezca su propiedad mode en manual, tal como se muestra en el fragmento siguiente:
positionBar.mode = ProgressBarMode.MANUAL;
Finalmente, aada una instancia de Label a la lista de visualizacin y asgnele el nombre positionLabel. La instancia de Timer establecer el valor de la instancia Label.
515
El mtodo metadataHandler() copia sus datos en la propiedad meta, definida anteriormente en el cdigo. Esto permite acceder a los metadatos del vdeo actual en cualquier momento y en toda la aplicacin. A continuacin, se ajusta el tamao del objeto Video del escenario para que coincida con las dimensiones que devuelven los metadatos. Por ltimo, se desplaza la instancia de ProgressBar positionBar, cuyo tamao se ajusta segn el tamao del vdeo que se reproduce en ese momento. El cdigo siguiente contiene todo el mtodo metadataHandler():
private function metadataHandler(metadataObj:Object):void { meta = metadataObj; vid.width = meta.width; vid.height = meta.height; positionBar.move(vid.x, vid.y + vid.height); positionBar.width = vid.width; }
Se llama al mtodo netStatusHandler() cuando se cambia el estado del vdeo. Esto tambin se aplica cuando un vdeo inicia o detiene la reproduccin, almacena en bfer, o bien si no se encuentra un flujo de vdeo. El cdigo siguiente muestra el evento netStatusHandler():
516
private function netStatusHandler(event:NetStatusEvent):void { try { switch (event.info.code) { case "NetStream.Play.Start": t.start(); break; case "NetStream.Play.StreamNotFound": case "NetStream.Play.Stop": t.stop(); playNextVideo(); break; } } catch (error:TypeError) { // Ignore any errors. } }
El cdigo anterior evala la propiedad de cdigo del objeto info y filtra si el cdigo es "NetStream.Play.Start", "NetStream.Play.StreamNotFound" o "NetStream.Play.Stop". Los otros cdigos se omitirn. Si el objeto NetStream inicia el cdigo, se inicia la instancia de Timer que actualiza la cabeza lectora. Si el objeto NetStream no se puede encontrar o se detiene, la instancia de Timer se detiene y la aplicacin intenta reproducir el siguiente vdeo de la lista de reproduccin. Cada vez que se ejecuta Timer, la instancia de ProgressBar positionBar actualiza su posicin actual llamando al mtodo setProgress() de la clase ProgressBar, y la instancia de Label positionLabel se actualiza con el tiempo transcurrido y el tiempo total del vdeo actual.
private function timerHandler(event:TimerEvent):void { try { positionBar.setProgress(ns.time, meta.duration); positionLabel.text = ns.time.toFixed(1) + " of " meta.duration.toFixed(1) + " seconds"; } catch (error:Error) { // Ignore this error. } }
517
El mtodo playVideo() llama al mtodo play() del objeto NetStream para cargar el vdeo seleccionado actualmente:
private function playVideo():void { var url:String = getVideo(); ns.play(url); }
El mtodo playPreviousVideo() reduce el ndice de vdeo actual, llama al mtodo playVideo() para cargar el nuevo archivo de vdeo y establece la instancia de ProgressBar en visible:
private function playPreviousVideo():void { if (idx > 0) { idx--; playVideo(); positionBar.visible = true; } }
El mtodo final, playNextVideo(), incrementa el ndice de vdeo y llama al mtodo playVideo(). Si el vdeo actual es el ltimo de la lista de reproduccin, se llama al mtodo clear() del objeto Video y la propiedad visible de la instancia de ProgressBar se establece en false:
518
private function playNextVideo():void { if (idx < (videosXML.length() - 1)) { idx++; playVideo(); positionBar.visible = true; } else { idx++; vid.clear(); positionBar.visible = false; } }
519
La clase StageVideo no hace obsoleta a la clase Video. Al trabajar de forma conjunta, estas dos clases ofrecen la experiencia de reproduccin de vdeo ptima que permiten los recursos del dispositivo en cualquier momento. La aplicacin aprovecha la aceleracin de hardware detectando los eventos adecuados y alternando entre StageVideo y Video segn sea necesario. La clase StageVideo impone determinadas restricciones en el uso del vdeo. Antes de implementar StageVideo, consulte las directrices y asegrese de que la aplicacin las acepte. Si acepta las restricciones, utilice la clase StageVideo siempre que Flash Player detecte que la representacin acelerada con hardware est disponible. Consulte Directrices y limitaciones en la pgina 520.
PU) nG co do era el (ac rio ena esc el ros od Ot cos de el v fi od n gr Flash Pla s1 le de tro 1 n eo Co Vd U) CP lo 2 (so les h 2 tro las eo on eF C Vd nd ci liza ua vis de ta Lis
Planos de visualizacin de vdeo
520
El objeto StageVideo aparece en una regin de la pantalla rectangular alineada con la ventana y no girada. No se pueden disponer en capas los objetos tras el plano de vdeo del escenario. Sin embargo, el plano de la lista de visualizacin de Flash se puede utilizar para poner en capa los dems grficos en la parte superior del plano de vdeo del escenario. Stage Video se ejecuta al mismo tiempo que la lista de visualizacin de De este modo, es posible utilizar los dos mecanismos de forma conjunta para crear un efecto visual unificado que utilice dos planos discretos. Por ejemplo, se puede utilizar el plano frontal para los controles de reproduccin que funcionan en el vdeo de escenario que se ejecuta en segundo plano.
Para obtener mejores resultados, realice ambos pasos. El cdec H.264 permite aprovechar al mximo la aceleracin con hardware, desde la descodificacin de vdeo hasta la presentacin. Stage video elimina la lectura de GPU a CPU. Es decir, la GPU ya no vuelve a enviar fotogramas descodificados a la CPU para la composicin con los objetos de la lista de visualizacin. En cambio, la GPU muestra los fotogramas descodificados y procesados directamente en la pantalla, tras los objetos de la lista de visualizacin. Esta tcnica reduce el uso de memoria y CPU y tambin proporciona una mejor fidelidad de pxel.
Ms temas de ayuda
Aspectos bsicos de los formatos de vdeo en la pgina 479
Directrices y limitaciones
Cuando el vdeo se ejecuta en modo de pantalla completa, stage video siempre est disponible si el dispositivo admite la aceleracin con hardware. Sin embargo, Flash Player, tambin se ejecuta en un navegador. En el contexto de navegador, la configuracin de wmode afecta a la disponibilidad de Stage Video. Intente utilizar wmode="direct" en todo momento si desea usar Stage Video. Stage Video no admite otra configuracin de wmode cuando no est modo de pantalla completa. Esta restriccin implica que, en tiempo de ejecucin, Stage Video puede vacilar de forma imprevisible entre estar o no disponible. Por ejemplo, si el usuario sale del modo de pantalla completa durante la ejecucin de Stage Video, el contexto del vdeo vuelve a cambiar al navegador. Si el parmetro wmode del navegador no es establece en "direct", Stage Video puede dejar de estar disponible de repente. Flash Player comunica los cambios de contexto de reproduccin a las aplicaciones mediante un conjunto de eventos. Si implementa la API de StageVideo, conserve un objeto Video como copia de seguridad cuando stage video deje de estar disponible. Debido a su relacin directa con el hardware, Stage Video limita algunas funciones de vdeo. Stage Video impone las siguientes limitaciones:
Para cada archivo SWF, Flash Player limita el nmero de objetos StageVideo que pueden mostrar vdeos al mismo
tiempo a cuatro. Sin embargo, el lmite real puede ser ms bajo, dependiendo de los recursos de hardware del dispositivo. En dispositivos de AIR para TV y en la mayor parte de dispositivos, slo puede mostrar vdeo un objeto StageVideo a la vez.
La duracin del vdeo no est sincronizada con el calendario del contenido de que muestra el motor de ejecucin. El rea de la pantalla de vdeo slo puede ser un rectngulo. No se puede utilizar reas de visualizacin ms
avanzadas, como formas elpticas o irregulares.
No se puede girar el vdeo. No se puede almacenar en cach de mapa de bits el vdeo ni utilizar el objeto BitmapData para acceder al mismo.
521
No se pueden aplicar filtros al vdeo. No se pueden aplicar transformaciones de color al vdeo. No se puede aplicar un valor alfa para el vdeo. Los modos de fusin que se aplican a los objetos del plano de la lista de visualizacin no se aplican a stage video. Se puede colocar el vdeo nicamente en los lmites de pxeles. Aunque la representacin con GPU es la mejor disponible para el hardware del dispositivo determinado, no es
100% idntico de pxeles en los dispositivos. Se producen ligeras variaciones debido a las diferencias de plataforma y controlador.
Algunos dispositivos no admiten todos los espacios de color necesarios. Por ejemplo, algunos dispositivos no son
compatibles con el estndar H.264, BT.709. En estos casos, se puede utilizar BT.601 para una visualizacin rpida.
Stage Video no se puede emplear con la configuracin de WMODE como, por ejemplo, normal, opaco o
transparente. Stage Video slo admite WMODE=direct cuando no est en modo de pantalla completa. WMODE no tiene efecto en Safari 4 o posterior, IE 9 o posterior ni en AIR para TV. En la mayora de los casos, estas limitaciones no afectan a las aplicaciones de reproduccin de vdeo. Si acepta estas limitaciones, utilice Stage Video siempre que sea posible.
Ms temas de ayuda
Trabajo con el modo de pantalla completa en la pgina 163
Propiedad Stage.stageVideos
La propiedad Stage.stageVideos es un objeto Vector que permite el acceso a las instancias de StageVideo. Este vector puede incluir hasta cuatro objetos StageVideo, dependiendo de los recursos del sistema y el hardware. Los dispositivos de AIR para TV se limitan a una sola instancia de StageVideo. Los dispositivos mviles se pueden limitar a uno o ninguno. Cuando Stage Video no est disponible, este vector no contiene objetos. Para evitar errores en tiempo de ejecucin, compruebe que slo accede a los miembros de este vector cuando el evento StageVideoAvailability ms reciente indique que Stage Video est disponible.
522
Eventos StageVideo
La arquitectura de la API de StageVideo proporciona los siguientes eventos:
StageVideoAvailabilityEvent.STAGE_VIDEO_AVAILABILITY (No se admite en AIR 2.5 para TV) Se enva cuando
est reproduciendo. Indica el tipo de descodificacin que se est utilizando: hardware, software o no disponible (no se muestra nada). El destino del evento contiene las propiedades videoWidth y videoHeight que son seguras para su uso en el cambio de tamao de la ventana grfica de vdeo. Importante: Las coordenadas obtenidas del objeto de destino StageVideo utilizan las coordenadas de Stage, ya que no forman parte de la lista de visualizacin estndar.
VideoEvent.RENDER_STATE (No se admite en AIR 2.5 para TV) Se enva cuando se est utilizando un objeto Video. Indica si se est utilizando la descodificacin con aceleracin por hardware o software. Si este evento indica descodificacin acelerada por hardware, cambie a un objeto StageVideo, si es posible. El destino del evento Video contiene las propiedades videoWidth y videoHeight que son seguras para su uso a la hora de cambiar el tamao de la ventana grfica de vdeo.
vector Stage.stageVideos. Consulte Uso del evento StageVideoAvailabilityEvent.STAGE_VIDEO_AVAILABILITY en la pgina 523. (No admitido en AIR 2.5 para TV.)
2 Si el evento StageVideoAvailabilityEvent.STAGE_VIDEO_AVAILABILITY informa que el escenario est
disponible, utilice el objeto vectorial Stage.stageVideos dentro del controlador de eventos para acceder a un objeto StageVideo. En AIR 2.5 para TV, acceda a Stage.stageVideos despus de haberse procesado el primer fotograma SWF.
3 Adjunte un objeto NetStream con StageVideo.attachNetStream(). 4 Reproduzca el vdeo con NetStream.play(). 5 Detecte el evento StageVideoEvent.RENDER_STATE en el objeto StageVideo para determinar el estado de
reproduccin del vdeo. La recepcin de este evento tambin indica que las propiedades width y height del vdeo se han inicializado o han cambiado. Consulte Uso de los eventos StageVideoEvent.RENDER_STATE y VideoEvent.RENDER_STATE en la pgina 525.
6 Detecte el evento VideoEvent.RENDER_STATE en el objeto Video. Este evento proporciona los mismos estados que
StageVideoEvent.RENDER_STATE, de modo que tambin puede utilizarlo para determinar si la aceleracin por GPU est disponible. La recepcin de este evento tambin indica que las propiedades width y height del vdeo se han inicializado o han cambiado. (No admitido en AIR 2.5 para TV.) Consulte los eventos Uso de los eventos StageVideoEvent.RENDER_STATE y VideoEvent.RENDER_STATE en la pgina 525.
523
public class SimpleStageVideo extends Sprite private var nc:NetConnection; private var ns:NetStream; public function SimpleStageVideo() { // Constructor for SimpleStageVideo class // Make sure the app is visible and stage available addEventListener(Event.ADDED_TO_STAGE, onAddedToStage); } private function onAddedToStage(event:Event):void { //... // Connections nc = new NetConnection(); nc.connect(null); ns = new NetStream(nc); ns.addEventListener(NetStatusEvent.NET_STATUS, onNetStatus); ns.client = this; // Screen video = new Video(); video.smoothing = true; // Video Events // the StageVideoEvent.STAGE_VIDEO_STATE informs you whether // StageVideo is available stage.addEventListener(StageVideoAvailabilityEvent.STAGE_VIDEO_AVAILABILITY, onStageVideoState); // in case of fallback to Video, listen to the VideoEvent.RENDER_STATE // event to handle resize properly and know about the acceleration mode running video.addEventListener(VideoEvent.RENDER_STATE, videoStateChange); //... }
caso, aada el objeto NetStream a un objeto Video. Finalmente, aada el objeto StageVideo o Video al escenario y llame a NetStream.play(). El siguiente cdigo muestra cmo controlar el evento
StageVideoAvailabilityEvent.STAGE_VIDEO_AVAILABILITY:
524
private var sv:StageVideo; private var video:Video; private function onStageVideoState(event:StageVideoAvailabilityEvent):void { // Detect if StageVideo is available and decide what to do in toggleStageVideo toggleStageVideo(event.availability == StageVideoAvailability.AVAILABLE); } private function toggleStageVideo(on:Boolean):void { // To choose StageVideo attach the NetStream to StageVideo if (on) { stageVideoInUse = true; if ( sv == null ) { sv = stage.stageVideos[0]; sv.addEventListener(StageVideoEvent.RENDER_STATE, stageVideoStateChange); sv.attachNetStream(ns); } if (classicVideoInUse) { // If you use StageVideo, remove from the display list the // Video object to avoid covering the StageVideo object // (which is always in the background) stage.removeChild ( video ); classicVideoInUse = false; } } else { // Otherwise attach it to a Video object if (stageVideoInUse) stageVideoInUse = false; classicVideoInUse = true; video.attachNetStream(ns); stage.addChildAt(video, 0); } if ( !played ) { played = true; ns.play(FILE_NAME); } }
Importante: La primera vez que una aplicacin accede al elemento vectorial en Stage.stageVideos[0], el rectngulo predeterminado se establece en 0,0,0,0 y las propiedades pan y zoom utilizan los valores predeterminados. Restablezca siempre estos valores a la configuracin preferida. Se pueden utilizar las propiedades videoWidth y videoHeight del destino del evento StageVideoEvent.RENDER_STATE o VideoEvent.RENDER_STATE para calcular las dimensiones de la ventana grfica del vdeo. Descargue el cdigo fuente completo para esta misma aplicacin en Getting Started with Stage Video (Introduccin a Stage Video; en ingls).
525
Los estados de representacin indican el momento en que se est utilizando la descodificacin acelerada con hardware, independientemente de qu clase est reproduciendo el vdeo actualmente. Compruebe la propiedad StageVideoEvent.status para saber si la descodificacin necesaria est disponible. Si esta propiedad se define como unavailable, el objeto StageVideo no puede reproducir el vdeo. Este estado requiere que vuelva a aadir inmediatamente el objeto NetStream a un objeto Video. Otros estados informan a la aplicacin de las condiciones de representacin actuales. En la siguiente tabla se describen las implicaciones de todos los valores del estado de representacin para los objetos StageVideoEvent y VideoEvent en Flash Player:
VideoStatus.ACCELERATED StageVideoEvent Tanto la descodificacin como la presentacin se producen en el hardware. (El mejor rendimiento.) VideoEvent Presentacin en software y descodificacin en hardware. (Rendimiento aceptable slo en un sistema de escritorio moderno. Rendimiento de pantalla completa degradado.) VideoStatus.SOFTWARE Representacin en hardware y descodificacin en software. (Rendimiento aceptable.) Presentacin en software y descodificacin en software. (En lo que respecta al rendimiento en el peor caso. Rendimiento de pantalla completa degradado.) VideoStatus.UNAVAILABLE No hay recursos de GPU disponibles para representar el vdeo y no se muestra nada. Retroceso a un objeto Video. (N/D)
Nota: AIR 2.5 para TV no define la clase VideoStatus ni descodifica H.264 en software. Consulte la clase StageVideoEvent en la Referencia de ActionScript 3 para obtener ms informacin sobre la implementacin del evento de AIR 2.5 para TV.
Espacios de color
Stage Video utiliza las capacidades de hardware subyacentes para admitir espacios de color. El contenido SWF puede proporcionar metadatos que indican su espacio de color preferido. Sin embargo, el hardware de los grficos del dispositivo determina si ese espacio de color se puede utilizar. Un dispositivo puede admitir varios espacios de color, mientras que otros no admiten ninguno. Si el hardware no admite el espacio de color solicitado, Flash Player intenta encontrar el que ms coincida entre los espacios de color compatibles. Para consultar qu espacios de color admite el hardware, utilice la propiedad StageVideo.colorSpaces. Esta propiedad devuelve la lista de espacios de color admitidos en un vector String:
var colorSpace:Vector.<String> = stageVideo.colorSpaces();
526
Para saber qu espacio de color est utilizando el vdeo que se est reproduciendo, compruebe la propiedad StageVideoEvent.colorSpace. Compruebe esta propiedad en su controlador de eventos para el evento StageVideoEvent.RENDER_STATE:
var currColorSpace:String; //StageVideoEvent.RENDER_STATE event handler private function stageVideoRenderState(event:Object):void { //... currColorSpace = (event as StageVideoEvent).colorSpace; //... }
Si Flash Player no puede encontrar ningn sustituto para un espacio de color no compatible, Stage Video usa el espacio de color predeterminado BT.601. Por ejemplo, los flujos de vdeo con codificacin H.264 suelen utilizar el espacio de color BT.709. Si el hardware del dispositivo no admite BT.709, la propiedad colorSpace devuelve "BT601". Un valor StageVideoEvent.colorSpace de "unknown" indica que el hardware no proporciona ningn medio para consultar el espacio de color. Nota: en AIR 2.5 para TV, StageVideo no es compatible con los espacios de color. La propiedad StageVideoEvent.colorSpace de esta plataforma devuelve BT709 para indicar representacin con hardware o BT601 para especificar la representacin con software. Si la aplicacin considera inaceptable el espacio de color actual, es posible optar por cambiar de un objeto StageVideo a un objeto Video. La clase Video es compatible con todos los espacios de color mediante la composicin de software.
527
Ms temas de ayuda
Christian Cantrell: How to use CameraUI in a Cross-platform Way (Cmo utilizar CameraUI en varias plataformas; en ingls) Michal CHAIZE: Android, AIR and the Camera
Las cmaras instaladas en el ordenador o el dispositivo del usuario que estn disponibles Si la cmara est instalada Si Flash Player tiene permiso para acceder a la cmara del usuario La cmara que est activa en ese momento La anchura y la altura del vdeo que se captura
La clase Camera incluye varios mtodos y propiedades tiles para utilizar objetos Camera. Por ejemplo, la propiedad Camera.names esttica contiene un conjunto de nombres de cmara instalados en ese momento en el ordenador del usuario. Asimismo, se puede utilizar la propiedad name para mostrar el nombre de la cmara activa en ese momento. Nota: al transmitir vdeo de cmara en la red, siempre se deben gestionar las interrupciones de red. Las interrupciones de red pueden suceder por varios motivos, especialmente en los dispositivos mviles.
528
Nota: la clase Camera no tiene un mtodo constructor. Para crear una nueva instancia de Camera, se utiliza el mtodo Camera.getCamera() esttico.
Comprobar si el usuario tiene una cmara instalada en ese momento. Gestione el caso donde no haya cmaras
disponibles.
Slo en Flash Player, compruebe si el usuario ha permitido el acceso a la cmara de forma explcita. Por motivos de
seguridad, el reproductor muestra el cuadro de dilogo Configuracin de Flash Player, en el que el usuario permite o deniega el acceso a su cmara. Esto impide que Flash Player se conecte a la cmara de un usuario y difunda un flujo de vdeo sin su permiso. Si el usuario permite el acceso haciendo clic en el botn correspondiente, la aplicacin puede conectarse a la cmara. De lo contrario, la aplicacin no podr acceder a dicha cmara. Las aplicaciones siempre deben controlar ambas situaciones adecuadamente.
Slo para AIR, compruebe si la clase Camera se admite en los perfiles del dispositivo compatibles con la aplicacin. La clase Camera no se admite en los navegadores mviles. La clase Camera no es compatible en las aplicaciones de AIR mviles que utilizan el modo de representacin con GPU. En iOS, slo una cmara puede estar activa al mismo tiempo. En Android, slo se puede acceder a la trasera
Ms temas de ayuda
Christophe Coenraets: Multi-User Video Tic-Tac-Toe (en ingls) Mark Doherty: Aplicacin Android Radar (cdigo fuente)
529
Se debe tener en cuenta que si un usuario no dispone de una cmara instalada, la aplicacin no mostrar nada. En situaciones reales, deben llevarse a cabo pasos adicionales para la aplicacin. Consulte Comprobacin de que las cmaras estn instaladas en la pgina 529 y Deteccin de permisos para el acceso a una cmara en la pgina 530 para obtener ms informacin.
Ms temas de ayuda
Lee Brimelow: How to access the camera on Android devices (Cmo acceder a la cmara en los dispositivos Android; en ingls)
Comprobar la propiedad esttica Camera.names que contiene un conjunto de nombres de cmara disponibles.
Normalmente, este conjunto tiene una cadena o ninguna, puesto que la mayora de usuarios no disponen de ms de una cmara instalada a la vez. En el cdigo siguiente se muestra cmo se puede comprobar la propiedad Camera.names para ver si el usuario tiene cmaras disponibles:
if (Camera.names.length > 0) { trace("User has at least one camera installed."); var cam:Camera = Camera.getCamera(); // Get default camera. } else { trace("User has no cameras installed."); }
530
Comprobar el valor devuelto del mtodo esttico Camera.getCamera(). Si no hay cmaras instaladas o
disponibles, este mtodo devuelve null; de lo contrario, devuelve una referencia a un objeto Camera. En el cdigo siguiente se muestra cmo se puede comprobar el mtodo Camera.getCamera() para ver si el usuario tiene cmaras disponibles:
var cam:Camera = Camera.getCamera(); if (cam == null) { trace("User has no cameras installed."); } else { trace("User has at least 1 camera installed."); }
Debido a que la clase Camera no ampla la clase DisplayObject, no se puede aadir directamente a la lista de visualizacin utilizando el mtodo addChild(). Para mostrar el vdeo capturado de la cmara, se debe crear un nuevo objeto Video y llamar al mtodo attachCamera() en la instancia de Video. Este fragmento de cdigo muestra cmo se puede conectar la cmara, si se dispone de ella; de lo contrario, la aplicacin no mostrar nada.
var cam:Camera = Camera.getCamera(); if (cam != null) { var vid:Video = new Video(); vid.attachCamera(cam); addChild(vid); }
Cmaras de dispositivos mviles La clase Camera no se admite en el motor de ejecucin de Flash Player en navegadores para mvil. En aplicaciones de AIR instaladas en dispositivos mviles es posible acceder a la cmara o a las cmaras en el dispositivo. En iOS, puede usarse tanto la cmara trasera como la delantera, pero no al mismo tiempo. (Cuando se activa una, se desactiva la otra.) La cmara delantera muestra una imagen invertida horizontal. En Android, slo se puede acceder a la cmara trasera.
531
Si se desea saber si el usuario ha permitido o rechazado el acceso a la cmara, se puede detectar el evento status (StatusEvent.STATUS) de la cmara, tal y como se muestra en el cdigo siguiente:
var cam:Camera = Camera.getCamera(); if (cam != null) { cam.addEventListener(StatusEvent.STATUS, statusHandler); var vid:Video = new Video(); vid.attachCamera(cam); addChild(vid); } function statusHandler(event:StatusEvent):void { // This event gets dispatched when the user clicks the "Allow" or "Deny" // button in the Flash Player Settings dialog box. trace(event.code); // "Camera.Muted" or "Camera.Unmuted" }
La funcin statusHandler() se llama cuando el usuario hace clic en los botones para permitir o denegar el acceso. Se puede detectar el botn en el que ha hecho clic el usuario con uno de estos dos mtodos:
El parmetro event de la funcin statusHandler() contiene una propiedad de cdigo que incluye la cadena
"Camera.Muted" o "Camera.Unmuted". Si el valor es "Camera.Muted", el usuario ha hecho clic en el botn para denegar el acceso y Flash Player no puede acceder a la cmara. Se puede ver un ejemplo de esto en el fragmento siguiente:
function statusHandler(event:StatusEvent):void { switch (event.code) { case "Camera.Muted": trace("User clicked Deny."); break; case "Camera.Unmuted": trace("User clicked Accept."); break; } }
La clase Camera contiene una propiedad de slo lectura denominada muted, que especifica si el usuario ha
denegado el acceso a la cmara (true) o lo ha permitido (false) en el panel Privacidad de Flash Player. Se puede ver un ejemplo de esto en el fragmento siguiente:
function statusHandler(event:StatusEvent):void { if (cam.muted) { trace("User clicked Deny."); } else { trace("User clicked Accept."); } }
532
Al buscar el evento de estado que se va a distribuir, se puede escribir cdigo que controle la aceptacin o el rechazo del acceso a la cmara por parte del usuario y llevar a cambio la limpieza correspondiente. Por ejemplo, si el usuario hace clic en el botn para denegar el acceso, se puede mostrar un mensaje al usuario que indique que debe hacer clic en el botn para permitir el acceso si desea participar en un chat de vdeo. Asimismo, se puede asegurar de que el objeto Video est eliminado de la lista de visualizacin para liberar recursos de sistema. En AIR, un objeto Camera no distribuye eventos de estado, ya que el permiso para utilizar la cmara no es dinmico.
Puesto que el mtodo getCamera() devuelve una referencia a un objeto Camera (o null si no hay cmaras disponibles), se puede acceder a los mtodos y las propiedades de la cmara aunque el usuario deniegue el acceso a ella. Esto permite establecer el tamao de la instancia de vdeo con la altura y la anchura nativas de la cmara.
533
var vid:Video; var cam:Camera = Camera.getCamera(); if (cam == null) { trace("Unable to locate available cameras."); } else { trace("Found camera: " + cam.name); cam.addEventListener(StatusEvent.STATUS, statusHandler); vid = new Video(); vid.attachCamera(cam); } function statusHandler(event:StatusEvent):void { if (cam.muted) { trace("Unable to connect to active camera."); } else { // Resize Video object to match camera settings and // add the video to the display list. vid.width = cam.width; vid.height = cam.height; addChild(vid); } // Remove the status event listener. cam.removeEventListener(StatusEvent.STATUS, statusHandler); }
Para obtener informacin sobre el modo de pantalla completa, consulte la seccin sobre este tema en Configuracin de las propiedades de Stage en la pgina 161.
534
var vid:Video; var cam:Camera = Camera.getCamera(); var tf:TextField = new TextField(); tf.x = 300; tf.autoSize = TextFieldAutoSize.LEFT; addChild(tf); if (cam != null) { cam.addEventListener(StatusEvent.STATUS, statusHandler); vid = new Video(); vid.attachCamera(cam); } function statusHandler(event:StatusEvent):void { if (!cam.muted) { vid.width = cam.width; vid.height = cam.height; addChild(vid); t.start(); } cam.removeEventListener(StatusEvent.STATUS, statusHandler); } var t:Timer = new Timer(100); t.addEventListener(TimerEvent.TIMER, timerHandler); function timerHandler(event:TimerEvent):void { tf.text = ""; tf.appendText("activityLevel: " + cam.activityLevel + "\n"); tf.appendText("bandwidth: " + cam.bandwidth + "\n"); tf.appendText("currentFPS: " + cam.currentFPS + "\n"); tf.appendText("fps: " + cam.fps + "\n"); tf.appendText("keyFrameInterval: " + cam.keyFrameInterval + "\n"); tf.appendText("loopback: " + cam.loopback + "\n"); tf.appendText("motionLevel: " + cam.motionLevel + "\n"); tf.appendText("motionTimeout: " + cam.motionTimeout + "\n"); tf.appendText("quality: " + cam.quality + "\n"); }
Cada 1/10 de segundo (100 milisegundos) se distribuye el evento timer del objeto Timer y la funcin timerHandler() actualiza el campo de texto de la lista de visualizacin.
535
Ms temas de ayuda
Paquete flash.net.drm flash.net.NetConnection flash.net.NetStream
536
Si no se produce ningn error y se autoriza correctamente al usuario a ver el contenido, el objeto NetStream distribuye un objeto DRMStatusEvent. La aplicacin comienza a reproducirse despus. El objeto DRMStatusEvent contiene la informacin de la licencia asociada, que identifica la pliza del usuario y sus permisos. Por ejemplo, contiene informacin relacionada con si el contenido puede verse sin conexin o cundo caduca la licencia. La aplicacin puede aprovechar estos datos para informar al usuario del estado de su pliza. Por ejemplo: la aplicacin puede mostrar en una barra de estado el nmero de das restantes para que el usuario pueda ver el contenido. (Slo AIR) Si el usuario tiene permiso para acceder sin conexin, la licencia se guarda en cach y el contenido cifrado se descarga en el equipo del usuario. El contenido est accesible en la duracin definida en el periodo de cesin sin conexin. La propiedad detail del evento contiene "DRM.voucherObtained". La aplicacin decide dnde guardar el contenido en el equipo para tenerlo a disposicin fuera de lnea. Tambin se puede realizar la carga previa de licencias mediante la clase DRMManager. Todos los errores relacionados con DRM hacen que la aplicacin distribuya un objeto DRMErrorEvent o, en AIR, un objeto DRMAuthenticationErrorEvent. Es responsabilidad de la aplicacin gestionar de forma explcita todos los dems eventos de error. Estos eventos incluyen casos en que el usuario introduce credenciales vlidas pero la licencia que protege el contenido cifrado limita el acceso al contenido. Por ejemplo, un usuario autenticado no puede acceder al contenido si no ha pagado por los derechos. Este caso tambin puede darse si dos miembros registrados del mismo editor intentan compartir contenido por el que solo uno de ellos ha pagado. La aplicacin debera informar al usuario sobre el error y ofrecer una sugerencia como alternativa. Una alternativa habitual es ofrecer instrucciones para registrarse y pagar por los derechos de visionado.
537
objeto como una variable, por ejemplo, metadata_bytes. Todo el contenido controlador por Flash Access tiene metadatos de Flash Access. Cuando se empaqueta el contenido, estos metadatos se pueden guardar como un archivo de metadatos independiente (.metadata) junto con el contenido. Para obtener ms informacin, consulte la documentacin de Flash Access.
2 Cree una instancia de DRMContentData. Coloque este cdigo en un bloque try-catch:
new DRMContentData(metadata_bytes)
IllegalOperationError con cdigo de error 3344. Para gestionar este error, descargue el mdulo Flash Access con la API SystemUpdater. Una vez descargado el mdulo, el objeto SystemUpdater distribuye un evento COMPLETE. Incluya un detector de eventos para este evento que vuelve al paso 2 cuando se distribuye. El siguiente cdigo demuestra estos pasos:
flash.system.SystemUpdater.addEventListener(Event.COMPLETE, updateCompleteHandler); flash.system.SystemUpdater.update(flash.system.SystemUpdaterType.DRM) private function updateCompleteHandler (event:Event):void { /*redo step 2*/ drmContentData = new DRMContentData(metadata_bytes); }
Si se debe actualizar el propio reproductor, se distribuye un evento status. Para obtener ms informacin sobre la gestin de este evento, consulte Deteccin de un evento update en la pgina 551. Nota: en aplicaciones de AIR, el archivo de instalacin de AIR gestiona la actualizacin del mdulo Flash Access y las posibles actualizaciones necesarias del motor de ejecucin.
4 Cree detectores para detectar los eventos DRMStatusEvent y DRMErrorEvent del objeto DRMManager:
DRMManager.addEventListener(DRMStatusEvent.DRM_STATUS, onDRMStatus); DRMManager.addEventListener(DRMErrorEvent.DRM_ERROR, onDRMError);
En el detector de DRMStatusEvent, confirme que la licencia es vlida (no null). En el detector de DRMErrorEvent, gestione eventos DRMErrorEvent. Consulte Uso de la clase DRMStatusEvent en la pgina 543 y Uso de la clase DRMErrorEvent en la pgina 548.
5 Cargue la licencia necesaria para poder reproducir el contenido.
538
8 Si el mtodo de autenticacin es ANONYMOUS, vaya al paso 13. 9 Si el mtodo de autenticacin es USERNAME_AND_PASSWORD, su aplicacin debe contar con un mecanismo para que
el usuario pueda introducir sus credenciales. Enve estas credenciales al servidor de licencias para autenticar al usuario:
DRMManager.authenticate(metadata.serverURL, metadata.domain, username, password)
DRMManager distribuye un evento DRMAuthenticationErrorEvent si falla la autenticacin y un evento DRMAuthenticationCompleteEvent si la autenticacin se produce correctamente. Cree detectores para estos eventos.
10 Si la autenticacin falla, la aplicacin debe volver al paso 9. Asegrese de que la aplicacin cuenta con un
mecanismo para gestionar y limitar el nmero de fallos de autenticacin repetidos. Por ejemplo, tras tres intentos, muestre un mensaje al usuario indicando que la autenticacin ha fallado y que no es posible visualizar el contenido.
11 Si la autenticacin se produce correctamente, descargue la licencia del servidor de licencias:
DRMManager.loadvoucher(drmContentData, LoadVoucherSetting.FORCE_REFRESH)
Una vez completada la carga, el objeto DRMManager distribuye un evento DRMStatusEvent.DRM_STATUS. Detecte este evento y, cuando se distribuya, podr reproducir el contenido.
12 (opcional) Si la autenticacin se realiza correctamente, puede capturar el smbolo de autenticacin (un conjunto
de bytes que se almacena en memoria). Obtenga este smbolo con la propiedad DRMAuthenticationCompleteEvent.token. Puede almacenar y usar el smbolo de autenticacin para que el usuario no tenga que introducir sus credenciales cada vez que quiera ver este contenido. El servidor de licencias determina el periodo de validez del smbolo de autenticacin. Para usar el smbolo almacenado y evitar tener que pedir al usuario que introduzca sus credenciales, establezca el smbolo con el mtodo DRMManager.setAuthenticationToken(). Seguidamente, descargue la licencia del servidor de licencias y reproduzca el contenido como en el paso 8.
13 Reproduzca el vdeo creando un objeto NetStream y llamando a su mtodo play() despus:
stream = new NetStream(connection); stream.addEventListener(DRMStatusEvent.DRM _STATUS, drmStatusHandler); stream.addEventListener(DRMErrorEvent.DRM_ERROR, drmErrorHandler); stream.addEventListener(NetStatusEvent.NET_STATUS, netStatusHandler); stream.client = new CustomClient(); video.attachNetStream(stream); stream.play(videoURL);
DRMAuthenticateEvent (slo AIR), distribuido por NetStream DRMAuthenticationCompleteEvent, distribuido por DRMManager DRMAuthenticationErrorEvent, distribuido por DRMManager DRMErrorEvent, distribuido por NetStream y por DRMManager DRMStatusEvent, distribuido por NetStream y por DRMManager StatusEvent NetStatusEvent. Consulte Deteccin de un evento update en la pgina 551
Para admitir contenido protegido con Flash Access, aada detectores de eventos para controlar los eventos DRM.
539
Uso de DRMContentData
Adobe AIR 2.0 y posterior En los siguientes pasos se describe el flujo de trabajo para precargar la licencia de un archivo multimedia protegido mediante un objeto DRMContentData.
1 Obtenga los metadatos binarios del contenido empaquetado. Si utiliza Flash Access Java Reference Packager, este
archivo de metadatos se genera automticamente con la extensin .metadata. Puede, por ejemplo, descargar estos metadatos mediante la clase URLLoader.
2 Cree un objeto DRMContentData pasando los metadatos a la funcin constructora:
var drmData:DRMContentData = new DRMContentData( metadata );
3 El resto de los pasos son idnticos a los del flujo de trabajo descrito en Aspectos bsicos del flujo de trabajo de
Uso de preloadEmbeddedMetadata()
Adobe AIR 1.5 y posterior Los siguientes pasos describen el flujo de trabajo para realizar la carga previa de la licencia para un archivo multimedia protegido por DRM usando preloadEmbeddedMetadata():
1 Descargue y almacene el archivo. (Los metadatos DRM slo se pueden precargar desde archivos almacenados
localmente.)
2 Cree los objetos NetConnection y NetStream, proporcionando implementaciones para las funciones callback
onDRMContentData() y onPlayStatus() del objeto cliente NetStream.
3 Cree un objeto NetStreamPlayOptions y establezca la propiedad stream en la URL del archivo de medios local. 4 Llame al mtodo preloadEmbeddedMetadata() de NetStream, transmitiendo el objeto NetStreamPlayOptions e
DRMManager. Si el valor de la propiedad authenticationMethod del objeto DRMContentData es userNameAndPassword, debe autenticar al usuario en el servidor de derechos multimedia antes de cargar la licencia. Las propiedades serverURL y domain del objeto DRMContentData se pueden transmitir al mtodo authenticate(), junto con las credenciales del usuario.
540
La ausencia de esta llamada tambin puede querer decir que Flash Access no protege este archivo. El siguiente ejemplo de cdigo para AIR muestra cmo precargar una licencia para un archivo multimedia local:
package { import flash.display.Sprite; import flash.events.DRMAuthenticationCompleteEvent; import flash.events.DRMAuthenticationErrorEvent; import flash.events.DRMErrorEvent; import flash.ev ents.DRMStatusEvent; import flash.events.NetStatusEvent; import flash.net.NetConnection; import flash.net.NetStream; import flash.net.NetStreamPlayOptions; import flash.net.drm.AuthenticationMethod; import flash.net.drm.DRMContentData; import flash.net.drm.DRMManager; import flash.net.drm.LoadVoucherSetting; public class DRMPreloader extends Sprite { private var videoURL:String = "app-storage:/video.flv"; private var userName:String = "user"; private var password:String = "password"; private var preloadConnection:NetConnection; private var preloadStream:NetStream; private var drmManager:DRMManager = DRMManager.getDRMManager(); private var drmContentData:DRMContentData; public function DRMPreloader():void { drmManager.addEventListener( DRMAuthenticationCompleteEvent.AUTHENTICATION_COMPLETE, onAuthenticationComplete); drmManager.addEventListener(DRMAuthenticationErrorEvent.AUTHENTICATION_ERROR, onAuthenticationError); drmManager.addEventListener(DRMStatusEvent.DRM_STATUS, onDRMStatus); drmManager.addEventListener(DRMErrorEvent.DRM_ERROR, onDRMError); preloadConnection = new NetConnection(); preloadConnection.addEventListener(NetStatusEvent.NET_STATUS, onConnect); preloadConnection.connect(null); } private function onConnect( event:NetStatusEvent ):void { preloadMetadata(); } private function preloadMetadata():void { preloadStream = new NetStream( preloadConnection ); preloadStream.client = this; var options:NetStreamPlayOptions = new NetStreamPlayOptions(); options.streamName = videoURL; preloadStream.preloadEmbeddedData( options ); } public function onDRMContentData( drmMetadata:DRMContentData ):void {
541
drmContentData = drmMetadata; if ( drmMetadata.authenticationMethod == AuthenticationMethod.USERNAME_AND_PASSWORD ) { authenticateUser(); } else { getVoucher(); } } private function getVoucher():void { drmManager.loadVoucher( drmContentData, LoadVoucherSetting.ALLOW_SERVER ); } private function authenticateUser():void { drmManager.authenticate( drmContentData.serverURL, drmContentData.domain, userName, password ); } private function onAuthenticationError( event:DRMAuthenticationErrorEvent ):void { trace( "Authentication error: " + event.errorID + ", " + event.subErrorID ); } private function onAuthenticationComplete( event:DRMAuthenticationCompleteEvent ):void { trace( "Authenticated to: " + event.serverURL + ", domain: " + event.domain ); getVoucher(); } private function onDRMStatus( event:DRMStatusEvent ):void { trace( "DRM Status: " + event.detail); trace("--Voucher allows offline playback = " + event.isAvailableOffline ); trace("--Voucher already cached = " + event.isLocal ); trace("--Voucher required authentication = " + !event.isAnonymous ); } private function onDRMError( event:DRMErrorEvent ):void { trace( "DRM error event: " + event.errorID + ", " + event.subErrorID + ", " + event.text ); } public function onPlayStatus( info:Object ):void { preloadStream.close(); } } }
542
drmStatus
status
La clase incluye los siguientes mtodos especficos de DRM, slo para su uso en AIR:
Mtodo resetDRMVouchers() Descripcin Elimina todos los datos de la licencia de administracin de derechos digitales (DRM) almacenados en cach local. Para que el usuario pueda acceder al contenido cifrado, la aplicacin debe volver a descargar las licencias. Por ejemplo, el siguiente cdigo elimina todas las licencias de la cach: NetStream.resetDRMVouchers(); setDRMAuthenticationCredentials() Pasa al objeto NetStream una serie de credenciales de autenticacin, a saber; nombre de usuario, contrasea y tipo de autenticacin, para fines de autenticacin. Los tipos de autenticacin vlidos son "drm" y "proxy" . Con el tipo de autenticacin "drm" , la credenciales proporcionadas se autentican con el servidor Flash Access. Con el tipo de autenticacin "proxy", las credenciales se autentican con el servidor proxy y deben coincidir con las que exige el servidor proxy. Por ejemplo, una empresa puede requerir que la aplicacin se autentique con un servidor proxy antes de que el usuario pueda acceder a Internet. La opcin de proxy permite este tipo de autenticacin. A menos que se utilice la autenticacin annima, despus de la autenticacin proxy el usuario an necesita autenticarse con Flash Access para obtener la licencia y poder reproducir el contenido. Se puede utilizar setDRMAuthenticationcredentials() una segunda vez, con la opcin "drm", para realizar la autenticacin con Flash Access. Analiza un archivo de medios local para metadatos incorporados. Cuando se encuentran metadatos relacionados con DRM, AIR llama a la funcin callback onDRMContentData() .
preloadEmbeddedMetadata()
543
Asimismo, en AIR, un objeto NetStream llama a las funciones callback onDRMContentData() y onPlayStatus() como resultado de una llamada al mtodo preloadEmbeddedMetaData(). La funcin onDRMContentData() se llama cuando los metadatos DRM se encuentran en un archivo de medios. La funcin onPlayStatus() se llama cuando el archivo se ha analizado. Las funciones onDRMContentData() y onPlayStatus() se deben definir en el objeto client asignado a la instancia de NetStream. Si utiliza el mismo objeto NetStream para precargar licencias y reproducir contenido, espere la llamada a onPlayStatus() generada mediante preloadEmbeddedMetaData() antes de comenzar la reproduccin. En el siguiente cdigo para AIR se configuran el nombre de usuario (administrator), la contrasea (password) y el tipo de autenticacin drm para autenticar al usuario. El mtodo setDRMAuthenticationCredentials() debe proporcionar credenciales que coincidan con las guardadas y aceptadas por el proveedor de contenido. Estas credenciales son las mismas que permiten al usuario ver el contenido. No se incluye aqu el cdigo para reproducir el vdeo y verificar que se haya realizado una conexin satisfactoria al flujo de vdeo.
var connection:NetConnection = new NetConnection(); connection.connect(null); var videoStream:NetStream = new NetStream(connection); videoStream.addEventListener(DRMAuthenticateEvent.DRM_AUTHENTICATE, drmAuthenticateEventHandler) private function drmAuthenticateEventHandler(event:DRMAuthenticateEvent):void { videoStream.setDRMAuthenticationCredentials("administrator", "password", "drm"); }
Propiedades de DRMStatusEvent
Flash Player 10.1, Adobe AIR 1.0 y posterior La clase DRMStatusEvent incluye las siguientes propiedades. Algunas propiedades aparecan en versiones de AIR posteriores a la versin 1.0. Para obtener informacin detallada sobre las versiones, consulte la Referencia de ActionScript 3.0.
544
En el caso de las propiedades no admitidas en Flash Player 10.1, la clase DRMVoucher proporciona propiedades similares para Flash Player.
Propiedad contentData detail (slo AIR) Descripcin Objeto DRMContentData que contiene los metadatos DRM incorporados en el contenido. Una cadena que explica el contexto del evento del estado. En DRM 1.0, el nico valor vlido es DRM.voucherObtained. Indica si el contenido, protegido con Flash Access, est disponible sin que el usuario tenga que proporcionar credenciales de autenticacin (true) o no (false). Un valor "false" significa que el usuario debe proporcionar un nombre de usuario y una contrasea que coincida con la que conoce y espera el proveedor del contenido.
isAvailableOffline (slo AIR) Indica si el contenido, protegido con Flash Access, puede estar disponible fuera de lnea (true) o no (false). Para que el contenido con proteccin digital est disponible fuera de lnea, su licencia debe estar en cach en el ordenador del usuario. isLocal offlineLeasePeriod (slo AIR) policies (slo AIR) voucher voucherEndDate (slo AIR) Indica si la licencia necesaria para reproducir el contenido est almacenada en cach localmente. La cantidad de das restantes durante los cuales se puede ver el contenido fuera de lnea.
Un objeto personalizado que puede contener propiedades DRM personalizadas. Objeto DRMVoucher. La fecha en que vence indefectiblemente la licencia y el contenido ya no se podr ver.
545
El controlador del evento DRMAuthenticateEvent es responsable de obtener las credenciales exigidas (nombre de usuario, contrasea y tipo) y de pasar los valores al mtodo NetStream.setDRMAuthenticationCredentials() para su validacin. Cada aplicacin de AIR debe proveer un mecanismo para obtener las credenciales de usuario. Por ejemplo, la aplicacin proporcionara al usuario una interfaz sencilla para introducir los valores de nombre de usuario y contrasea. Asimismo, ofrece un mecanismo para gestionar y limitar los intentos repetidos de autenticacin.
Propiedades de DRMAuthenticateEvent
Adobe AIR 1.0 y posterior La clase DRMAuthenticateEvent incluye las siguientes propiedades:
Propiedad authenticationType Descripcin Indica si las credenciales facilitadas son para autenticacin con Flash Access (drm) o un servidor proxy (proxy). Por ejemplo: la opcin "proxy" permite a la aplicacin realizar la autenticacin ante un servidor proxy si se necesita antes de que el usuario pueda acceder a Internet. A menos que se utilice la autenticacin annima, despus de la autenticacin proxy el usuario an necesita autenticarse con Flash Access para obtener la licencia y poder reproducir el contenido. Se puede utilizar setDRMAuthenticationcredentials() una segunda vez, con la opcin "drm", para realizar la autenticacin con Flash Access. El encabezado del archivo de contenido cifrado suministrado por el servidor. Contiene informacin acerca del contexto del contenido cifrado. El objeto NetStream que inici este evento. Una solicitud de la credencial de contrasea, proporcionada por el servidor. La cadena puede incluir una instruccin sobre el tipo de contrasea que se requiere. Una solicitud de una cadena de URL, proporcionada por el servidor. La cadena puede indicar el lugar donde se envan el nombre de usuario y la contrasea. Una solicitud de la credencial de nombre de usuario, proporcionada por el servidor. La cadena puede incluir una instruccin sobre el tipo de nombre de usuario que se requiere. Por ejemplo: un proveedor de contenido puede exigir que el nombre de usuario sea una direccin de correo electrnico.
header
netstream passwordPrompt
urlPrompt
usernamePrompt
546
El mtodo credentials() es un mtodo definido por el usuario que pasa al mtodo setDRMAuthenticationCredentials() los valores de nombre de usuario y contrasea. Una vez pasados estos valores, el mtodo credentials() restaura los valores de los objetos TextInput.
<mx:Script> <![CDATA[ public function credentials():void { videoStream.setDRMAuthenticationCredentials(uName, pWord, "drm"); uName.text = ""; pWord.text = ""; } ]]> </mx:Script>
Una forma de implementar este tipo de interfaz sencilla es incluir el panel como parte de un nuevo estado. El nuevo estado se origina del estado base cuando se emite el objeto DRMAuthenticateEvent. El siguiente ejemplo contiene un objeto VideoDisplay con un atributo de origen que apunta a un archivo FLV protegido. En ese caso, el mtodo credentials() se modifica para que tambin devuelva la aplicacin a su estado base. Este mtodo lo hace tras pasar las credenciales del usuario y restaurar los valores del objeto TextInput.
547
<?xml version="1.0" encoding="utf-8"?> <mx:WindowedApplication xmlns:mx="http://www.adobe.com/2006/mxml" layout="absolute" width="800" height="500" title="DRM FLV Player" creationComplete="initApp()" > <mx:states> <mx:State name="LOGIN"> <mx:AddChild position="lastChild"> <mx:Panel x="236.5" y="113" width="325" height="204" layout="absolute" title="Login"> <mx:TextInput x="110" y="46" id="uName"/> <mx:TextInput x="110" y="76" id="pWord" displayAsPassword="true"/> <mx:Text x="35" y="48" text="Username:"/> <mx:Text x="35" y="78" text="Password:"/> <mx:Button x="120" y="115" label="Login" click="credentials()"/> <mx:Button x="193" y="115" label="Reset" click="uName.text=''; pWord.text='';"/> </mx:Panel> </mx:AddChild> </mx:State> </mx:states> <mx:Script> <![CDATA[ import flash.events.DRMAuthenticateEvent; private function initApp():void { videoStream.addEventListener(DRMAuthenticateEvent.DRM_AUTHENTICATE, drmAuthenticateEventHandler); } public function credentials():void { videoStream.setDRMAuthenticationCredentials(uName, pWord, "drm"); uName.text = ""; pWord.text = ""; currentState=''; } private function drmAuthenticateEventHandler(event:DRMAuthenticateEvent):void { currentState='LOGIN'; } ]]> </mx:Script> <mx:VideoDisplay id="video" x="50" y="25" width="700" height="350" autoPlay="true" bufferTime="10.0" source="http://www.example.com/flv/Video.flv" /> </mx:WindowedApplication>
548
Propiedades de DRMErrorEvent
Flash Player 10.1 y posterior, Adobe AIR 1.0 y posterior Para obtener una lista completa de errores, consulte Errores en tiempo de ejecucin en la Referencia de ActionScript 3.0. Los errores relacionados con DRM comienzan en el error 3300.
549
Cada vez que un usuario reproduce contenido protegido, el motor de ejecucin obtiene la licencia necesaria para ver el contenido y la guarda en cach. Si la aplicacin guarda el archivo localmente, y la licencia permite la reproduccin sin conexin, el usuario puede ver el contenido en la aplicacin de AIR. Esta reproduccin local sin conexin se produce incluso si no hay disponible ninguna conexin con el servidor de derechos digitales. Con el mtodo DRMManager y NetStream preloadEmbeddedMetadata(), puede guardar en cach previamente la licencia. La aplicacin no deber obtener la licencia necesaria para ver el contenido. Por ejemplo, la aplicacin puede descargar el archivo de medios y posteriormente obtener la licencia mientras que el usuario est en lnea. Para precargar una licencia, utilice el mtodo preloadEmbeddedMetadata() de NetStream para obtener un objeto DRMContentData. El objeto DRMContentData contiene la direccin URL y el dominio del servidor de derechos de medios que puede proporcionar la licencia y describe si se requiere la autenticacin del usuario. Con esta informacin, puede llamar al mtodo loadVoucher() de DRMManager para obtener y almacenar en cach la licencia. El flujo de trabajo para la carga previa de licencias se describe ms detalladamente en Precarga de licencias para reproduccin sin conexin en la pgina 539. Administracin de sesin Tambin puede utilizar DRMManager para autenticar al usuario en un servidor de derechos de medios y para administrar sesiones persistentes. Llame al mtodo authenticate() de DRMManager para establecer una sesin con el servidor de derechos de medios. Una vez que la autenticacin se lleva a cabo correctamente, DRMManager distribuye un objeto DRMAuthenticationCompleteEvent. Este objeto contiene un token de sesin. Este token se puede guardar para establecer futuras sesiones de modo que el usuario no tenga que proporcionar sus credenciales de cuenta. Transmita el token al mtodo setAuthenticationToken() para establecer una nueva sesin autenticada. (La configuracin del servidor que gener el token determina su caducidad y otros atributos. El cdigo de la aplicacin de AIR no debe interpretar la estructura de datos del token, ya que esta estructura pueda cambiar con futuras actualizaciones de AIR.) Los token de autenticacin se pueden transferir a otros equipos. Para proteger los token, puede almacenarlos en el almacn local cifrado de AIR. Consulte Almacenamiento local cifrado en la pgina 715 para obtener ms informacin.
Eventos DRMStatus
Flash Player 10.1 y posterior, Adobe AIR 1.5 y posterior DRMManager distribuye un objeto DRMStatusEvent cuando la llamada al mtodo loadVoucher() se completa correctamente. Si se obtiene una licencia, la propiedad detail (slo AIR) del objeto de evento tendr el valor: "DRM.voucherObtained" y la propiedad voucher contendr el objeto DRMVoucher. Si no se obtiene ninguna licencia, la propiedad detail (slo AIR) an tendr el valor: "DRM.voucherObtained"; sin embargo, la propiedad voucher ser null. No se puede obtener una licencia si, por ejemplo, se utiliza LoadVoucherSetting de localOnly y no existen ninguna licencia almacenada en la cach local. Si la llamada a loadVoucher() no se realiza correctamente, quiz debido a un error de comunicacin o autenticacin, DRMManager distribuye un objeto DRMErrorEvent o un objeto DRMAuthenticationErrorEvent.
550
Eventos DRMAuthenticationComplete
Flash Player 10.1 y posterior, Adobe AIR 1.5 y posterior DRMManager distribuye un objeto DRMAuthenticationCompleteEvent cuando un usuario se autentica correctamente mediante una llamada al mtodo authenticate(). El objeto DRMAuthenticationCompleteEvent contiene un token reutilizable que se puede usar para mantener la autenticacin del usuario a travs de sesiones de la aplicacin. Transmita este token al mtodo setAuthenticationToken() de DRMManager para restablecer la sesin. (El creador del token define sus atributos, como la caducidad. Adobe no proporciona ninguna API para examinar los atributos del token.)
Eventos DRMAuthenticationError
Flash Player 10.1 y posterior, Adobe AIR 1.5 y posterior DRMManager distribuye un objeto DRMAuthenticationErrorEvent cuando un usuario no se puede autenticar correctamente mediante una llamada a los mtodos authenticate() o setAuthenticationToken().
551
Nota: en versiones anteriores a Flash Player 10.1, utilice el mecanismo de actualizacin admitido en versiones anteriores del reproductor (descarga manual e instalacin desde www.adobe.com o ExpressInstall). Asimismo, el archivo de instalacin de AIR gestiona las actualizaciones necesarias de Flash Access y no admite la API SystemUpdater.
Este cdigo actualiza el mdulo Flash Access instalado en el reproductor. No es necesario el consentimiento del usuario para actualizar el mdulo. Si no se encuentra el mdulo Flash Access, se emite un error. Consulte el paso 3 de Flujo de trabajo detallado de la API en la pgina 537. Nota: si se llama a play() en un flujo cifrado en reproductores anteriores a la versin 10.1, se emite un evento NetStatusEvent con valor de cdigo de NetStream.Play.StreamNotFound. En reproductores anteriores, utilice el mecanismo de actualizacin admitido en dichos reproductores (descarga manual e instalacin desde www.adobe.com o ExpressInstall). Cuando se necesita una actualizacin del propio reproductor, el objeto SystemUpdater distribuye un evento StatusEvent con un valor de cdigo de DRM.UpdateNeededButIncompatible. Para actualizar el reproductor s es necesario el consentimiento del usuario. En su aplicacin, incluya una interfaz para que el usuario d su consentimiento y para iniciar la actualizacin del reproductor. Detecte el evento StatusEvent y llame al siguiente cdigo:
SystemUpdater.update(flash.system.SystemUpdaterType.SYSTEM);
Este cdigo inicia la actualizacin del reproductor. Encontrar documentacin sobre ms eventos de la clase SystemUpdater en Referencia de ActionScript 3.0 para la plataforma de Adobe Flash. Una vez finalizada la actualizacin del reproductor, se redirige al usuario a la pgina en la que se inici la actualizacin. Se descarga el mdulo Flash Access y el flujo comienza a reproducirse.
552
HTMLPDFCapability.ERROR_INSTALLED_READER_NOT_FOUND
HTMLPDFCapability.ERROR_INSTALLED_READER_TOO_OLD
HTMLPDFCapability.ERROR_PREFERRED_READER_TOO_OLD
en Windows, si est funcionando Adobe Acrobat o Adobe Reader versin 7.x o posterior en el sistema del usuario, sa es la versin que se utiliza aunque se instale una versin posterior compatible con la carga de PDF cargado. En este caso, si el valor de la propiedad pdfCampability es HTMLPDFCapability.STATUS_OK, cuando una aplicacin de AIR intenta cargar contenido PDF, la versin anterior de Acrobat o Reader presenta un aviso (y no se emite ninguna excepcin en la aplicacin de AIR). Si sta es una situacin posible para los usuarios, considere facilitarles instrucciones para que cierren Acrobat mientras ejecutan la aplicacin de AIR. Puede convenir que aparezcan estas instrucciones si el contenido PDF no se carga en un plazo de tiempo aceptable.
553
En Linux, AIR busca Adobe Reader en la RUTA exportada por el usuario (si contiene el comando acroread) y en el directorio /opt/Adobe/Reader. El siguiente cdigo detecta si un usuario puede visualizar contenido PDF en una aplicacin de AIR. Si el usuario no puede visualizar PDF, se rastrea el cdigo de error que corresponde al objeto de error HTMLPDFCapability:
if(HTMLLoader.pdfCapability == HTMLPDFCapability.STATUS_OK) { trace("PDF content can be displayed"); } else { trace("PDF cannot be displayed. Error code:", HTMLLoader.pdfCapability); }
Tambin se puede cargar contenido desde las URL de archivos y esquemas de URL especficos para AIR, como app y app-storage. En el siguiente ejemplo el cdigo carga el archivo test.pdf en el subdirectorio de PDF del directorio de la aplicacin: app:/js_api_reference.pdf Para obtener ms informacin sobre los esquemas de URL de AIR, consulte Esquemas de URI en la pgina 821.
Control de la ampliacin y del desplazamiento por la pgina Procesamiento de formularios dentro del documento Control de eventos multimedia
554
Para obtener todos los detalles de la extensiones de JavaScript para Adobe Acrobat, consulte el Centro de desarrollo de Adobe Acrobat en http://www.adobe.com/devnet/acrobat/javascript.html (en ingls).
El siguiente cdigo JavaScript del contenido HTML enva un mensaje a JavaScript del archivo PDF:
pdfObject = document.getElementById("PDFObj"); pdfObject.postMessage(["testMsg", "hello"]);
El archivo PDF puede incluir JavaScript para recibir este mensaje. Se puede aadir cdigo JavaScript a archivos PDF en algunos contextos, entre ellos los contextos a nivel de documento, carpeta, pgina, campo y lote. Aqu slo trataremos el contexto a nivel de documento, que define los scripts que se evalan al abrirse el documento PDF. Un archivo PDF puede aadir una propiedad messageHandler al objeto hostContainer. La propiedad messageHandler es un objeto que define las funciones del controlador para responder a los mensajes. En el siguiente ejemplo, el cdigo define la funcin para gestionar mensajes que recibe del contenedor host (que es el contenido HTML que incorpora el archivo PDF) el archivo PDF:
this.hostContainer.messageHandler = {onMessage: myOnMessage}; function myOnMessage(aMessage) { if(aMessage[0] == "testMsg") { app.alert("Test message: " + aMessage[1]); } else { app.alert("Error"); } }
El cdigo JavaScript de una pgina HTML puede llamar al mtodo postMessage() del objeto PDF contenido en la pgina. Al llamar a este mtodo se enva un mensaje ("Hello from HTML") a JavaScript a nivel de documento en el archivo PDF:
555
<html> <head> <title>PDF Test</title> <script> function init() { pdfObject = document.getElementById("PDFObj"); try { pdfObject.postMessage(["alert", "Hello from HTML"]); } catch (e) { alert( "Error: \n name = " + e.name + "\n message = " + e.message ); } } </script> </head> <body onload='init()'> <object id="PDFObj" data="test.pdf" type="application/pdf" width="100%" height="100%"/> </body> </html>
Para ver un ejemplo ms avanzado, as como informacin sobre el uso de Acrobat 8 para aadir JavaScript a un archivo PDF, consulte Creacin de scripts entre contenidos PDF en Adobe AIR.
El contenido PDF no se visualiza en una ventana (un objeto NativeWindow) que es transparente (para la que la
propiedad transparent est definida en true).
El orden de visualizacin de un archivo PDF no funciona de la misma manera que para otros objetos de
visualizacin en una aplicacin de AIR. Si bien el contenido PDF se ajusta correctamente de acuerdo con el orden de visualizacin de HTML, siempre permanece encima del contenido en el orden de visualizacin de la aplicacin de AIR.
556
Si se modifican determinadas propiedades visuales de un objeto HTMLLoader que contiene un documento PDF,
el documento PDF ser invisible. Entre estas propiedades se incluyen filters, alpha, rotation y scaling. El cambio de estas propiedades hace que el contenido PDF resulte invisible hasta que las propiedades se vuelvan a establecer. Tambin es el caso si se modifican estas propiedades para un contenedor de objetos de visualizacin que contenga el objeto HTMLLoader.
El contenido PDF slo se puede ver si la propiedad scaleMode del objeto Stage del objeto NativeWindow que
incluye el contenido PDF se establece en StageScaleMode.NO_SCALE. Cuando se define con otro valor, el contenido PDF no podr verse.
Si se hace clic en un vnculo a contenido dentro del archivo PDF, se actualiza la posicin de desplazamiento del
contenido PDF. Si se hace clic en un vnculo a contenido situado fuera del archivo PDF, el objeto HTMLLoader se redirige al objeto que contiene el PDF (aunque el destino del vnculo sea una nueva ventana).
557
pulsacin de una tecla en el teclado). Por ejemplo, "D" y "d" tienen distintos cdigos de carcter, aunque se crean con la misma tecla en un teclado ingls de EE.UU.
Men contextual Men que aparece cuando un usuario hace clic con el botn derecho o utiliza una combinacin especfica de teclado-ratn. Los comandos de men contextual suelen aplicarse directamente al objeto en el que se ha hecho clic. Por ejemplo, un men contextual para una imagen puede contener un comando para mostrar la imagen en una ventana independiente y un comando para descargarla. Seleccin Indicacin de que un elemento seleccionado est activo y es el destino de una interaccin de teclado o ratn. Cdigo de tecla Cdigo numrico correspondiente a una tecla fsica del teclado.
Ms temas de ayuda
InteractiveObject Keyboard
558
Mouse ContextMenu
Administracin de la seleccin
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior Un objeto interactivo puede recibir la seleccin mediante programacin o mediante una accin del usuario. Adems, si la propiedad tabEnabled se establece en true, el usuario puede pasar la seleccin de un objeto a otro mediante la tecla Tabulador. Hay que tener en cuenta que el valor de tabEnabled es false de manera predeterminada, salvo en los siguientes casos:
En un objeto SimpleButton, el valor es true. Para un campo de texto de entrada, el valor es true. En un objeto Sprite o MovieClip con buttonMode establecido en true, el valor es true.
En cada una de estas situaciones, se puede aadir un detector de FocusEvent.FOCUS_IN o FocusEvent.FOCUS_OUT para proporcionar un comportamiento adicional cuando cambie la seleccin. Esto es especialmente til en los campos de texto y formularios, pero tambin se puede utilizar en objetos Sprite, MovieClip o en cualquier objeto que herede de la clase InteractiveObject. El siguiente ejemplo muestra cmo activar el cambio de seleccin de un objeto a otro con la tecla Tabulador y cmo responder al evento de seleccin posterior. En este caso, cada cuadrado cambia de color cuando se selecciona. Nota: Flash Professional utiliza mtodos abreviados de teclado para administrar la seleccin; por lo tanto, para simular correctamente la administracin de la seleccin, hay que probar los archivos SWF en un navegador o AIR en lugar de en Flash.
var var var var var var for { rows:uint = 10; cols:uint = 10; rowSpacing:uint = 25; colSpacing:uint = 25; i:uint; j:uint; (i = 0; i < rows; i++) for (j = 0; j < cols; j++) { createSquare(j * colSpacing, i * rowSpacing, (i * cols) + j); } } function createSquare(startX:Number, startY:Number, tabNumber:uint):void { var square:Sprite = new Sprite(); square.graphics.beginFill(0x000000); square.graphics.drawRect(0, 0, colSpacing, rowSpacing); square.graphics.endFill(); square.x = startX;
559
square.y = startY; square.tabEnabled = true; square.tabIndex = tabNumber; square.addEventListener(FocusEvent.FOCUS_IN, changeColor); addChild(square); } function changeColor(event:FocusEvent):void { event.target.transform.colorTransform = getRandomColor(); } function getRandomColor():ColorTransform { // Generate random values for the red, green, and blue color channels. var red:Number = (Math.random() * 512) - 255; var green:Number = (Math.random() * 512) - 255; var blue:Number = (Math.random() * 512) - 255; // Create and return a ColorTransform object with the random colors. return new ColorTransform(1, 1, 1, 1, red, green, blue, 0); }
Admite entrada con lpiz stylus o con los dedos (o no admite ninguna entrada tctil). Tiene un teclado virtual o fsico para el usuario (o no tiene ningn teclado). Muestra un cursor (si no es as, las funciones que dependen de la posicin del cursor sobre los objetos no
funcionarn). Las API de ActionScript de deteccin de entrada incluyen:
560
Las API de deteccin de entrada permiten aprovechar las capacidades del dispositivo del usuario u ofrecer alternativas si dichas capacidades no estn presentes. Estas API son especialmente tiles para desarrollar aplicaciones mviles y con tecnologa tctil. Por ejemplo, si tiene una interfaz para dispositivo mvil con botones demasiado pequeos para un lpiz stylus, puede proporcionar una interfaz alternativa con botones ms grandes que el usuario puede tocar con los dedos. El siguiente cdigo es para una aplicacin con una funcin llamada createStylusUI() que asigna un conjunto de elementos de interfaz de usuario indicados para lpices stylus. Otra funcin, llamada createTouchUI(), asigna otro conjunto de elementos de interfaz de usuario indicados para operaciones tctiles:
if(Capabilities.touchscreenType == TouchscreenType.STYLUS ){ //Construct the user interface using small buttons for a stylus //and allow more screen space for other visual content createStylusUI(); } else if(Capabilities.touchscreenType = TouchscreenType.FINGER){ //Construct the user interface using larger buttons //to capture a larger point of contact with the device createTouchUI(); }
Cuando desarrolle aplicaciones para distintos entornos de entrada, tenga en cuenta la siguiente tabla de compatibilidad:
Entorno supportsCursor touchscreenType == TCTIL touchscreenType == STYLUS touchscreenType == NINGUNO false false true false
Escritorio tradicional Dispositivos tctiles capacitivos (tablets, PDA y telfonos que detectan toques suaves de los dedos, como el iPhone de Apple o Palm Pre) Dispositivos tctiles duros (tablets, PDA y telfonos que detectan toques precisos y con presin, como el HTC Fuze) Dispositivos no tctiles (telfonos y dispositivos que pueden ejecutar aplicaciones pero que no disponen de pantallas tctiles)
true false
false true
false
false
true
false
false
false
false
true
Nota: las distintas plataformas de dispositivos pueden admitir muchas combinaciones de tipos de entrada. Utilice esta tabla como gua general.
561
Ms temas de ayuda
flash.events.KeyboardEvent flash.system.IME
Alguna teclas, como la tecla Ctrl, generan eventos aunque no tengan un glifo de representacin. En el ejemplo de cdigo anterior, el detector de eventos del teclado captura la entrada de teclado para todo el escenario. Tambin se puede escribir un detector de eventos para un objeto de visualizacin especfico en el escenario; este detector de eventos se activara cuando se seleccionara el objeto. En el siguiente ejemplo, las pulsaciones de teclas se reflejan en el panel Salida cuando el usuario escribe en la instancia de TextField. Si se mantiene presionada la tecla Mays, el color del borde de TextField cambiar temporalmente a rojo. En este cdigo se supone que hay una instancia de TextField denominada tf en el objeto Stage (el escenario).
562
tf.border = true; tf.type = "input"; tf.addEventListener(KeyboardEvent.KEY_DOWN,reportKeyDown); tf.addEventListener(KeyboardEvent.KEY_UP,reportKeyUp); function reportKeyDown(event:KeyboardEvent):void { trace("Key Pressed: " + String.fromCharCode(event.charCode) + " (key code: " + event.keyCode + " character code: " + event.charCode + ")"); if (event.keyCode == Keyboard.SHIFT) tf.borderColor = 0xFF0000; } function reportKeyUp(event:KeyboardEvent):void { trace("Key Released: " + String.fromCharCode(event.charCode) + " (key code: " + event.keyCode + " character code: " + event.charCode + ")"); if (event.keyCode == Keyboard.SHIFT) { tf.borderColor = 0x000000; } }
La clase TextField tambin notifica un evento textInput que se puede detectar cuando un usuario introduce texto. Para obtener ms informacin, consulte Captura de entradas de texto en la pgina 381. Nota: en el motor de ejecucin de AIR se puede cancelar un evento keyboard. En el motor de ejecucin de Flash Player, no se puede cancelar un evento keyboard.
563
Precedencia de KeyboardEvent
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior Al igual que con los otros eventos, la secuencia de eventos de teclado se determina por la jerarqua de objetos de visualizacin, no en el orden en que se asignan mtodos addEventListener() en el cdigo. Por ejemplo, supongamos que se coloca un campo de texto tf dentro de un clip de pelcula denominado container y que se aade un detector de eventos para un evento de teclado en ambas instancias, como se muestra en el siguiente ejemplo:
container.addEventListener(KeyboardEvent.KEY_DOWN,reportKeyDown); container.tf.border = true; container.tf.type = "input"; container.tf.addEventListener(KeyboardEvent.KEY_DOWN,reportKeyDown); function reportKeyDown(event:KeyboardEvent):void { trace(event.currentTarget.name + " hears key press: " + String.fromCharCode(event.charCode) + " (key code: " + event.keyCode + " character code: " + event.charCode + ")"); }
Debido a que hay un detector en el campo de texto y en su contenedor principal, se llama dos veces a la funcin reportKeyDown() por cada pulsacin en el campo de texto. Hay que tener en cuenta que por cada tecla pulsada, el campo de texto distribuye un evento antes de que el clip de pelcula contenedor distribuya un evento. El sistema operativo y el navegador web procesarn los eventos de teclado antes que Adobe Flash Player o AIR. Por ejemplo, en Microsoft Internet Explorer, si se pulsan Ctrl+W se cierra la ventana del navegador antes de que un archivo SWF contenido pueda distribuir un evento de teclado.
Si hay instalado un IME en el equipo del usuario (Capabilities.hasIME). Si el IME est activado o desactivado en el equipo del usuario (IME.enabled). El modo de conversin utilizado por el IME actual (IME.conversionMode).
Se puede asociar un campo de entrada de texto con un contexto de IME especfico. Al cambiar de un campo de entrada a otro, tambin se puede cambiar el IME a Hiragana (Japons), nmeros de anchura completa, nmeros de anchura media, entrada directa, etc.. Un IME permite al usuario introducir caracteres de texto en idiomas multibyte, como chino, japons o coreano, con una codificacin distinta de ASCII. Para ms informacin sobre los IME, consulte la documentacin del sistema operativo para el que desarrolla la aplicacin. Para ver recursos adicionales, consulte los siguientes sitios web:
http://www.msdn.microsoft.com/goglobal/ http://developer.apple.com/documentation/
564
http://www.java.sun.com/
Nota: si un IME no est activo en el ordenador del usuario, fallarn todas las llamadas a los mtodos o propiedades IME que no sean Capabilities.hasIME. Tras activar manualmente un IME, las siguientes llamadas de ActionScript a mtodos y propiedades IME funcionarn como se esperaba. Por ejemplo, si se utiliza un IME japons, debe estar activado antes de llamar a cualquier mtodo o propiedad del IME.
El cdigo anterior comprueba primero si el usuario tiene un IME instalado mediante la propiedad Capabilities.hasIME. Si esta propiedad est establecida en true, el cdigo consulta la propiedad IME.enabled para comprobar si el IME del usuario est activado actualmente.
565
if (Capabilities.hasIME) { switch (IME.conversionMode) { case IMEConversionMode.ALPHANUMERIC_FULL: tf.text = "Current conversion mode is alphanumeric (full-width)."; break; case IMEConversionMode.ALPHANUMERIC_HALF: tf.text = "Current conversion mode is alphanumeric (half-width)."; break; case IMEConversionMode.CHINESE: tf.text = "Current conversion mode is Chinese."; break; case IMEConversionMode.JAPANESE_HIRAGANA: tf.text = "Current conversion mode is Japananese Hiragana."; break; case IMEConversionMode.JAPANESE_KATAKANA_FULL: tf.text = "Current conversion mode is Japanese Katakana (full-width)."; break; case IMEConversionMode.JAPANESE_KATAKANA_HALF: tf.text = "Current conversion mode is Japanese Katakana (half-width)."; break; case IMEConversionMode.KOREAN: tf.text = "Current conversion mode is Korean."; break; default: tf.text = "Current conversion mode is " + IME.conversionMode + "."; break; } } else { tf.text = "Please install an IME and try again."; }
El cdigo anterior comprueba primero si el usuario tiene un IME instalado. A continuacin comprueba el modo de conversin utilizado por el IME actual comparando el valor de la propiedad IME.conversionMode con cada una de las constantes de la clase IMEConversionMode.
566
var statusText:TextField = new TextField; statusText.autoSize = TextFieldAutoSize.LEFT; addChild(statusText); if (Capabilities.hasIME) { try { IME.enabled = true; IME.conversionMode = IMEConversionMode.KOREAN; statusText.text = "Conversion mode is " + IME.conversionMode + "."; } catch (error:Error) { statusText.text = "Unable to set conversion mode.\n" + error.message; } }
El cdigo anterior crea primero un campo de texto, que se utiliza para mostrar un mensaje de estado al usuario. A continuacin, si el IME est instalado, el cdigo lo activa y establece el modo de conversin en Coreano. Si el equipo del usuario no tiene un IME coreano instalado, Flash Player o AIR emite un error que es detectado por el bloque try..catch. El bloque try..catch muestra el mensaje de error en el campo de texto creado previamente.
567
var phoneTxt:TextField = new TextField(); var nameTxt:TextField = new TextField(); phoneTxt.type = TextFieldType.INPUT; phoneTxt.addEventListener(FocusEvent.FOCUS_IN, focusInHandler); phoneTxt.addEventListener(FocusEvent.FOCUS_OUT, focusOutHandler); phoneTxt.restrict = "0-9"; phoneTxt.width = 100; phoneTxt.height = 18; phoneTxt.background = true; phoneTxt.border = true; addChild(phoneTxt); nameField.type = TextFieldType.INPUT; nameField.x = 120; nameField.width = 100; nameField.height = 18; nameField.background = true; nameField.border = true; addChild(nameField); function focusInHandler(event:FocusEvent):void { if (Capabilities.hasIME) { IME.enabled = false; } } function focusOutHandler(event:FocusEvent):void { if (Capabilities.hasIME) { IME.enabled = true; } }
Este ejemplo crea dos campos de entrada de texto, phoneTxt y nameTxt, y despus aade dos detectores de eventos al campo de texto phoneTxt. Cuando el usuario establece la seleccin en el campo de texto phoneTxt, se distribuye un evento FocusEvent.FOCUS_IN y se desactiva el IME. Cuando el campo de texto phoneTxt deja de estar seleccionado, se distribuye el evento FocusEvent.FOCUS_OUT para volver a activar el IME.
568
var inputTxt:TextField; var outputTxt:TextField; inputTxt = new TextField(); inputTxt.type = TextFieldType.INPUT; inputTxt.width = 200; inputTxt.height = 18; inputTxt.border = true; inputTxt.background = true; addChild(inputTxt); outputTxt = new TextField(); outputTxt.autoSize = TextFieldAutoSize.LEFT; outputTxt.y = 20; addChild(outputTxt); if (Capabilities.hasIME) { IME.enabled = true; try { IME.conversionMode = IMEConversionMode.JAPANESE_HIRAGANA; } catch (error:Error) { outputTxt.text = "Unable to change IME."; } System.ime.addEventListener(IMEEvent.IME_COMPOSITION, imeCompositionHandler); } else { outputTxt.text = "Please install IME and try again."; } function imeCompositionHandler(event:IMEEvent):void { outputTxt.text = "you typed: " + event.text; }
El cdigo anterior crea dos campos de texto y los aade a la lista de visualizacin. El primer campo de texto, inputTxt, es un campo de entrada de texto que permite al usuario escribir texto en japons. El segundo campo de texto, outputTxt, es un campo de texto dinmico que muestra mensajes de error al usuario o reproduce la cadena en japons que el usuario escribe en el campo de texto inputTxt.
Teclados virtuales
Flash Player 10.2 y posterior, AIR 2.6 y posterior Los dispositivos mviles, como telfonos y tabletas, suelen incluir un teclado virtual y no uno fsico. Las clases de la API Flash permiten al usuario:
Detectar cundo aparece el teclado virtual y cundo se cierra. Impedir que el teclado aparezca.
569
Determinar el rea del escenario que queda oscurecida cuando aparece el teclado virtual. Crear objetos interactivos que hacen que aparezca el teclado virtual cuando se seleccionan. (No se admite en
aplicaciones de AIR en iOS.)
(Solo AIR) Desactivar el comportamiento de desplazamiento automtico para que la aplicacin pueda modificar su
propia visualizacin y dejar sitio para el teclado.
570
tf2.border = true; tf2.type = TextFieldType.INPUT; tf2.width = this.stage.stageWidth; tf2.y = tf1.y + tf1.height + 30; this.addChild( tf2 ); tf2.addEventListener( SoftKeyboardEvent.SOFT_KEYBOARD_ACTIVATING, allowSoftKeyboard ); tf2.addEventListener( SoftKeyboardEvent.SOFT_KEYBOARD_ACTIVATE, allowSoftKeyboard ); tf2.addEventListener( SoftKeyboardEvent.SOFT_KEYBOARD_DEACTIVATE, allowSoftKeyboard); } private function preventSoftKeyboard( event:SoftKeyboardEvent ):void { event.preventDefault(); this.stage.focus = null; //close the keyboard, if raised trace( "tf1 dispatched: " + event.type + " -- " + event.triggerType ); } private function allowSoftKeyboard( event:SoftKeyboardEvent ) :void { trace( "tf2 dispatched: " + event.type + " -- " + event.triggerType ); } } }
571
package { import import import import import import import import import import
flash.geom.Rectangle; flash.display.Sprite; flash.text.engine.TextElement; flash.text.engine.TextBlock; flash.events.MouseEvent; flash.events.FocusEvent; flash.events.KeyboardEvent; flash.text.engine.TextLine; flash.text.engine.ElementFormat; flash.events.Event;
public class TextInput extends Sprite { public var text:String = " "; public var textSize:Number = 24; public var textColor:uint = 0x000000; private var _bounds:Rectangle = new Rectangle( 0, 0, 100, textSize ); private var textElement: TextElement; private var textBlock:TextBlock = new TextBlock(); public function TextInput( text:String = "" ) { this.text = text; this.scrollRect = _bounds; this.focusRect= false; //Enable keyboard support this.needsSoftKeyboard = true; this.addEventListener(MouseEvent.MOUSE_DOWN, onSelect); this.addEventListener(FocusEvent.FOCUS_IN, onFocusIn); this.addEventListener(FocusEvent.FOCUS_OUT, onFocusOut); //Setup text engine textElement = new TextElement( text, new ElementFormat( null, textSize, textColor ) ); textBlock.content = textElement; var firstLine:TextLine = textBlock.createTextLine( null, _bounds.width - 8 ); firstLine.x = 4; firstLine.y = 4 + firstLine.totalHeight; this.addChild( firstLine ); } private function onSelect( event:MouseEvent ):void { stage.focus = this; } private function onFocusIn( event:FocusEvent ):void { this.addEventListener( KeyboardEvent.KEY_DOWN, onKey ); } private function onFocusOut( event:FocusEvent ):void { this.removeEventListener( KeyboardEvent.KEY_UP, onKey ); }
572
private function onKey( event:KeyboardEvent ):void { textElement.replaceText( textElement.text.length, textElement.text.length, String.fromCharCode( event.charCode ) ); updateText(); } public function set bounds( newBounds:Rectangle ):void { _bounds = newBounds.clone(); drawBackground(); updateText(); this.scrollRect = _bounds; //force update to focus rect, if needed if( this.stage!= null && this.focusRect && this.stage.focus == this ) this.stage.focus = this; } private function updateText():void { //clear text lines while( this.numChildren > 0 ) this.removeChildAt( 0 ); //and recreate them var textLine:TextLine = textBlock.createTextLine( null, _bounds.width - 8); while ( textLine) { textLine.x = 4; if( textLine.previousLine != null ) { textLine.y = textLine.previousLine.y + textLine.previousLine.totalHeight + 2; } else { textLine.y = 4 + textLine.totalHeight; } this.addChild(textLine); textLine = textBlock.createTextLine(textLine, _bounds.width - 8 ); } } private function drawBackground():void { //draw background and border for the field this.graphics.clear(); this.graphics.beginFill( 0xededed ); this.graphics.lineStyle( 1, 0x000000 ); this.graphics.drawRect( _bounds.x + 2, _bounds.y + 2, _bounds.width - 4, _bounds.height - 4); this.graphics.endFill(); } } }
573
La siguiente clase de aplicacin principal muestra cmo usar la clase TextInput y gestiona el diseo de la aplicacin cuando el teclado aparece o cambia la orientacin del dispositivo. La clase principal crea un objeto TextInput y define sus lmites para que llene todo el escenario. La clase ajusta el tamao del objeto TextInput si aparece el teclado o el escenario cambia de tamao. La clase detecta eventos del teclado virtual desde el objeto TextInput y cambia de tamao los eventos del escenario. Independientemente de la causa del evento, la aplicacin determina el rea visible del escenario y cambia de tamao el control de entrada para llenarla. Naturalmente, en una aplicacin real sera necesario usar un algoritmo de diseo mucho ms sofisticado.
package { flash.display.MovieClip; flash.events.SoftKeyboardEvent; flash.geom.Rectangle; flash.events.Event; flash.display.StageScaleMode; flash.display.StageAlign;
public class CustomTextField extends MovieClip { private var customField:TextInput = new TextInput("Input text: "); public function CustomTextField() { this.stage.scaleMode = StageScaleMode.NO_SCALE; this.stage.align = StageAlign.TOP_LEFT; this.addChild( customField ); customField.bounds = new Rectangle( 0, 0, this.stage.stageWidth, this.stage.stageHeight ); //track soft keyboard and stage resize events customField.addEventListener(SoftKeyboardEvent.SOFT_KEYBOARD_ACTIVATE, onDisplayAreaChange ); customField.addEventListener(SoftKeyboardEvent.SOFT_KEYBOARD_DEACTIVATE, onDisplayAreaChange ); this.stage.addEventListener( Event.RESIZE, onDisplayAreaChange ); } private function onDisplayAreaChange( event:Event ):void { //Fill the stage if possible, but avoid the area covered by a keyboard var desiredBounds = new Rectangle( 0, 0, this.stage.stageWidth, this.stage.stageHeight ); if( this.stage.stageHeight - this.stage.softKeyboardRect.height < desiredBounds.height ) desiredBounds.height = this.stage.stageHeight this.stage.softKeyboardRect.height; customField.bounds = desiredBounds; } } }
Nota: el escenario solo distribuye eventos de cambio de tamao como respuesta a un cambio de orientacin si la propiedad scaleMode se establece como noScale. En otros modos, las dimensiones del escenario no cambian; en su lugar, se escala el contenido para compensar.
574
Cuando se desactiva el comportamiento predeterminado, es responsabilidad de la aplicacin llevar a cabo los ajustes necesarios para la visualizacin. Cuando se muestra el teclado, se distribuye un evento softKeyboardActivate. Cuando se distribuye el evento softKeyboardActivate, la propiedad softKeyboardRect del escenario contiene las dimensiones del rea oscurecida por el teclado abierto. Utilice estas dimensiones para mover o cambiar de tamao el contenido y que se visualice correctamente cuando se muestra el teclado y el usuario est escribiendo. (Cuando el teclado se cierra, las dimensiones del rectngulo softKeyboardRect son todas de cero.) Cuando el teclado se cierra, se distribuye un evento softKeyboardDeactivate y la pantalla de la aplicacin puede volver a normal.
package { import import import import import import import import flash.display.MovieClip; flash.events.SoftKeyboardEvent; flash.events.Event; flash.display.StageScaleMode; flash.display.StageAlign; flash.display.InteractiveObject; flash.text.TextFieldType; flash.text.TextField;
public class PanningExample extends MovieClip { private var textField:TextField = new TextField(); public function PanningExample() { this.stage.scaleMode = StageScaleMode.NO_SCALE; this.stage.align = StageAlign.TOP_LEFT; textField.y = this.stage.stageHeight - 201; textField.width = this.stage.stageWidth; textField.height = 200; textField.type = TextFieldType.INPUT; textField.border = true; textField.wordWrap = true; textField.multiline = true; this.addChild( textField ); //track soft keyboard and stage resize events textField.addEventListener(SoftKeyboardEvent.SOFT_KEYBOARD_ACTIVATE, onKeyboardChange ); textField.addEventListener(SoftKeyboardEvent.SOFT_KEYBOARD_DEACTIVATE, onKeyboardChange ); this.stage.addEventListener( Event.RESIZE, onDisplayAreaChange ); } private function onDisplayAreaChange( event:Event ):void {
575
textField.y = this.stage.stageHeight - 201; textField.width = this.stage.stageWidth; } private function onKeyboardChange( event:SoftKeyboardEvent ):void { var field:InteractiveObject = textField; var offset:int = 0; //if the softkeyboard is open and the field is at least partially covered if( (this.stage.softKeyboardRect.y != 0) && (field.y + field.height > this.stage.softKeyboardRect.y) ) offset = field.y + field.height - this.stage.softKeyboardRect.y; //but don't push the top of the field above the top of the screen if( field.y - offset < 0 ) offset += field.y - offset; this.y = -offset; } } }
Nota: en Android, hay casos (incluido el modo de pantalla completa) en los que el sistema operativo no expone las dimensiones exactas del teclado. En esa situacin, no queda ms remedio que calcular el tamao. Tambin, en orientacin horizontal, el teclado IME nativo en pantalla completa se utiliza para la introduccin de texto. Este teclado IME cuenta con un campo de introduccin de texto incorporado y oscurece todo el escenario. No hay modo alguno de visualizar un teclado horizontal que no rellene la pantalla.
576
Ms temas de ayuda
flash.ui.Mouse flash.events.MouseEvent Entrada tctil, multitctil y de gestos en la pgina 582
577
En el ejemplo anterior, el evento de ratn contiene informacin de posicin sobre el clic. Las propiedades localX y localY contienen la ubicacin donde tuvo lugar el clic en el objeto secundario inferior de la cadena de visualizacin. Por ejemplo, si se hace clic en la esquina superior izquierda de square, se notifican las coordenadas locales [0,0], ya que es el punto de registro de square. Como alternativa, las propiedades stageX y stageY hacen referencia a las coordenadas globales del clic en el escenario. El mismo clic notifica [50,50] para estas coordenadas, ya que square se movi a estas coordenadas. Ambos pares de coordenadas pueden ser tiles, dependiendo de cmo se desee responder a la interaccin del usuario. El objeto MouseEvent tambin contiene las propiedades booleanas altKey, ctrlKey y shiftKey. Se pueden utilizar estas propiedades para comprobar si tambin se est pulsando la tecla Alt, Ctrl o Mays a la vez que se hace clic con el ratn.
578
Para obtener ms informacin, consulte la seccin sobre la creacin de interaccin con el arrastre de ratn en Cambio de posicin en la pgina 168. Arrastrar y colocar en AIR En Adobe AIR, se puede habilitar la compatibilidad con las operaciones de arrastrar y colocar para que los usuarios puedan arrastrar datos dentro y fuera de la aplicacin. Para obtener ms informacin, consulte Operacin de arrastrar y colocar en AIR en la pgina 609.
Generacin de una cuadrcula de componentes de forma dinmica Respuesta a eventos de ratn Mantenimiento de una puntuacin segn la interaccin del usuario
Para obtener los archivos de la aplicacin de este ejemplo, consulte www.adobe.com/go/learn_programmingAS3samples_flash_es. Los archivos de la aplicacin WordSearch se encuentran en la carpeta Samples/WordSearch. La aplicacin consta de los siguientes archivos:
579
Descripcin La clase que proporciona la funcionalidad principal de la aplicacin. Archivo principal de la aplicacin de Flex (MXML) o de Flash (FLA).
Un archivo que se utiliza para determinar si las palabras escritas puntan y estn bien escritas.
Carga de un diccionario
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior Para crear un juego consistente en encontrar palabras hay que utilizar un diccionario. En el ejemplo se incluye un archivo de texto denominado dictionary.txt, que contiene una lista de palabras separadas por retornos de carro. Despus de crear un conjunto denominado words, la funcin loadDictionary() solicita este archivo y, una vez cargado correctamente, lo convierte en una cadena larga. Esta cadena se puede analizar para generar un conjunto de palabras con el mtodo split(), dividindola en cada instancia del retorno de carro (cdigo de carcter 10) o lnea nueva (cdigo de carcter 13). Este anlisis se realiza en la funcin dictionaryLoaded():
words = dictionaryText.split(String.fromCharCode(13, 10));
580
private function generateBoard(startX:Number, startY:Number, totalRows:Number, totalCols:Number, buttonSize:Number):void { buttons = new Array(); var colCounter:uint; var rowCounter:uint; for (rowCounter = 0; rowCounter < totalRows; rowCounter++) { for (colCounter = 0; colCounter < totalCols; colCounter++) { var b:Button = new Button(); b.x = startX + (colCounter*buttonSize); b.y = startY + (rowCounter*buttonSize); b.addEventListener(MouseEvent.CLICK, letterClicked); b.label = getRandomLetter().toUpperCase(); b.setSize(buttonSize,buttonSize); b.name = "buttonRow"+rowCounter+"Col"+colCounter; addChild(b); buttons.push(b); } } }
Aunque slo hay una lnea que aade un detector para un evento MouseEvent.CLICK, como est en un bucle for se asignar un detector a cada instancia de Button. Adems, a cada botn se le asigna un nombre derivado de su posicin de fila y columna, lo que proporciona una manera sencilla de hacer referencia a la fila y columna de cada botn en otras partes del cdigo.
return ((prevButtonCol == currButtonCol && Math.abs(prevButtonRow - currButtonRow) <= 1) || (prevButtonRow == currButtonRow && Math.abs(prevButtonCol - currButtonCol) <= 1)); }
581
Los mtodos charAt() e indexOf() de la clase String recuperan las filas y columnas adecuadas del botn en el que se acaba de hacer clic y del botn en el que se hizo clic previamente. El mtodo isLegalContinuation() devuelve true si la fila o columna no cambia, y si la fila o columna que ha cambiado corresponde a un solo incremento con respecto a la anterior. Si se desea cambiar las reglas del juego y permitir la formacin de palabras en diagonal, se pueden eliminar las comprobaciones de filas o columnas que no cambian; la lnea final sera como la siguiente:
return (Math.abs(prevButtonRow - currButtonRow) <= 1) && Math.abs(prevButtonCol currButtonCol) <= 1));
Esta funcin recorre todas las palabras del diccionario. Si la palabra del usuario coincide con una palabra del diccionario, se devuelve su posicin en el diccionario. El mtodo submitWord() comprueba entonces la respuesta y actualiza la puntuacin si la posicin es vlida.
Personalizacin
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior Al principio de la clase hay varias constantes. Se puede modificar el juego modificando estas variables. Por ejemplo, se puede cambiar la cantidad de tiempo de juego incrementando la variable TOTAL_TIME. O se puede incrementar ligeramente la variable PERCENT_VOWELS para aumentar la probabilidad de encontrar palabras.
582
tctil. Algunos dispositivos admiten varios puntos simultneos de contacto con un dedo o un lpiz stylus.
Multitctil Entrada con ms de un punto simultneo de contacto. Gesto Entrada interpretada por un dispositivo o sistema operativo como respuesta a uno o varios eventos tctiles. Por
ejemplo, un usuario gira dos dedos a la vez y el dispositivo o sistema operativo interpreta que dicha entrada tctil es un gesto de giro. Algunos gestos se realizan con un dedo o punto de contacto y otros requieren varios puntos tctiles. El dispositivo o sistema operativo establece el tipo de gesto que se asigna a la entrada. Tanto la entrada tctil como la de gesto puede ser multitctil en funcin del dispositivo del usuario. ActionScript proporciona una API para gestionar eventos tctiles, eventos de gesto y para hacer un seguimiento individual de los eventos tctiles con entrada multitctil. Nota: la deteccin eventos tctiles y de gestos puede consumir una cantidad importante de recursos de procesamiento (equivalentes al procesamiento de varios fotogramas por segundo), dependiendo del dispositivo informtico y del sistema operativo. Suele ser mejor utilizar los eventos del ratn cuando realmente no es necesaria la funcionalidad adicional que proporcionan los gestos o el toque. Cuando se utilizan eventos de gestos o tctiles, considere la reduccin de cambios grficos que pueden suceder, especialmente cuando estos eventos se pueden distribuir rpidamente, durante una operacin de zoom, giro o panormica. Por ejemplo, se puede detener la animacin en un componente mientras que el usuario lo cambia de tamao utilizando un gesto de zoom.
Ms temas de ayuda
flash.ui.Multitouch flash.events.TouchEvent flash.events.GestureEvent flash.events.TransformGestureEvent flash.events.GesturePhase flash.events.PressAndTapGestureEvent Paul Trani: Touch Events and Gestures on Mobile (Eventos tctiles y de gestos en Mobile; en ingls) Mike Jones: Virtual Game Controllers
583
Usuario
Dispositivo
Afortunadamente, la API de ActionScript para desarrollar aplicaciones tctiles incluye clases, mtodos y propiedades para determinar la compatibilidad de entrada tctil y multitctil en el entorno del motor de ejecucin. La API utilizada para determinar la compatibilidad de entrada tctil es la API de deteccin para la gestin de eventos tctiles. Conceptos y trminos importantes La siguiente lista de referencia contiene trminos importantes para la creacin de aplicaciones de control de eventos tctiles:
API de deteccin Los mtodos y propiedades utilizados para probar si el entorno del motor de ejecucin admite eventos tctiles y otros modos de entrada. Evento tctil Accin de entrada realizada en un dispositivo tctil con un nico punto de contacto. Punto de contacto Punto de contacto de un nico evento tctil. Incluso si el dispositivo no admite entrada de gestos, puede admitir varios puntos tctiles simultneos. Secuencia tctil Serie de eventos que representan todo un toque individual. Estos eventos incluyen un movimiento
ms de un dedo).
Evento de gesto Una accin de entrada realizada en un dispositivo tctil con movimientos complejos. Por ejemplo, un gesto es tocar una pantalla con dos dedos y moverlos simultneamente alrededor del permetro de un crculo imaginario para indicar un giro. Fases Puntos concretos de tiempo en el flujo del evento (como el punto inicial y el final).
584
Lpiz stylus Herramienta para interactuar con una pantalla tctil. Un lpiz stylus aporta ms precisin que el dedo humano. Algunos dispositivos slo reconocen la entrada de determinados tipos de lpiz stylus. Los dispositivos no reconocen entrada de lpiz stylus tal vez no reconozcan varios puntos de contacto simultneos o con los dedos. Pulsar y tocar Tipo de gesto de entrada multitctil donde el usuario presiona un dedo en el dispositivo tctil y toca con otro dedo o dispositivo sealador. Este gesto suele simular la accin de clic con el botn derecho del ratn en las aplicaciones multitctiles.
Deteccin
La API de deteccin permite probar el entorno de hardware y software en el motor de ejecucin. Los valores proporcionados por el motor de ejecucin determinan la entrada tctil disponible en el motor de ejecucin de Flash en ese contexto. Asimismo, puede utilizar las propiedades y mtodos de deteccin para que la aplicacin reaccione ante eventos de ratn (no slo ante eventos tctiles, por si alguna entrada tctil no se admite en el entorno). Para obtener ms informacin, consulte Deteccin con soporte tctil en la pgina 585.
Eventos
ActionScript gestiona eventos de entrada tctil con detectores y controladores de eventos, como lo hace con los dems. Sin embargo, tambin se debe tener en cuenta la gestin de eventos de entrada tctil:
El dispositivo o el sistema operativo puede interpretar un toque de varias formas, bien como una secuencia de
toques o, de forma colectiva, como un gesto.
Un solo toque en un dispositivo tctil (con un dedo, lpiz stylus o dispositivo sealador) siempre distribuye
tambin un evento de ratn. Puede gestionar el evento de ratn con los tipos de eventos de la clase MouseEvent. O puede disear la aplicacin para que slo responda a eventos tctiles. Tambin puede disear una aplicacin para que responda a ambos.
Una aplicacin puede responder a varios eventos tctiles simultneos y controlar cada uno de ellos por separado.
Normalmente, la API de deteccin se utiliza para controlar condicionalmente eventos gestionados por la aplicacin y para hacerlo de un modo determinado. Una vez que la aplicacin conoce el entorno del motor de ejecucin, puede llamar al controlador adecuado o establecer el objeto de evento correcto cuando el usuario interacte con la aplicacin. O la aplicacin puede indicar que una entrada concreta no se puede controlar en el entorno actual y ofrecer al usuario una alternativa o informacin. Para obtener ms informacin, consulte Gestin de eventos tctiles en la pgina 586 y Gestin de eventos de gestos en la pgina 591.
Fases
En aplicaciones tctiles y multitctiles, los objetos de eventos tctiles contienen propiedades para hacer un seguimiento de las fases de la interaccin del usuario. Escriba ActionScript para gestionar fases como la inicial, la de actualizacin o la final de la entrada del usuario para que pueda lograrlo. Responda a fases de eventos para que los objetos visuales cambien a medida que el usuario toca y mueve el punto tctil en la pantalla. O utilice las fases para realizar un seguimiento de las propiedades concretas de un gesto a medida que ste evoluciona.
585
En eventos de puntos tctiles, observe el tiempo que el usuario permanece en un objeto interactivo concreto. Una aplicacin puede realizar el seguimiento de fases con varios puntos tctiles simultneos por separado y gestionar cada uno como corresponda. En un gesto, la informacin especfica sobre la transformacin del gesto se interpreta a media que ocurre. Siga las coordenadas del punto de contacto (o varios, si hay ms de uno) a medida que se mueve por la pantalla.
Puntos tctiles nicos Toda la entrada tctil se interpreta por separado y todos los puntos tctiles se supervisan y se controlan. Establezca: Multitouch.inputMode=MultitouchInputMode.TOUCH_POINT y utilice la clase TouchEvent para gestionar la entrada. Entrada de gesto El dispositivo o sistema operativo interpreta la entrada como una combinacin compleja de movimientos de dedos en la pantalla. El dispositivo o sistema operativo asigna colectivamente el movimiento a un solo evento de entrada de gesto. Establezca: Multitouch.inputMode=MultitouchInputMode.GESTURE y utilice las clases TransformGestureEvent, PressAndTapGestureEvent o GestureEvent para gestionar la entrada.
Consulte Gestin de eventos tctiles en la pgina 586 para ver un ejemplo que utiliza la propiedad
Multitouch.inputMode para establecer el tipo de entrada antes de controlar un evento tctil.
586
2 Asocie un detector de eventos a la instancia de una clase que herede propiedades de la clase InteractiveObject, por
Por ejemplo, el siguiente cdigo muestra un mensaje cuando el cuadrado dibujado en mySprite se toca en un dispositivo tctil:
Multitouch.inputMode=MultitouchInputMode.TOUCH_POINT; var mySprite:Sprite = new Sprite(); var myTextField:TextField = new TextField(); mySprite.graphics.beginFill(0x336699); mySprite.graphics.drawRect(0,0,40,40); addChild(mySprite); mySprite.addEventListener(TouchEvent.TOUCH_TAP, taphandler); function taphandler(evt:TouchEvent): void { myTextField.text = "I've been tapped"; myTextField.y = 50; addChild(myTextField); }
587
Consulte la clase TouchEvent para saber qu propiedades hay disponibles en el objeto de evento. Nota: no todas las propiedades TouchEvent se admiten en todos los entornos de motor de ejecucin. Por ejemplo, no todos los dispositivos tctiles pueden detectar la cantidad de presin que el usuario aplica a la pantalla tctil. As, la propiedad TouchEvent.pressure no se admite en dichos dispositivos. Intente probar una propiedad concreta para garantizar que la aplicacin funciona y consulte Solucin de problemas en la pgina 594 para obtener ms informacin.
588
Multitouch.inputMode = MultitouchInputMode.TOUCH_POINT; var mySprite:Sprite = new Sprite(); mySprite.graphics.beginFill(0x336699); mySprite.graphics.drawRect(0,0,40,40); addChild(mySprite); var myTextField:TextField = new TextField(); myTextField.width = 200; myTextField.height = 20; addChild(myTextField); mySprite.addEventListener(TouchEvent.TOUCH_BEGIN, onTouchBegin); stage.addEventListener(TouchEvent.TOUCH_MOVE, onTouchMove); stage.addEventListener(TouchEvent.TOUCH_END, onTouchEnd); function onTouchBegin(event:TouchEvent) { myTextField.text = "touch begin" + event.touchPointID; } function onTouchMove(event:TouchEvent) { myTextField.text = "touch move" + event.touchPointID; } function onTouchEnd(event:TouchEvent) { myTextField.text = "touch end" + event.touchPointID; }
Nota: el detector tctil inicial se asocia a mySprite, pero los detectores de movimiento y finalizacin del evento tctil no se asocian. Si el dedo del usuario o el dispositivo sealador se mueve por delante del objeto de visualizacin, el escenario sigue detectando el evento tctil.
ID de punto tctil
La propiedad TouchEvent.touchPointID es esencial a la hora de escribir aplicaciones que respondan a entrada tctil. El motor de ejecucin de Flash asigna a cada punto tctil un nico valor touchPointID. Cada vez que una aplicacin responde a las fases o movimiento de una entrada tctil, compruebe touchPointID antes de gestionar el evento. Los mtodos de arrastre de entrada tctil de la clase Sprite utilizan la propiedad touchPointID como parmetro para que se gestione la instancia de entrada correcta. La propiedad touchPointID garantiza que un controlador de eventos responde a la entrada tctil correcta. En caso contrario, el controlador de eventos responde a cualquier instancia de tipo tctil (como todos los eventos touchMove) en el dispositivo y produce un comportamiento impredecible. La propiedad es especialmente importante si el usuario arrastra objetos. Utilice la propiedad touchPointID para gestionar una secuencia tctil completa. Una secuencia tctil tiene un evento touchBegin, cero o ms eventos touchMove y un evento touchEnd, todos con el mismo valor de touchPointID. El siguiente ejemplo establece una variable touchMoveID para probar el valor correcto de touchPointID antes de responder a un evento de movimiento. En caso contrario, otra entrada tctil activar el controlador de eventos tambin. Tenga en cuenta que los detectores de las fases de movimiento y final se encuentran en el escenario, no en el objeto de visualizacin. El escenario detecta fases de movimiento o final en caso de que la accin tctil del usuario vaya ms all de los lmites del objeto de visualizacin.
589
Multitouch.inputMode = MultitouchInputMode.TOUCH_POINT; var mySprite:Sprite = new Sprite(); mySprite.graphics.beginFill(0x336699); mySprite.graphics.drawRect(0,0,40,40); addChild(mySprite); var myTextField:TextField = new TextField(); addChild(myTextField); myTextField.width = 200; myTextField.height = 20; var touchMoveID:int = 0; mySprite.addEventListener(TouchEvent.TOUCH_BEGIN, onTouchBegin); function onTouchBegin(event:TouchEvent) { if(touchMoveID != 0) { myTextField.text = "already moving. ignoring new touch"; return; } touchMoveID = event.touchPointID; myTextField.text = "touch begin" + event.touchPointID; stage.addEventListener(TouchEvent.TOUCH_MOVE, onTouchMove); stage.addEventListener(TouchEvent.TOUCH_END, onTouchEnd); } function onTouchMove(event:TouchEvent) { if(event.touchPointID != touchMoveID) { myTextField.text = "ignoring unrelated touch"; return; } mySprite.x = event.stageX; mySprite.y = event.stageY; myTextField.text = "touch move" + event.touchPointID; } function onTouchEnd(event:TouchEvent) { if(event.touchPointID != touchMoveID) { myTextField.text = "ignoring unrelated touch end"; return; } touchMoveID = 0; stage.removeEventListener(TouchEvent.TOUCH_MOVE, onTouchMove); stage.removeEventListener(TouchEvent.TOUCH_END, onTouchEnd); myTextField.text = "touch end" + event.touchPointID; }
Tocar y arrastrar
Flash Player 10.1 y posterior, Adobe AIR 2 y posterior Se han aadido dos mtodos a la clase Sprite para aportar compatibilidad adicional para aplicaciones tctiles con entrada multitctil: Sprite.startTouchDrag() y Sprite.stopTouchDrag(). Estos mtodos se comportan del mismo modo que Sprite.startDrag() y Sprite.stopDrag() en eventos de ratn. Sin embargo, tenga en cuenta que tanto el mtodo Sprite.startTouchDrag() como Sprite.stopTouchDrag() toman valores de touchPointID como parmetros.
590
El motor de ejecucin asigna el valor de touchPointID al objeto de evento para un evento tctil. Utilice este valor para responder a un punto tctil concreto en caso de que el entorno admita varios puntos tctiles simultneos (incluso si no admite gestos). Para obtener ms informacin sobre la propiedad touchPointID consulte ID de punto tctil en la pgina 588. El siguiente cdigo muestra un sencillo controlador de eventos de inicio y detencin de arrastre para un evento tctil. La variable bg es un objeto de visualizacin que contiene mySprite:
mySprite.addEventListener(TouchEvent.TOUCH_BEGIN, onTouchBegin); mySprite.addEventListener(TouchEvent.TOUCH_END, onTouchEnd); function onTouchBegin(e:TouchEvent) { e.target.startTouchDrag(e.touchPointID, false, bg.getRect(this)); trace("touch begin"); } function onTouchEnd(e:TouchEvent) { e.target.stopTouchDrag(e.touchPointID); trace("touch end"); }
A continuacin se muestra un ejemplo ms avanzado que combina el arrastre con fases de eventos tctiles:
Multitouch.inputMode = MultitouchInputMode.TOUCH_POINT; var mySprite:Sprite = new Sprite(); mySprite.graphics.beginFill(0x336699); mySprite.graphics.drawRect(0,0,40,40); addChild(mySprite); mySprite.addEventListener(TouchEvent.TOUCH_BEGIN, onTouchBegin); mySprite.addEventListener(TouchEvent.TOUCH_MOVE, onTouchMove); mySprite.addEventListener(TouchEvent.TOUCH_END, onTouchEnd); function onTouchBegin(evt:TouchEvent) { evt.target.startTouchDrag(evt.touchPointID); evt.target.scaleX *= 1.5; evt.target.scaleY *= 1.5; } function onTouchMove(evt:TouchEvent) { evt.target.alpha = 0.5; } function onTouchEnd(evt:TouchEvent) { evt.target.stopTouchDrag(evt.touchPointID); evt.target.width = 40; evt.target.height = 40; evt.target.alpha = 1; }
591
2 Asocie un detector de eventos a la instancia de una clase que herede propiedades de la clase InteractiveObject, por
Por ejemplo, el siguiente cdigo muestra un mensaje cuando el cuadrado dibujado en mySprite se toca en un dispositivo tctil:
Multitouch.inputMode=MultitouchInputMode.GESTURE; var mySprite:Sprite = new Sprite(); var myTextField:TextField = new TextField(); mySprite.graphics.beginFill(0x336699); mySprite.graphics.drawRect(0,0,40,40); addChild(mySprite); mySprite.addEventListener(TransformGestureEvent.GESTURE_SWIPE, swipehandler); function swipehandler(evt:TransformGestureEvent): void { myTextField.text = "I've been swiped"; myTextField.y = 50; addChild(myTextField); }
Los eventos de toque con dos dedos se gestionan del mismo modo, pero con la clase GestureEvent:
Multitouch.inputMode=MultitouchInputMode.GESTURE; var mySprite:Sprite = new Sprite(); var myTextField:TextField = new TextField(); mySprite.graphics.beginFill(0x336699); mySprite.graphics.drawRect(0,0,40,40); addChild(mySprite); mySprite.addEventListener(GestureEvent.GESTURE_TWO_FINGER_TAP, taphandler); function taphandler(evt:GestureEvent): void { myTextField.text = "I've been two-finger tapped"; myTextField.y = 50; addChild(myTextField); }
592
Los eventos de pulsar y tocar tambin se gestionan del mismo modo, pero con la clase PressAndTapGestureEvent:
Multitouch.inputMode=MultitouchInputMode.GESTURE; var mySprite:Sprite = new Sprite(); var myTextField:TextField = new TextField(); mySprite.graphics.beginFill(0x336699); mySprite.graphics.drawRect(0,0,40,40); addChild(mySprite); mySprite.addEventListener(PressAndTapGestureEvent.GESTURE_PRESS_AND_TAP, taphandler); function taphandler(evt:PressAndTapGestureEvent): void { myTextField.text = "I've been press-and-tapped"; myTextField.y = 50; addChild(myTextField); }
Nota: no todos los eventos GestureEvent, TransformGestureEvent y PressAndTapGestureEvent se admiten en todos los entornos de motor de ejecucin. Por ejemplo, no todos los dispositivos tctiles pueden detectar toques con varios dedos. Por ello, los eventos gestureSwipe de InteractiveObject no se admiten en dichos dispositivos. Intente probar un evento concreto para garantizar que la aplicacin funciona y consulte Solucin de problemas en la pgina 594 para obtener ms informacin.
593
Nota: no todas las propiedades TransformGestureEvent se admiten en todos los entornos de motor de ejecucin. Por ejemplo, no todos los dispositivos tctiles pueden detectar el giro de un gesto en la pantalla. Por ello, la propiedad TransformGestureEvent.rotation no se admite en estos dispositivos. Intente probar una propiedad concreta para garantizar que la aplicacin funciona y consulte Solucin de problemas en la pgina 594 para obtener ms informacin.
Fases de gestos
Adems, los eventos de gestos se pueden supervisar por fases y sus propiedades se analizan a medida que se produce el gesto. Por ejemplo, puede supervisar coordenadas x a medida que un objeto se mueve con un gesto de barrido. Utilice estos valores para dibujar una lnea en todos los puntos del trazado una vez finalizado el barrido. O cambie visualmente un objeto de visualizacin a medida que se arrastra por la pantalla con un gesto de desplazamiento. Cambie el objeto de nuevo cuando haya terminado el gesto de desplazamiento.
Multitouch.inputMode = MultitouchInputMode.GESTURE; var mySprite = new Sprite(); mySprite.addEventListener(TransformGestureEvent.GESTURE_PAN , onPan); mySprite.graphics.beginFill(0x336699); mySprite.graphics.drawRect(0, 0, 40, 40); var myTextField = new TextField(); myTextField.y = 200; addChild(mySprite); addChild(myTextField); function onPan(evt:TransformGestureEvent):void { evt.target.localX++; if (evt.phase==GesturePhase.BEGIN) { myTextField.text = "Begin"; evt.target.scaleX *= 1.5; evt.target.scaleY *= 1.5; } if (evt.phase==GesturePhase.UPDATE) { myTextField.text = "Update"; evt.target.alpha = 0.5; } if (evt.phase==GesturePhase.END) { myTextField.text = "End"; evt.target.width = 40; evt.target.height = 40; evt.target.alpha = 1; } }
Nota: la frecuencia de la fase de actualizacin depende del entorno del motor de ejecucin. Algunas combinaciones de sistema operativo y hardware no permiten actualizacin alguna.
594
Multitouch.inputMode = MultitouchInputMode.GESTURE; var mySprite = new Sprite(); mySprite.addEventListener(TransformGestureEvent.GESTURE_SWIPE, onSwipe); mySprite.addEventListener(GestureEvent.GESTURE_TWO_FINGER_TAP, onTwoTap); mySprite.graphics.beginFill(0x336699); mySprite.graphics.drawRect(0, 0, 40, 40); var myTextField = new TextField(); myTextField.y = 200; addChild(mySprite); addChild(myTextField); function onSwipe(swipeEvt:TransformGestureEvent):void { myTextField.text = swipeEvt.phase // Output is "all" } function onTwoTap(tapEvt:GestureEvent):void { myTextField.text = tapEvt.phase // Output is "all" }
Solucin de problemas
Flash Player 10.1 y posterior, Adobe AIR 2 y posterior La compatibilidad de hardware y software con entradas tctiles cambia a pasos agigantados. Esta referencia no contiene una lista de todas las combinaciones de dispositivos y sistemas operativos que admiten tecnologa multitctil. Ofrece, no obstante, informacin sobre el uso de la API de deteccin para determinar si su aplicacin se ha desarrollado en un dispositivo compatible con tecnologa multitctil y proporciona sugerencias para solucionar posibles problemas en el cdigo ActionScript. Los motores de ejecucin de Flash responden a eventos tctiles segn la informacin que el dispositivo, sistema operativo o software (por ejemplo, un navegador) transfiere al motor de ejecucin. Esta dependencia del entorno de software complica la documentacin de la compatibilidad con la tecnologa multitctil. Algunos dispositivos interpretan un gesto o movimiento tctil de modo distinto. El giro se define con dos dedos girando al mismo tiempo? El giro se define con un solo dedo dibujando un crculo en la pantalla? En funcin del entorno de hardware y software, el gesto de giro podra ser incluso un gesto totalmente distinto. As, es el dispositivo quien informa al sistema operativo de la entrada del usuario. Posteriormente, el sistema operativo transfiere esta informacin al motor de ejecucin. Si el motor de ejecucin est en un navegador, el software del navegador a veces interpreta el gesto o evento tctil y no necesita transferir la entrada al motor de ejecucin. Este comportamiento es similar al de las teclas de funcin: puede insertar una combinacin de teclas especfica para Flash Player haga algo dentro del navegador y ste mantiene un men abierto. Las API individuales y las clases mencionan si no son compatibles con determinados sistemas operativos. Puede analizar las distintas entradas de las API aqu, comenzando por la clase Multitouch: http://help.adobe.com/es_ES/FlashPlatform/reference/actionscript/3/flash/ui/Multitouch.html. A continuacin encontrar descripciones sobre gestos y toques habituales:
Desplazamiento Mueva un dedo de izquierda a derecha o de derecha a izquierda. Algunos dispositivos requieren el
dedos). El punto de giro se establece en el punto medio entre los dos puntos de contacto de los dedos.
595
Barrido Mueva rpidamente tres dedos de izquierda a derecha, de derecha a izquierda, de arriba abajo o de abajo
arriba.
Zoom Toque con dos dedos y muvalos separndolos entre s para ampliar y acercndolos para reducir el zoom. Pulsar y tocar Mueva o pulse con un dedo y toque la superficie con otro.
Cada dispositivo tiene su propia documentacin para explicar los gestos admitidos y cmo realizarlos en el dispositivo. En general, el usuario debe levantar todos los dedos del dispositivo entre los distintos gestos, aunque esto depende del sistema operativo. Si su aplicacin no responde a eventos o gestos tctiles, pruebe lo siguiente:
1 Dispone de detectores de eventos para eventos tctiles o de gestos asociados a una clase de objeto que herede de la
clase InteractiveObject? Slo las instancias de InteractiveObject pueden detectar eventos tctiles y de gestos
2 Est probando la aplicacin en Flash Professional CS5? Si es as, intente publicar y probar la aplicacin, ya que
de Multitouch.inputMode):
Multitouch.inputMode=MultitouchInputMode.TOUCH_POINT; var mySprite:Sprite = new Sprite(); var myTextField:TextField = new TextField() mySprite.graphics.beginFill(0x336699); mySprite.graphics.drawRect(0,0,40,40); addChild(mySprite); mySprite.addEventListener(TouchEvent.TOUCH_TAP, taplistener); function taplistener(e:TouchEvent): void { myTextField.text = "I've been tapped"; myTextField.y = 50; addChild(myTextField); }
Toque el rectngulo. Si este ejemplo funciona, sabr que su entorno admite un toque simple. Puede continuar con gestiones ms complicadas. Probar la compatibilidad de gestos es ms complicado. Un dispositivo o sistema operativo individual puede admitir todas las combinaciones de gestos o ninguna. A continuacin incluimos una sencilla prueba del gesto de zoom:
Multitouch.inputMode = MultitouchInputMode.GESTURE; stage.addEventListener(TransformGestureEvent.GESTURE_ZOOM , onZoom); var myTextField = new TextField(); myTextField.y = 200; myTextField.text = "Perform a zoom gesture"; addChild(myTextField); function onZoom(evt:TransformGestureEvent):void { myTextField.text = "Zoom is supported"; }
596
Realice un gesto de zoom en el dispositivo y vea si en el campo de texto aparece el mensaje Zoom is supported (Se admite zoom). El detector de eventos se aade al escenario para que pueda realizar el gesto en cualquier parte de la aplicacin de prueba. A continuacin incluimos una sencilla prueba del gesto de barrido:
Multitouch.inputMode = MultitouchInputMode.GESTURE; stage.addEventListener(TransformGestureEvent.GESTURE_PAN , onPan); var myTextField = new TextField(); myTextField.y = 200; myTextField.text = "Perform a pan gesture"; addChild(myTextField); function onPan(evt:TransformGestureEvent):void { myTextField.text = "Pan is supported"; }
Realice un gesto de barrido en el dispositivo y vea si en el campo de texto aparece el mensaje Pan is supported (Se admite barrido). El detector de eventos se aade al escenario para que pueda realizar el gesto en cualquier parte de la aplicacin de prueba. Ciertas combinaciones de sistemas operativos y dispositivos pueden admitir ambos gestos, otras admitir slo uno y otras ninguno. Pruebe su entorno de desarrllo de aplicacin para asegurarse.
Problemas conocidos
A continuacin se detallan problemas conocidos con la entrada tctil:
1 Mobile Internet Explorer en el sistema operativo Windows Mobile aplica el zoom automticamente al contenido
de archivos SWF: Este comportamiento de zoom de Internet Explorer se puede anular aadiendo lo siguiente a la pgina HTML que contiene el archivo SWF:
<head> <meta name="viewport" content="width=device-width, height=device-height, initialscale=1.0"> </head>
2 En Windows 7 (y posiblemente otros sistemas operativos), el usuario debe levantar el dispositivo sealador (o el
dedo) de la pantalla entre los distintos gestos. Por ejemplo, para girar y ampliar una imagen:
Primero se realiza el gesto de giro. Luego se levantan los dedos de la pantalla. Y luego se han de volver a colocar los dedos sobre la pantalla para realizar el gesto de zoom.
3 Windows 7 (y posiblemente en otros sistemas operativos), los gestos de giro y zoom no siempre generan una fase
http://forums.adobe.com/thread/579180?tstart=0
5 En Mac OS 10.5.3 y versiones posteriores, el valor Multitouch.supportsGestureEvents siempre es true,
597
Texto Texto en formato HTML Datos en formato de texto enriquecido Objetos serializados Referencias a objetos (slo vlido en la aplicacin original) Mapas de bits (slo AIR) Archivos (slo AIR) Cadenas URL (slo AIR)
La propiedad esttica Clipboard.generalClipboard representa el portapapeles del sistema operativo. La clase Clipboard ofrece mtodos para leer y escribir datos en objetos clipboard. La clases HTMLLoader (en AIR) y TextField implementan el comportamiento predeterminado para los mtodos abreviados de teclado normales de copiar y pegar. Para implementar el comportamiento de mtodos abreviados de teclado para copiar y pegar componentes personalizados, se pueden detectar directamente estas pulsaciones de teclas. Tambin se pueden utilizar comandos de men nativos junto con equivalentes a las teclas para responder a las pulsaciones de teclas de forma indirecta. Un mismo objeto Clipboard puede poner a disposicin distintas representaciones de la misma informacin para aumentar la probabilidad de que otra aplicacin pueda comprender y utilizar los datos. Por ejemplo, una imagen puede incluirse como datos de imagen, objeto Bitmap serializado o archivo. La representacin de los datos en un formato determinado puede diferirse de modo que el formato no se cree hasta el momento de leerse los datos en ese formato.
598
Nota: el contenido que se ejecuta en Flash Player o en un entorno limitado que no pertenezca a la aplicacin en AIR slo puede llamar al mtodo getData() en un controlador de eventos para un evento paste. Es decir, nicamente el cdigo que se ejecuta en el entorno limitado de la aplicacin de AIR puede llamar al mtodo getData() fuera de un controlador de eventos paste. Para escribir en el portapapeles, aada los datos al objeto Clipboard.generalClipboard en uno o varios formatos. Los datos que ya existan en el mismo formato se sobrescriben automticamente. No obstante, conviene siempre vaciar el portapapeles del sistema antes de escribirle nuevos datos para asegurarse de que tambin se supriman los datos no relacionados que pueda haber en algn otro formato.
import flash.desktop.Clipboard; import flash.desktop.ClipboardFormats; var textToCopy:String = "Copy to clipboard."; Clipboard.generalClipboard.clear(); Clipboard.generalClipboard.setData(ClipboardFormats.TEXT_FORMAT, textToCopy, false);
Nota: el contenido que se ejecuta en Flash Player o en un entorno limitado que no pertenezca a la aplicacin en AIR slo puede llamar al mtodo setData() en un controlador de eventos de usuario, por ejemplo, eventos de teclado o de ratn, o de eventos copy o cut. Es decir, nicamente el cdigo que se ejecuta en el entorno limitado de la aplicacin de AIR puede llamar al mtodo setData() desde fuera de un controlador de eventos de usuario.
599
Comportamiento predeterminado
Adobe AIR 1.0 y posterior De forma predeterminada, AIR copia elementos seleccionados como respuesta al comando de copiar, que se puede generar mediante un mtodo abreviado de teclado o un men contextual. En las regiones editables AIR corta texto como respuesta al comando de cortar o pega texto en el lugar seleccionado como respuesta al comando de pegar. Para impedir que se produzca el comportamiento predeterminado, el controlador de eventos puede llamar al mtodo preventDefault() del objeto de evento distribuido.
Para tener acceso a los datos que se pegan se puede utilizar el mtodo getData() del objeto clipboardData, pasando el tipo MIME del formato de los datos. Los formatos disponibles los notifica la propiedad types.
function customPaste(event){ var pastedData = event.clipboardData("text/plain"); }
Slo se tiene acceso al mtodo getData() y a la propiedad types en el objeto de evento distribuido por el evento paste. El siguiente ejemplo ilustra cmo suprimir el comportamiento predeterminado de copiar y pegar en una pgina HTML. El controlador de eventos copy pone el texto copiado en cursiva y lo copia en el portapapeles como texto en formato HTML. El controlador de eventos cut copia los datos seleccionados en el portapapeles y los borra del documento. El controlador de eventos paste inserta el contenido del portapapeles en formato HTML y aplica el estilo negrita al texto insertado.
600
<html> <head> <title>Copy and Paste</title> <script language="javascript" type="text/javascript"> function onCopy(event){ var selection = window.getSelection(); event.clipboardData.setData("text/html","<i>" + selection + "</i>"); event.preventDefault(); } function onCut(event){ var selection = window.getSelection(); event.clipboardData.setData("text/html","<i>" + selection + "</i>"); var range = selection.getRangeAt(0); range.extractContents(); event.preventDefault(); } function onPaste(event){ var insertion = document.createElement("b"); insertion.innerHTML = event.clipboardData.getData("text/html"); var selection = window.getSelection(); var range = selection.getRangeAt(0); range.insertNode(insertion); event.preventDefault(); } </script> </head> <body onCopy="onCopy(event)" onPaste="onPaste(event)" onCut="onCut(event)"> <p>Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt.</p> </body> </html>
601
Un objeto Clipboard puede contener representaciones de la misma informacin en distintos formatos. Por ejemplo, un objeto Clipboard que representa a un elemento Sprite puede incluir un formato de referencia para utilizarse dentro de la misma aplicacin, un formato serializado para utilizarlo con otra aplicacin que se ejecute en Flash Player o AIR, un formato de mapa de bits para utilizarse en un editor de imgenes y un formato de lista de archivos (posiblemente con representacin aplazada para codificar un archivo PNG) para copiar o arrastrar una representacin del elemento Sprite al sistema de archivos.
BITMAP_FORMAT FILE_LIST_FORMAT
URL_FORMAT
Al copiar y pegar datos como respuesta a un evento copy, cut, o paste en contenido HTML alojado en una aplicacin de AIR, es necesario usar tipos MIME en lugar de cadenas ClipboardFormat. Los tipos de datos MIME vlidos son:
Tipo MIME Texto URL Mapa de bits Lista de archivos Descripcin "text/plain" "text/uri-list" "image/x-vnd.adobe.air.bitmap" "application/x-vnd.adobe.air.file-list"
Nota: los datos en formato de texto enriquecido no estn disponibles en la propiedad clipboardData del objeto de evento distribuido como resultado de un evento paste en contenido HTML.
602
Modos de transferencia
Flash Player 10 y posterior, Adobe AIR 1.0 y posterior Cuando un objeto se escribe en el portapapeles con un formato de datos personalizado, los datos del objeto se pueden leer en el portapapeles, bien como una referencia o como una copia serializada del objeto original. Existen cuatro modos de transferencia que determinan si los objetos se transfieren como referencias o como copias serializadas:
Modo de transferencia ClipboardTransferModes.ORIGINAL_ONLY Descripcin Slo se devuelve una referencia. Si no se dispone de ninguna referencia, se devuelve un valor nulo. Se devuelve una referencia, si hay una disponible. En caso contrario, se devuelve una copia serializada. Slo se devuelve una copia serializada. Si no hay ninguna disponible, se devuelve un valor null. Se devuelve una copia serializada, si hay una disponible. En caso contrario, se devuelve una referencia.
ClipboardTransferModes.ORIGINAL_PREFFERED
ClipboardTransferModes.CLONE_ONLY
ClipboardTransferModes.CLONE_PREFFERED
Para extraer un objeto serializado del objeto Clipboard (tras una operacin de soltar y pegar), utilice el mismo nombre de formato y los modos de transferencia CLONE_ONLY o CLONE_PREFFERED.
var transfer:Object = clipboard.getData("object", ClipboardTransferMode.CLONE_ONLY);
Siempre se aade una referencia al objeto Clipboard. Para extraer la referencia del objeto portapapeles (tras una operacin de colocar o pegar), en lugar de la copia serializada utilice los modos de transferencia ORIGINAL_ONLY o ORIGINAL_PREFFERED:
var transferredObject:Object = clipboard.getData("object", ClipboardTransferMode.ORIGINAL_ONLY);
Las referencias slo son vlidas si el objeto Clipboard viene de la aplicacin de actual. Utilice el modo de transferencia ORIGINAL_PREFFERED para tener acceso a la referencia cuando est disponible, y la copia serializada cuando la referencia no est disponible.
Representacin aplazada
Flash Player 10 y posterior, Adobe AIR 1.0 y posterior Si la creacin de un formato de datos requiere mucho procesamiento, puede utilizar la representacin aplazada si suministra una funcin que proporcione los datos a peticin. Slo se llama a la funcin si el receptor de la operacin de colocar o pegar solicita datos en el formato diferido.
603
La funcin de representacin se aade a un objeto Clipboard utilizando el mtodo setDataHandler(). La funcin debe devolver los datos en el formato adecuado. Por ejemplo: si llam a setDataHandler(ClipboardFormat.TEXT_FORMAT, writeText), la funcin writeText() debe devolver una cadena. Si se aade un formato de datos del mismo tipo a un objeto Clipboard con el mtodo setData(), esos datos tendrn prioridad sobre la versin aplazada (no se llama nunca a la funcin de representacin). La funcin de representacin puede o no volver a llamarse si se solicita acceso una segunda vez a los mismos datos del portapapeles. Nota: en Mac OS X, la representacin aplazada funciona slo con formatos de datos personalizados. En los formatos de datos estndar, se llama a la funcin de representacin inmediatamente.
604
copyText = createTextField(10, 110, 35, 20); copyText.htmlText = "<a href='#'>Copy</a>"; copyText.addEventListener(MouseEvent.CLICK, onCopy); destination = createTextField(10, 145, 380, 90); destination.addEventListener(Event.PASTE, onPaste); } private function createTextField(x:Number, y:Number, width:Number, height:Number):TextField { var newTxt:TextField = new TextField(); newTxt.x = x; newTxt.y = y; newTxt.height = height; newTxt.width = width; newTxt.border = true; newTxt.multiline = true; newTxt.wordWrap = true; newTxt.type = TextFieldType.INPUT; addChild(newTxt); return newTxt; } public function onCopy(event:MouseEvent):void { Clipboard.generalClipboard.clear(); Clipboard.generalClipboard.setDataHandler(ClipboardFormats.TEXT_FORMAT, renderData); } public function onPaste(event:Event):void { sourceTextField.text = Clipboard.generalClipboard.getData(ClipboardFormats.TEXT_FORMAT).toString; } public function renderData():String { trace("Rendering data"); var sourceStr:String = sourceTextField.text; if (sourceTextField.selectionEndIndex > sourceTextField.selectionBeginIndex) { return sourceStr.substring(sourceTextField.selectionBeginIndex, sourceTextField.selectionEndIndex); } else { return sourceStr; } } } }
605
Ejemplo de Flex
<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml" layout="absolute" width="326" height="330" applicationComplete="init()"> <mx:Script> <![CDATA[ import flash.desktop.Clipboard; import flash.desktop.ClipboardFormats; public function init():void { destination.addEventListener("paste", doPaste); } public function doCopy():void { Clipboard.generalClipboard.clear(); Clipboard.generalClipboard.setDataHandler(ClipboardFormats.TEXT_FORMAT, renderData); } public function doPaste(event:Event):void { destination.text = Clipboard.generalClipboard.getData(ClipboardFormats.TEXT_FORMAT).toString; } public function renderData():String{ trace("Rendering data"); return source.text; } ]]> </mx:Script> <mx:Label x="10" y="10" text="Source"/> <mx:TextArea id="source" x="10" y="36" width="300" height="100"> <mx:text>Neque porro quisquam est qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit.</mx:text> </mx:TextArea> <mx:Label x="10" y="181" text="Destination"/> <mx:TextArea id="destination" x="12" y="207" width="300" height="100"/> <mx:Button click="doCopy();" x="91" y="156" label="Copy"/> </mx:Application>
606
Ms temas de ayuda
flash.sensors.Accelerometer flash.events.AccelerometerEvent Michal Chiaze: AIR y el acelermetro Jonathan Campos: AIR para Android: Acelermetro
La clase Accelerometer y sus miembros son accesibles para las versiones del motor de ejecucin incluidas en cada entrada de la API. Sin embargo, el entorno actual en tiempo de ejecucin determina la disponibilidad de esta funcin. Por ejemplo, puede compilar cdigo usando las propiedades de la clase Accelerometer para Flash Player 10.1, pero deber usar la propiedad Accelerometer.isSupported para comprobar la disponibilidad de la funcin Accelerometer en el dispositivo del usuario. Si Accelerometer.isSupported es true en tiempo de ejecucin, se admite la funcin Accelerometer.
607
cuando est en la posicin vertical. (El dispositivo est en orientacin vertical y con la parte superior hacia arriba.) La aceleracin es positiva si el dispositivo se mueve hacia la derecha.
accelerationY: aceleracin en el eje y, medida en g. El eje y se ejecuta de abajo arriba en el dispositivo cuando est
en la posicin vertical. (El dispositivo est en orientacin vertical y con la parte superior hacia arriba.) La aceleracin es positiva si el dispositivo se mueve hacia arriba con relacin a este eje.
accelerationZ: aceleracin en el eje z, medida en g. El eje z se ejecuta perpendicular a la cara del dispositivo. La
aceleracin es positiva si mueve el dispositivo de modo que la parte frontal apunte hacia arriba. La aceleracin es negativa si la parte frontal del dispositivo apunta hacia el suelo.
timestamp: el nmero de milisegundos en el momento del evento desde que se inicializ el motor de ejecucin.
1 g es la aceleracin estndar debida a la gravedad, aproximadamente 9,8 m/s2.. A continuacin incluimos un ejemplo bsico que muestra datos del acelermetro en un campo de texto:
var accl:Accelerometer; if (Accelerometer.isSupported) { accl = new Accelerometer(); accl.addEventListener(AccelerometerEvent.UPDATE, updateHandler); } else { accTextField.text = "Accelerometer feature not supported"; } function updateHandler(evt:AccelerometerEvent):void { accTextField.text = "acceleration X: " + evt.accelerationX.toString() + "\n" + "acceleration Y: " + evt.accelerationY.toString() + "\n" + "acceleration Z: " + evt.accelerationZ.toString() }
Para usar este ejemplo, debe crear un campo de texto accTextField y aadirlo a la lista de visualizacin antes de utilizar este cdigo. Puede ajustar el intervalo de tiempo deseado para los eventos de acelermetro llamando al mtodo
setRequestedUpdateInterval() del objeto Accelerometer. Este mtodo toma un parmetro, interval, que es el
El tiempo real entre las actualizaciones de acelermetro puede ser mayor o menor que este valor. Cualquier cambio en el intervalo de actualizacin afecta a todos los detectores registrados. Si no llama al mtodo setRequestedUpdateInterval(), la aplicacin recibe actualizaciones basadas en el intervalo predeterminado del dispositivo.
608
Los datos del acelermetro tienen cierto grado de imprecisin. Puede utilizar una media aproximada de los datos recientes para mejorar los datos. Por ejemplo, a continuacin se analizan diversas lecturas recientes del acelermetro con la lectura actual para obtener un resultado redondeado:
var accl:Accelerometer; var rollingX:Number = 0; var rollingY:Number = 0; var rollingZ:Number = 0; const FACTOR:Number = 0.25; if (Accelerometer.isSupported) { accl = new Accelerometer(); accl.setRequestedUpdateInterval(200); accl.addEventListener(AccelerometerEvent.UPDATE, updateHandler); } else { accTextField.text = "Accelerometer feature not supported"; } function updateHandler(event:AccelerometerEvent):void { accelRollingAvg(event); accTextField.text = rollingX + "\n" + rollingY + "\n" + rollingZ + "\n"; } function accelRollingAvg(event:AccelerometerEvent):void { rollingX = (event.accelerationX * FACTOR) + (rollingX * (1 - FACTOR)); rollingY = (event.accelerationY * FACTOR) + (rollingY * (1 - FACTOR)); rollingZ = (event.accelerationZ * FACTOR) + (rollingZ * (1 - FACTOR)); }
Sin embargo, esta media aproximada slo es deseable si el intervalo de actualizacin del acelermetro es pequeo.
609
Mapas de bits Archivos Texto en formato HTML Texto Datos en formato de texto enriquecido URL Promesas de archivo Objetos serializados Referencias de objetos (vlidas solamente en la aplicacin de origen)
Supporting drag-and-drop and copy-and-paste (Compatibilidad con las funciones de arrastrar y colocar, y copiar
y pegar, en ingls) (Flex)
Supporting drag-and-drop and copy-and-paste (Compatibilidad con las funciones de arrastrar y colocar, y copiar
y pegar, en ingls) (Flash) La API de arrastrar y colocar contiene las clases siguientes.
610
Paquete flash.desktop
Clases
Las constantes que se utilizan con la API de arrastrar y colocar se definen en las clases siguientes: NativeDragActions ClipboardFormat ClipboardTransferModes
flash.events
NativeDragEvent
Etapas de gestos de arrastrar y colocar El gesto de arrastrar y colocar tiene tres etapas:
Inicio Un usuario inicia una operacin de arrastrar y colocar arrastrando desde un componente, o un elemento de un
componente, mientras mantiene pulsado el botn del ratn. El componente que es el origen del elemento arrastrado suele designarse como iniciador de la operacin de arrastrar y distribuye los eventos nativeDragStart y nativeDragComplete. Una aplicacin de Adobe AIR inicia una operacin de arrastrar llamando al mtodo NativeDragManager.doDrag() como respuesta a un evento mouseDown o mouseMove. Si la operacin de arrastrar se inicia fuera de una aplicacin de AIR, no hay ningn objeto iniciador que distribuya eventos nativeDragStart o nativeDragComplete.
Arrastrar El usuario mantiene pulsado el botn del ratn al desplazar el cursor a otro componente, a otra aplicacin o al escritorio. Siempre y cuando est en curso la operacin de arrastrar, el objeto iniciador distribuye eventos nativeDragUpdate. (Sin embargo, este evento no se distribuye en AIR para Linux.) Cuando el usuario pasa el ratn sobre un posible destino en una aplicacin de AIR, el destino distribuye un evento nativeDragEnter. El controlador de eventos puede examinar el objeto de evento para determinar si los datos arrastrados estn disponibles en un formato aceptado por el destino y, en caso afirmativo, dejar al usuario colocar los datos en l llamando al mtodo NativeDragManager.acceptDragDrop().
Siempre y cuando el gesto de arrastrar permanezca sobre un objeto interactivo, dicho objeto distribuye eventos nativeDragOver. Cuando el gesto de arrastrar abandona el objeto interactivo, distribuye un evento nativeDragExit.
Colocar El usuario suelta el ratn sobre un destino idneo. Si el destino es una aplicacin de AIR o un componente, el objeto de destino distribuye un evento nativeDragDrop. El controlador de eventos tiene acceso a los datos transferidos desde el objeto de evento. Si el destino se encuentra fuera de AIR, el sistema operativo u otra aplicacin controla la colocacin. En ambos casos, el objeto iniciador distribuye un evento nativeDragComplete (si la operacin de arrastrar empez en AIR).
La clase NativeDragManager controla tanto los gestos de arrastrar hacia dentro como los de arrastrar hacia fuera. Todos los miembros de la clase NativeDragManager son estticos: no cree una instancia de esta clase.
611
Objeto Clipboard Los datos que se arrastran dentro o fuera de una aplicacin o un componente se contienen en un objeto Clipboard. Un mismo objeto Clipboard puede poner a disposicin distintas representaciones de la misma informacin para aumentar la probabilidad de que otra aplicacin pueda comprender y utilizar los datos. Por ejemplo, una imagen puede incluirse como datos de imagen, objeto Bitmap serializado o archivo. La representacin de los datos en un formato determinado puede diferirse a una funcin de representacin a la que no se llama hasta el momento de leerse los datos. Una vez iniciado un gesto de arrastrar, slo se tiene acceso al objeto Clipboard desde un controlador de eventos para los eventos nativeDragEnter, nativeDragOver, y nativeDragDrop. Despus de finalizado el gesto de arrastrar, no se puede volver a leer o utilizar el objeto Clipboard. Un objeto de aplicacin puede transferirse como referencia y como objeto serializado. Las referencias slo son vlidas en la aplicacin de origen. Las transferencias de objetos serializados son vlidos entre aplicaciones de AIR, pero slo pueden utilizarse con objetos que permanecen vlidos al serializarse y deserializarse. Los objetos que se serializan se convierten al formato de mensaje de accin para ActionScript 3 (AMF3), un formato de transferencia de datos basado en cadenas. Trabajo con la arquitectura de Flex En la mayora de los casos es mejor utilizar la API de arrastrar y colocar de Adobe Flex al crear aplicaciones de Flex. La arquitectura de Flex proporciona un conjunto de funciones equivalentes cuando se ejecuta una aplicacin de Flex en AIR (utiliza el mtodo NativeDragManager de AIR de modo interno). Flex mantiene adems un conjunto de funciones ms limitado si una aplicacin o un componente se ejecutan en el entorno ms limitado del navegador. Las clases de AIR no pueden utilizarse en componentes o aplicaciones que se ejecuten fuera del entorno del motor de ejecucin de AIR.
612
El siguiente ejemplo muestra cmo se crea un objeto Clipboard que contiene un mapa de bits en diversos formatos: un objeto Bitmap, un formato de mapa de bits nativo y un formato de lista de archivos que contiene el archivo desde el que se carg originalmente el mapa de bits:
import flash.desktop.Clipboard; import flash.display.Bitmap; import flash.filesystem.File; public function createClipboard(image:Bitmap, sourceFile:File):Clipboard{ var transfer:Clipboard = new Clipboard(); transfer.setData("CUSTOM_BITMAP", image, true); //Flash object by value and by reference transfer.setData(ClipboardFormats.BITMAP_FORMAT, image.bitmapData, false); transfer.setData(ClipboardFormats.FILE_LIST_FORMAT, new Array(sourceFile), false); return transfer; }
clipboard
dragImage
offset
actionsAllowed
El ejemplo siguiente muestra cmo se inicia una operacin de arrastrar para un objeto de mapa de bits cargado desde un archivo. En el ejemplo se carga una imagen y, al darse un evento mouseDown, se inicia la operacin de arrastrar.
613
package { import flash.desktop.NativeDragManager; import mx.core.UIComponent; import flash.display.Sprite; import flash.display.Loader; import flash.system.LoaderContext; import flash.net.URLRequest; import flash.geom.Point; import flash.desktop.Clipboard; import flash.display.Bitmap; import flash.filesystem.File; import flash.events.Event; import flash.events.MouseEvent; public class DragOutExample extends UIComponent Sprite { protected var fileURL:String = "app:/image.jpg"; protected var display:Bitmap; private function init():void { loadImage(); } private function onMouseDown(event:MouseEvent):void { var bitmapFile:File = new File(fileURL); var transferObject:Clipboard = createClipboard(display, bitmapFile); NativeDragManager.doDrag(this, transferObject, display.bitmapData, new Point(-mouseX,-mouseY)); } public function createClipboard(image:Bitmap, sourceFile:File):Clipboard { var transfer:Clipboard = new Clipboard(); transfer.setData("bitmap", image, true); // ActionScript 3 Bitmap object by value and by reference transfer.setData(ClipboardFormats.BITMAP_FORMAT, image.bitmapData, false); // Standard BitmapData format transfer.setData(ClipboardFormats.FILE_LIST_FORMAT,
614
new Array(sourceFile), false); // Standard file list format return transfer; } private function loadImage():void { var url:URLRequest = new URLRequest(fileURL); var loader:Loader = new Loader(); loader.load(url,new LoaderContext()); loader.contentLoaderInfo.addEventListener(Event.COMPLETE, onLoadComplete); } private function onLoadComplete(event:Event):void { display = event.target.loader.content; var flexWrapper:UIComponent = new UIComponent(); flexWrapper.addChild(event.target.loader.content); addChild(flexWrapper); flexWrapper.addEventListener(MouseEvent.MOUSE_DOWN, onMouseDown); } } }
disponibles y las acciones admitidas. Si el componente puede controlar la operacin de colocar, llama a
NativeDragManager.acceptDragDrop().
615
4 El NativeDragManager cambia el cursor del ratn para indicar que se puede colocar el objeto. 5 El usuario coloca el objeto sobre el componente. 6 El componente receptor distribuye un evento nativeDragDrop. 7 El componente receptor lee los datos en el formato deseado del objeto Clipboard dentro del objeto de evento. 8 Si el gesto de arrastrar origin en una aplicacin de AIR, el objeto interactivo iniciador distribuye un evento
nativeDragComplete. Si el gesto origin fuera de AIR, no se enva ninguna confirmacin.
616
serializada del objeto. El ejemplo siguiente ilustra un controlador de eventos para el evento nativeDragDrop.
import flash.desktop.Clipboard; import flash.events.NativeDragEvent; public function onDrop(event:NativeDragEvent):void { if (event.clipboard.hasFormat(ClipboardFormats.TEXT_FORMAT)) { var text:String = String(event.clipboard.getData(ClipboardFormats.TEXT_FORMAT, ClipboardTransferMode.ORIGINAL_PREFERRED)); }
Una vez que sale el controlador de eventos, el objeto Clipboard ya no es vlido. Todo intento de acceso al objeto o a sus datos genera un error.
nativeDragUpdate
nativeDragEnter
nativeDragOver
nativeDragExit
nativeDragComplete
617
618
drag dragend
dragenter
El objeto de evento que se distribuye como respuesta a estos eventos es similar a un evento de ratn. Se pueden utilizar propiedades de evento de ratn tales como (clientX, clientY) y (screenX, screenY) para determinar la posicin del ratn. La propiedad ms importante de un objeto de evento drag es dataTransfer, que contiene los datos arrastrados. El objeto dataTransfer en s tiene los siguientes mtodos y propiedades:
619
Descripcin El efecto admitido por el origen de la operacin de arrastrar. Lo habitual es que este valor lo defina el controlador del evento dragstart. Consulte Efectos de arrastrar en HTML en la pgina 620. El efecto elegido por el destino o el usuario. Si se define la propiedad dropEffect en un controlador de eventos dragover o dragenter, AIR actualiza el cursor para mostrar el efecto que se producira si el usuario soltara el ratn. Si la definicin de dropEffect no coincide con uno de los efectos admitidos, no se permite colocar y se presenta el cursor de indisposicin. Si usted no ha definido la propiedad dropEffect como respuesta al ltimo evento dragover o dragenter, el usuario podr elegir entre los efectos admitidos con las teclas modificadoras normales del sistema operativo. El efecto final lo notifica la propiedad dropEffect del objeto distribuido para dragend. Si el usuario abondona la operacin de colocar, soltando el ratn fuera de un destino idneo, dropEffect se define en none.
dropEffect
types
Un conjunto que contiene las cadenas de tipos MIME para cada formato de datos presente en el objetodataTransfer. Obtiene los datos en el formato especificado por el parmetro mimeType. El mtodo getData() slo puede llamarse como respuesta al evento drop.
getData(mimeType)
setData(mimeType)
Aade datos a dataTransfer en el formato especificado por el parmetro mimeType. Para aadir datos en varios formatos, llame a setData() para cada tipo MIME. Los datos que el comportamiento predeterminado de arrastrar haya colocado en el objeto dataTransfer se eliminan. El mtodo setData() slo puede llamarse como respuesta al evento dragstart.
Elimina datos en el formato especificado por el parmetro mimeType. Configura una imagen de arrastrar personalizada. El mtodo setDragImage()slo se puede llamar como respuesta al evento dragstart y nicamente cuando un elemento HTML completo se arrastra estableciendo su estilo CSS -webkit-user-drag en element. El parmetro image puede ser un elemento JavaScript o un objeto Image.
Tambin se pueden utilizar otras cadenas MIME, incluidas las que define la aplicacin. Sin embargo, cabe la posibilidad de que otras aplicaciones no reconozcan o no puedan utilizar los datos transferidos. Es su responsabilidad aadir datos al objeto dataTransfer en el formato previsto. Importante: Slo el cdigo que se ejecute en el entorno limitado de la aplicacin tiene acceso a los archivos colocados tras una operacin de arrastre. Si se intenta leer o definir una propiedad de un objeto File dentro de un entorno limitado ajeno a la aplicacin, se produce un error de seguridad. Para obtener ms informacin, consulte Gestin de la colocacin de archivos en entornos limitados de HTML ajenos a la aplicacin en la pgina 624.
620
El destino del gesto de arrastrar puede definir la propiedad dataTransfer.dropEffect para indicar la accin que se realiza si el usuario finaliza la operacin de colocar. Si el efecto de colocar es una de las acciones admitidas, el sistema muestra el cursor de copiar, mover o vincular, segn proceda. De lo contrario, el sistema muestra el cursor de indisposicin. Si el destino no define ningn efecto de colocar, el usuario puede elegir entre las acciones admitidas con las teclas modificadoras. Defina el valor dropEffect de los controladores para ambos eventos, dragover y dragenter:
function doDragStart(event) { event.dataTransfer.setData("text/plain","Text to drag"); event.dataTransfer.effectAllowed = "copyMove"; } function doDragOver(event) { event.dataTransfer.dropEffect = "copy"; } function doDragEnter(event) { event.dataTransfer.dropEffect = "copy"; }
Nota: si bien conviene siempre definir la propiedad dropEffect en el controlador de dragenter, tenga en cuenta que el siguiente evento dragover restaurar el valor predeterminado de la propiedad. Defina dropEffect como respuesta a ambos eventos.
621
Nota: cuando se llama al mtodo setData() del objeto dataTransfer, el comportamiento predeterminado de arrastrar y colocar no aade datos.
622
Se puede permitir otro comportamiento de arrastrar hacia dentro en una pgina si se controlan los eventos dragenter, dragover ydrop para cualquier elemento que acepte datos arrastrados.
Utilice el mtodo dataTransfer.getData() para leer los datos y ponerlos en el portapapeles, pasando el tipo MIME del formato de datos a leerse. Para averiguar qu formatos de datos estn disponibles, utilice la propiedad types del objeto dataTransfer. El conjunto types contiene la cadena de tipo MIME de cada formato disponible. Cuando cancela el comportamiento predeterminado en los eventos dragenter o dragover, usted queda responsable de introducir los datos colocados en el lugar correspondiente del documento. No existe ninguna API que convierta una posicin del ratn en posicin de insercin en un elemento. Esta limitacin puede dificultar la implementacin de gestos de arrastrar tipo insercin.
623
<html> <head> <title>Drag-and-drop</title> <script language="javascript" type="text/javascript" src="AIRAliases.js"></script> <script language="javascript"> function init(){ var target = document.getElementById('target'); target.addEventListener("dragenter", dragEnterOverHandler); target.addEventListener("dragover", dragEnterOverHandler); target.addEventListener("drop", dropHandler); var source = document.getElementById('source'); source.addEventListener("dragstart", dragStartHandler); source.addEventListener("dragend", dragEndHandler); emptyRow = document.getElementById("emptyTargetRow"); } function dragStartHandler(event){ event.dataTransfer.effectAllowed = "copy"; } function dragEndHandler(event){ air.trace(event.type + ": " + event.dataTransfer.dropEffect); } function dragEnterOverHandler(event){ event.preventDefault(); } var emptyRow; function dropHandler(event){ for(var prop in event){ air.trace(prop + " = " + event[prop]); } var row = document.createElement('tr'); row.innerHTML = "<td>" + event.dataTransfer.getData("text/plain") + "</td>" + "<td>" + event.dataTransfer.getData("text/html") + "</td>" + "<td>" + event.dataTransfer.getData("text/uri-list") + "</td>" + "<td>" + event.dataTransfer.getData("application/x-vnd.adobe.air.file-list") + "</td>"; var imageCell = document.createElement('td'); if((event.dataTransfer.types.toString()).search("image/x-vnd.adobe.air.bitmap") > 1){ imageCell.appendChild(event.dataTransfer.getData("image/xvnd.adobe.air.bitmap")); } row.appendChild(imageCell); var parent = emptyRow.parentNode; parent.insertBefore(row, emptyRow); } </script> </head> <body onLoad="init()" style="padding:5px"> <div> <h1>Source</h1>
624
<p>Items to drag:</p> <ul id="source"> <li>Plain text.</li> <li>HTML <b>formatted</b> text.</li> <li>A <a href="http://www.adobe.com">URL.</a></li> <li><img src="icons/AIRApp_16.png" alt="An image"/></li> <li style="-webkit-user-drag:none;"> Uses "-webkit-user-drag:none" style. </li> <li style="-webkit-user-select:none;"> Uses "-webkit-user-select:none" style. </li> </ul> </div> <div id="target" style="border-style:dashed;"> <h1 >Target</h1> <p>Drag items from the source list (or elsewhere).</p> <table id="displayTable" border="1"> <tr><th>Plain text</th><th>Html text</th><th>URL</th><th>File list</th><th>Bitmap Data</th></tr> <tr id="emptyTargetRow"><td> </td><td> </td><td> </td><td> </td><td> </ td></tr> </table> </div> </div> </body> </html>
625
En el ejemplo siguiente un documento principal carga una pgina secundaria en un entorno limitado remoto (http://localhost/). El documento principal detecta el evento nativeDragDrop en el objeto HTMLLoader y resea la URL del archivo.
<html> <head> <title>Drag-and-drop in a remote sandbox</title> <script language="javascript" type="text/javascript" src="AIRAliases.js"></script> <script language="javascript"> window.htmlLoader.addEventListener("nativeDragDrop",function(event){ var filelist = event.clipboard.getData(air.ClipboardFormats.FILE_LIST_FORMAT); air.trace(filelist[0].url); }); </script> </head> <body> <iframe src="child.html" sandboxRoot="http://localhost/" documentRoot="app:/" frameBorder="0" width="100%" height="100%"> </iframe> </body> </html>
El documento secundario debe presentar un destino vlido, llamando al mtodo preventDefault() del objeto Event en los controladores de eventos en HTML dragenter y dragover. De lo contrario, el evento drop nunca se llevar a cabo.
<html> <head> <title>Drag and drop target</title> <script language="javascript" type="text/javascript"> function preventDefault(event){ event.preventDefault(); } </script> </head> <body ondragenter="preventDefault(event)" ondragover="preventDefault(event)"> <div> <h1>Drop Files Here</h1> </div> </body> </html>
626
Se puede utilizar la clase URLFilePromise en una aplicacin de AIR para arrastrar y colocar archivos a los que se puede acceder en una URL. La implementacin de URLFilePromise se proporciona en la biblioteca aircore como parte del AIR 2 SDK. Puede utilizar el archivo aircore.swc o aircore.swf del directorio frameworks/libs/air de SDK. Otra alternativa es implementar su propia lgica de promesa de archivos con la interfaz IFilePromise (definida en el paquete flash.desktop del motor de ejecucin). Las promesas de archivo son similares en concepto a la representacin aplazada utilizando una funcin de controlador de datos en el portapapeles. Utilice las promesas de archivo en lugar de la representacin aplazada al arrastrar y colocar archivos. La tcnica de representacin aplazada puede dar lugar a pausas no deseadas en la operacin de arrastrar cuando se generan o se descargan los datos. Utilice la representacin aplazada para las operaciones de copiar y pegar (para las que no se admiten las promesas de archivo). Limitaciones en el uso de promesas de archivo Las promesas de archivo presentan las siguientes limitaciones si se comparan con otros formatos de datos que se pueden situar en un portapapeles de arrastrar y colocar:
Las promesas de archivo slo se pueden arrastrar desde una aplicacin de AIR; no se pueden colocar en una
aplicacin de AIR.
Las promesas de archivo no son compatibles con todos los sistemas operativos. Utilice la propiedad
Clipboard.supportsFilePromise para comprobar si las promesas de archivo se admiten en el sistema host. En
los sistemas que no admiten promesas de archivo, se debe proporcionar un mecanismo alternativo para descargar o generar los datos de archivo.
Ms temas de ayuda
flash.desktop.IFilePromise air.desktop.URLFilePromise
627
Se puede permitir al usuario que arrastre varios archivos a la vez aadiendo ms objetos de promesa de archivo al conjunto asignado al portapapeles. Tambin se pueden especificar subdirectorios en la propiedad relativePath de modo que algunos o todos los archivos incluidos en la operacin se coloquen en una subcarpeta relativa a la ubicacin de destino. En el siguiente ejemplo se muestra cmo iniciar una operacin de arrastrar que incluye varias promesas de archivo. En este ejemplo, una pgina html, article.html, se sita en el portapapeles como promesa de archivo, junto con sus dos archivos de imagen vinculados. Las imgenes se copian en una subcarpeta images de modo que se mantengan los vnculos relativos.
if( Clipboard.supportsFilePromise ) { //Create the promise objects var filePromise:URLFilePromise = new URLFilePromise(); filePromise.request = new URLRequest("http://example.com/article.html"); filePromise.relativePath = "article.html"; var image1Promise:URLFilePromise = new URLFilePromise(); image1Promise.request = new URLRequest("http://example.com/images/img_1.jpg"); image1Promise.relativePath = "images/img_1.html"; var image2Promise:URLFilePromise = new URLFilePromise(); image2Promise.request = new URLRequest("http://example.com/images/img_2.jpg"); image2Promise.relativePath = "images/img_2.jpg";
//Put the promise objects onto the clipboard inside an array var fileList:Array = new Array( filePromise, image1Promise, image2Promise ); var clipboard:Clipboard = new Clipboard(); clipboard.setData( ClipboardFormats.FILE_PROMISE_LIST_FORMAT, fileList ); //Start the drag operation NativeDragManager.doDrag( dragSource, clipboard ); }
ByteArray (sincrnica)
628
open():IDataInput: devuelve el objeto proveedor de datos en el que se leen los datos para el archivo prometido.
El objeto debe implementar la interfaz IDataInput. Si los datos se proporciona de forma asncrona, el objeto tambin debe implementar la interfaz IEventDispatcher y distribuir los eventos necesarios (consulte Uso de un proveedor de datos asncrono en una promesa de archivo en la pgina 630).
get relativePath():String: proporciona la ruta, incluyendo el nombre de archivo, para el archivo creado. La
ruta se resuelve en funcin de la ubicacin de destino seleccionada por el usuario en la operacin de arrastrar y colocar. Para garantizar que la ruta utilice el carcter separador apropiado para el sistema operativo del ordenador host, utilice la constante File.separator al especificar las rutas que incluyen directorios. Se puede aadir una funcin captadora o emplear un parmetro constructor para permitir que la ruta se establezca en tiempo de ejecucin.
get isAsync():Boolean: informa al motor de ejecucin de AIR si el objeto proveedor de datos proporciona su
leer los datos. Todos los mtodos IFilePromise se llaman mediante el motor de ejecucin durante una operacin de arrastrar y colocar que implica la promesa de archivo. Generalmente la lgica de la aplicacin no debe llamar a ninguno de estos mtodos directamente.
629
public class SynchronousFilePromise implements IFilePromise { private const fileSize:int = 5000; //size of file data private var filePath:String = "SynchronousFile.txt"; public function get relativePath():String { return filePath; } public function get isAsync():Boolean { return false; } public function open():IDataInput { var fileContents:ByteArray = new ByteArray(); //Create some arbitrary data for the file for( var i:int = 0; i < fileSize; i++ ) { fileContents.writeUTFBytes( 'S' ); } //Important: the ByteArray is read from the current position fileContents.position = 0; return fileContents; } public function close():void { //Nothing needs to be closed in this case. } public function reportError(e:ErrorEvent):void { trace("Something went wrong: " + e.errorID + " - " + e.type + ", " + e.text ); } } }
En la prctica, las promesas de archivo sincrnicas presentan una utilidad limitada. Si la cantidad de datos es pequea, se puede crear fcilmente un archivo en un directorio temporal y aadir un conjunto de lista de archivos normal al portapapeles de arrastrar y colocar. Por otra parte, si la cantidad de informacin es grande o la generacin de datos requiere mucho procesamiento, es necesario contar un proceso sincrnico largo. Los procesos sincrnicos largos pueden bloquear las actualizaciones de la IU durante una cantidad considerable de tiempo y hacer que la aplicacin no responda. Para evitar este problema, se puede crear un proveedor de datos asncrono controlado por un temporizador.
630
Event.OPEN: informa al motor de ejecucin de que el origen de datos est listo. ProgressEvent.PROGRESS: indica al motor de ejecucin que los datos estn disponibles. El motor de ejecucin
leer la cantidad de datos disponibles desde el objeto proveedor de datos.
ProgressEvent.SOCKET_DATA: indica al motor de ejecucin que los datos estn disponibles. El evento
socketData se distribuye mediante los objetos basados en socket. Para otros tipos de objetos, se debe distribuir un
evento progress. (El motor de ejecucin detecta ambos eventos para percibir el momento en que se pueden leer los datos.)
Event.COMPLETE: indica al motor de ejecucin que todos los datos se han ledo. Event.CLOSE: indica al motor de ejecucin que todos los datos se han ledo. (El motor de ejecucin detecta close
y complete para este propsito.)
IOErrorEvent.IOERROR: indica al motor de ejecucin que se ha producido un error al leer los datos. El motor de
ejecucin anula la creacin del archivo y llama al mtodo close() de IFilePromise.
Nota: los objetos incorporados, FileStream, Socket y URLStream distribuyen los eventos adecuados de forma automtica. En el siguiente ejemplo se crea una promesa de archivo utilizando un proveedor de datos asncrono y personalizado. La clase del proveedor de datos ampla ByteArray (para la compatibilidad con IDataInput) e implementa la interfaz IEventDispatcher. En cada evento del temporizador, el objeto genera un campo de datos y distribuye un evento de progreso para indicar al motor de ejecucin que los datos estn disponibles. Una vez generados datos suficientes, el objeto distribuye un evento completo.
631
package { import flash.events.Event; import flash.events.EventDispatcher; import flash.events.IEventDispatcher; import flash.events.ProgressEvent; import flash.events.TimerEvent; import flash.utils.ByteArray; import flash.utils.Timer; [Event(name="open", type="flash.events.Event.OPEN")] [Event(name="complete", type="flash.events.Event.COMPLETE")] [Event(name="progress", type="flash.events.ProgressEvent")] [Event(name="ioError", type="flash.events.IOErrorEvent")] [Event(name="securityError", type="flash.events.SecurityErrorEvent")] public class AsyncDataProvider extends ByteArray implements IEventDispatcher { private var dispatcher:EventDispatcher = new EventDispatcher(); public var fileSize:int = 0; //The number of characters in the file private const chunkSize:int = 1000; //Amount of data written per event private var dispatchDataTimer:Timer = new Timer( 100 ); private var opened:Boolean = false; public function AsyncDataProvider() { super(); dispatchDataTimer.addEventListener( TimerEvent.TIMER, generateData ); } public function begin():void{ dispatchDataTimer.start(); } public function end():void { dispatchDataTimer.stop(); } private function generateData( event:Event ):void { if( !opened ) { var open:Event = new Event( Event.OPEN ); dispatchEvent( open ); opened = true; } else if( position + chunkSize < fileSize ) { for( var i:int = 0; i <= chunkSize; i++ ) { writeUTFBytes( 'A' ); } //Set position back to the start of the new data this.position -= chunkSize; var progress:ProgressEvent = new ProgressEvent( ProgressEvent.PROGRESS, false, false, bytesAvailable, bytesAvailable + chunkSize); dispatchEvent( progress )
632
} else { var complete:Event = new Event( Event.COMPLETE ); dispatchEvent( complete ); } } //IEventDispatcher implementation public function addEventListener(type:String, listener:Function, useCapture:Boolean=false, priority:int=0, useWeakReference:Boolean=false):void { dispatcher.addEventListener( type, listener, useCapture, priority, useWeakReference ); } public function removeEventListener(type:String, listener:Function, useCapture:Boolean=false):void { dispatcher.removeEventListener( type, listener, useCapture ); } public function dispatchEvent(event:Event):Boolean { return dispatcher.dispatchEvent( event ); } public function hasEventListener(type:String):Boolean { return dispatcher.hasEventListener( type ); } public function willTrigger(type:String):Boolean { return dispatcher.willTrigger( type ); } } }
Nota: debido a que la clase AsyncDataProvider del ejemplo ampla ByteArray, no puede ampliar tambin EventDispatcher. Para implementar la interfaz IEventDispatcher, la clase utiliza un objeto interno EventDispatcher y reenva las llamadas del mtodo IEventDispatcher a ese objeto interno. Tambin se puede ampliar EventDispatcher e implementar IDataInput (o implementar ambas interfaces). La implementacin asncrona de IFilePromise resulta casi idntica a la implementacin sincrnica. Las principales diferencias radican en que isAsync devuelve el valor true y que el mtodo open() devuelve un objeto de datos asncrono:
633
public class AsynchronousFilePromise extends EventDispatcher implements IFilePromise { private var fileGenerator:AsyncDataProvider; private const fileSize:int = 5000; //size of file data private var filePath:String = "AsynchronousFile.txt"; public function get relativePath():String { return filePath; } public function get isAsync():Boolean { return true; } public function open():IDataInput { fileGenerator = new AsyncDataProvider(); fileGenerator.fileSize = fileSize; fileGenerator.begin(); return fileGenerator; } public function close():void { fileGenerator.end(); } public function reportError(e:ErrorEvent):void { trace("Something went wrong: " + e.errorID + " - " + e.type + ", " + e.text ); } } }
634
Adding native menus to an AIR application (Cmo aadir mens nativos a una aplicacin de AIR, en ingls) (Flex) Adding native menus to an AIR application (Cmo aadir mens nativos a una aplicacin de AIR, en ingls)
(Flash) Las clases de men nativo permiten acceder a las funciones del men nativo del sistema operativo donde se ejecuta la aplicacin. Se pueden utilizar los objetos NativeMenu para mens de aplicacin (disponibles en Mac OS X), mens de ventana (disponibles en Windows y Linux), mens contextuales y mens emergentes. Fuera de AIR, se pueden utilizar las clases del men contextual para modificar el men contextual que muestra automticamente Flash Player cuando un usuario hace clic con el botn derecho o presiona comando y hace clic en un objeto de la aplicacin. (En las aplicaciones de AIR no se muestra ningn men contextual automtico.)
Clases de men
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior Entre las clases de men se incluyen:
Paquete flash.display Clases
flash.ui
flash.events
635
Variedades de men
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior AIR admite los siguientes tipos de mens:
Mens contextuales Los mens contextuales se abren en respuesta a un clic con el botn derecho del ratn o a un clic
de un comando en un objeto interactivo en el contenido SWF o en un elemento de documento en un contenido HTML. En el motor de ejecucin de Flash Player, un men contextual se muestra automticamente. Las clases ContextMenu y ContextMenuItem se pueden emplear para aadir comandos propios al men. Tambin se pueden eliminar algunos, pero no todos, comandos incorporados. En el motor de ejecucin de AIR, se puede crear un men contextual utilizando la clase NativeMenu o ContextMenu. En el contenido HTML en AIR, se puede utilizar el Webkit HTML y las API JavaScript para aadir mens contextuales a elementos HTML.
Mens de aplicacin (slo AIR) Un men de aplicacin es un men global que se aplica a toda la aplicacin. Los mens de aplicacin son compatibles en Mac OS X, pero no en Windows o Linux. En Mac OS X, el sistema operativo automticamente crea un men de aplicacin. Se puede utilizar la API del men AIR para aadir elementos y submens secundarios a los mens estndar. Se pueden aadir detectores para gestionar los comandos de men existentes. O bien se pueden quitar elementos existentes. Mens de ventana (slo AIR) Un men de ventana est asociado con una sola ventana y se muestra debajo de la barra de ttulo. Se pueden aadir los mens a una ventana creando un objeto NativeMenu y asignndolo a la propiedad menu del objeto NativeWindow. Los mens de ventana son compatibles con los sistemas operativos Windows y Linux, pero no en Mac OS X. Los mens de ventana nativos solo se pueden utilizar con ventanas que tienen fondo cromtico del sistema. Mens del icono de acoplamiento y de bandeja del sistema (slo AIR) Estos mens de iconos son similares a los mens
contextuales y se asignan a un icono de aplicacin en el acoplamiento de Mac OS X o las reas de notificacin en la barra de tareas de Windows y Linux. Los mens del icono de acoplamiento y bandeja del sistema utilizan la clase NativeMenu. En Mac OS X, los elementos en el men se aaden por encima de los elementos del sistema operativo estndar. En Windows o Linux, no hay un men estndar.
Mens emergentes (slo AIR) Un men emergente de AIR es como un men contextual, pero no necesariamente est asociado con un determinado objeto o elemento de aplicacin. Los mens emergentes se pueden mostrar en cualquier parte de una ventana llamando al mtodo display() de cualquier objeto NativeMenu. Mens personalizados El sistema operativo invoca los mens nativos y, como tal, existen fuera de los modelos de
representacin de Flash y HTML. En lugar de utilizar mens nativos, siempre puede crear sus propios mens no nativos y personalizados utilizando MXML, ActionScript o JavaScript (en AIR). Estos mens deben procesarse por completo dentro del contenido de la aplicacin.
Mens de Flex La arquitectura Adobe Flex proporciona una serie de componentes de men Flex. El motor de
ejecucin y no el sistema operativo invoca los mens Flex y no son mens nativos. El componente del men Flex se puede utilizar para ventanas Flex que no tienen un fondo cromtico del sistema. Otra ventaja de utilizar el componente de men Flex es que se pueden especificar mens de forma declarativa en el formato MXML. Si se utiliza la arquitectura de Flex, se utilizan las clases del men Flex para los mens de ventana en lugar de las clases nativas. Mens predeterminados (slo AIR) El sistema operativo o una clase incorporada de AIR proporciona los siguientes mens predeterminados:
636
Men de icono de acoplamiento en Mac OS X Men contextual para texto e imgenes seleccionados en un contenido HTML Men contextual para texto seleccionado en un objeto TextField (o en un objeto que ampla TextField)
Mens contextuales
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior En el contenido SWF, a cualquier objeto que hereda de InteractiveObject se le puede asignar un men contextual asignando un objeto de men a la propiedad contextMenu. Se incluyen varios comandos de manera predeterminada, incluidos Forward (Avanzar), Back (Atrs), Print (Imprimir), Quality (Calidad) y Zoom. En el motor de ejecucin de AIR, el objeto de men asignado a contextMenu puede ser del tipo NativeMenu o ContextMenu. En el motor de ejecucin de Flash Player, slo est disponible la clase ContextMenu. Puede detectar eventos de men nativo o eventos de mens contextuales con el uso de las clases ContextMenu y ContextMenuItem; ambas se distribuyen. Una ventaja que ofrecen las propiedades del objeto ContextMenuEvent es que contextMenuOwner identifica el objeto al que se asocia el men y mouseTarget identifica el objeto en el que se hizo clic para abrir el men. Esta informacin no est disponible en el objeto NativeMenuEvent. El siguiente ejemplo crea un objeto Sprite y aade un simple men contextual de edicin:
var sprite:Sprite = new Sprite(); sprite.contextMenu = createContextMenu() private function createContextMenu():ContextMenu{ var editContextMenu:ContextMenu = new ContextMenu(); var cutItem:ContextMenuItem = new ContextMenuItem("Cut") cutItem.addEventListener(ContextMenuEvent.MENU_ITEM_SELECT, doCutCommand); editContextMenu.customItems.push(cutItem); var copyItem:ContextMenuItem = new ContextMenuItem("Copy") copyItem.addEventListener(ContextMenuEvent.MENU_ITEM_SELECT, doCopyCommand); editContextMenu.customItems.push(copyItem); var pasteItem:ContextMenuItem = new ContextMenuItem("Paste") pasteItem.addEventListener(ContextMenuEvent.MENU_ITEM_SELECT, doPasteCommand); editContextMenu.customItems.push(pasteItem); return editContextMenu } private function doCutCommand(event:ContextMenuEvent):void{trace("cut");} private function doCopyCommand(event:ContextMenuEvent):void{trace("copy");} private function doPasteCommand(event:ContextMenuEvent):void{trace("paste");}
Nota: a diferencia del contenido SWF que se muestra en un entorno de navegador, los mens contextuales en AIR no tienen comandos incorporados. Personalizacin de un men contextual de Flash Player En un navegador o proyector, los mens contextuales en el contenido SWF siempre disponen de elementos incorporados. Se pueden eliminar todos los comandos predeterminados del men, excepto Configuracin y Acerca de. Si se establece la propiedad showDefaultContextMenu del objeto Stage en false, se eliminan estos comandos del men contextual.
637
Para crear un men contextual personalizado para un objeto de visualizacin especfico hay que crear una nueva instancia de la clase ContextMenu, llamar al mtodo hideBuiltInItems() y asignar dicha instancia a la propiedad contextMenu de la instancia de DisplayObject. El siguiente ejemplo proporciona un cuadrado dibujado dinmicamente con un comando de men contextual para aplicarle un color aleatorio:
var square:Sprite = new Sprite(); square.graphics.beginFill(0x000000); square.graphics.drawRect(0,0,100,100); square.graphics.endFill(); square.x = square.y = 10; addChild(square); var menuItem:ContextMenuItem = new ContextMenuItem("Change Color"); menuItem.addEventListener(ContextMenuEvent.MENU_ITEM_SELECT,changeColor); var customContextMenu:ContextMenu = new ContextMenu(); customContextMenu.hideBuiltInItems(); customContextMenu.customItems.push(menuItem); square.contextMenu = customContextMenu; function changeColor(event:ContextMenuEvent):void { square.transform.colorTransform = getRandomColor(); } function getRandomColor():ColorTransform { return new ColorTransform(Math.random(), Math.random(), Math.random(),1,(Math.random() * 512) - 255, (Math.random() * 512) -255, (Math.random() * 512) - 255, 0); }
638
El siguiente diagrama muestra la estructura de un men tpico. El men raz representa la barra de mens y contiene dos elementos de men que hacen referencia a un submen Archivo y a un submen Editar. El submen Archivo en esta estructura contiene dos elementos de comando y un elemento que hace referencia a un submen Men Abrir reciente, que contiene tres elementos. El submen Editar contiene tres comandos y un separador.
La definicin de un submen requiere un objeto NativeMenu y NativeMenuItem. El objeto NativeMenuItem define la etiqueta que se muestra en el men principal y permite al usuario abrir el submen. El objeto NativeMenu acta como un contenedor para los elementos en el submen. El objeto NativeMenuItem hace referencia al objeto NativeMenu a travs de la propiedad submenu de NativeMenuItem. Para ver un ejemplo de cdigo que crea este men, consulte Ejemplo de men nativo: Men de aplicacin y de ventana (AIR) en la pgina 646.
Eventos de men
Adobe AIR 1.0 y posterior Los objetos NativeMenu y NativeMenuItem distribuyen eventos preparing, displaying y select: Preparing: siempre que el objeto est a punto de comenzar una interaccin con el usuario, los elementos de men distribuyen un evento preparing a cualquiera de los detectores registrados. La interaccin incluye la apertura del men o la seleccin de un elemento con un mtodo abreviado de teclado.
639
Nota: el evento preparing slo est disponible para Adobe AIR 2.6 y posterior.
Displaying: Inmediatamente antes de visualizar un men, el men y los elementos de men distribuyen un evento
displaying a cualquier detector registrado.
Los eventos preparing y displaying proporcionan la oportunidad de actualizar los contenidos de men o la apariencia de elementos antes de que se muestre al usuario. Por ejemplo, en el detector para el evento displaying de un men Abrir reciente, se pueden cambiar los elementos de men para reflejar la lista actual de documentos recientemente visualizados. Si se elimina el elemento de men cuyo mtodo abreviado de teclado activ un evento preparing, la interaccin con el men se cancela y no se distribuye ningn eventoselect. Las propiedades target y currentTarget del evento son ambas el objeto en el que se registra el detector: el propio men o uno de sus elementos. El evento preparing se distribuye antes del evento displaying. Generalmente se detecta un evento o el otro, no ambos.
Select: Cuando el usuario elige un elemento de comando, el elemento distribuye un evento select a cualquier detector registrado. Los elementos de submen y separador no se pueden seleccionar y por ende nunca distribuyen un evento select.
Un evento select se propaga desde un elemento de men al men que lo contienen hasta el men raz. Se pueden detectar eventos selectdirectamente en un elemento y en niveles superiores en la estructura del men. Cuando se detecta el evento select en un men, se puede identificar el elemento seleccionado utilizando la propiedad de evento target. A medida que el evento se propaga a travs de la jerarqua, la propiedad currentTarget del objeto de evento identifica el objeto de men actual. Nota: los objetos ContextMenu y ContextMenuItem distribuyen eventos menuItemSelect y menuSelect, as como eventos select, preparing y displaying.
640
Nota: si asigna el valor Keyboard.COMMAND a un conjunto de modificadores de teclas en el sistema operativo Windows, no se muestra ningn equivalente de tecla en el men. Sin embargo, se debe utilizar la tecla de control para activar el comando de men. En el siguiente ejemplo se asigna Ctrl+Mays+G como el equivalente de tecla para un elemento de men:
var item:NativeMenuItem = new NativeMenuItem("Ungroup"); item.keyEquivalent = "G";
En este ejemplo se asigna Ctrl+Mays+G como el equivalente de tecla configurando directamente el conjunto modificador:
var item:NativeMenuItem = new NativeMenuItem("Ungroup"); item.keyEquivalent = "G"; item.keyEquivalentModifiers = [Keyboard.CONTROL];
Nota: los equivalentes de teclas solo se activan para mens de ventana y de aplicacin. Si se aade un equivalente de tecla a un men contextual o emergente, el mismo se muestra en la etiqueta de men, pero el comando de men asociado nunca se invoca.
641
enabled Seleccione el valor true o false para controlar si el comando est activado o no. Los elementos desactivados
Para los mens de aplicacin y de ventana, el men raz representa la barra de mens y solo debe tener los elementos que abren submens. Los mens contextual y emergentes no tienen una barra de mens, por lo que el men raz puede tener lneas separadoras y comandos as como submens. Despus de crear el men, se pueden aadir elementos de men. Los elementos aparecen en el men en el orden en que se aaden, a menos que se aadan los elementos en un ndice especfico utilizando el mtodo addItemAt() de un objeto de men. Se puede asignar el men como un men de aplicacin, de ventana, de icono o contextual o mostrarlo como un men emergente como se muestra en las siguientes secciones: Definicin del men de aplicacin o el men de ventana Es importante que el cdigo se acomode a los mens de la aplicacin (admitidos en Mac OS) y a los mens de ventana (admitidos en otros sistemas operativos)
642
var root:NativeMenu = new NativeMenu(); if (NativeApplication.supportsMenu) { NativeApplication.nativeApplication.menu = root; } else if (NativeWindow.supportsMenu) { nativeWindow.menu = root; }
Nota: Mac OS define un men que contiene elementos estndares para cada aplicacin. Si se asigna un nuevo objeto NativeMenu a la propiedad menu del objeto NativeApplication se remplaza el men estndar. Tambin se puede utilizar el men estndar en lugar de sustituirlo. Adobe Flex proporciona una clase FlexNativeMenu para crear fcilmente mens que funcionen en distintas plataformas. Si est utilizando Flex Framework, use las clases FlexNativeMenu en lugar de la clase NativeMenu. Definicin de un men contextual en un objeto interactivo
interactiveObject.contextMenu = root;
Definicin de un men de icono de acoplamiento o un men de icono de la bandeja del sistema Es importante que el cdigo se acomode a los mens de la aplicacin (admitidos en Mac OS) y a los mens de ventana (admitidos en otros sistemas operativos)
if (NativeApplication.supportsSystemTrayIcon) { SystemTrayIcon(NativeApplication.nativeApplication.icon).menu = root; } else if (NativeApplication.supportsDockIcon) { DockIcon(NativeApplication.nativeApplication.icon).menu = root; }
Nota: Mac OS X define un men estndar para el icono de acoplamiento de la aplicacin. Cuando se asigna un nuevo NativeMenu a la propiedad de men del objeto DockIcon, los elementos en ese men se muestran arriba de los elementos estndar. No se pueden quitar, acceder ni modificar los elementos de men estndar. Visualizacin de un men como un men emergente
root.display(stage, x, y);
Ms temas de ayuda
Desarrollo de aplicaciones de AIR para varias plataformas
Creacin de un submen
Adobe AIR 1.0 y posterior Para crear un submen, se aade un objeto NativeMenuItem al men principal y luego se asigna el objeto NativeMenu definiendo el submen a la propiedad submenu del elemento. AIR proporciona dos modos de crear elementos de submen y los objetos de men asociados: Se puede crear un elemento de men y el objeto de men relacionado en un paso con el mtodo addSubmenu():
var editMenuItem:NativeMenuItem = root.addSubmenu(new NativeMenu(), "Edit");
643
Tambin se puede crear el elemento de men y asignar el objeto de men a la propiedad submenu de forma separada:
var editMenuItem:NativeMenuItem = root.addItem("Edit", false); editMenuItem.submenu = new NativeMenu();
Se puede detectar un evento select en el elemento de comando mismo (como se muestra en el ejemplo) o se puede detectar el evento select en un objeto de men principal. Nota: los elementos de men que representan submens y lneas separadoras no distribuyen eventos select y por ende no se pueden utilizar como comandos.
Luego se puede mostrar un men contextual personalizado utilizando las tcnicas DHTML o mostrando un men contextual nativo de AIR. En el siguiente ejemplo se muestra un men contextual nativo llamando el mtodo display() del men en respuesta al evento contextmenu HTML:
644
<html> <head> <script src="AIRAliases.js" language="JavaScript" type="text/javascript"></script> <script language="javascript" type="text/javascript"> function showContextMenu(event){ event.preventDefault(); contextMenu.display(window.nativeWindow.stage, event.clientX, event.clientY); } function createContextMenu(){ var menu = new air.NativeMenu(); var command = menu.addItem(new air.NativeMenuItem("Custom command")); command.addEventListener(air.Event.SELECT, onCommand); return menu; } function onCommand(){ air.trace("Context command invoked."); } var contextMenu = createContextMenu(); </script> </head> <body> <p oncontextmenu="showContextMenu(event)" style="-khtml-user-select:auto;">Custom context menu.</p> </body> </html>
Nota: no se necesita mostrar el men en respuesta directa a un evento Cualquier mtodo puede llamar a la funcin display().
645
Debido a que los eventos select se propagan a los mens que los contienen, tambin puede detectar eventos select en un men principal. Cuando se detecta a nivel de men, se puede utilizar la propiedad target del objeto de evento para determinar el comando de men seleccionado. En el siguiente ejemplo se rastrea la etiqueta del comando seleccionado:
646
var colorMenuItem:NativeMenuItem = new NativeMenuItem("Choose a color"); var colorMenu:NativeMenu = new NativeMenu(); colorMenuItem.submenu = colorMenu; var red:NativeMenuItem = new NativeMenuItem("Red"); var green:NativeMenuItem = new NativeMenuItem("Green"); var blue:NativeMenuItem = new NativeMenuItem("Blue"); colorMenu.addItem(red); colorMenu.addItem(green); colorMenu.addItem(blue); if(NativeApplication.supportsMenu){ NativeApplication.nativeApplication.menu.addItem(colorMenuItem); NativeApplication.nativeApplication.menu.addEventListener(Event.SELECT, colorChoice); } else if (NativeWindow.supportsMenu){ var windowMenu:NativeMenu = new NativeMenu(); this.stage.nativeWindow.menu = windowMenu; windowMenu.addItem(colorMenuItem); windowMenu.addEventListener(Event.SELECT, colorChoice); } function colorChoice(event:Event):void { var menuItem:NativeMenuItem = event.target as NativeMenuItem; trace(menuItem.label + " has been selected"); }
Si se utiliza la clase ContextMenuItem, se puede detectar el evento select o el evento menuItemSelect. El evento menuItemSelect proporciona informacin adicional sobre el objeto propietario del men contextual, pero no se propaga a los mens que lo contienen.
647
El men est diseado para funcionar en Windows, en el que solo se admiten mens de ventana, y en Mac OS X, en el que solo se admiten mens de aplicacin. Para hacer una distincin, el constructor de la clase MenuExample verifica las propiedades estticas supportsMenu de las clases NativeWindow y NativeApplication. Si NativeWindow.supportsMenu es true, entonces el constructor crea un objeto NativeMenu para la ventana y luego crea y aade los submens Archivo y Editar. Si NativeApplication.supportsMenu es true, entonces el constructor crea y aade los mens Archivo y Editar al men existente proporcionado por el sistema operativo Mac OS X. El ejemplo tambin muestra la gestin de eventos de men. El evento select se gestiona a nivel del elemento y tambin a nivel del men. Cada men en la cadena desde el men que contiene el elemento seleccionado hasta el men raz responde al evento select. El evento displaying se utiliza con el men Abrir reciente. Justo antes de que se abra el men, los elementos en el men se actualizan del conjunto de documentos recientes (que en realidad no cambia en este ejemplo). Aunque no se muestra en este ejemplo, tambin se pueden detectar eventos displaying en elementos individuales.
package { import import import import import import import flash.display.NativeMenu; flash.display.NativeMenuItem; flash.display.NativeWindow; flash.display.Sprite; flash.events.Event; flash.filesystem.File; flash.desktop.NativeApplication;
public class MenuExample extends Sprite { private var recentDocuments:Array = new Array(new File("app-storage:/GreatGatsby.pdf"), new File("app-storage:/WarAndPeace.pdf"), new File("app-storage:/Iliad.pdf")); public function MenuExample() { var fileMenu:NativeMenuItem; var editMenu:NativeMenuItem; if (NativeWindow.supportsMenu){ stage.nativeWindow.menu = new NativeMenu(); stage.nativeWindow.menu.addEventListener(Event.SELECT, selectCommandMenu); fileMenu = stage.nativeWindow.menu.addItem(new NativeMenuItem("File")); fileMenu.submenu = createFileMenu(); editMenu = stage.nativeWindow.menu.addItem(new NativeMenuItem("Edit")); editMenu.submenu = createEditMenu(); } if (NativeApplication.supportsMenu){ NativeApplication.nativeApplication.menu.addEventListener(Event.SELECT, selectCommandMenu); fileMenu = NativeApplication.nativeApplication.menu.addItem(new NativeMenuItem("File")); fileMenu.submenu = createFileMenu(); editMenu = NativeApplication.nativeApplication.menu.addItem(new NativeMenuItem("Edit")); editMenu.submenu = createEditMenu(); } }
648
public function createFileMenu():NativeMenu { var fileMenu:NativeMenu = new NativeMenu(); fileMenu.addEventListener(Event.SELECT, selectCommandMenu); var newCommand:NativeMenuItem = fileMenu.addItem(new NativeMenuItem("New")); newCommand.addEventListener(Event.SELECT, selectCommand); var saveCommand:NativeMenuItem = fileMenu.addItem(new NativeMenuItem("Save")); saveCommand.addEventListener(Event.SELECT, selectCommand); var openRecentMenu:NativeMenuItem = fileMenu.addItem(new NativeMenuItem("Open Recent")); openRecentMenu.submenu = new NativeMenu(); openRecentMenu.submenu.addEventListener(Event.DISPLAYING, updateRecentDocumentMenu); openRecentMenu.submenu.addEventListener(Event.SELECT, selectCommandMenu); return fileMenu; } public function createEditMenu():NativeMenu { var editMenu:NativeMenu = new NativeMenu(); editMenu.addEventListener(Event.SELECT, selectCommandMenu); var copyCommand:NativeMenuItem = editMenu.addItem(new NativeMenuItem("Copy")); copyCommand.addEventListener(Event.SELECT, selectCommand); copyCommand.keyEquivalent = "c"; var pasteCommand:NativeMenuItem = editMenu.addItem(new NativeMenuItem("Paste")); pasteCommand.addEventListener(Event.SELECT, selectCommand); pasteCommand.keyEquivalent = "v"; editMenu.addItem(new NativeMenuItem("", true)); var preferencesCommand:NativeMenuItem = editMenu.addItem(new NativeMenuItem("Preferences")); preferencesCommand.addEventListener(Event.SELECT, selectCommand); return editMenu; } private function updateRecentDocumentMenu(event:Event):void { trace("Updating recent document menu."); var docMenu:NativeMenu = NativeMenu(event.target); for each (var item:NativeMenuItem in docMenu.items) { docMenu.removeItem(item); } for each (var file:File in recentDocuments) { var menuItem:NativeMenuItem = docMenu.addItem(new NativeMenuItem(file.name)); menuItem.data = file; menuItem.addEventListener(Event.SELECT, selectRecentDocument); } } private function selectRecentDocument(event:Event):void { trace("Selected recent document: " + event.target.data.name); }
649
private function selectCommand(event:Event):void { trace("Selected command: " + event.target.label); } private function selectCommandMenu(event:Event):void { if (event.currentTarget.parent != null) { var menuItem:NativeMenuItem = findItemForMenu(NativeMenu(event.currentTarget)); if (menuItem != null) { trace("Select event for \"" + event.target.label + "\" command handled by menu: " + menuItem.label); } } else { trace("Select event for \"" + event.target.label + "\" command handled by root menu."); } } private function findItemForMenu(menu:NativeMenu):NativeMenuItem { for each (var item:NativeMenuItem in menu.parent.items) { if (item != null) { if (item.submenu == menu) { return item; } } } return null; } } }
650
Using the system tray and dock icons (Iconos del Dock y de la bandeja del sistema, en ingls) (Flex) Using the system tray and dock icons (Iconos del dock y de la bandeja del sistema, en ingls) (Flash)
Ms temas de ayuda
flash.desktop.NativeApplication flash.desktop.DockIcon flash.desktop.SystemTrayIcon
Para cambiar la imagen del icono, asigne un conjunto con la nueva imagen o las nuevas imgenes a la propiedad bitmaps. Puede animar el icono haciendo que la imagen cambie en respuesta a un evento enterFrame o timer. Para eliminar el icono del rea de notificacin de Windows y Linux o para restaurar el aspecto predeterminado del icono en Mac OS X, establezca bitmaps como un conjunto vaco:
NativeApplication.nativeApplication.icon.bitmaps = [];
651
652
flash.display.Loader; flash.display.NativeMenu; flash.display.NativeMenuItem; flash.display.NativeWindow; flash.display.Sprite; flash.desktop.DockIcon; flash.desktop.SystemTrayIcon; flash.events.Event; flash.net.URLRequest; flash.desktop.NativeApplication;
public class SysTrayApp extends Sprite { public function SysTrayApp():void{ NativeApplication.nativeApplication.autoExit = false; var icon:Loader = new Loader(); var iconMenu:NativeMenu = new NativeMenu(); var exitCommand:NativeMenuItem = iconMenu.addItem(new NativeMenuItem("Exit"));
653
exitCommand.addEventListener(Event.SELECT, function(event:Event):void { NativeApplication.nativeApplication.icon.bitmaps = []; NativeApplication.nativeApplication.exit(); }); if (NativeApplication.supportsSystemTrayIcon) { NativeApplication.nativeApplication.autoExit = false; icon.contentLoaderInfo.addEventListener(Event.COMPLETE, iconLoadComplete); icon.load(new URLRequest("icons/AIRApp_16.png")); var systray:SystemTrayIcon = NativeApplication.nativeApplication.icon as SystemTrayIcon; systray.tooltip = "AIR application"; systray.menu = iconMenu; } if (NativeApplication.supportsDockIcon){ icon.contentLoaderInfo.addEventListener(Event.COMPLETE,iconLoadComplete); icon.load(new URLRequest("icons/AIRApp_128.png")); var dock:DockIcon = NativeApplication.nativeApplication.icon as DockIcon; dock.menu = iconMenu; } } private function iconLoadComplete(event:Event):void { NativeApplication.nativeApplication.icon.bitmaps = [event.target.content.bitmapData]; } } }
Nota: al utilizar el componente WindowedApplication de Flex, el atributo visible de la etiqueta WindowedApplication debe definirse como false. Este atributo sustituye a la configuracin en el descriptor de la aplicacin. Nota: en el ejemplo se asume que existen dos archivos de imagen llamados AIRApp_16.png y AIRApp_128.png en un subdirectorio de la aplicacin denominado icons. (El SDK de AIR contiene archivos de icono de ejemplos que puede copiar en su carpeta del proyecto.)
654
NotificationType.CRITICAL: el icono de la ventana parpadea hasta que el usuario la pone en primer plano. NotificationType.INFORMATIONAL: el icono de la ventana se resalta cambiando de color.
Nota: en Linux, slo se admite el tipo informativo de notificacin. La transmisin de cualquier valor de tipo a la funcin notifyUser() crear el mismo efecto. La siguiente sentencia resalta el botn de la barra de tareas de una ventana:
stage.nativeWindow.notifyUser(NotificationType.CRITICAL);
Si llama al mtodo NativeWindow.notifyUser() en un sistema operativo no compatible con avisos de nivel de ventana, no producir ningn efecto. Utilice la propiedad NativeWindow.supportsNotification para determinar si es compatible con la notificacin de ventanas.
Si una ventana est minimizada en el Dock de Mac OS X al establecer la propiedad visible como false, el icono del Dock no desaparece. El usuario puede seguir haciendo clic en el icono para volver a mostrar la ventana.
655
Ms temas de ayuda
flash.net.FileReference flash.net.FileReferenceList flash.filesystem.File flash.filesystem.FileStream
656
Clase FileReference
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior Cada objeto FileReference representa un nico archivo de datos del equipo. Las propiedades de la clase FileReference contienen la siguiente informacin referente al archivo: tamao, tipo, nombre, extensin, creador, fecha de creacin y fecha de modificacin. Nota: la propiedad creator slo se utiliza en Mac OS. En todas las dems plataformas se devuelve null. Nota: la propiedad extension slo se admite en Adobe AIR. Se puede crear una instancia de la clase FileReference de una de estas dos formas:
Llame al mtodo FileReferenceList.browse(), que abre un cuadro de dilogo y solicita al usuario que
seleccione uno o varios archivos para cargar. Seguidamente, crea un conjunto de objetos FileReference si el usuario selecciona correctamente uno o varios archivos. Una vez creado el objeto FileReference, puede realizar lo siguiente:
Llamar al mtodo FileReference.browse(), que abre un cuadro de dilogo y solicita al usuario que seleccione
un solo archivo del sistema de archivos locales. Esto se suele realizar antes de una llamada posterior al mtodo
FileReference.upload() o FileReference.load(). Llame al mtodo FileReference.upload() para cargar
el archivo en un servidor remoto. Llame al mtodo FileReference.load() para abrir un archivo local.
Llamada al mtodo FileReference.load(). Este mtodo comienza a cargar datos desde un archivo seleccionado
previamente mediante el mtodo browse(). No es posible llamar al mtodo load() hasta que no finaliza la operacin de browse() (el usuario selecciona un archivo).
Llamada al mtodo FileReference.save(). Este mtodo abre un cuadro de dilogo y pide al usuario que
seleccione una ubicacin de archivo nica en el sistema de archivos local. Seguidamente, guarda los datos en la ubicacin especificada. Nota: slo se puede realizar una accin browse(), download() o save() a la vez, ya que no se pueden abrir varios cuadros de dilogo de forma simultnea. Las propiedades del objeto FileReference, como name, size o modificationDate no se definen hasta que se produce una de las situaciones siguientes:
continan ejecutando el archivo SWF, incluidas la distribucin de eventos y la ejecucin del cdigo.
657
Para las operaciones de carga y descarga, un archivo SWF slo puede acceder a archivos de su propio dominio, incluidos los dominios especificados en un archivo de poltica. Es preciso colocar un archivo de poltica en el servidor que contiene el archivo si dicho servidor no se encuentra en el mismo dominio que el archivo SWF que inicia la carga o la descarga. Consulte FileReference.
Evento open (Event.OPEN): se distribuye cuando se inicia la operacin de carga. Evento progress (ProgressEvent.PROGRESS): se distribuye peridicamente a medida que se leen bytes de datos
del archivo.
Evento complete (Event.COMPLETE): se distribuye cuando la operacin de carga finaliza correctamente. Evento ioError (IOErrorEvent.IO_ERROR): se distribuye si falla el proceso de carga debido a un error de
entrada/salida durante la apertura o la lectura de los datos en el archivo. Cuando el objeto FileReference distribuye el evento complete, es posible acceder a los datos cargados como un elemento ByteArray en la propiedad data del objeto FileReference. El siguiente ejemplo muestra cmo solicitar al usuario que seleccione un archivo y cargue en la memoria los datos de dicho archivo:
658
public class FileReferenceExample1 extends Sprite { private var fileRef:FileReference; public function FileReferenceExample1() { fileRef = new FileReference(); fileRef.addEventListener(Event.SELECT, onFileSelected); fileRef.addEventListener(Event.CANCEL, onCancel); fileRef.addEventListener(IOErrorEvent.IO_ERROR, onIOError); fileRef.addEventListener(SecurityErrorEvent.SECURITY_ERROR, onSecurityError); var textTypeFilter:FileFilter = new FileFilter("Text Files (*.txt, *.rtf)", "*.txt;*.rtf"); fileRef.browse([textTypeFilter]); } public function onFileSelected(evt:Event):void { fileRef.addEventListener(ProgressEvent.PROGRESS, onProgress); fileRef.addEventListener(Event.COMPLETE, onComplete); fileRef.load(); } public function onProgress(evt:ProgressEvent):void { trace("Loaded " + evt.bytesLoaded + " of " + evt.bytesTotal + " bytes."); } public function onComplete(evt:Event):void { trace("File was successfully loaded."); trace(fileRef.data); } public function onCancel(evt:Event):void { trace("The browse request was canceled by the user."); } public function onIOError(evt:IOErrorEvent):void { trace("There was an IO Error."); } public function onSecurityError(evt:Event):void { trace("There was a security error."); } } }
659
El cdigo de ejemplo primero crea el objeto FileReference llamado fileRef y, a continuacin, llama a su mtodo browse(). El mtodo browse() abre un cuadro de dilogo que solicita al usuario que seleccione un archivo. Cuando un archivo est seleccionado, el cdigo invoca al mtodo onFileSelected(). Este mtodo aade detectores para los eventos progress y complete y, seguidamente, llama al mtodo load() del objeto FileReference. Los otros mtodos de controladores del ejemplo simplemente producen mensajes que informan sobre el progreso de la operacin de carga. Cuando finaliza la carga, la aplicacin muestra el contenido del archivo cargado mediante el mtodo trace(). En Adobe AIR, la clase FileStream proporciona una funcionalidad adicional para leer datos desde un archivo local. Consulte Lectura y escritura de archivos en la pgina 694.
Evento select (Event.SELECT): se distribuye cuando el usuario especifica la ubicacin y el nombre de archivo del
nuevo archivo que se va a guardar.
Evento cancel (Event.CANCEL): se distribuye cuando el usuario hace clic en el botn Cancelar del cuadro de
dilogo.
Evento open (Event.OPEN): se distribuye cuando se inicia la operacin de grabacin. Evento progress (ProgressEvent.PROGRESS): se distribuye peridicamente a medida que los bytes de datos se
guardan en el archivo.
Evento complete (Event.COMPLETE): se distribuye cuando la operacin de grabacin finaliza correctamente. Evento ioError (IOErrorEvent.IO_ERROR): se distribuye si el proceso de grabacin falla debido a un error de
entrada/salida al intentar guardar los datos en el archivo. El tipo de objeto transferido en el parmetro data del mtodo FileReference.save() determina el modo en el que se escriben los datos en el archivo:
Si es un valor String, se guarda como un archivo de texto con codificacin UTF-8. Si es un objeto XML, se escribe en un archivo en formato XML (conservando todo el formato). Si es un objeto Array, su contenido se escribe directamente en el archivo sin conversin alguna. Si es cualquier otro objeto, el mtodo FileReference.save() llama al mtodo toString() del objeto y guarda el
valor String resultante en un archivo de texto UTF-8. Si no se puede llamar al mtodo toString() del objeto, se emite un error. Si el valor del parmetro data es null, se genera un error.
660
El siguiente cdigo ampla el ejemplo anterior para el mtodo FileReference.load(). Una vez ledos los datos del archivo, este ejemplo solicita al usuario que especifique un nombre de archivo y, a continuacin, guarda los datos en un nuevo archivo:
package { import import import import import import
public class FileReferenceExample2 extends Sprite { private var fileRef:FileReference; public function FileReferenceExample2() { fileRef = new FileReference(); fileRef.addEventListener(Event.SELECT, onFileSelected); fileRef.addEventListener(Event.CANCEL, onCancel); fileRef.addEventListener(IOErrorEvent.IO_ERROR, onIOError); fileRef.addEventListener(SecurityErrorEvent.SECURITY_ERROR, onSecurityError); var textTypeFilter:FileFilter = new FileFilter("Text Files (*.txt, *.rtf)", "*.txt;*.rtf"); fileRef.browse([textTypeFilter]); } public function onFileSelected(evt:Event):void { fileRef.addEventListener(ProgressEvent.PROGRESS, onProgress); fileRef.addEventListener(Event.COMPLETE, onComplete); fileRef.load(); } public function onProgress(evt:ProgressEvent):void { trace("Loaded " + evt.bytesLoaded + " of " + evt.bytesTotal + " bytes."); } public function onCancel(evt:Event):void { trace("The browse request was canceled by the user."); } public function onComplete(evt:Event):void { trace("File was successfully loaded."); fileRef.removeEventListener(Event.SELECT, onFileSelected); fileRef.removeEventListener(ProgressEvent.PROGRESS, onProgress); fileRef.removeEventListener(Event.COMPLETE, onComplete); fileRef.removeEventListener(Event.CANCEL, onCancel); saveFile(); } public function saveFile():void { fileRef.addEventListener(Event.SELECT, onSaveFileSelected); fileRef.save(fileRef.data,"NewFileName.txt"); }
661
public function onSaveFileSelected(evt:Event):void { fileRef.addEventListener(ProgressEvent.PROGRESS, onSaveProgress); fileRef.addEventListener(Event.COMPLETE, onSaveComplete); fileRef.addEventListener(Event.CANCEL, onSaveCancel); } public function onSaveProgress(evt:ProgressEvent):void { trace("Saved " + evt.bytesLoaded + " of " + evt.bytesTotal + " bytes."); } public function onSaveComplete(evt:Event):void { trace("File saved."); fileRef.removeEventListener(Event.SELECT, onSaveFileSelected); fileRef.removeEventListener(ProgressEvent.PROGRESS, onSaveProgress); fileRef.removeEventListener(Event.COMPLETE, onSaveComplete); fileRef.removeEventListener(Event.CANCEL, onSaveCancel); } public function onSaveCancel(evt:Event):void { trace("The save request was canceled by the user."); } public function onIOError(evt:IOErrorEvent):void { trace("There was an IO Error."); } public function onSecurityError(evt:Event):void { trace("There was a security error."); } } }
Si todos los datos se cargan desde el archivo, el cdigo llama al mtodo onComplete(). El mtodo onComplete() elimina los detectores de los eventos de carga y seguidamente llama al mtodo saveFile(). El mtodo saveFile() llama a FileReference.save(). El mtodo FileReference.save() abre un nuevo cuadro de dilogo para que el usuario pueda indicar un nuevo nombre de archivo y ubicacin para guardarlo. Los mtodos de detectores de eventos restantes realizan el seguimiento del progreso de grabacin del archivo hasta que finaliza. En Adobe AIR, la clase FileStream proporciona funcionalidad adicional para escribir datos en un archivo local. Consulte Lectura y escritura de archivos en la pgina 694.
662
Cuando el usuario ha seleccionado los archivos y ha hecho clic en el botn Abrir en el selector de archivos del sistema, se distribuye el evento Event.SELECT. Si se ha utilizado el mtodo FileReference.browse() para seleccionar un archivo para cargarlo, es necesario utilizar el siguiente cdigo para enviar el archivo a un servidor web:
var fileRef:FileReference = new FileReference(); fileRef.addEventListener(Event.SELECT, selectHandler); fileRef.addEventListener(Event.COMPLETE, completeHandler); try { var success:Boolean = fileRef.browse(); } catch (error:Error) { trace("Unable to browse for files."); } function selectHandler(event:Event):void { var request:URLRequest = new URLRequest("http://www.[yourdomain].com/fileUploadScript.cfm") try { fileRef.upload(request); } catch (error:Error) { trace("Unable to upload file."); } } function completeHandler(event:Event):void { trace("uploaded"); }
663
Para enviar datos al servidor con el mtodo FileReference.upload(), se pueden utilizar las propiedades URLRequest.method y URLRequest.data para enviar variables con los mtodos POST o GET. Cuando se intenta cargar un archivo con el mtodo FileReference.upload(), se pueden distribuir los siguientes eventos:
Evento open (Event.OPEN): se distribuye cuando se inicia la operacin de carga. Evento progress (ProgressEvent.PROGRESS): se distribuye peridicamente a medida que se cargan los bytes de
datos del archivo.
Evento complete (Event.COMPLETE): se distribuye cuando la operacin de carga finaliza correctamente. Evento httpStatus (HTTPStatusEvent.HTTP_STATUS): se distribuye cuando el proceso de carga falla debido a un
error HTTP.
Evento ioError (IOErrorEvent.IO_ERROR): se distribuye si falla el proceso de carga por cualquiera de los
siguientes motivos:
Se produce un error de entrada/salida mientras Flash Player lee, escribe o transmite el archivo. El archivo SWF intenta cargar un archivo en un servidor que requiere autenticacin, por ejemplo, un nombre
de usuario y una contrasea. Durante la carga, Flash Player no proporciona un medio para que los usuarios introduzcan contraseas.
El parmetro url contiene un protocolo no vlido. El mtodo FileReference.upload() debe utilizar HTTP
o HTTPS. Flash Player no ofrece compatibilidad total con los servidores que requieren autenticacin. nicamente los archivos SWF que se ejecutan en un navegador y emplean el plugin de navegador o un control Microsoft ActiveX, pueden mostrar un cuadro de dilogo que indique al usuario que introduzca un nombre de usuario y una contrasea para la autenticacin y, adems, slo para descargas. La transferencia de archivos no se producir correctamente en las cargas que utilicen el plug-in o el control ActiveX, o en las cargas y descargas que utilicen el reproductor autnomo o externo. Si se crea un script de servidor en ColdFusion para aceptar una carga de archivos desde Flash Player, se puede utilizar un cdigo similar al siguiente:
<cffile action="upload" filefield="Filedata" destination="#ExpandPath('./')#" nameconflict="OVERWRITE" />
Este cdigo de ColdFusion carga el archivo enviado por Flash Player y lo guarda en el mismo directorio que la plantilla de ColdFusion, sobrescribiendo cualquier archivo con el mismo nombre. El cdigo anterior muestra la cantidad mnima de cdigo necesario para aceptar una carga de archivos; este script no debera utilizarse en un entorno de produccin. Lo ideal sera aadir validacin de datos para garantizar que los usuarios slo cargan tipos de archivos aceptados como, por ejemplo, una imagen, en lugar de un script de servidor potencialmente peligroso. El siguiente cdigo muestra cargas de archivos mediante PHP e incluye validacin de datos. El script limita en 10 el nmero de archivos cargados en el directorio de carga, garantiza que el tamao de archivo es inferior a 200 KB, y slo permite cargar y guardar archivos JPEG, GIF o PNG en el sistema de archivos.
664
<?php $MAXIMUM_FILESIZE = 1024 * 200; // 200KB $MAXIMUM_FILE_COUNT = 10; // keep maximum 10 files on server echo exif_imagetype($_FILES['Filedata']); if ($_FILES['Filedata']['size'] <= $MAXIMUM_FILESIZE) { move_uploaded_file($_FILES['Filedata']['tmp_name'], "./temporary/".$_FILES['Filedata']['name']); $type = exif_imagetype("./temporary/".$_FILES['Filedata']['name']); if ($type == 1 || $type == 2 || $type == 3) { rename("./temporary/".$_FILES['Filedata']['name'], "./images/".$_FILES['Filedata']['name']); } else { unlink("./temporary/".$_FILES['Filedata']['name']); } } $directory = opendir('./images/'); $files = array(); while ($file = readdir($directory)) { array_push($files, array('./images/'.$file, filectime('./images/'.$file))); } usort($files, sorter); if (count($files) > $MAXIMUM_FILE_COUNT) { $files_to_delete = array_splice($files, 0, count($files) - $MAXIMUM_FILE_COUNT); for ($i = 0; $i < count($files_to_delete); $i++) { unlink($files_to_delete[$i][0]); } } print_r($files); closedir($directory); function sorter($a, $b) { if ($a[1] == $b[1]) { return 0; } else { return ($a[1] < $b[1]) ? -1 : 1; } } ?>
Se pueden pasar variables adicionales al script de carga mediante el mtodo de peticin POST o GET. Para enviar variables adicionales de POST al script de carga, se puede utilizar el siguiente cdigo:
665
var fileRef:FileReference = new FileReference(); fileRef.addEventListener(Event.SELECT, selectHandler); fileRef.addEventListener(Event.COMPLETE, completeHandler); fileRef.browse(); function selectHandler(event:Event):void { var params:URLVariables = new URLVariables(); params.date = new Date(); params.ssid = "94103-1394-2345"; var request:URLRequest = new URLRequest("http://www.yourdomain.com/FileReferenceUpload/fileupload.cfm"); request.method = URLRequestMethod.POST; request.data = params; fileRef.upload(request, "Custom1"); } function completeHandler(event:Event):void { trace("uploaded"); }
El ejemplo anterior crea un objeto URLVariables que se transmite al script del servidor remoto. En versiones anteriores de ActionScript, se podan pasar variables al script de carga del servidor pasando valores en la cadena de consulta. ActionScript 3.0 permite pasar variables al script remoto con un objeto URLRequest, que permite pasar datos mediante el mtodo POST o GET que, a su vez, hace ms sencillo pasar grandes conjuntos de datos. Para especificar si las variables se pasan con el mtodo de peticin GET o POST, se puede establecer la propiedad URLRequest.method en URLRequestMethod.GET o URLRequestMethod.POST, respectivamente. ActionScript 3.0 tambin permite sustituir el nombre del campo de archivo de carga predeterminado, Filedata, proporcionando un segundo parmetro al mtodo upload(), como se muestra en el ejemplo anterior (que sustitua el valor predeterminado Filedata por Custom1). De forma predeterminada, Flash Player no intentar enviar una carga de prueba, aunque este valor predeterminado se puede omitir pasando un valor de true como tercer parmetro al mtodo upload(). El objetivo de la carga de prueba es comprobar si la carga de archivos real se realizar correctamente, as como la autenticacin del servidor, en caso de ser necesaria. Nota: actualmente, la carga de prueba slo puede realizarse en Flash Player basado en Windows. El script de servidor que gestiona la carga de archivos espera una peticin HTTP POST con los siguientes elementos:
Content-Type con un valor multipart/form-data. Content-Disposition con un atributo name establecido en "Filedata" y un atributo filename establecido en el
nombre del archivo original. Se puede especificar un atributo name personalizado pasando un valor para el parmetro uploadDataFieldName en el mtodo FileReference.upload().
666
POST /handler.asp HTTP/1.1 Accept: text/* Content-Type: multipart/form-data; boundary=----------Ij5ae0ae0KM7GI3KM7ei4cH2ei4gL6 User-Agent: Shockwave Flash Host: www.mydomain.com Content-Length: 421 Connection: Keep-Alive Cache-Control: no-cache ------------Ij5ae0ae0KM7GI3KM7ei4cH2ei4gL6 Content-Disposition: form-data; name="Filename" sushi.jpg ------------Ij5ae0ae0KM7GI3KM7ei4cH2ei4gL6 Content-Disposition: form-data; name="Filedata"; filename="sushi.jpg" Content-Type: application/octet-stream Test File ------------Ij5ae0ae0KM7GI3KM7ei4cH2ei4gL6 Content-Disposition: form-data; name="Upload" Submit Query ------------Ij5ae0ae0KM7GI3KM7ei4cH2ei4gL6 (actual file data,,,)
La siguiente peticin de ejemplo HTTP POST enva tres variables POST: api_sig, api_key y auth_token y utiliza un valor de nombre de campo de datos de carga personalizado de "photo":
667
POST /handler.asp HTTP/1.1 Accept: text/* Content-Type: multipart/form-data; boundary=----------Ij5ae0ae0KM7GI3KM7ei4cH2ei4gL6 User-Agent: Shockwave Flash Host: www.mydomain.com Content-Length: 421 Connection: Keep-Alive Cache-Control: no-cache ------------Ij5GI3GI3ei4GI3ei4KM7GI3KM7KM7 Content-Disposition: form-data; name="Filename" sushi.jpg ------------Ij5GI3GI3ei4GI3ei4KM7GI3KM7KM7 Content-Disposition: form-data; name="api_sig" XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX ------------Ij5GI3GI3ei4GI3ei4KM7GI3KM7KM7 Content-Disposition: form-data; name="api_key" XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX ------------Ij5GI3GI3ei4GI3ei4KM7GI3KM7KM7 Content-Disposition: form-data; name="auth_token" XXXXXXXXXXXXXXXXXXXXXXX ------------Ij5GI3GI3ei4GI3ei4KM7GI3KM7KM7 Content-Disposition: form-data; name="photo"; filename="sushi.jpg" Content-Type: application/octet-stream (actual file data,,,) ------------Ij5GI3GI3ei4GI3ei4KM7GI3KM7KM7 Content-Disposition: form-data; name="Upload" Submit Query ------------Ij5GI3GI3ei4GI3ei4KM7GI3KM7KM7--
Para establecer currentnews.xml como nombre predeterminado, en lugar de index.xml, es necesario especificar el parmetro defaultFileName, como se muestra en el siguiente fragmento de cdigo:
668
var request:URLRequest = new URLRequest("index.xml"); var fileToDownload:FileReference = new FileReference(); fileToDownload.download(request, "currentnews.xml");
Cambiar el nombre de un archivo puede ser muy til si el nombre de archivo del servidor no es intuitivo o ha sido generado por el servidor. Tambin se recomienda especificar de forma explcita el parmetro defaultFileName cuando se descarga un archivo mediante un script de servidor, en lugar de descargarlo directamente. Por ejemplo, es necesario especificar el parmetro defaultFileName si se dispone de un script de servidor que descarga archivos especficos en funcin de las variables de URL que se le pasan. De lo contrario, el nombre predeterminado del archivo descargado es el nombre del script de servidor. Es posible enviar datos al servidor mediante el mtodo download() aadiendo parmetros al URL, para que los analice el script de servidor. El siguiente fragmento de cdigo ActionScript 3.0 descarga un documento en funcin de los parmetros pasados a un script de ColdFusion:
package { import import import import import
public class DownloadFileExample extends Sprite { private var fileToDownload:FileReference; public function DownloadFileExample() { var request:URLRequest = new URLRequest(); request.url = "http://www.[yourdomain].com/downloadfile.cfm"; request.method = URLRequestMethod.GET; request.data = new URLVariables("id=2"); fileToDownload = new FileReference(); try { fileToDownload.download(request, "file2.txt"); } catch (error:Error) { trace("Unable to download file."); } } } }
El siguiente cdigo muestra el script ColdFusion, download.cfm, que descarga uno de los dos archivos del servidor, dependiendo del valor de una variable de URL:
<cfparam name="URL.id" default="1" /> <cfswitch expression="#URL.id#"> <cfcase value="2"> <cfcontent type="text/plain" file="#ExpandPath('two.txt')#" deletefile="No" /> </cfcase> <cfdefaultcase> <cfcontent type="text/plain" file="#ExpandPath('one.txt')#" deletefile="No" /> </cfdefaultcase> </cfswitch>
669
Clase FileReferenceList
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior La clase FileReferenceList permite al usuario seleccionar uno o varios archivos para cargarlos en un script de servidor. La carga de archivos se controla mediante el mtodo FileReference.upload(), al que es necesario llamar en cada archivo que selecciona el usuario. El siguiente cdigo crea dos objetos FileFilter (imageFilter y textFilter) y los pasa en un conjunto al mtodo FileReferenceList.browse(). Como consecuencia, el cuadro de dilogo del archivo del sistema operativo muestra dos filtros de tipos de archivo posibles.
var imageFilter:FileFilter = new FileFilter("Image Files (*.jpg, *.jpeg, *.gif, *.png)", "*.jpg; *.jpeg; *.gif; *.png"); var textFilter:FileFilter = new FileFilter("Text Files (*.txt, *.rtf)", "*.txt; *.rtf"); var fileRefList:FileReferenceList = new FileReferenceList(); try { var success:Boolean = fileRefList.browse(new Array(imageFilter, textFilter)); } catch (error:Error) { trace("Unable to browse for files."); }
Permitir al usuario seleccionar y cargar uno o varios archivos mediante la clase FileReferenceList equivale a utilizar FileReference.browse() para seleccionar archivos, aunque FileReferenceList permite seleccionar ms de un archivo. Para cargar varios archivos es necesario actualizar cada uno de los archivos seleccionados mediante FileReference.upload(), como se muestra en el siguiente cdigo:
670
var fileRefList:FileReferenceList = new FileReferenceList(); fileRefList.addEventListener(Event.SELECT, selectHandler); fileRefList.browse(); function selectHandler(event:Event):void { var request:URLRequest = new URLRequest("http://www.[yourdomain].com/fileUploadScript.cfm"); var file:FileReference; var files:FileReferenceList = FileReferenceList(event.target); var selectedFileArray:Array = files.fileList; for (var i:uint = 0; i < selectedFileArray.length; i++) { file = FileReference(selectedFileArray[i]); file.addEventListener(Event.COMPLETE, completeHandler); try { file.upload(request); } catch (error:Error) { trace("Unable to upload files."); } } } function completeHandler(event:Event):void { trace("uploaded"); }
Dado que el evento Event.COMPLETE se aade a cada objeto FileReference individual del conjunto, Flash Player llama al mtodo completeHandler() cuando finaliza la carga de cada uno de los archivos.
Copiar, crear, eliminar y mover archivos y directorios. Obtener informacin sobre archivos y directorios. Leer y escribir archivos.
671
Building a text-file editor (Creacin de un editor de archivos de texto, en ingls) (Flash) Building a text-file editor (Creacin de un editor de archivos de texto, en ingls) (Flex) Building a directory search application (Creacin de una aplicacin de bsqueda de directorios, en ingls) (Flex) Reading and writing from an XML preferences file (Lectura y escritura desde un archivo XML de preferencias, en
ingls) (Flex)
FileMode
FileStream
Algunos mtodos de la clase File tienen versiones tanto sincrnicas como asncronas:
File.copyTo() y File.copyToAsync() File.deleteDirectory() y File.deleteDirectoryAsync() File.deleteFile() y File.deleteFileAsync() File.getDirectoryListing() y File.getDirectoryListingAsync() File.moveTo() y File.moveToAsync() File.moveToTrash() y File.moveToTrashAsync()
Adems, las opciones de FileStream funcionan de modo sincrnico o asncrono, dependiendo de cmo abre el archivo el objeto FileStream: si llama al mtodo open() o llama al mtodo openAsync(). Las versiones asncronas permiten iniciar procesos que se ejecutan en segundo plano y distribuyen eventos cuando se han finalizado (o cuando se produce un evento de error). Puede ejecutarse otro tipo de cdigo mientras tienen lugar estos procesos asncronos en segundo plano. Con las versiones asncronas de las operaciones, hay que configurar las funciones de deteccin de eventos empleando el mtodo addEventListener() del objeto File o FileStream que llama a la funcin. Las versiones sincrnicas permiten escribir cdigo ms sencillo que no depende de la configuracin de funciones de deteccin de eventos. Sin embargo, dado que no puede ejecutarse otro cdigo mientras se ejecuta el mtodo sincrnico, pueden retrasar procesos importantes como la animacin o la representacin de objetos de visualizacin.
672
Clase File
Adobe AIR 1.0 y posterior La clase File se emplea para lo siguiente:
obtener la ruta a directorios especiales, entre ellos el directorio del usuario, el directorio de documentos del usuario,
el directorio desde el cual se inici la aplicacin, y el directorio de la aplicacin;
copiar archivos y directorios; mover archivos y directorios; eliminar archivos y directorios (o pasarlos a la papelera); enumerar los archivos y directorios que contiene un directorio; crear archivos y directorios temporales.
Una vez que un objeto File apunta a una ruta de archivo, se puede utilizar para leer y escribir datos de archivo usando la clase FileStream. Un objeto File puede apuntar a la ruta de un archivo o directorio que an no existe. Puede utilizarse un objeto File de este tipo al crear un archivo o directorio.
Descripcin Especifica la ruta a un archivo en una plataforma determinada. Por ejemplo, una ruta en Windows podra ser "c:\Directorio de muestras\test.txt" mientras que en Mac OS sera "/Directorio de muestras/test.txt". En Windows, una propiedad nativePath utiliza la barra diagonal inversa (\) como carcter separador de directorios, mientras que en Mac OS y Linux utilizan la barra diagonal (/). Esto puede utilizar el esquema de URL de archivo para apuntar a un archivo. Por ejemplo, una ruta en Windows podra ser "file:///c:/Directorio%20de%20muestras/test.txt" mientras que en Mac OS sera "file:///Directorio%20de%20muestras/test.txt". El motor de ejecucin incluye otros esquemas de URL especiales adems de file que se describen en Esquemas de URL compatibles de AIR en la pgina 681.
url
673
La clase File incluye propiedades estticas para sealar a directorios estndar tanto en Mac OS, Windows y Linux. Entre estas propiedades se incluyen:
instalada.. Este directorio es un lugar adecuado para almacenar preferencias de usuario y recursos de la aplicacin dinmicos. Considere en almacenamiento de grandes cantidades de datos en otro lugar. En Android e iOS, el directorio de almacenamiento de la aplicacin se elimina cuando la aplicacin se desinstala o el usuario opta por borrar los datos de la aplicacin, pero este no es el caso en otras plataformas.
File.applicationDirectory; directorio donde se instala la aplicacin (junto con cualquier activo instalado). En algunos sistemas operativos, la aplicacin se almacena en un slo archivo de paquete en lugar de en un directorio fsico. En este caso, es posible que no se pueda acceder al contenido utilizando la ruta nativa. El directorio de la aplicacin es de slo lectura. File.desktopDirectory: directorio del escritorio del usuario. Si una plataforma no define un directorio de
otra ubicacin del sistema de archivos. Nota: si una plataforma no define ubicaciones estndar para los directorios de usuario, documentos o escritorio, File.documentsDirectory, File.desktopDirectory y File.userDirectory pueden hacer referencia al mismo directorio. Estas propiedades tienen valores diferentes en los distintos sistemas operativos. Por ejemplo, Mac y Windows cuentan con rutas nativas distintas en el directorio del escritorio del usuario. Sin embargo, la propiedad File.desktopDirectory seala a una ruta de directorio adecuada en todas las plataformas. Para escribir aplicaciones que funcionen bien en distintas plataformas, utilice estas propiedades como base para hacer referencia a otros directorios y archivos utilizados por la aplicacin. Utilice el mtodo resolvePath() para mejorar la ruta. Por ejemplo, el siguiente cdigo seala al archivo preferences.xml en el directorio de almacenamiento de la aplicacin:
var prefsFile:File = File.applicationStorageDirectory; prefsFile = prefsFile.resolvePath("preferences.xml");
Aunque la clase File permite sealar a una ruta de archivo especfica, esto puede implicar que las aplicaciones no funcionen en distintas plataformas. Por ejemplo, la ruta C:\Documents and Settings\joe\ slo funciona en Windows. Por estos motivos, es mejor utilizar las propiedades estticas de la clase File como, por ejemplo, File.documentsDirectory.
674
no accesible no accesible
/private/var/mobile/Applications/uid/tmp/FlashTmpNNN
no accesible
/opt/filename/share /home/userName/.appdata/applicationID/Local Store
/Users/userName/Desktop /Users/userName/Documents /private/var/folders/JY/randomString/TemporaryItems/FlashTmp /Users/userName C:\Program Files\filename C:\Documents and settings\userName\ApplicationData\applicationID\Local Store C:\Documents and settings\userName\Desktop C:\Documents and settings\userName\My Documents C:\Documents and settings\userName\Local Settings\Temp\randomString.tmp C:\Documents and settings\userName
Usuario
675
Las rutas nativas reales para estos directorios varan en funcin del sistema operativo y la configuracin del equipo. Las rutas que se muestran en esta tabla representan ejemplos tpicos. Siempre se deben utilizar las propiedades estticas adecuadas de la clase File para hacer referencia a estos directorios de forma que la aplicacin funcione correctamente en cualquier plataforma. En una aplicacin real de AIR, los valores para applicationID y filename mostrados en la tabla proceden del descriptor de la aplicacin. Si se especifica un ID de editor en el descriptor de la aplicacin, este ID se aade al ID de la aplicacin en estas rutas. El valor de userName es el nombre de la cuenta del usuario que realiza la instalacin.
Si una aplicacin intenta acceder a un directorio prohibido, el motor de ejecucin emite una excepcin que el cdigo de ActionScript puede detectar. En la siguiente tabla se muestra el valor File.nativePath para distintos mtodos y propiedades File. Los valores reflejan la vista limitada de la aplicacin del sistema de archivos del dispositivo.
Mtodo o propiedad File Valor
File.nativePat h applicationDirectory applicationStorageDirectory /app/ /app-storage/
Informacin de asignacin
Se asigna a un directorio especfico de la aplicacin. Se asigna a un directorio especfico de la aplicacin en un directorio especfico de usuario. Se asigna a un directorio especfico de la aplicacin en un directorio especfico de usuario. El mismo directorio que userDirectory y documentsDirectory. Se asigna a un directorio especfico de la aplicacin en un directorio especfico de usuario. El mismo directorio que desktopDirectory y documentsDirectory. Se asigna a un directorio especfico de la aplicacin en un directorio especfico de usuario. El mismo directorio que userDirectory y desktopDirectory. Se asigna a un directorio temporal. AIR para TV elimina este directorio y su contenido si existe la aplicacin de AIR.
desktopDirectory
/home/
userDirectory
/home/
documentsDirectory
/home/
createTempDirectory()
/tmp/
676
Tambin se debe tener en cuenta el comportamiento de los siguientes mtodos en los dispositivos de AIR para TV:
File.createTempFile() crea un archivo en el directorio /tmp/. File.getRootDirectories() devuelve un conjunto con un objeto File. La propiedad nativePath del objeto File
cuenta con el valor /. Este directorio raz contiene los directorios app, app-storage, home y tmp.
StorageVolumeInfo.storageVolumeInfo.getStorageVolumes() devuelve un vector de objetos StorageVolume. Todas las propiedades rootDirectory del objeto StorageVolume es un objeto File. El valor nativePath del objeto File comienza con /volumes/. Todas las aplicaciones y usuarios tienen acceso al directorio /volumes/.
Apuntar al directorio de documentos del usuario Adobe AIR 1.0 y posterior Un objeto File puede apuntar al directorio de documentos del usuario. El siguiente cdigo configura un objeto File para que apunte a un subdirectorio AIR Test del directorio de documentos:
var file:File = File.documentsDirectory.resolvePath("AIR Test");
Apuntar al directorio del escritorio Adobe AIR 1.0 y posterior Un objeto File puede apuntar al escritorio. El siguiente cdigo configura un objeto File para que apunte a un subdirectorio AIR Test del escritorio:
var file:File = File.desktopDirectory.resolvePath("AIR Test");
Apuntar al directorio de almacenamiento de la aplicacin Adobe AIR 1.0 y posterior Un objeto File puede apuntar al directorio de almacenamiento de la aplicacin. Para cada aplicacin de AIR hay una ruta asociada exclusiva que define el directorio de almacenamiento de la aplicacin. Este directorio es exclusivo para cada aplicacin y usuario. Se puede utilizar este directorio para guardar datos que son especficos del usuario y la aplicacin (como los archivos de datos de usuario o de preferencias). Por ejemplo, el siguiente cdigo configura un objeto File para que apunte a un archivo de preferencias, prefs.xml, que se encuentra en el directorio de almacenamiento de la aplicacin:
var file:File = File.applicationStorageDirectory; file = file.resolvePath("prefs.xml");
677
La ubicacin del directorio de almacenamiento de la aplicacin se suele basar en el nombre de usuario y el ID de la aplicacin. Las siguientes ubicaciones del sistema de archivos se incluyen aqu para ayudar a depurar la aplicacin. Siempre se debe usar la propiedad File.applicationStorage o app-storage: esquema de URI para resolver archivos en este directorio:
Por ejemplo:
/Users/babbage/Library/Preferences/com.example.TestApp/Local Store
En LinuxEn:
/home/nombre de usuario/.appdata/applicationID/Local Store/
Por ejemplo:
/home/babbage/.appdata/com.example.TestApp/Local Store
En Androiden:
/data/data/androidPackageID/applicationID/Local Store Por ejemplo:
/data/data/air.com.example.TestApp/com.example.TestApp/Local Store
En dispositivos de AIR para TV, la ubicacin se describe en Vista del directorio para aplicaciones de AIR para TV
en la pgina 675. Nota: si una aplicacin dispone de ID de edicin, ste tambin se utiliza como parte de la ruta al directorio de almacenamiento de la aplicacin. La URL (y la propiedad url) para un objeto File creado con File.applicationStorageDirectory utiliza el esquema de URL app-storage (consulte Esquemas de URL compatibles de AIR en la pgina 681), como en el ejemplo siguiente:
var dir:File = File.applicationStorageDirectory; dir = dir.resolvePath("preferences"); trace(dir.url); // app-storage:/preferences
Apuntar al directorio de la aplicacin Adobe AIR 1.0 y posterior Un objeto File puede apuntar al directorio en el que se instal la aplicacin, al que se describe como directorio de la aplicacin. Para ello se utiliza propiedad File.applicationDirectory. Este directorio puede utilizarse para examinar el archivo descriptor de la aplicacin u otros recursos que haya instalados con la aplicacin. Por ejemplo, el siguiente cdigo configura un objeto File para que apunte a un directorio llamado images que se encuentra en el directorio de la aplicacin:
var dir:File = File.applicationDirectory; dir = dir.resolvePath("images");
678
La URL (y la propiedad url) para un objeto File creado con File.applicationDirectory utiliza el esquema de URL app-storage (consulte Esquemas de URL compatibles de AIR en la pgina 681), como en el ejemplo siguiente:
var dir:File = File.applicationDirectory; dir = dir.resolvePath("images"); trace(dir.url); // app:/images
Nota: en Android, no se puede acceder a los archivos del paquete de la aplicacin a travs de nativePath. La propiedad nativePath es una cadena vaca. Utilice siempre la direccin URL para acceder a los archivos en el directorio de la aplicacin en lugar de una ruta nativa. Apuntar a la raz del sistema de archivos Adobe AIR 1.0 y posterior El mtodo File.getRootDirectories() enumera todos los volmenes raz -como C: y los volmenes montados- de un ordenador con Windows. En Mac OS y Linux, este mtodo siempre produce como resultado el directorio raz exclusivo del ordenador (el directorio "/"). El mtodo StorageVolumeInfo.getStorageVolumes() proporciona ms informacin detallada sobre los volmenes de almacenamiento montados (consulte Trabajo con volmenes de almacenamiento en la pgina 692). Nota: la raz del sistema de archivos no se puede leer en Android. Se devuelve un objeto File que hace referencia al directorio con la ruta nativa, /, pero las propiedades de ese objeto no tienen valores precisos. Por ejemplo, spaceAvailable siempre es 0. Apuntar a un directorio explcito Adobe AIR 1.0 y posterior Para que un objeto File apunte a un directorio explcito, se configura la propiedad nativePath del objeto File, como en el ejemplo siguiente (en Windows):
var file:File = new File(); file.nativePath = "C:\\AIR Test";
Importante: sealar a una ruta explcita de este modo puede implicar que el cdigo no funcione en distintas plataformas. Por ejemplo, el ejemplo anterior slo funciona en Windows. Se pueden utilizar las propiedades estticas del objeto File como, por ejemplo, File.applicationStorageDirectory, para localizar un directorio que funcione en varias plataformas. Utilice el mtodo resolvePath() (consulte la seccin siguiente) para buscar una ruta relativa. Desplazarse a rutas relativas Adobe AIR 1.0 y posterior El mtodo resolvePath() sirve para obtener una ruta relativa a otra ruta determinada. En el ejemplo siguiente, el cdigo configura un objeto File para que apunte a un subdirectorio "AIR Test" del directorio de inicio del usuario:
var file:File = File.userDirectory; file = file.resolvePath("AIR Test");
Tambin se puede utilizar la propiedad url de un objeto File para que apunte a un directorio con base en una cadena URL, como en el ejemplo siguiente:
var urlStr:String = "file:///C:/AIR Test/"; var file:File = new File() file.url = urlStr;
679
Dejar que el usuario utilice la funcin Examinar para seleccionar un directorio Adobe AIR 1.0 y posterior La clase File incluye el mtodo browseForDirectory(), que presenta un cuadro de dilogo del sistema que permite al usuario seleccionar un directorio para asignarlo al objeto. El mtodo browseForDirectory() es asncrono. El objeto File distribuye un evento select si el usuario selecciona un directorio y hace clic en el botn Abrir, o distribuye un evento cancel si el usuario hace clic en el botn Cancelar. Por ejemplo, con el siguiente cdigo el usuario puede seleccionar un directorio y se produce una ruta a ese directorio al seleccionarlo:
var file:File = new File(); file.addEventListener(Event.SELECT, dirSelected); file.browseForDirectory("Select a directory"); function dirSelected(e:Event):void { trace(file.nativePath); }
Nota: en Android, no se admite el mtodo browseForDirectory(). La llamada a este mtodo no tiene efecto; un evento cancel se distribuye de forma inmediata. Para que los usuarios puedan seleccionar un directorio, utilice un cuadro de dilogo personalizado y definido por la aplicacin. Apuntar al directorio desde el que se invoc la aplicacin Adobe AIR 1.0 y posterior La ubicacin del directorio desde el cual se invoca una aplicacin puede obtenerse comprobando la propiedad
currentDirectory del objeto InvokeEvent que se distribuye al invocar la aplicacin. Para obtener ms informacin,
Tambin se puede pasar la URL a la funcin constructora File(), como en el ejemplo siguiente:
680
La propiedad url siempre produce la versin codificada en formato URI de la URL (por ejemplo, los espacios en blanco se sustituyen con "%20"):
file.url = "file:///c:/AIR Test"; trace(file.url); // file:///c:/AIR%20Test
Se puede utilizar tambin la propiedad nativePath de un objeto File para definir una ruta explcita. Por ejemplo, cuando se ejecuta en un ordenador con Windows, el cdigo que aparece a continuacin configura un objeto File para que apunte al archivo test.txt en el subdirectorio AIR Test de la unidad C:.
var file:File = new File(); file.nativePath = "C:/AIR Test/test.txt";
Tambin se puede pasar esta ruta a la funcin constructora File(), como en el ejemplo siguiente:
var file:File = new File("C:/AIR Test/test.txt");
Utilice el carcter de barra diagonal (/) como delimitador para la propiedad nativePath. En Windows, tambin puede utilizar el carcter de barra diagonal inversa (\), pero esto implica que las aplicaciones no funcionen en distintas plataformas. Para ver ms informacin, consulte Modificacin de rutas de archivos en la pgina 681. Enumeracin de los archivos de un directorio Adobe AIR 1.0 y posterior El mtodo getDirectoryListing() de un objeto File sirve para obtener un conjunto de objetos File que apuntan a archivos y subdirectorios en el nivel raz de un directorio. Para obtener ms informacin, consulte Enumeracin de directorios en la pgina 687. Dejar que el usuario utilice la funcin Examinar para seleccionar un archivo Adobe AIR 1.0 y posterior La clase File incluye los siguientes mtodos que presentan un cuadro de dilogo del sistema que permite al usuario seleccionar un archivo para asignarlo al objeto:
Todos estos mtodos son asncronos. Los mtodos browseForOpen() y browseForSave() distribuyen el evento "select" cuando el usuario selecciona un archivo (o una ruta de destino, en el caso de browseForSave()). Con los mtodos browseForOpen() y browseForSave(), al seleccionarlo el objeto File de destino apunta a los archivos seleccionados. El mtodo browseForOpenMultiple() distribuye un evento selectMultiple cuando el usuario selecciona varios archivos. El evento selectMultiple es del tipo FileListEvent, el cual tiene una propiedad files que es un conjunto de objetos File (que apuntan a los archivos seleccionados). Por ejemplo, el siguiente cdigo presenta al usuario un cuadro de dilogo Abrir que le permite seleccionar un archivo:
681
var fileToOpen:File = File.documentsDirectory; selectTextFile(fileToOpen); function selectTextFile(root:File):void { var txtFilter:FileFilter = new FileFilter("Text", "*.as;*.css;*.html;*.txt;*.xml"); root.browseForOpen("Open", [txtFilter]); root.addEventListener(Event.SELECT, fileSelected); } function fileSelected(event:Event):void { trace(fileToOpen.nativePath); }
Si en la aplicacin ya estaba abierto otro cuadro de dilogo con la funcin examinar cuando se llama a un mtodo de examinar, el motor de ejecucin emite una excepcin de Error. Nota: en Android, slo se pueden seleccionar los archivos de audio, vdeo e imagen con los mtodos browseForOpen() y browseForOpenMultiple(). El cuadro de dilogo browseForSave() tambin muestra nicamente los archivos de medios aunque el usuario pueda introducir un nombre de archivo arbitrario. Para abrir y guardar los archivos que no son de medios, se debe tener en cuenta el uso de cuadros de dilogo personalizados en lugar de estos mtodos.
Al usar la propiedad nativePath, utilice el carcter de barra diagonal (/) como carcter separador de directorios. En Windows, tambin se puede emplear el carcter de barra diagonal inversa (\), pero no es recomendable, ya que implica que el cdigo no funcione en distintas plataformas.
682
Descripcin Se utiliza para especificar una ruta relativa a la raz del sistema de archivos. Por ejemplo:
file:///c:/AIR Test/test.txt
La norma para URL especifica que la URL tipo "file" debe tener el formato file://<host>/<ruta>. Como caso especial, <host> puede ser la cadena vaca, que se interpreta como "la mquina desde la cual se interpreta la URL". Esta es la razn por la cual las URL del tipo "file" a menudo tienen tres barras diagonales (///). app Se utiliza para especificar una ruta relativa al directorio raz de la aplicacin instalada (el directorio que contiene el archivo aplicacion.xml para la aplicacin instalada). Por ejemplo, la ruta siguiente apunta a un subdirectorio de imgenes del directorio de la aplicacin instalada:
app:/images
app-storage
Se utiliza para especificar una ruta relativa al directorio de almacenamiento de la aplicacin. AIR define un directorio de almacenamiento exclusivo para cada una de las aplicaciones instaladas, lo cual proporciona un lugar til para guardar datos que son especficos para esa aplicacin. Por ejemplo, la siguiente ruta apunta al archivo "prefs.xml" en el subdirectorio "settings" del directorio de almacenamiento de la aplicacin:
app-storage:/settings/prefs.xml
El segundo parmetro del mtodo getRelativePath(), el parmetro useDotDot, permite que se incluya la sintaxis .. en los resultados para indicar directorios superiores:
var file1:File = File.documentsDirectory; file1 = file1.resolvePath("AIR Test"); var file2:File = File.documentsDirectory; file2 = file2.resolvePath("AIR Test/bob/test.txt"); var file3:File = File.documentsDirectory; file3 = file3.resolvePath("AIR Test/susan/test.txt"); trace(file2.getRelativePath(file1, true)); // ../.. trace(file3.getRelativePath(file2, true)); // ../../bob/test.txt
683
No obstante, los documentos y nombres de directorio s incluyen maysculas. En los siguientes ejemplos se da por sentado que existe una carpeta llamada AIR Test en el directorio de documentos:
var file:File = File.documentsDirectory.resolvePath("AIR test"); trace(file.nativePath); // ... AIR test file.canonicalize(); trace(file.nativePath); // ... AIR Test
El mtodo canonicalize() convierte el objeto nativePath para que figuren correctamente las maysculas en el nombre del archivo o directorio. En los sistemas de archivos que distinguen entre maysculas y minsculas (como Linux), cuando existen varios archivos con nombres que difieren nicamente en las maysculas y minsculas, el mtodo canonicalize() ajusta la ruta para que coincida con el primer archivo encontrado (en un orden que determina el sistema de archivos). El mtodo canonicalize() tambin sirve para convertir nombres de archivo cortos (nombres "8.3") en nombres de archivo largos en Windows, como en los ejemplos siguientes:
var path:File = new File(); path.nativePath = "C:\\AIR~1"; path.canonicalize(); trace(path.nativePath); // C:\AIR Test
684
El cdigo siguiente itera a travs del directorio del escritorio del usuario, enumerando los archivos y directorios que no son vnculos simblicos:
var desktopNodes:Array = File.desktopDirectory.getDirectoryListing(); for (var i:uint = 0; i < desktopNodes.length; i++) { if (!desktopNodes[i].isSymbolicLink) { trace(desktopNodes[i].name); } }
El mtodo canonicalize() modifica la ruta de un vnculo simblico para apuntar al archivo o directorio al que se refiere el vnculo. El cdigo siguiente itera a travs del directorio del escritorio del usuario y notifica las rutas referenciadas por archivos que son vnculos simblicos:
var desktopNodes:Array = File.desktopDirectory.getDirectoryListing(); for (var i:uint = 0; i < desktopNodes.length; i++) { if (desktopNodes[i].isSymbolicLink) { var linkNode:File = desktopNodes[i] as File; linkNode.canonicalize(); trace(linkNode.nativePath); } }
Si el objeto File remite a un directorio, la propiedad spaceAvailable indica el espacio en el directorio que utilizan los archivos. Si el objeto File remite a un archivo, la propiedad spaceAvailable indica el espacio en el que podra ampliarse el archivo. Si no existe la ubicacin de archivo, la propiedad spaceAvailable se define en 0. Si el objeto File remite a un vnculo simblico, la propiedad spaceAvailable se define en el espacio disponible en el lugar al que apunta el vnculo simblico. El espacio disponible para un directorio o archivo suele ser el mismo que el que est disponible en el volumen que contiene el directorio o el archivo. No obstante, el espacio disponible puede ajustarse teniendo en cuenta los cupos y lmites por directorio. Para aadir un archivo o directorio a un volumen se suele necesitar ms espacio que el tamao mismo del archivo o del contenido del directorio. Por ejemplo, el sistema operativo puede necesitar ms espacio para guardar la informacin del ndice. O los sectores del disco que se requieren pueden usar espacio adicional. Adems, el espacio que hay disponible cambia constantemente. Por todo ello es que no se puede asignar todo el espacio notificado a guardar los archivos. Para ver ms informacin sobre la escritura en el sistema de archivos, consulte Lectura y escritura de archivos en la pgina 694. El mtodo StorageVolumeInfo.getStorageVolumes() proporciona ms informacin detallada sobre los volmenes de almacenamiento montados (consulte Trabajo con volmenes de almacenamiento en la pgina 692).
685
Nota: en Linux, el tipo MIME del archivo (no la extensin del nombre de archivo) determina la aplicacin predeterminada para un archivo. El siguiente cdigo permite al usuario buscar un archivo mp3 y abrirlo en la aplicacin predeterminada para reproducir archivos mp3:
var file:File = File.documentsDirectory; var mp3Filter:FileFilter = new FileFilter("MP3 Files", "*.mp3"); file.browseForOpen("Open", [mp3Filter]); file.addEventListener(Event.SELECT, fileSelected); function fileSelected(e:Event):void { file.openWithDefaultApplication(); }
El mtodo openWithDefaultApplication() no se puede utilizar con archivos ubicados en el directorio de la aplicacin. AIR impide el uso del mtodo openWithDefaultApplication() para abrir determinados archivos. En Windows, AIR impide la apertura de archivos de determinados tipos como, por ejemplo, EXE o BAT. En Mac OS y en Linux, AIR impide abrir archivos que inician una aplicacin especfica. (Estos incluyen Terminal y AppletLauncher en Mac OS; y csh, bash o ruby en Linux.) Si se intenta abrir uno de estos archivos con el mtodo openWithDefaultApplication(), se generar una excepcin. Para obtener una lista de los tipos de archivo con limitaciones, consulte la entrada de la referencia del lenguaje del mtodo File.openWithDefaultApplication(). Nota: esta restriccin no existe en una aplicacin de AIR instalada con un programa de instalacin nativo (una aplicacin de escritorio ampliada).
686
Propiedad
File.lineEnding
Descripcin La secuencia de caracteres de final de lnea que utiliza el sistema operativo del ordenador host. En Mac OS y Linux es el carcter de salto de lnea. En Windows es el carcter de retorno de carro seguido del carcter de salto de lnea. El carcter separador de componentes de rutas en el sistema operativo del ordenador host. En Mac OS y Linux es el carcter de barra diagonal (/). En Windows es el carcter de barra diagonal inversa (\). El cdigo predeterminado que utiliza para los archivos el sistema operativo del ordenador host. Esto corresponde al lenguaje del juego de caracteres que utiliza el sistema operativo.
File.separator
File.systemCharset
La clase Capabilities incluye tambin informacin del sistema que puede resultar de utilidad al trabajar con archivos:
Propiedad Capabilities.hasIME Descripcin Especifica si el reproductor se ejecuta en un sistema que tiene (true) o no tiene (false) un editor de mtodo de entrada (IME) instalado. Especifica el cdigo de idioma del sistema en el que se est ejecutando el reproductor. Especifica el sistema operativo actual.
Capabilities.language Capabilities.os
Nota: tenga cuidado al utilizar Capabilities.os para determinar caractersticas del sistema. Si existe una propiedad ms especfica para determinar una caracterstica del sistema, utilcela. De lo contrario, corre el riesgo de escribir cdigo que no funcione correctamente en todas las plataformas. Por ejemplo, considrese el fragmento de cdigo siguiente:
var separator:String; if (Capablities.os.indexOf("Mac") > -1) { separator = "/"; } else { separator = "\\"; }
Este cdigo implica problemas en Linux. Es mejor utilizar simplemente la propiedad File.separator.
Creacin de directorios
Adobe AIR 1.0 y posterior El mtodo File.createDirectory() sirve para crear un directorio. En el ejemplo siguiente, el cdigo crea un directorio llamado "AIR Test" como subdirectorio del directorio de inicio del usuario:
var dir:File = File.userDirectory.resolvePath("AIR Test"); dir.createDirectory();
687
Si el directorio ya existe, el mtodo createDirectory() no hace nada. Adems, en algunos modos un objeto FileStream crea un directorio cuando se abre un archivo. Se crean directorios inexistentes cuando se concreta una instancia de FileStream con el parmetro fileMode del constructor FileStream() definido en FileMode.APPEND o FileMode.WRITE. Para ver ms informacin, consulte Flujo de trabajo de lectura y escritura de archivos en la pgina 694.
El mtodo createTempDirectory() crea automticamente un directorio temporal exclusivo (ahorrndole el trabajo de determinar un nuevo lugar exclusivo). Se puede utilizar un directorio temporal para guardar de forma provisional los archivos temporales que se utilizan para una sesin de la aplicacin. Cabe observar que existe un mtodo createTempFile() para crear nuevos archivos temporales exclusivos en el directorio temporal del sistema. Puede que desee eliminar el directorio temporal antes de cerrar la aplicacin, dado que no se elimina de forma automtica en todos los dispositivos.
Enumeracin de directorios
Adobe AIR 1.0 y posterior El mtodo getDirectoryListing() o el mtodo getDirectoryListingAsync() de un objeto File sirve para obtener un conjunto de objetos File que apuntan a archivos y subdirectorios de un directorio. Por ejemplo, el siguiente cdigo enumera el contenido del directorio de documentos del usuario (sin examinar los subdirectorios):
var directory:File = File.documentsDirectory; var contents:Array = directory.getDirectoryListing(); for (var i:uint = 0; i < contents.length; i++) { trace(contents[i].name, contents[i].size); }
Al utilizar la versin asncrona del mtodo, el objeto de evento directoryListing tiene una propiedad files que es el conjunto de objetos File que corresponden a los directorios:
688
var directory:File = File.documentsDirectory; directory.getDirectoryListingAsync(); directory.addEventListener(FileListEvent.DIRECTORY_LISTING, dirListHandler); function dirListHandler(event:FileListEvent):void { var contents:Array = event.files; for (var i:uint = 0; i < contents.length; i++) { trace(contents[i].name, contents[i].size); } }
Si se especifica "true" para el parmetro overwrite del mtodo copyTo(), se eliminan todos los archivos y las carpetas de un directorio de destino existente, sustituyndose por los archivos y carpetas del directorio de origen (aunque el archivo de destino no exista en el directorio de origen). El directorio que se especifique como parmetro newLocation del mtodo copyTo() especifica la ruta al directorio resultante; no especifica el directorio superior que contendr el directorio resultante. Para obtener ms informacin, consulte Copia y movimiento de directorios en la pgina 690.
El cdigo siguiente elimina de modo asncrono el subdirectorio AIR Test del directorio de documentos del usuario:
689
var directory:File = File.documentsDirectory.resolvePath("AIR Test"); directory.addEventListener(Event.COMPLETE, completeHandler) directory.deleteDirectoryAsync(true); function completeHandler(event:Event):void { trace("Deleted.") }
Tambin se incluyen los mtodos moveToTrash() y moveToTrashAsync(), que sirven para trasladar un directorio a la papelera del sistema. Para obtener ms informacin, consulte Traslado de archivos a la papelera en la pgina 691.
downloaded
exists extension
Windows XP Service Pack 2 y posterior, y en Windows Vista Mac OS 10.5 y versiones posteriores
Si existe o no el archivo o directorio al que se remite. La extensin del archivo, que es la parte del nombre despus del punto final ("."), sin incluir este. Si el nombre de archivo no contiene un punto, la extensin es null. Un objeto Icon que contiene los iconos definidos para el archivo. Si el objeto File remite o no a un directorio. La fecha de la ltima modificacin del archivo o directorio del disco local. El nombre del archivo o directorio (incluida la extensin, si la hay) en el disco duro, El trayecto completo en la representacin del sistema operativo del ordenador host. Consulte Rutas a objetos File en la pgina 672.
690
Descripcin La carpeta que contiene la carpeta o el archivo que representa el objeto File. Esta propiedad es null si el objeto File remite a un archivo o directorio que se encuentra en la raz del sistema de archivos. El tamao del archivo en el disco local, expresado en bytes. Obsoleto: utilice la propiedad extension. (En un ordenador Macintosh esta propiedad es el tipo de archivo de cuatro caracteres, que slo se utiliza en las versiones de Mac OS anteriores a Mac OS X). La URL del archivo o directorio. Consulte Rutas a objetos File en la pgina 672.
size type
url
Para obtener ms informacin sobre estas propiedades, consulte la entrada de la clase File en Referencia de ActionScript 3.0 para la plataforma de Adobe Flash.
En este ejemplo el valor del parmetro overwrite del mtodo copyTo() (el segundo parmetro) est definido en true. Al definir overwrite como true, si el archivo de destino ya existe se sobrescribe. Este parmetro es opcional. Si est definido en false (el valor predeterminado), la operacin distribuye un evento IOErrorEvent en el caso de que el archivo de destino ya exista (el archivo no se copia). Las versiones Async de los mtodos de copiar y mover funcionan de modo asncrono. Utilice el mtodo addEventListener() para controlar si se concluye la tarea o se produce un estado de error, como en el cdigo siguiente:
691
var original = File.documentsDirectory; original = original.resolvePath("AIR Test/test.txt"); var destination:File = File.documentsDirectory; destination = destination.resolvePath("AIR Test 2/copy.txt"); original.addEventListener(Event.COMPLETE, fileMoveCompleteHandler); original.addEventListener(IOErrorEvent.IO_ERROR, fileMoveIOErrorEventHandler); original.moveToAsync(destination); function fileMoveCompleteHandler(event:Event):void { trace(event.target); // [object File] } function fileMoveIOErrorEventHandler(event:IOErrorEvent):void { trace("I/O Error."); }
La clase File tambin incluye los mtodos File.moveToTrash() y File.moveToTrashAsync(), que sirven para trasladar un archivo o directorio a la papelera del sistema.
Eliminacin de archivos
Adobe AIR 1.0 y posterior La clase File incluye un mtodo deleteFile() y un mtodo deleteFileAsync(). Estos mtodos eliminan archivos, el primero de forma sincrnica y el segundo de forma asncrona (consulte Aspectos bsicos de los archivos de AIR en la pgina 671). En el ejemplo siguiente, el cdigo elimina de modo sincrnico el archivo test.txt del directorio de documentos del usuario:
var file:File = File.documentsDirectory.resolvePath("test.txt"); file.deleteFile();
El cdigo siguiente elimina de modo asncrono el archivo test.txt del directorio de documentos del usuario:
var file:File = File.documentsDirectory.resolvePath("test.txt"); file.addEventListener(Event.COMPLETE, completeHandler) file.deleteFileAsync(); function completeHandler(event:Event):void { trace("Deleted.") }
Tambin se incluyen los mtodos moveToTrash() y moveToTrashAsync(), que sirven para trasladar un archivo o directorio a la papelera del sistema. Para obtener ms informacin, consulte Traslado de archivos a la papelera en la pgina 691.
692
En el ejemplo siguiente, el cdigo traslada de modo sincrnico el archivo test.txt del directorio de documentos del usuario a la papelera del sistema:
var file:File = File.documentsDirectory.resolvePath("test.txt"); file.moveToTrash();
Nota: en sistemas operativos que no admiten el concepto de carpeta de papelera recuperable, los archivos se eliminan inmediatamente.
El mtodo createTempFile() crea automticamente un archivo temporal exclusivo (ahorrndole el trabajo de determinar un nuevo lugar exclusivo). Se puede utilizar un archivo temporal para guardar de forma provisional la informacin que se utiliza en una sesin de la aplicacin. Obsrvese que existe adems un mtodo createTempDirectory() para crear nuevos directorios temporales exclusivos en el directorio temporal System. Puede que desee eliminar el archivo temporal antes de cerrar la aplicacin, dado que no se elimina de forma automtica en todos los dispositivos.
drive: letra de la unidad del volumen en Windows (null en otros sistemas operativos) fileSystemType: tipo del sistema de archivos en el volumen de almacenamiento (por ejemplo, "FAT", "NTFS",
"HFS" o "UFS").
isRemoveable: indica si se puede eliminar un volumen (true) o no (false). isWritable: indica si se puede modificar un volumen (true) o no (false) name: nombre del volumen. rootDirectory: objeto File que se corresponde con el directorio raz del volumen.
693
La clase StorageVolumeChangeEvent tambin incluye una propiedad rootDirectory. La propiedad rootDirectory es un objeto File que hace referencia al directorio raz del volumen de almacenamiento que se ha montado o desmontado. La propiedad storageVolume del objeto StorageVolumeChangeEvent es undefined (null) en volmenes sin montar. Sin embargo, se puede acceder a la propiedad rootDirectory del evento. El siguiente cdigo genera el nombre y la ruta de archivo de un volumen de almacenamiento cuando se monta:
StorageVolumeInfo.storageVolumeInfo.addEventListener(StorageVolumeChangeEvent.STORAGE_VOLUME _MOUNT, onVolumeMount); function onVolumeMount(event:StorageVolumeChangeEvent):void { trace(event.storageVolume.name, event.rootDirectory.nativePath); }
El objeto StorageVolumeInfo.storageVolumeInfo incluye un mtodo getStorageVolumes(). Este mtodo devuelve un vector de los objetos StorageVolume que se corresponde con los volmenes de almacenamiento montados actualmente. El siguiente cdigo muestra cmo agrupar los nombres y los directorios raz de todos los volmenes de almacenamiento montados:
var volumes:Vector.<StorageVolume> = new Vector.<StorageVolume>; volumes = StorageVolumeInfo.storageVolumeInfo.getStorageVolumes(); for (var i:int = 0; i < volumes.length; i++) { trace(volumes[i].name, volumes[i].rootDirectory.nativePath); }
Nota: en distribuciones modernas de Linux, el mtodo getStorageVolumes() devuelve objetos correspondientes a dispositivos fsicos y unidades de red montadas en ubicaciones determinadas. El mtodo File.getRootDirectories() incluye los directorios raz (consulte Apuntar a la raz del sistema de archivos en la pgina 678. No obstante, los objetos StorageVolume (enumerados mediante el mtodo StorageVolumeInfo.getStorageVolumes()) ofrecen ms informacin sobre los volmenes de almacenamiento. La propiedad spaceAvailable de la propiedad rootDirectory de un objeto StorageVolume se puede utilizar para obtener el espacio disponible en un volumen de almacenamiento. (Consulte Determinacin del espacio disponible en un volumen en la pgina 684.) Para obtener informacin sobre los volmenes de almacenamiento en los dispositivos de AIR para TV, consulte Vista del directorio para aplicaciones de AIR para TV en la pgina 675.
Ms temas de ayuda
StorageVolume StorageVolumeInfo
694
En este ejemplo se utiliza la propiedad File.documentsDirectory y el mtodo resolvePath() de un objeto File para inicializar el objeto File. Existen tambin varias formas ms de configurar un objeto File para que apunte a un archivo. Para obtener ms informacin, consulte Configuracin de un objeto File para que apunte a un archivo en la pgina 679. Inicialice un objeto FileStream. Llame al mtodo open() u openAsync() del objeto FileStream. El mtodo que se llame depender de si se desea abrir el archivo para realizar operaciones sincrnicas o asncronas. Utilice el objeto File como parmetro file del mtodo open. Para el parmetro fileMode, indique una constante de la clase FileMode que especifique la forma en que se utilizar el archivo. En el ejemplo siguiente, el cdigo inicializa un objeto FileStream que se utiliza para crear un archivo y sobrescribir los datos existentes:
var fileStream:FileStream = new FileStream(); fileStream.open(file, FileMode.WRITE);
Para obtener ms informacin, consulte Inicializacin de un objeto FileStream, y apertura y cierre de archivos en la pgina 696 y Modos de apertura de FileStream en la pgina 695. Si abri el archivo de forma asncrona (con el mtodo openAsync()), aada y configure detectores de eventos para el objeto FileStream. Estos mtodos de deteccin de eventos responden a eventos distribuidos por el objeto FileStream en distintas situaciones. Entre estas situaciones se incluyen el momento en que los datos se leen desde el archivo, cuando se detectan errores de E/S o cuando se ha escrito la cantidad total de datos que se debe escribir. Para obtener ms informacin, consulte Programacin asncrona y eventos generados por un objeto FileStream abierto de forma asncrona en la pgina 700. Incluya cdigo para leer y escribir datos, segn proceda. Existen varios mtodos de la clase FileStream relacionados con la lectura y la escritura. (Cada uno empieza con "read" o "write"). El mtodo que se elija para leer o escribir datos depende del formato de los datos en el archivo de destino.
695
Por ejemplo, si el contenido del archivo de destino es texto codificado en UTF, se pueden utilizar los mtodos readUTFBytes() y writeUTFBytes(). Si se desea tratar los datos como conjuntos de bytes, se pueden utilizar los mtodos readByte(), readBytes(), writeByte() y writeBytes(). Para obtener ms informacin, consulte Formatos de datos y eleccin de los mtodos de lectura y escritura en la pgina 701. Si abri el archivo de forma asncrona, asegrese de que disponga de suficientes datos antes de llamar a un mtodo de lectura. Para obtener ms informacin, consulte Bfer de lectura y propiedad bytesAvailable de un objeto FileStream en la pgina 698. Antes de escribir en un archivo, si se desea comprobar la cantidad de espacio disponible en el disco se puede comprobar la propiedad spaceAvailable del objeto File. Para obtener ms informacin, consulte Determinacin del espacio disponible en un volumen en la pgina 684. Llame al mtodo close() del objeto FileStream cuando haya terminado de trabajar con el archivo. La llamada al mtodo close() hace que el archivo est disponible para las dems aplicaciones. Para obtener ms informacin, consulte Inicializacin de un objeto FileStream, y apertura y cierre de archivos en la pgina 696. Para ver una aplicacin de muestra que utiliza la clase FileStream para leer y escribir archivos, consulte los artculos siguientes en el centro de desarrollo de Adobe AIR:
Building a text-file editor (Creacin de un editor de archivos de texto, en ingls) Building a text-file editor (Creacin de un editor de archivos de texto, en ingls) Reading and writing from an XML preferences file (Lectura y escritura desde un archivo XML de preferencias, en
ingls)
La capacidad de leer del archivo La capacidad de escribir en el archivo Si los datos se anexarn siempre al final del archivo (al escribir) Qu hacer si el archivo no existe (y cuando no existen los directorios superiores)
A continuacin se enumeran los distintos modos de archivo (que se pueden especificar como parmetro fileMode de los mtodos open() y openAsync()):
696
Descripcin Especifica que el archivo est abierto slo para fines de lectura. Especifica que el archivo est abierto con posibilidad de escritura. Si el archivo no existe, se crea al abrirse el objeto FileStream. Si el archivo existe, se eliminan los datos existentes. Especifica que el archivo est abierto con posibilidad de anexarle datos. Si el archivo no existe, se crea el mismo. Si el archivo existe, no se sobrescriben los datos existentes y la escritura comienza al final del archivo. Especifica que el archivo est abierto con posibilidad de lectura y escritura. Si el archivo no existe, se crea el mismo. Especifique este modo para tener acceso directo de lectura/escritura al archivo. Se puede leer desde cualquier posicin del archivo. Al escribir en el archivo, slo los bytes que se escriben nuevamente sobreescriben los bytes existentes (todos los dems permanecen sin modificar).
FileMode.APPEND
FileMode.UPDATE
Inicializacin de un objeto FileStream, y apertura y cierre de archivos Adobe AIR 1.0 y posterior Al abrir un objeto FileStream, ste queda a disposicin para leer y escribir datos en un archivo. Para abrir un objeto FileStream se pasa un objeto File al mtodo open() o openAsync() del objeto FileStream:
var myFile:File = File.documentsDirectory.resolvePath("AIR Test/test.txt"); var myFileStream:FileStream = new FileStream(); myFileStream.open(myFile, FileMode.READ);
El parmetro fileMode (el segundo parmetro de los mtodos open() y openAsync()) especifica el modo en que ha de abrirse el archivo: para lectura, escritura, anexado o actualizacin. Para ver ms informacin, consulte la seccin anterior, Modos de apertura de FileStream en la pgina 695. Si se utiliza el mtodo openAsync() de abrir el archivo para operaciones asncronas, se debe configurar los detectores de eventos para que controlen eventos asncronos:
var myFile:File = File.documentsDirectory.resolvePath("AIR Test/test.txt"); var myFileStream:FileStream = new FileStream(); myFileStream.addEventListener(Event.COMPLETE, completeHandler); myFileStream.addEventListener(ProgressEvent.PROGRESS, progressHandler); myFileStream.addEventListener(IOErrorEvent.IOError, errorHandler); myFileStream.open(myFile, FileMode.READ); function completeHandler(event:Event):void { // ... } function progressHandler(event:ProgressEvent):void { // ... } function errorHandler(event:IOErrorEvent):void { // ... }
El archivo se abre para realizar operaciones sincrnicas o asncronas, segn se utilice el mtodo open() o openAsync(). Para obtener ms informacin, consulte Aspectos bsicos de los archivos de AIR en la pgina 671.
697
Si se define el parmetro fileMode en FileMode.READ o FileMode.UPDATE en el mtodo open del objeto FileStream, los datos se leern en el bfer de lectura en cuanto se abra el objeto FileStream. Para obtener ms informacin, consulte Bfer de lectura y propiedad bytesAvailable de un objeto FileStream en la pgina 698. Se puede llamar al mtodo close() de un objeto FileStream para cerrar el archivo asociado, dejndolo a disposicin de otras aplicaciones. Propiedad "position" de un objeto FileStream Adobe AIR 1.0 y posterior La propiedad position de un objeto FileStream determina dnde se leern o escribirn los datos en el siguiente mtodo de lectura o escritura. Antes de una operacin de lectura o escritura, configure la propiedad position con cualquier posicin vlida del archivo. En el ejemplo siguiente, el cdigo escribe la cadena "hello" (con cdigo UTF) en la posicin 8 del archivo:
var myFile:File = File.documentsDirectory.resolvePath("AIR Test/test.txt"); var myFileStream:FileStream = new FileStream(); myFileStream.open(myFile, FileMode.UPDATE); myFileStream.position = 8; myFileStream.writeUTFBytes("hello");
Cuando recin se abre un objeto FileStream, la propiedad position es 0. Antes de una operacin de lectura, el valor de position debe ser 0 como mnimo y menos que la cantidad de bytes del archivo (que son las posiciones existentes en el archivo). El valor de la propiedad position slo se modifica en las siguientes situaciones:
cuando se configura explcitamente la propiedad position; cuando se llama a un mtodo de lectura; cuando se llama a un mtodo de escritura.
Cuando se llama a un mtodo de lectura o escritura de un objeto FileStream, la propiedad position se incrementa inmediatamente en la cantidad de bytes que se leen o escriben. Dependiendo del mtodo de lectura que se utilice, la propiedad position se incrementa en la cantidad de bytes que se especifican para leer o en la cantidad de bytes que hay disponibles. Posteriormente, al llamar a un mtodo de lectura o escritura se leer o escribir empezando en la nueva posicin.
var myFile:File = File.documentsDirectory.resolvePath("AIR Test/test.txt"); var myFileStream:FileStream = new FileStream(); myFileStream.open(myFile, FileMode.UPDATE); myFileStream.position = 4000; trace(myFileStream.position); // 4000 myFileStream.writeBytes(myByteArray, 0, 200); trace(myFileStream.position); // 4200
Hay una excepcin a ello: si el FileStream se abri en modo de anexado, la propiedad position no se modifica tras llamar a un mtodo de escritura. (En el modo de anexado, los datos siempre se escriben al final del archivo, independientemente del valor de la propiedad position). Si es un archivo que se abri para realizar operaciones asncronas, la operacin de escritura no se finaliza antes de ejecutarse la siguiente lnea del cdigo. Sin embargo, se puede llamar a varios mtodos asncronos de forma secuencial y la rutina los ejecuta en la secuencia prevista:
698
var myFile:File = File.documentsDirectory.resolvePath("AIR Test/test.txt"); var myFileStream:FileStream = new FileStream(); myFileStream.openAsync(myFile, FileMode.WRITE); myFileStream.writeUTFBytes("hello"); myFileStream.writeUTFBytes("world"); myFileStream.addEventListener(Event.CLOSE, closeHandler); myFileStream.close(); trace("started."); closeHandler(event:Event):void { trace("finished."); }
S se puede especificar el valor de position inmediatamente despus de llamar a un mtodo de lectura o escritura (o en cualquier momento); la siguiente operacin de lectura o escritura se llevar a cabo empezando en esa posicin. Por ejemplo, observe que el siguiente cdigo define la propiedad position inmediatamente despus de llamar a la operacin writeBytes(), y position se define en ese valor (300) incluso despus de haberse concluido la operacin de escritura:
var myFile:File = File.documentsDirectory.resolvePath("AIR Test/test.txt"); var myFileStream:FileStream = new FileStream(); myFileStream.openAsync(myFile, FileMode.UPDATE); myFileStream.position = 4000; trace(myFileStream.position); // 4000 myFileStream.writeBytes(myByteArray, 0, 200); myFileStream.position = 300; trace(myFileStream.position); // 300
Bfer de lectura y propiedad bytesAvailable de un objeto FileStream Adobe AIR 1.0 y posterior Cuando se abre un objeto FileStream con capacidad de lectura (uno en que el parmetro fileMode del mtodo open() o openAsync() se defini en READ o UPDATE), el motor de ejecucin guarda los datos en un bfer interno. El objeto FileStream empieza a leer datos en el bfer en cuanto se abre el archivo (llamando al mtodo open() o openAsync() del objeto FileStream). Si es un archivo que se abri para realizar operaciones sincrnicas (con el mtodo open()), siempre se puede configurar el puntero position en cualquier posicin (dentro de los lmites del archivo) y empezar a leer cualquier cantidad de datos (dentro de los lmites del archivo), como se ilustra en el siguiente cdigo, que presupone que el archivo contiene por lo menos 100 bytes):
var myFile:File = File.documentsDirectory.resolvePath("AIR Test/test.txt"); var myFileStream:FileStream = new FileStream(); myFileStream.open(myFile, FileMode.READ); myFileStream.position = 10; myFileStream.readBytes(myByteArray, 0, 20); myFileStream.position = 89; myFileStream.readBytes(myByteArray, 0, 10);
699
Se abra el archivo para operaciones sincrnicas o para operaciones asncronas, los mtodos de lectura siempre leen desde los bytes "disponibles", representados por la propiedad bytesAvailable. Al leer de forma sincrnica, todos los bytes del archivo estn disponibles todo el tiempo. Al leer de forma asncrona, los bytes quedan disponibles a partir de la posicin especificada por la propiedad position en una serie de llenados de bfer asncronos sealados por los eventos progress. Para archivos que se abren para realizar operaciones sincrnicas, la propiedad bytesAvailable se define siempre de modo que represente la cantidad de bytes desde la propiedad position hasta el final del archivo (para fines de lectura, siempre estn disponibles todos los bytes del archivo). En el caso de archivos abiertos para realizar operaciones asncronas, hay que asegurarse de que el bfer de lectura haya consumido suficientes datos antes de llamar a un mtodo de lectura. Para un archivo abierto de forma asncrona, a medida que avanza la operacin de lectura se van aadiendo al bfer los datos del archivo -empezando por el valor especificado para position cuando se inici la operacin de lectura- y la propiedad bytesAvailable se incrementa con cada byte que se lee. La propiedad bytesAvailable indica la cantidad de bytes que hay disponibles desde el byte de la posicin especificada por la propiedad position y el final del bfer. El objeto FileStream enva peridicamente un evento progress. Para un archivo abierto de forma asncrona, a medida que los datos quedan disponibles en el bfer de lectura el objeto FileStream distribuye peridicamente el evento progress. Por ejemplo, el siguiente cdigo lee datos en un objeto ByteArray, bytes, a medida que se van leyendo los mismos para ponerlos en el bfer.
var bytes:ByteArray = new ByteArray(); var myFile:File = File.documentsDirectory.resolvePath("AIR Test/test.txt"); var myFileStream:FileStream = new FileStream(); myFileStream.addEventListener(ProgressEvent.PROGRESS, progressHandler); myFileStream.openAsync(myFile, FileMode.READ); function progressHandler(event:ProgressEvent):void { myFileStream.readBytes(bytes, myFileStream.position, myFileStream.bytesAvailable); }
Para un archivo abierto de forma asncrona, slo se pueden leer los datos que se encuentran en el bfer de lectura. Adems, a medida que el usuario lee los datos, stos se eliminan del bfer de lectura. Para las operaciones de lectura hay que asegurarse de que los datos existan en el bfer de lectura antes de llamar a la operacin de lectura. En el siguiente ejemplo el cdigo lee 8.000 bytes de datos empezando por la posicin 4.000 del archivo:
var myFile:File = File.documentsDirectory.resolvePath("AIR Test/test.txt"); var myFileStream:FileStream = new FileStream(); myFileStream.addEventListener(ProgressEvent.PROGRESS, progressHandler); myFileStream.addEventListener(Event.COMPLETE, completed); myFileStream.openAsync(myFile, FileMode.READ); myFileStream.position = 4000; var str:String = ""; function progressHandler(event:Event):void { if (myFileStream.bytesAvailable > 8000 ) { str += myFileStream.readMultiByte(8000, "iso-8859-1"); } }
700
Durante una operacin de escritura, el objeto FileStream no lee datos para ponerlos en el bfer de lectura. Cuando finaliza una operacin de escritura (todos los datos en el bfer de escritura se han escrito en el archivo), el objeto FileStream inicia un nuevo bfer de lectura (suponiendo que el objeto FileStream asociado se abri con capacidad de lectura) y empieza a leer datos para ponerlos en el bfer de lectura, comenzando por la posicin especificada por la propiedad position. La propiedad position puede ser la posicin del ltimo byte escrito, o puede ser otra posicin si el usuario especifica otro valor para el objeto position despus de la operacin de escritura. Programacin asncrona y eventos generados por un objeto FileStream abierto de forma asncrona Adobe AIR 1.0 y posterior Cuando se abre un archivo de forma asncrona (con el mtodo openAsync()), la lectura y escritura de los archivos se realiza de modo asncrono. Puede ejecutarse otros cdigos ActionScript a medida que se leen datos para ponerlos en el bfer de lectura y se escriben los datos de salida. Ello significa que hay que registrarse para los eventos generados por el objeto FileStream que se abren de forma asncrona. Al registrarse para el evento progress, se puede notificar al usuario a medida que se disponen de nuevos datos para la lectura, como en el cdigo siguiente:
var myFile:File = File.documentsDirectory.resolvePath("AIR Test/test.txt"); var myFileStream:FileStream = new FileStream(); myFileStream.addEventListener(ProgressEvent.PROGRESS, progressHandler); myFileStream.openAsync(myFile, FileMode.READ); var str:String = ""; function progressHandler(event:ProgressEvent):void { str += myFileStream.readMultiByte(myFileStream.bytesAvailable, "iso-8859-1"); }
Para leer la totalidad de los datos, regstrese para el evento complete, como en el cdigo siguiente:
var myFile:File = File.documentsDirectory.resolvePath("AIR Test/test.txt"); var myFileStream:FileStream = new FileStream(); myFileStream.addEventListener(Event.COMPLETE, completed); myFileStream.openAsync(myFile, FileMode.READ); var str:String = ""; function completeHandler(event:Event):void { str = myFileStream.readMultiByte(myFileStream.bytesAvailable, "iso-8859-1"); }
De modo muy similar a lo que sucede con los datos de entrada que pasan al bfer para permitir la lectura asncrona, los datos que se escriben en una secuencia asncrona pasan a un bfer para escribirse de forma asncrona en el archivo. A medida que se escriben los datos en un archivo, el objeto FileStream distribuye peridicamente un objeto OutputProgressEvent. Un objeto OutputProgressEvent incluye una propiedad bytesPending que se ajusta a la cantidad de bytes que quedan por escribir. Puede registrarse para el evento outputProgress para que se le notifique el momento en que se escriba el contenido del bfer en el archivo, lo que permitir presentar un cuadro de dilogo del progreso, por ejemplo, pero en general no es necesario. En especial, puede llamar al mtodo close() sin preocuparse por los bytes sin escribir. El objeto FileStream seguir escribiendo datos y el evento close se entregar cuando se haya escrito el byte final en el archivo y se haya cerrado el archivo subyacente.
701
Formatos de datos y eleccin de los mtodos de lectura y escritura Adobe AIR 1.0 y posterior Cada archivo es un grupo de bytes en un disco. En ActionScript, los datos de un archivo pueden siempre representarse como un conjunto de bytes (ByteArray). En el siguiente ejemplo el cdigo lee los datos de un archivo para ponerlos en un objeto ByteArray denominado bytes:
var myFile:File = File.documentsDirectory.resolvePath("AIR Test/test.txt"); var myFileStream:FileStream = new FileStream(); myFileStream.addEventListener(Event.COMPLETE, completeHandler); myFileStream.openAsync(myFile, FileMode.READ); var bytes:ByteArray = new ByteArray(); function completeHandler(event:Event):void { myFileStream.readBytes(bytes, 0, myFileStream.bytesAvailable); }
Asimismo, el cdigo siguiente escribe los datos de ByteArray denominado bytes en un archivo:
var myFile:File = File.documentsDirectory.resolvePath("AIR Test/test.txt"); var myFileStream:FileStream = new FileStream(); myFileStream.open(myFile, FileMode.WRITE); myFileStream.writeBytes(bytes, 0, bytes.length);
Sin embargo, con frecuencia no se desea guardar los datos en un objeto ByteArray de ActionScript. Y sucede con frecuencia que el archivo de datos tiene un formato de archivo especificado. Por ejemplo, los datos del archivo pueden ser en formato de archivo de texto, y tal vez no le interese representar estos datos en un objeto String. Por este motivo la clase FileStream incluye mtodos de lectura y escritura para leer y escribir datos en (y de) tipos de objetos que no sean ByteArray. Por ejemplo, el mtodo readMultiByte() permite leer datos de un archivo y guardarlos en una cadena, como en el siguiente cdigo:
var myFile:File = File.documentsDirectory.resolvePath("AIR Test/test.txt"); var myFileStream:FileStream = new FileStream(); myFileStream.addEventListener(Event.COMPLETE, completed); myFileStream.openAsync(myFile, FileMode.READ); var str:String = ""; function completeHandler(event:Event):void { str = myFileStream.readMultiByte(myFileStream.bytesAvailable, "iso-8859-1"); }
El segundo parmetro del mtodo readMultiByte() especifica el formato de texto que utiliza ActionScript para interpretar los datos ("iso-8859-1" en el ejemplo). Adobe AIR admite las codificaciones de juegos de caracteres comunes (consulte Juegos de caracteres admitidos). La clase FileStream incluye tambin el mtodo readUTFBytes(), que lee datos del bfer de lectura y los pone en una cadena utilizando el juego de caracteres UTF-8. Dada la longitud variable de los caracteres del juego de caracteres UTF-8, no utilice readUTFBytes() en un mtodo que responda al evento progress, puesto que los datos al final del bfer de lectura pueden representar un carcter incompleto. (ste es tambin el caso cuando se emplea el mtodo readMultiByte() con codificacin de caracteres de longitud variable). Por este motivo conviene leer la totalidad de los datos cuando el objeto FileStream distribuye el evento complete.
702
Tambin hay mtodos similares de escritura, writeMultiByte() y writeUTFBytes(), para trabajar con objetos String y archivos de texto. Los mtodos readUTF() y writeUTF() (no deben confundirse con readUTFBytes() y writeUTFBytes()) tambin leen y escriben los datos de texto en un archivo, pero presuponen que los datos de texto vienen precedidos de datos que especifican la longitud de los datos de texto, lo cual no es comn con los archivos de texto estndar. Algunos archivos de texto en cdigo UTF empiezan con un carcter "UTF-BOM" (marca de orden de bytes) que define la propiedad "endian" adems del formato de codificacin (como UTF-16 o UTF-32). Para ver un ejemplo de lectura y escritura en un archivo de texto, consulte Ejemplo: Lectura de un archivo XML para ponerlo en un objeto XML en la pgina 703.
readObject() y writeObject() son formas convenientes de guardar y recuperar datos para objetos ActionScript
complejos. Los datos se codifican en AMF (formato de mensaje de accin). Adobe AIR, Flash Player, Flash Media Server y Flex Data Services incluyen APIs para trabajar con datos en este formato. Existen algunos otros mtodos de lectura y escritura (como readDouble() y writeDouble()). Si se utiliza alguno de stos, asegrese de que el formato del archivo se corresponda con los formatos de los datos definidos por estos mtodos. Los formatos de archivo son a menudo ms complejos que formatos de texto sencillo. Por ejemplo, un archivo MP3 incluye datos comprimidos que slo pueden interpretarse con algoritmos de descompresin y descodificacin que son exclusivos para archivos MP3. Los archivos MP3 pueden incluir tambin etiquetas ID3 que contienen informacin acerca del archivo en forma de de metaetiquetas (como el ttulo y el artista de una cancin). Existen varias versiones del formato ID3, pero la ms sencilla de ellas (ID3 versin 1) se trata en la seccin Ejemplo: Lectura y escritura de datos con acceso directo en la pgina 704. Otros formatos de archivos (para imgenes, bases de datos, documentos de aplicaciones, etc.) tienen distintas estructuras; para trabajar con estos datos en ActionScript hay que entender cmo estn estructurados los mismos.
El parmetro data del mtodo save() puede adoptar un valor String, XML o ByteArray. Cuando el argumento es un valor String o XML, el mtodo guarda el archivo como archivo de texto codificado como UTF-8. Cuando se ejecuta este ejemplo de cdigo, la aplicacin muestra un cuadro de dilogo en el que el usuario selecciona el destino del archivo guardado.
703
El siguiente cdigo carga una cadena de un archivo de texto codificado como UTF-8:
var file:File = File.applicationStorageDirectory.resolvePath("test.txt"); file.addEventListener(Event.COMPLETE, loaded); file.load(); var str:String; function loaded(event:Event):void { var bytes:ByteArray = file.data; str = bytes.readUTFBytes(bytes.length); trace(str); }
La clase FileStream proporciona ms funcionalidad que la que ofrecen los mtodos load() y save():
Con el uso de la clase FileStream, puede leer y escribir datos de forma sincrnica y asncrona. El uso de la clase FileStream permite escribir de forma incremental en un archivo. La utilizacin de la clase FileStream permite abrir un archivo para acceso aleatorio (pudiendo escribir y leer en
cualquier seccin del archivo).
La clase FileStream permite especificar el tipo de acceso al archivo del que se dispone, estableciendo el parmetro
fileMode del mtodo open() u openAsync().
La clase FileStream permite guardar datos en archivos sin tener que mostrar al usuario un cuadro de dilogo para
abrir o guardar.
Puede utilizar directamente tipos distintos a los conjuntos de bytes al leer datos con la clase FileStream.
Asimismo, para escribir los datos en el archivo basta con configurar objetos File y FileStream apropiados y luego llamar a un mtodo de escritura del objeto FileStream. Pase la versin en cadena de los datos XML al mtodo de escritura, como en el cdigo siguiente:
var prefsXML:XML = <prefs><autoSave>true</autoSave></prefs>; var file:File = File.documentsDirectory.resolvePath("AIR Test/preferences.xml"); fileStream = new FileStream(); fileStream.open(file, FileMode.WRITE); var outputString:String = '<?xml version="1.0" encoding="utf-8"?>\n'; outputString += prefsXML.toXMLString(); fileStream.writeUTFBytes(outputString); fileStream.close();
704
En estos ejemplos se utilizan los mtodos readUTFBytes() y writeUTFBytes() porque presuponen que los archivos estn en formato UTF-8. En caso contrario, puede resultar necesario usar otro mtodo (consulte Formatos de datos y eleccin de los mtodos de lectura y escritura en la pgina 701). Los ejemplos anteriores utilizan objetos FileStream abiertos para una operacin sincrnica. Tambin se pueden abrir archivos para operaciones asncronas (que dependen de las funciones de deteccin de eventos para responder a los eventos). Por ejemplo, el siguiente cdigo muestra cmo leer un archivo XML de forma asncrona:
var file:File = File.documentsDirectory.resolvePath("AIR Test/preferences.xml"); var fileStream:FileStream = new FileStream(); fileStream.addEventListener(Event.COMPLETE, processXMLData); fileStream.openAsync(file, FileMode.READ); var prefsXML:XML; function processXMLData(event:Event):void { prefsXML = XML(fileStream.readUTFBytes(fileStream.bytesAvailable)); fileStream.close(); }
El mtodo processXMLData() se invoca cuando se lee la totalidad del archivo para ponerlo en el bfer del lectura (cuando el objeto FileStream distribuye el evento complete). Llama al mtodo readUTFBytes() para obtener una versin en cadena de los datos ledos, y crea un objeto XML, prefsXML, con base en esa cadena. Para ver un ejemplo de aplicacin que muestra estas capacidades, consulte Reading and writing from an XML preferences file (Lectura y escritura desde un archivo XML de preferencias, en ingls).
Esto permite tanto leer como escribir en el archivo. Al abrir el archivo se puede definir el puntero position en la posicin de 128 bytes antes del final del archivo:
fileStr.position = file.size - 128;
Este cdigo define la propiedad position en esta ubicacin del archivo porque el formato ID3 v1.0 especifica que los datos de la etiqueta ID3 se guardan en los ltimos 128 bytes del archivo. La especificacin tambin estipula lo siguiente:
705
Los 30 caracteres siguientes contienen el ttulo del tema MP3 en forma de cadena. Los 30 caracteres siguientes contienen el nombre del artista en forma de cadena. Los 30 caracteres siguientes contienen el nombre del lbum en forma de cadena. Los 4 caracteres siguientes contienen el ao en forma de cadena. Los 30 caracteres siguientes contienen el comentario en forma de cadena. El siguiente byte contiene un cdigo que indica el gnero del tema. Todos los datos de texto estn en formato ISO 8859-1.
El mtodo id3TagRead() comprueba los datos despus de ledos (en el momento del evento complete):
function id3TagRead():void { if (fileStr.readMultiByte(3, "iso-8859-1").match(/tag/i)) { var id3Title:String = fileStr.readMultiByte(30, "iso-8859-1"); var id3Artist:String = fileStr.readMultiByte(30, "iso-8859-1"); var id3Album:String = fileStr.readMultiByte(30, "iso-8859-1"); var id3Year:String = fileStr.readMultiByte(4, "iso-8859-1"); var id3Comment:String = fileStr.readMultiByte(30, "iso-8859-1"); var id3GenreCode:String = fileStr.readByte().toString(10); } }
Tambin se puede realizar una escritura de acceso directo en el archivo. Por ejemplo, se podra analizar la variable id3Title para asegurarse de que las maysculas sean correctas (empleando los mtodos de la clase String) y despus escribir en el archivo una cadena modificada, denominada newTitle, como en el caso siguiente:
fileStr.position = file.length - 125; // 128 - 3 fileStr.writeMultiByte(newTitle, "iso-8859-1");
Para cumplir la norma ID3 versin 1, la longitud de la cadena newTitle debe ser de 30 caracteres, con el carcter 0 de relleno al final (String.fromCharCode(0)).
706
Objetos compartidos
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior Un objeto compartido, a menudo referido como cookie de Flash, es un archivo de datos que se puede crear en el equipo a partir de los sitios que se visitan. Los objetos compartidos se utilizan sobre todo para mejorar la navegacin en web ya que, por ejemplo, permiten personalizar el aspecto de un sitio web que se visita con frecuencia.
Pueden caducar y a menudo lo hacen al final de una sesin y de forma predeterminada. Pueden desactivarse mediante el cliente en funcin de los criterios especficos de un sitio.
707
Existe un lmite de 300 cookies en total y 20 cookies como mximo por sitio. Se suelen limitar a un tamao de 4 KB cada una. En ocasiones se consideran una amenaza para la seguridad y, como resultado, se deshabilitan en el cliente. Se almacenan en una ubicacin especificada por el navegador cliente. Se transmiten del cliente al servidor mediante HTTP.
Por el contrario, los objetos compartidos cuentan con las propiedades siguientes:
No caducan de forma predeterminada. De forma predeterminada, se limitan a un tamao de 100 KB cada uno. Pueden almacenar tipos de datos sencillos (por ejemplo, String, Array y Date). Se almacenan en una ubicacin que especifica la aplicacin (en el directorio de inicio del usuario). Nunca se transmiten entre el cliente y el servidor.
Descripcin Elimina todos los datos del objeto SharedObject y elimina el archivo SharedObject del disco. De forma inmediata escribe el archivo SharedObject en un archivo en el cliente. Devuelve una referencia al objeto SharedObject local especfico del dominio del cliente. Si no existe ninguno, este mtodo crea un objeto compartido en el cliente. Tamao del archivo SharedObject en bytes. El tamao predeterminado es de 100 KB, aunque puede ser mayor si el cliente lo permite.
getSize()
Adems de estos mtodos, los objetos SharedObject tienen las siguientes propiedades:
Propiedad
data
Descripcin Propiedad de slo lectura que representa la coleccin de atributos que almacena el objeto compartido. Controlador de eventos del objeto compartido que se invoca para cada advertencia, error o nota informativa.
onStatus
708
Con ello se crea un archivo en equipo del cliente llamado preferences.sol. El trmino local hace referencia a la ubicacin del objeto compartido. En este caso, Adobe Flash Player almacena el archivo SharedObject localmente en el directorio de inicio del cliente. Cuando se crea un objeto compartido, Flash Player crea un nuevo directorio para la aplicacin y el dominio dentro de su entorno limitado. Tambin crea un archivo *.sol que almacena los datos de SharedObject. La ubicacin predeterminada de este archivo es un subdirectorio del directorio de inicio del usuario. La siguiente tabla muestra las ubicaciones predeterminadas de este directorio:
Sistema operativo Windows 95/98/ME/2000/XP Windows Vista Macintosh OS X Ubicacin
c:/Documents and Settings/username/Application Data/Macromedia/Flash Player/#SharedObjects c:/Users/username/AppData/Roaming/Macromedia/Flash Player/#SharedObjects /Users/username/Library/Preferences/Macromedia/Flash Player/#SharedObjects/web_domain/path_to_application/applicatio n_name/object_name.sol /home/username/.macromedia/Flash_Player/#SharedObjects/web_doma in/path_to_application/application_name/object_name.sol
Linux/Unix
Bajo el directorio #SharedObjects existe un directorio nombrado al azar. Debajo hay un directorio que coincide con el nombre de host y, a continuacin, la ruta a la aplicacin y finalmente el archivo *.sol. Por ejemplo, si solicita una aplicacin denominada MyApp.swf en el host local, y en un subdirectorio llamado /sos, Flash Player almacena el archivo *.sol en la siguiente ubicacin en Windows XP:
c:/Documents and Settings/fred/Application Data/Macromedia/Flash Player/#SharedObjects/KROKWXRK/#localhost/sos/MyApp.swf/data.sol
Nota: si no proporcionan ningn nombre en el mtodo SharedObject.getLocal(), Flash Player asigna un nombre al archivo undefined.sol. De forma predeterminada, Flash puede guardar objetos SharedObject persistentes localmente de hasta 100 KB por dominio. Este valor puede configurarlo el usuario. Si la aplicacin intenta guardar datos en un objeto compartido que podran hacerlo superior a 100 KB, Flash Player muestra el cuadro de dilogo Almacenamiento local, que permite al usuario permitir o rechazar ms almacenamiento local para el dominio que est solicitando acceso.
Flash Player escribe el archivo SharedObject en el directorio /#localhost (o /localhost si la aplicacin est fuera de lnea). Esto resulta til si se desea que varias aplicaciones en el cliente puedan acceder al mismo objeto compartido. En este caso, el cliente podra ejecutar dos aplicaciones de Flex, que especifican una ruta al objeto compartido que es la raz del dominio; el cliente podra acceder al mismo objeto compartido desde ambas aplicaciones. Para compartir datos entre varias aplicaciones sin persistencia, puede utilizar el objeto LocalConnection. Si especifica un directorio que no existe, Flash Player no crea ningn archivo SharedObject.
709
En el siguiente ejemplo se aaden las propiedades userName, itemNumbers y adminPrivileges y sus valores a SharedObject:
public var currentUserName:String = "Reiner"; public var itemsArray:Array = new Array(101,346,483); public var currentUserIsAdmin:Boolean = true; mySO.data.userName = currentUserName; mySO.data.itemNumbers = itemsArray; mySO.data.adminPrivileges = currentUserIsAdmin;
Tras asignar valores a la propiedad data, debe indicar a Flash Player que escriba estos valores en el archivo de SharedObject. Para que Flash Player escriba los valores en el archivo de SharedObject, utilice el mtodo flush() deSharedObject, del siguiente modo:
mySO.flush();
Si no se llama al mtodo SharedObject.flush(), Flash Player escribe los valores en el archivo cuando se cierra la aplicacin. No obstante, esto no proporciona al usuario ninguna oportunidad de aumentar el espacio disponible que Flash Player tiene para almacenar los datos si stos sobrepasan la configuracin predeterminada. Por lo tanto, se recomienda llamar a SharedObject.flush(). Cuando se utiliza el mtodo flush() para escribir objetos compartidos en el disco duro de un usuario, es necesario comprobar si el usuario ha desactivado de forma explcita el almacenamiento local a travs del Administrador de configuracin de Flash Player (www.macromedia.com/support/documentation/es/flashplayer/help/settings_manager07.html), tal y como se muestra en el siguiente ejemplo:
var so:SharedObject = SharedObject.getLocal("test"); trace("Current SharedObject size is " + so.size + " bytes."); so.flush();
Almacenamiento de objetos en objetos compartidos Es posible almacenar objetos sencillos, como Arrays o Strings, en una propiedad data de SharedObject. El siguiente ejemplo muestra una clase de ActionScript que define mtodos que controlan la interaccin con el objeto compartido. Estos mtodos permiten al usuario aadir y eliminar objetos del objeto compartido. Esta clase almacena una ArrayCollection que contiene objetos simples.
710
package { import mx.collections.ArrayCollection; import flash.net.SharedObject; public class LSOHandler { private var mySO:SharedObject; private var ac:ArrayCollection; private var lsoType:String; // The parameter is "feeds" or "sites". public function LSOHandler(s:String) { init(s); } private function init(s:String):void { ac = new ArrayCollection(); lsoType = s; mySO = SharedObject.getLocal(lsoType); if (getObjects()) { ac = getObjects(); } } public function getObjects():ArrayCollection { return mySO.data[lsoType]; } public function addObject(o:Object):void { ac.addItem(o); updateSharedObjects(); } private function updateSharedObjects():void { mySO.data[lsoType] = ac; mySO.flush(); } } }
La siguiente aplicacin Flex crea una instancia de la clase de ActionScript para cada uno de los tipos de objetos compartidos que necesita. A continuacin llama al mtodo de esa clase cuando el usuario aade o elimina direcciones URL de sitios o blogs.
711
<?xml version="1.0"?> <!-- lsos/BlogAggregator.mxml --> <mx:Application xmlns:local="*" xmlns:mx="http://www.adobe.com/2006/mxml" creationComplete="initApp()" backgroundColor="#ffffff" > <mx:Script> <![CDATA[ import mx.collections.ArrayCollection; import mx.utils.ObjectUtil; import flash.net.SharedObject; [Bindable] public var welcomeMessage:String; [Bindable] public var localFeeds:ArrayCollection = new ArrayCollection(); [Bindable] public var localSites:ArrayCollection = new ArrayCollection(); public var lsofeeds:LSOHandler; public var lsosites:LSOHandler; private function initApp():void { lsofeeds = new LSOHandler("feeds"); lsosites = new LSOHandler("sites"); if (lsofeeds.getObjects()) { localFeeds = lsofeeds.getObjects(); } if (lsosites.getObjects()) { localSites = lsosites.getObjects(); } } // Adds a new feed to the feeds DataGrid. private function addFeed():void { // Construct an object you want to store in the // LSO. This object can contain any number of fields. var o:Object = {name:ti1.text, url:ti2.text, date:new Date()}; lsofeeds.addObject(o); // Because the DataGrid's dataProvider property is // bound to the ArrayCollection, Flex updates the // DataGrid when you call this method. localFeeds = lsofeeds.getObjects(); // Clear the text fields. ti1.text = ''; ti2.text = ''; } // Removes feeds from the feeds DataGrid. private function removeFeed():void {
712
// // // // // if
Use a method of ArrayCollection to remove a feed. Because the DataGrid's dataProvider property is bound to the ArrayCollection, Flex updates the DataGrid when you call this method. You do not need to update it manually. (myFeedsGrid.selectedIndex > -1) {
localFeeds.removeItemAt(myFeedsGrid.selectedIndex); } } private function addSite():void { var o:Object = {name:ti3.text, date:new Date()}; lsosites.addObject(o); localSites = lsosites.getObjects(); ti3.text = ''; } private function removeSite():void { if (mySitesGrid.selectedIndex > -1) { localSites.removeItemAt(mySitesGrid.selectedIndex); } } ]]> </mx:Script> <mx:Label text="Blog aggregator" fontSize="28"/> <mx:Panel title="Blogs"> <mx:Form id="blogForm"> <mx:HBox> <mx:FormItem label="Name:"> <mx:TextInput id="ti1" width="100"/> </mx:FormItem> <mx:FormItem label="Location:"> <mx:TextInput id="ti2" width="300"/> </mx:FormItem> <mx:Button id="b1" label="Add Feed" click="addFeed()"/> </mx:HBox> <mx:FormItem label="Existing Feeds:"> <mx:DataGrid id="myFeedsGrid" dataProvider="{localFeeds}" width="400" /> </mx:FormItem> <mx:Button id="b2" label="Remove Feed" click="removeFeed()"/> </mx:Form> </mx:Panel> <mx:Panel title="Sites">
713
<mx:Form id="siteForm"> <mx:HBox> <mx:FormItem label="Site:"> <mx:TextInput id="ti3" width="400"/> </mx:FormItem> <mx:Button id="b3" label="Add Site" click="addSite()"/> </mx:HBox> <mx:FormItem label="Existing Sites:"> <mx:DataGrid id="mySitesGrid" dataProvider="{localSites}" width="400" /> </mx:FormItem> <mx:Button id="b4" label="Remove Site" click="removeSite()"/> </mx:Form> </mx:Panel> </mx:Application>
Almacenamiento de objetos con tipo en objetos compartidos Se pueden almacenar instancias de ActionScript con tipo en objetos compartidos. Esto se lleva a cabo llamando al mtodo flash.net.registerClassAlias() para registrar la clase. Si se crea una instancia de la clase y se almacena en el miembro de datos del objeto compartido y posteriormente se lee el objeto, se obtendr una instancia con tipo. De forma predeterminada, la propiedad objectEncoding de SharedObject admite la codificacin AMF3 y desempaqueta la instancia almacenada desde el objeto SharedObject; la instancia almacenada conserva el mismo tipo que se especific cuando se llam al mtodo registerClassAlias().
Con esto se crean los archivos preferences.sol y history.sol en el directorio local de la aplicacin Flex.
714
Los archivos SWF enviados mediante conexiones no HTTPS pueden leer o escribir en este objeto compartido. Si un archivo SWF se ha enviado a travs de una conexin no HTTPS y se intenta establecer este parmetro en true, no se podr crear un nuevo objeto compartido (o acceder a un objeto compartido seguro creado anteriormente), se emitir un error y el objeto compartido se establecer en null. Si se intenta ejecutar el siguiente fragmento de cdigo desde una conexin no HTTPS, el mtodo SharedObject.getLocal() emitir un error:
try { var so:SharedObject = SharedObject.getLocal("contactManager", null, true); } catch (error:Error) { trace("Unable to create SharedObject."); }
Independientemente del valor de este parmetro, los objetos compartidos creados aumentan el espacio en disco total permitido en el dominio.
Ejemplo de SharedObject
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior El siguiente ejemplo muestra cmo se almacenan objetos sencillos, como un objeto Date, en un objeto SharedObject sin tener que serializarlos ni deserializarlos manualmente.
715
El ejemplo siguiente comienza dndole la bienvenida como visitante. Al hacer clic en Log Out (Cerrar sesin), la aplicacin almacena la fecha actual en un objeto compartido. La prxima vez que inicie esta aplicacin o actualice la pgina, la aplicacin le dar la bienvenida con un recordatorio de la hora en que cerr la sesin. Para ver la aplicacin en funcionamiento, haga clic en Log Out y despus actualice la pgina. La aplicacin muestra la fecha y la hora en la que hizo clic en el botn Log Out en su visita anterior. En cualquier momento, puede eliminar la informacin almacenada haciendo clic en el botn Delete LSO.
<?xml version="1.0"?> <!-- lsos/WelcomeMessage.mxml --> <mx:Application xmlns:mx="http://www.adobe.com/2006/mxml" initialize="initApp()"> <mx:Script><![CDATA[ public var mySO:SharedObject; [Bindable] public var welcomeMessage:String; public function initApp():void { mySO = SharedObject.getLocal("mydata"); if (mySO.data.visitDate==null) { welcomeMessage = "Hello first-timer!" } else { welcomeMessage = "Welcome back. You last visited on " + getVisitDate(); } } private function getVisitDate():Date { return mySO.data.visitDate; } private function storeDate():void { mySO.data.visitDate = new Date(); mySO.flush(); } private function deleteLSO():void { // Deletes the SharedObject from the client machine. // Next time they log in, they will be a 'first-timer'. mySO.clear(); } ]]></mx:Script> <mx:Label id="label1" text="{welcomeMessage}"/> <mx:Button label="Log Out" click="storeDate()"/> <mx:Button label="Delete LSO" click="deleteLSO()"/> </mx:Application>
716
Nota: adems del almacn local cifrado, AIR tambin proporciona cifrado para el contenido almacenado en bases de datos SQL. Para obtener ms informacin, consulte Uso del cifrado con bases de datos SQL en la pgina 765. El almacn local cifrado resulta prctico para guardar informacin que debe estar protegida, como los datos de inicio de sesin para servicios web. EL ELS est indicado para almacenar informacin que deba permanecer privada para otros usuarios. Sin embargo, no protege los datos de otros procesos ejecutados en la misma cuenta de usuario. Por esto, no est indicado para proteger datos secretos de aplicaciones, como DRM o claves de cifrado. AIR utiliza DPAPI en Windows, KeyChain en Mac OS y KeyRing o KWallet en Linux para asociar el almacn local cifrado a todas las aplicaciones y usuarios. El almacn local cifrado utiliza cifrado AES-CBC de 128 bits. La informacin en el almacn local cifrado slo est disponible para contenido de aplicaciones de AIR en el entorno limitado de seguridad de la aplicacin. Si actualiza una aplicacin de AIR, la versin actualizada conserva el acceso a todos los datos existentes en el almacn local cifrado a no ser que:
Los elementos se hayan aadido con el parmetro stronglyBound establecido en true La versin existente y la actualizada se publican en versiones anteriores a AIR 1.5.3 y la actualizacin est firmada
con una firma de migracin. Limitaciones del almacn local cifrado Los datos del almacn local cifrado se protegen con las credenciales de la cuenta en el sistema operativo del usuario. Otras entidades no pueden acceder a los datos del almacn a menos que puedan iniciar la sesin como usuario. Sin embargo, los datos no estn seguros frente al acceso de otras aplicaciones ejecutadas por un usuario autenticado. El usuario debe autenticarse para que funcionen estos ataques, por lo que los datos privados del usuario an estn protegidos (a no ser que la propia cuenta de usuario sea vulnerable). Sin embargo, la informacin que la aplicacin pueda desear mantener en secreto para los usuarios, como las claves utilizadas para la administracin de derechos digitales o de licencia, no est segura. Por lo tanto, el almacn local cifrado no es la ubicacin adecuada para almacenar este tipo de informacin. Slo resulta un lugar apropiado para almacenar datos privados del usuario como, por ejemplo, contraseas. Los datos del ELS se pueden perder por muchos motivos. Por ejemplo, el usuario puede desinstalar la aplicacin y eliminar el archivo cifrado. O el ID de edicin podra cambiarse como resultado de la actualizacin. Por ello, el ELS debe tratarse como una memoria cach privada, no como espacio de almacenamiento de datos permanente. El parmetro stronglyBound ya no se utiliza y no debe establecerse en true. Establecer el parmetro como true no aporta proteccin adicional a los datos. Al mismo tiempo, se pierde el acceso a los datos cada vez que se actualiza la aplicacin, incluso si el ID de edicin permanece invariable. Es posible que el almacn local cifrado funcione ms lento si los datos guardados superan los 10 MB. Al desinstalar una aplicacin de AIR, el programa de desinstalacin no elimina los datos que tenga guardados el almacn local cifrado. Entre las mejores prcticas para el uso del almacn local cifrado (ELS) se incluyen:
Utilice el ELS para almacenar datos importantes del usuario como, por ejemplo, contraseas (estableciendo
stronglyBound en false)
No utilice el ELS para almacenar secretos de las aplicaciones como, por ejemplo, claves de DRM (administracin
de derechos digitales) o tokens de licencia..
Permite que la aplicacin pueda recrear los datos almacenados en el ELS si stos se pierden. Por ejemplo, puede
pedir al usuario que vuelva a introducir sus credenciales de cuenta de usuario cuando sea necesario.
717
No utilice el parmetro stronglyBound. Si establece stronglyBound como true, no migre los elementos almacenados durante una actualizacin. Vuelva a
crear los datos una vez concluida la actualizacin.
Almacene nicamente cantidades relativamente pequeas de datos. Para cantidades ms grandes, utilice una base
de datos SQL de AIR con cifrado.
Ms temas de ayuda
flash.data.EncryptedLocalStore
El tercer parmetro del mtodo setItem(), el parmetro stronglyBound, es opcional. Cuando este parmetro se establece como true, el almacn local cifrado vincula el elemento guardado con los bits y la firma digital de la aplicacin de AIR:
var str:String = "Bob"; var bytes:ByteArray = new ByteArray(); bytes.writeUTFBytes(str); EncryptedLocalStore.setItem("firstName", bytes, false);
Para un elemento guardado con stronglyBound definido en true, las llamadas posteriores a getItem() slo tendrn xito si la aplicacin de AIR que llama es idntica a la aplicacin de almacenamiento (si no se ha cambiado ningn dato en los archivos del directorio de la aplicacin). Si la aplicacin de AIR que llama no es la misma que la que realiza el almacenamiento, la aplicacin emite una excepcin Error cuando se llama a getItem() para un elemento fuertemente vinculado. Si se actualiza la aplicacin, sta no podr leer datos fuertemente vinculados que se haban escrito en el almacn local cifrado. Si el parmetro stronglyBound es establece en false (valor predeterminado), nicamente el ID de editor debe ser el mismo para que la aplicacin lea los datos. Los bits de la aplicacin pueden cambiar (y debe firmarlos el mismo editor), pero no es necesario que sean exactamente los mismos bits que estaban en la aplicacin que almacen los datos. Las aplicaciones actualizadas con el mismo ID de edicin que el original pueden seguir accediendo a los datos. Nota: en la prctica, establecer stronglyBound como true no aade ninguna proteccin adicional a los datos. Un usuario malintencionado podra alterar la aplicacin para tener acceso a los elementos guardados en el ELS. Adems, los datos tienen el mismo nivel de proteccin frente a amenazas externas de usuarios ajenos si se establece stronglyBound como true o como false. Por estos motivos, establecer stronglyBound como true no se recomienda.
718
Para borrar todos los datos del almacn local cifrado, llame al mtodo EncryptedLocalStore.removeItem(), como en el siguiente ejemplo:
EncryptedLocalStore.reset();
719
Working asynchronously with a local SQL database (Trabajo de forma asncrona con bases de datos SQL locales,
en ingls) (Flex)
Working synchronously with a local SQL database (Trabajo de forma sincrnica con bases de datos SQL locales, en
ingls) (Flex).
Using an encrypted database (Uso de una base de datos cifrada, en ingls) (Flex). Working asynchronously with a local SQL database (Trabajo en forma asncrona con bases de datos SQL locales,
en ingls) (Flash).
Working asynchronously with a local SQL database (Trabajo en forma asncrona con bases de datos SQL locales,
en ingls) (Flash).
Using an encrypted database (Uso de una base de datos cifrada, en ingls) (Flash).
Adobe AIR incluye un motor de base de datos relacional basado en SQL que se ejecuta en tiempo de ejecucin, con datos almacenados de forma local en archivos de base de datos en el equipo donde se ejecuta la aplicacin de AIR (por ejemplo, en el disco duro). Dado que la base de datos ejecuta archivos de datos que se almacenan de forma local, una aplicacin de AIR puede usar una base de datos independientemente si hay disponible una conexin de red. Por consiguiente, el motor de la base datos SQL local del motor de ejecucin proporciona un mecanismo conveniente para almacenar datos de aplicacin local persistentes, especialmente si tiene experiencia con SQL y bases de datos relacionales.
720
Para una aplicacin orientada a datos (por ejemplo una agenda de direcciones) se puede usar una base de datos para
almacenar los datos de la aplicacin principal.
Para una aplicacin orientada a documentos, donde los usuarios crean documentos para guardar y posiblemente
compartir, se puede guardar cada documento como un archivo de base de datos, en una ubicacin designada por el usuario. (Sin embargo, se debe tener en cuenta que a no ser que la base de datos est cifrada, cualquier aplicacin de AIR podra abrir el archivo de base de datos. El cifrado se recomienda para documentos que pueden llegar a ser de especial importancia.)
Para una aplicacin de red, se puede usar una base de datos para almacenar cach local de los datos de aplicacin o
almacenar datos temporalmente cuando no se encuentra disponible una conexin de red. Se puede crear un mecanismo para sincronizar la base de datos local con el almacn de datos de red.
Para cualquier aplicacin, se puede usar una base de datos para almacenar la configuracin de aplicacin individual
de un usuario, como opciones de usuario o informacin de aplicacin como color y posicin de la ventana.
Ms temas de ayuda
Christophe Coenraets: Director de personal en AIR para Android Raymond Camden: jQuery and AIR - Moving from web page to application (Movimiento desde la pgina web a la aplicacin; en ingls)
721
Conceptos de SQL
Adobe AIR 1.0 y posterior Structured Query Language, SQL (del ingls Lenguaje de consulta estructurado) se utiliza con bases de datos relacionales para manipular y recuperar datos. SQL es un lenguaje descriptivo en vez de un lenguaje de procedimientos. En vez de impartir instrucciones al equipo sobre cmo debera recuperar datos, una declaracin SQL describe el conjunto de datos que necesita. El motor de base de datos determina la manera de recuperar esos datos.
722
El lenguaje SQL ha sido estandarizado por el American National Standards Institute, ANSI (del ingls Instituto Nacional Estadounidense de Normas). La base de datos SQL local de Adobe AIR admite la mayora de las normas SQL-92. Para obtener descripciones especficas del lenguaje SQL admitido en Adobe AIR, consulte Compatibilidad de SQL en bases de datos locales en la pgina 1125.
flash.data.SQLStatement
flash.data.SQLResult
Para obtener la informacin de esquemas que describen la estructura de una base de datos, se usan estas clases en el paquete flash.data:
Clase flash.data.SQLSchemaResult Descripcin Acta como un contenedor para los resultados de esquema de la base de datos generados al llamar al mtodo SQLConnection.loadSchema(). Proporciona informacin que describe un sola tabla en una base de datos. Proporciona informacin que describe un sola vista en una base de datos. Proporciona informacin que describe una sola columna de una tabla o vista en una base de datos. Proporciona informacin que describe un solo desencadenador en una base de datos.
Otras clases en el paquete flash.data proporcionan restricciones que se usan con la clase SQLConnection y la clase SQLColumnSchema:
Clase flash.data.SQLMode Descripcin Define un conjunto de constantes que representan los valores posibles del parmetro openMode de los mtodos SQLConnection.open() y SQLConnection.openAsync(). Define un conjunto de constantes que representan los valores posibles de la propiedad
SQLConnection.columnNameStyle.
flash.data.SQLColumnNameStyle
flash.data.SQLTransactionLockType Define un conjunto de constantes que representan los valores posibles del parmetro de opcin del mtodo SQLConnection.begin(). flash.data.SQLCollationType Define un conjunto de constantes que representan los valores posibles de la propiedad
SQLColumnSchema.defaultCollationType y el parmetro defaultCollationType del constructor SQLColumnSchema().
Adems, las siguientes clases en el paquete flash.events representan los eventos (y constantes admitidas) que usa:
723
Clase flash.events.SQLEvent
Descripcin Define los eventos que una instancia SQLConnection o SQLStatement distribuye cuando cualquiera de sus operaciones se ejecuta correctamente. Cada operacin tiene una constante de tipo de evento asociada definida en la clase SQLEvent. Define el evento que una instancia SQLConnection o SQLStatement distribuye cuando cualquiera de sus operaciones resulta en error.
flash.events.SQLErrorEvent
flash.events.SQLUpdateEven Define el evento que una instancia SQLConnection distribuye cuando los datos de la tabla en una de las t bases de datos conectadas cambia como resultado de la ejecucin de una declaracin SQL INSERT, UPDATE o DELETE.
Por ltimo, las siguientes clases en el paquete flash.errors proporcionan informacin sobre los errores de operacin de la base de datos:
Clase flash.errors.SQLError Descripcin Proporciona informacin sobre un error de operacin de la base de datos, incluida la operacin que se estaba intentando realizar y la razn del error. Define un conjunto de constantes que representa los valores posibles para la propiedad operation de la clase SQLError, que indica la operacin de la base de datos que result en error.
flash.errors.SQLErrorOperati on
724
Si las operaciones se ejecutan de forma asncrona o sincrnicamente se define en el nivel SQLConnection. Si se usa una sola conexin de base de datos, no se pueden ejecutar algunas operaciones o sentencias sincrnicamente y otras de forma asncrona. Especifique si una SQLConnection funciona en el modo de ejecucin asncrono o sincrnico llamando a un mtodo SQLConnection para abrir la base de datos. Si llama a SQLConnection.open() la conexin funciona en el modo de ejecucin sincrnico y si llama a SQLConnection.openAsync() la conexin funciona en el modo de ejecucin asncrono. Una vez que una instancia SQLConnection se conecta a una base de datos usando open() o openAsync(), se fija en el modo de ejecucin asncrono o sincrnico a menos que elija cerrar y volver a abrir la conexin a la base de datos. Cada modo de ejecucin tiene sus ventajas. Mientras que la mayora de los aspectos son similares, hay algunas diferencias que debe tener en cuenta cuando trabaja con cada modo. Para ms informacin sobre estos temas y sugerencias para trabajar en cada modo, consulte Uso de operaciones sincrnicas y asncronas de base de datos en la pgina 760.
Ms temas de ayuda
Mind the Flex: Updating an existing AIR database (Flex: actualizacin de una base de datos de AIR existente; en ingls)
725
var conn:SQLConnection = new SQLConnection(); conn.addEventListener(SQLEvent.OPEN, openHandler); conn.addEventListener(SQLErrorEvent.ERROR, errorHandler); // The database file is in the application storage directory var folder:File = File.applicationStorageDirectory; var dbFile:File = folder.resolvePath("DBSample.db"); conn.openAsync(dbFile); function openHandler(event:SQLEvent):void { trace("the database was created successfully"); } function errorHandler(event:SQLErrorEvent):void { trace("Error message:", event.error.message); trace("Details:", event.error.details); }
726
<?xml version="1.0" encoding="utf-8"?> <mx:WindowedApplication xmlns:mx="http://www.adobe.com/2006/mxml" creationComplete="init()"> <mx:Script> <![CDATA[ import flash.data.SQLConnection; import flash.events.SQLErrorEvent; import flash.events.SQLEvent; import flash.filesystem.File; private function init():void { var conn:SQLConnection = new SQLConnection(); conn.addEventListener(SQLEvent.OPEN, openHandler); conn.addEventListener(SQLErrorEvent.ERROR, errorHandler); // The database file is in the application storage directory var folder:File = File.applicationStorageDirectory; var dbFile:File = folder.resolvePath("DBSample.db"); conn.openAsync(dbFile); } private function openHandler(event:SQLEvent):void { trace("the database was created successfully"); } private function errorHandler(event:SQLErrorEvent):void { trace("Error message:", event.error.message); trace("Details:", event.error.details); } ]]> </mx:Script> </mx:WindowedApplication>
Nota: aunque la clase File permite sealar una ruta de archivos nativos especfica, esto puede implicar que las aplicaciones no funcionen correctamente en diversas plataformas. Por ejemplo, la ruta C:\Documents and Settings\joe\test.db nicamente funciona en Windows. Por estos motivos, resulta ms adecuado usar propiedades estticas de la clase File como, por ejemplo,File.applicationStorageDirectory, as como el mtodo resolvePath() (tal y como se muestra en el ejemplo anterior). Para obtener ms informacin, consulte Rutas a objetos File en la pgina 672. Para ejecutar las operaciones sincrnicamente, cuando abre una conexin de base de datos con la instancia SQLConnection, llame al mtodo open(). En el siguiente ejemplo se muestra la manera de crear y abrir una instancia SQLConnection que ejecuta las operaciones sincrnicamente:
727
import flash.data.SQLConnection; import flash.errors.SQLError; import flash.filesystem.File; var conn:SQLConnection = new SQLConnection(); // The database file is in the application storage directory var folder:File = File.applicationStorageDirectory; var dbFile:File = folder.resolvePath("DBSample.db"); try { conn.open(dbFile); trace("the database was created successfully"); } catch (error:SQLError) { trace("Error message:", error.message); trace("Details:", error.details); } <?xml version="1.0" encoding="utf-8"?> <mx:WindowedApplication xmlns:mx="http://www.adobe.com/2006/mxml" creationComplete="init()"> <mx:Script> <![CDATA[ import flash.data.SQLConnection; import flash.errors.SQLError; import flash.filesystem.File; private function init():void { var conn:SQLConnection = new SQLConnection(); // The database file is in the application storage directory var folder:File = File.applicationStorageDirectory; var dbFile:File = folder.resolvePath("DBSample.db"); try { conn.open(dbFile); trace("the database was created successfully"); } catch (error:SQLError) { trace("Error message:", error.message); trace("Details:", error.details); } } ]]> </mx:Script> </mx:WindowedApplication>
728
// ... create and open the SQLConnection instance named conn ... var createStmt:SQLStatement = new SQLStatement(); createStmt.sqlConnection = conn; var sql:String = "CREATE TABLE IF NOT EXISTS employees (" + " empId INTEGER PRIMARY KEY AUTOINCREMENT, " + " firstName TEXT, " + " lastName TEXT, " + " salary NUMERIC CHECK (salary > 0)" + ")"; createStmt.text = sql; createStmt.addEventListener(SQLEvent.RESULT, createResult); createStmt.addEventListener(SQLErrorEvent.ERROR, createError); createStmt.execute(); function createResult(event:SQLEvent):void { trace("Table created"); } function createError(event:SQLErrorEvent):void { trace("Error message:", event.error.message); trace("Details:", event.error.details); }
729
<?xml version="1.0" encoding="utf-8"?> <mx:WindowedApplication xmlns:mx="http://www.adobe.com/2006/mxml" creationComplete="init()"> <mx:Script> <![CDATA[ import flash.data.SQLConnection; import flash.data.SQLStatement; import flash.events.SQLErrorEvent; import flash.events.SQLEvent; private function init():void { // ... create and open the SQLConnection instance named conn ... var createStmt:SQLStatement = new SQLStatement(); createStmt.sqlConnection = conn; var sql:String = "CREATE TABLE IF NOT EXISTS employees (" + " empId INTEGER PRIMARY KEY AUTOINCREMENT, " + " firstName TEXT, " + " lastName TEXT, " + " salary NUMERIC CHECK (salary > 0)" + ")"; createStmt.text = sql; createStmt.addEventListener(SQLEvent.RESULT, createResult); createStmt.addEventListener(SQLErrorEvent.ERROR, createError); createStmt.execute(); } private function createResult(event:SQLEvent):void { trace("Table created"); } private function createError(event:SQLErrorEvent):void { trace("Error message:", event.error.message); trace("Details:", event.error.details); } ]]> </mx:Script> </mx:WindowedApplication>
En el siguiente ejemplo se demuestra la creacin de una tabla denominada employees en un archivo de base de datos existente, usando el modo de ejecucin sincrnico. Observe que en este cdigo se supone que existe una instancia de SQLConnection denominada conn que ya se ha creado y est conectada a una base de datos.
730
import flash.data.SQLConnection; import flash.data.SQLStatement; import flash.errors.SQLError; // ... create and open the SQLConnection instance named conn ... var createStmt:SQLStatement = new SQLStatement(); createStmt.sqlConnection = conn; var sql:String = "CREATE TABLE IF NOT EXISTS employees (" + " empId INTEGER PRIMARY KEY AUTOINCREMENT, " + " firstName TEXT, " + " lastName TEXT, " + " salary NUMERIC CHECK (salary > 0)" + ")"; createStmt.text = sql; try { createStmt.execute(); trace("Table created"); } catch (error:SQLError) { trace("Error message:", error.message); trace("Details:", error.details); }
731
<?xml version="1.0" encoding="utf-8"?> <mx:WindowedApplication xmlns:mx="http://www.adobe.com/2006/mxml" creationComplete="init()"> <mx:Script> <![CDATA[ import flash.data.SQLConnection; import flash.data.SQLStatement; import flash.errors.SQLError; private function init():void { // ... create and open the SQLConnection instance named conn ... var createStmt:SQLStatement = new SQLStatement(); createStmt.sqlConnection = conn; var sql:String = "CREATE TABLE IF NOT EXISTS employees (" + " empId INTEGER PRIMARY KEY AUTOINCREMENT, " + " firstName TEXT, " + " lastName TEXT, " + " salary NUMERIC CHECK (salary > 0)" + ")"; createStmt.text = sql; try { createStmt.execute(); trace("Table created"); } catch (error:SQLError) { trace("Error message:", error.message); trace("Details:", error.details); } } ]]> </mx:Script> </mx:WindowedApplication>
732
Puede elegir realizar operaciones de base de datos de forma asncrona, es decir, el motor de la base de datos se ejecuta en segundo plano y le notifica cuando la operacin se completa correctamente o falla distribuyendo un evento. Asimismo puede realizar estas operaciones sincrnicamente. En ese caso las operaciones de la base de datos se realizan una despus de la otra y toda la aplicacin (incluyendo las actualizaciones de la pantalla) esperan a que se completen las operaciones antes de ejecutar otro cdigo. Para ms informacin sobre el uso del modo de ejecucin sincrnico o asncronos, consulte Uso de operaciones sincrnicas y asncronas de base de datos en la pgina 760.
var conn:SQLConnection = new SQLConnection(); conn.addEventListener(SQLEvent.OPEN, openHandler); conn.addEventListener(SQLErrorEvent.ERROR, errorHandler); // The database file is in the application storage directory var folder:File = File.applicationStorageDirectory; var dbFile:File = folder.resolvePath("DBSample.db"); conn.openAsync(dbFile, SQLMode.UPDATE); function openHandler(event:SQLEvent):void { trace("the database opened successfully"); } function errorHandler(event:SQLErrorEvent):void { trace("Error message:", event.error.message); trace("Details:", event.error.details); }
733
<?xml version="1.0" encoding="utf-8"?> <mx:WindowedApplication xmlns:mx="http://www.adobe.com/2006/mxml" creationComplete="init()"> <mx:Script> <![CDATA[ import flash.data.SQLConnection; import flash.data.SQLMode; import flash.events.SQLErrorEvent; import flash.events.SQLEvent; import flash.filesystem.File; private function init():void { var conn:SQLConnection = new SQLConnection(); conn.addEventListener(SQLEvent.OPEN, openHandler); conn.addEventListener(SQLErrorEvent.ERROR, errorHandler); // The database file is in the application storage directory var folder:File = File.applicationStorageDirectory; var dbFile:File = folder.resolvePath("DBSample.db"); conn.openAsync(dbFile, SQLMode.UPDATE); } private function openHandler(event:SQLEvent):void { trace("the database opened successfully"); } private function errorHandler(event:SQLErrorEvent):void { trace("Error message:", event.error.message); trace("Details:", event.error.details); } ]]> </mx:Script> </mx:WindowedApplication>
En el siguiente ejemplo se muestra cmo abrir un archivo de base de datos existente para la ejecucin sincrnica. El archivo de la base de datos se denomina DBSample.db y se encuentra en el Apuntar al directorio de almacenamiento de la aplicacin en la pgina 676.
734
var conn:SQLConnection = new SQLConnection(); // The database file is in the application storage directory var folder:File = File.applicationStorageDirectory; var dbFile:File = folder.resolvePath("DBSample.db"); try { conn.open(dbFile, SQLMode.UPDATE); trace("the database opened successfully"); } catch (error:SQLError) { trace("Error message:", error.message); trace("Details:", error.details); } <?xml version="1.0" encoding="utf-8"?> <mx:WindowedApplication xmlns:mx="http://www.adobe.com/2006/mxml" creationComplete="init()"> <mx:Script> <![CDATA[ import flash.data.SQLConnection; import flash.data.SQLMode; import flash.errors.SQLError; import flash.filesystem.File; private function init():void { var conn:SQLConnection = new SQLConnection(); // The database file is in the application storage directory var folder:File = File.applicationStorageDirectory; var dbFile:File = folder.resolvePath("DBSample.db"); try { conn.open(dbFile, SQLMode.UPDATE); trace("the database opened successfully"); } catch (error:SQLError) { trace("Error message:", error.message); trace("Details:", error.details); } } ]]> </mx:Script> </mx:WindowedApplication>
735
Observe que en la llamada del mtodo openAsync() en el ejemplo asncrono y en la llamada del mtodo open() en el ejemplo sincrnico, el segundo argumento es la constante SQLMode.UPDATE. La especificacin de SQLMode.UPDATE para el segundo parmetro (openMode) hace que el motor de ejecucin distribuya un error si el archivo especificado no existe. Si pasa un valor SQLMode.CREATE para el parmetro openMode (o si desactiva el parmetro openMode), el motor de ejecucin intenta crear un archivo de base de datos si el archivo especial no existe. No obstante, si el archivo existe est abierto, que es lo mismo que utilizar SQLMode.Update. Asimismo puede especificar SQLMode.READ para el parmetro openMode para abrir una base de datos existente en el modo de slo lectura. En ese caso, se pueden recuperar los datos de la base de datos pero no se pueden aadir, eliminar ni cambiar datos.
Especificar la base de datos donde se realiza la consulta. Para ello, defina la propiedad sqlConnection del objeto SQLStatement a la instancia SQLConnection que est conectada con la base de datos deseada.
// A SQLConnection named "conn" has been created previously selectData.sqlConnection = conn;
Especificar la declaracin SQL real. Cree el texto de la declaracin como una cadena y asgnela a la propiedad text de la instancia SQLStatement.
selectData.text = "SELECT col1, col2 FROM my_table WHERE col1 = :param1";
Definir las funciones para gestionar el resultado de la operacin de ejecucin (slo modo de ejecucin asncrono) Use el mtodo addEventListener()para registrar funciones como detectores para los eventos result y error de la instancia SQLStatement.
// using listener methods and addEventListener() selectData.addEventListener(SQLEvent.RESULT, resultHandler); selectData.addEventListener(SQLErrorEvent.ERROR, errorHandler); function resultHandler(event:SQLEvent):void { // do something after the statement execution succeeds } function errorHandler(event:SQLErrorEvent):void { // do something after the statement execution fails }
Como alternativa, puede especificar mtodos de detectores usando un objeto Responder. En ese caso, cree la instancia Responder y vincule los mtodos de detector a la misma.
736
// using a Responder (flash.net.Responder) var selectResponder = new Responder(onResult, onError); function onResult(result:SQLResult):void { // do something after the statement execution succeeds } function onError(error:SQLError):void { // do something after the statement execution fails }
Si el texto de la declaracin incluye definiciones de parmetro, asigne valores para esos parmetros. Para asignar valores de parmetro, use la propiedad de conjunto asociativa parameters de la instancia SQLStatement.
selectData.parameters[":param1"] = 25;
Adems, si est usando Responder en vez de detectores de eventos en el modo de ejecucin asncrono, pase la instancia Responder al mtodo execute(().
// using a Responder in asynchronous execution mode selectData.execute(-1, selectResponder);
Para ejemplos especficos que demuestran estos pasos, consulte los siguientes temas: Recuperacin de datos de una base de datos en la pgina 739 Insercin de datos en la pgina 749 Cambio o eliminacin de datos en la pgina 755
737
El valor parameter_identifier es una cadena si est usando un parmetro con nombre o un ndice de nmero entero si est usando un parmetro sin nombre.
738
Para obtener ms informacin sobre las clases de almacenamiento y la afinidad de columnas, consulte Compatibilidad de tipos de datos en la pgina 1148.
Mayor seguridad El uso de los parmetros ayuda a prevenir la ejecucin de una tcnica malintencionada conocida como ataque de inyeccin SQL. En un ataque de inyeccin SQL, un usuario introduce un cdigo SQL en una ubicacin accesible al usuario (por ejemplo, un campo de introduccin de datos) Si el cdigo de aplicacin crea una declaracin SQL directamente concatenando entradas del usuario en el texto SQL, el cdigo SQL introducido por el usuario se ejecuta con la base de datos. A continuacin se muestra un ejemplo de entradas del usuario concatenadas en el texto SQL. No utilice esta tcnica:
739
// assume the variables "username" and "password" // contain user-entered data var sql:String = "SELECT userId " + "FROM users " + "WHERE username = '" + username + "' " + " AND password = '" + password + "'"; var statement:SQLStatement = new SQLStatement(); statement.text = sql;
La utilizacin de parmetros de instruccin en lugar de valores introducidos por el usuario concatenados en un texto de declaracin impide un ataque de inyeccin SQL. La inyeccin SQL no se puede llevar a cabo porque los valores de los parmetros se tratan explcitamente como valores sustituidos, en lugar de ser parte del texto de la declaracin literal. La siguiente alternativa es la alternativa que se recomienda del ejemplo anterior:
// assume the variables "username" and "password" // contain user-entered data var sql:String = "SELECT userId " + "FROM users " + "WHERE username = :username " + " AND password = :password"; var statement:SQLStatement = new SQLStatement(); statement.text = sql; // set parameter values statement.parameters[":username"] = username; statement.parameters[":password"] = password;
740
var selectStmt:SQLStatement = new SQLStatement(); // A SQLConnection named "conn" has been created previously selectStmt.sqlConnection = conn; selectStmt.text = "SELECT itemId, itemName, price FROM products"; selectStmt.addEventListener(SQLEvent.RESULT, resultHandler); selectStmt.addEventListener(SQLErrorEvent.ERROR, errorHandler); selectStmt.execute(); function resultHandler(event:SQLEvent):void { var result:SQLResult = selectStmt.getResult(); var numResults:int = result.data.length; for (var i:int = 0; i < numResults; i++) { var row:Object = result.data[i]; var output:String = "itemId: " + row.itemId; output += "; itemName: " + row.itemName; output += "; price: " + row.price; trace(output); } } function errorHandler(event:SQLErrorEvent):void { // Information about the error is available in the // event.error property, which is an instance of // the SQLError class. } <?xml version="1.0" encoding="utf-8"?> <mx:WindowedApplication xmlns:mx="http://www.adobe.com/2006/mxml" creationComplete="init()"> <mx:Script> <![CDATA[ import flash.data.SQLConnection; import flash.data.SQLResult; import flash.data.SQLStatement; import flash.errors.SQLError; import flash.events.SQLErrorEvent; import flash.events.SQLEvent; private function init():void { var selectStmt:SQLStatement = new SQLStatement(); // A SQLConnection named "conn" has been created previously selectStmt.sqlConnection = conn; selectStmt.text = "SELECT itemId, itemName, price FROM products"; selectStmt.addEventListener(SQLEvent.RESULT, resultHandler); selectStmt.addEventListener(SQLErrorEvent.ERROR, errorHandler);
741
selectStmt.execute(); } private function resultHandler(event:SQLEvent):void { var result:SQLResult = selectStmt.getResult(); var numResults:int = result.data.length; for (var i:int = 0; i < numResults; i++) { var row:Object = result.data[i]; var output:String = "itemId: " + row.itemId; output += "; itemName: " + row.itemName; output += "; price: " + row.price; trace(output); } } private function errorHandler(event:SQLErrorEvent):void { // Information about the error is available in the // event.error property, which is an instance of // the SQLError class. } ]]> </mx:Script> </mx:WindowedApplication>
En el siguiente ejemplo se muestra la ejecucin de una declaracin SELECT para recuperar datos de la tabla denominada "products", utilizando el modo de ejecucin sincrnica:
742
var selectStmt:SQLStatement = new SQLStatement(); // A SQLConnection named "conn" has been created previously selectStmt.sqlConnection = conn; selectStmt.text = "SELECT itemId, itemName, price FROM products"; try { selectStmt.execute(); var result:SQLResult = selectStmt.getResult(); var numResults:int = result.data.length; for (var i:int = 0; i < numResults; i++) { var row:Object = result.data[i]; var output:String = "itemId: " + row.itemId; output += "; itemName: " + row.itemName; output += "; price: " + row.price; trace(output); } } catch (error:SQLError) { // Information about the error is available in the // error variable, which is an instance of // the SQLError class. } <?xml version="1.0" encoding="utf-8"?> <mx:WindowedApplication xmlns:mx="http://www.adobe.com/2006/mxml" creationComplete="init()"> <mx:Script> <![CDATA[ import flash.data.SQLConnection; import flash.data.SQLResult; import flash.data.SQLStatement; import flash.errors.SQLError; import flash.events.SQLErrorEvent; import flash.events.SQLEvent; private function init():void { var selectStmt:SQLStatement = new SQLStatement(); // A SQLConnection named "conn" has been created previously selectStmt.sqlConnection = conn; selectStmt.text = "SELECT itemId, itemName, price FROM products"; try { selectStmt.execute(); var result:SQLResult = selectStmt.getResult();
743
var numResults:int = result.data.length; for (var i:int = 0; i < numResults; i++) { var row:Object = result.data[i]; var output:String = "itemId: " + row.itemId; output += "; itemName: " + row.itemName; output += "; price: " + row.price; trace(output); } } catch (error:SQLError) { // Information about the error is available in the // error variable, which is an instance of // the SQLError class. } } ]]> </mx:Script> </mx:WindowedApplication>
En el modo de ejecucin asncrono, cuando se termina de ejecutar la declaracin, la instancia SQLStatement distribuye un evento result (SQLEvent.RESULT) que indica que la declaracin se ejecut correctamente. Como alternativa, si se transmite un objeto Responder como argumento al mtodo execute(), se llama a la funcin de control de resultados del objeto Responder. En el modo de ejecucin sincrnico, la ejecucin hace una pausa hasta que la operacin execute() termina, y contina en la siguiente lnea de cdigo.
El mtodo getResult() devuelve un objeto SQLResult. La propiedad data del objeto SQLResult es un conjunto que contiene los resultados de la declaracin SELECT:
var numResults:int = result.data.length; for (var i:int = 0; i < numResults; i++) { // row is an Object representing one row of result data var row:Object = result.data[i]; }
Cada fila de datos del resultado SELECT se convierte en una instancia de Object incluida en el conjunto data. Dicho objeto tiene propiedades cuyos nombres coinciden con los nombres de columna del conjunto de resultados. Las propiedades contienen los valores de las columnas del conjunto de resultados. Por ejemplo, supongamos que una declaracin SELECT especifica un conjunto de resultados con tres columnas llamadas itemId, itemName y price. Para cada fila en el conjunto de resultados, se crea una instancia Object con propiedades denominadas itemId, itemName y price. Esas propiedades contienen los valores de sus respectivas columnas.
744
El siguiente ejemplo de cdigo define una instancia SQLStatement cuyo texto es una instruccin SELECT. La declaracin recupera las filas que contiene los valores de la columna firstName y lastName de todas las filas de una tabla denominada employees. Este ejemplo utiliza el modo de ejecucin asncrono. Cuando se termina la ejecucin, se llama al mtodo selectResult(), y se accede a las filas de datos resultantes usando SQLStatement.getResult() y se muestran usando el mtodo trace(). Observe que este cdigo supone que existe una instancia de SQLConnection denominada conn que ya ha sido creada y ya est conectada a una base de datos. Asimismo, supone que la tabla employees ya ha sido creada y llenada con datos.
import import import import import flash.data.SQLConnection; flash.data.SQLResult; flash.data.SQLStatement; flash.events.SQLErrorEvent; flash.events.SQLEvent;
// ... create and open the SQLConnection instance named conn ... // create the SQL statement var selectStmt:SQLStatement = new SQLStatement(); selectStmt.sqlConnection = conn; // define the SQL text var sql:String = "SELECT firstName, lastName " + "FROM employees"; selectStmt.text = sql; // register listeners for the result and error events selectStmt.addEventListener(SQLEvent.RESULT, selectResult); selectStmt.addEventListener(SQLErrorEvent.ERROR, selectError); // execute the statement selectStmt.execute(); function selectResult(event:SQLEvent):void { // access the result data var result:SQLResult = selectStmt.getResult(); var numRows:int = result.data.length; for (var i:int = 0; i < numRows; i++) { var output:String = ""; for (var columnName:String in result.data[i]) { output += columnName + ": " + result.data[i][columnName] + "; "; } trace("row[" + i.toString() + "]\t", output); } } function selectError(event:SQLErrorEvent):void { trace("Error message:", event.error.message); trace("Details:", event.error.details); }
745
<?xml version="1.0" encoding="utf-8"?> <mx:WindowedApplication xmlns:mx="http://www.adobe.com/2006/mxml" creationComplete="init()"> <mx:Script> <![CDATA[ import flash.data.SQLConnection; import flash.data.SQLResult; import flash.data.SQLStatement; import flash.events.SQLErrorEvent; import flash.events.SQLEvent; private function init():void { // ... create and open the SQLConnection instance named conn ... // create the SQL statement var selectStmt:SQLStatement = new SQLStatement(); selectStmt.sqlConnection = conn; // define the SQL text var sql:String = "SELECT firstName, lastName " + "FROM employees"; selectStmt.text = sql; // register listeners for the result and error events selectStmt.addEventListener(SQLEvent.RESULT, selectResult); selectStmt.addEventListener(SQLErrorEvent.ERROR, selectError); // execute the statement selectStmt.execute(); } private function selectResult(event:SQLEvent):void { // access the result data var result:SQLResult = selectStmt.getResult(); var numRows:int = result.data.length; for (var i:int = 0; i < numRows; i++) { var output:String = ""; for (var columnName:String in result.data[i]) { output += columnName + ": " + result.data[i][columnName] + "; "; } trace("row[" + i.toString() + "]\t", output); } } private function selectError(event:SQLErrorEvent):void { trace("Error message:", event.error.message); trace("Details:", event.error.details); } ]]> </mx:Script> </mx:WindowedApplication>
746
El siguiente ejemplo de cdigo demuestra las mismas tcnicas como la anterior pero utiliza el modo de ejecucin sincrnico. El ejemplo define una instancia de SQLStatement cuyo texto es una instancia SELECT. La declaracin recupera las filas que contiene los valores de la columna firstName y lastName de todas las filas de una tabla denominada employees. Se accede a las filas de datos resultantes utilizando SQLStatement.getResult() y se muestran usando el mtodo trace(). Observe que este cdigo supone que existe una instancia de SQLConnection denominada conn que ya ha sido creada y ya est conectada a una base de datos. Asimismo, supone que la tabla employees ya ha sido creada y llenada con datos.
import import import import flash.data.SQLConnection; flash.data.SQLResult; flash.data.SQLStatement; flash.errors.SQLError;
// ... create and open the SQLConnection instance named conn ... // create the SQL statement var selectStmt:SQLStatement = new SQLStatement(); selectStmt.sqlConnection = conn; // define the SQL text var sql:String = "SELECT firstName, lastName " + "FROM employees"; selectStmt.text = sql; try { // execute the statement selectStmt.execute(); // access the result data var result:SQLResult = selectStmt.getResult(); var numRows:int = result.data.length; for (var i:int = 0; i < numRows; i++) { var output:String = ""; for (var columnName:String in result.data[i]) { output += columnName + ": " + result.data[i][columnName] + "; "; } trace("row[" + i.toString() + "]\t", output); } } catch (error:SQLError) { trace("Error message:", error.message); trace("Details:", error.details); }
747
<?xml version="1.0" encoding="utf-8"?> <mx:WindowedApplication xmlns:mx="http://www.adobe.com/2006/mxml" creationComplete="init()"> <mx:Script> <![CDATA[ import flash.data.SQLConnection; import flash.data.SQLResult; import flash.data.SQLStatement; import flash.errors.SQLError; private function init():void { // ... create and open the SQLConnection instance named conn ... // create the SQL statement var selectStmt:SQLStatement = new SQLStatement(); selectStmt.sqlConnection = conn; // define the SQL text var sql:String = "SELECT firstName, lastName " + "FROM employees"; selectStmt.text = sql; try { // execute the statement selectStmt.execute(); // access the result data var result:SQLResult = selectStmt.getResult(); var numRows:int = result.data.length; for (var i:int = 0; i < numRows; i++) { var output:String = ""; for (var columnName:String in result.data[i]) { output += columnName + ": "; output += result.data[i][columnName] + "; "; } trace("row[" + i.toString() + "]\t", output); } } catch (error:SQLError) { trace("Error message:", error.message); trace("Details:", error.details); } } ]]> </mx:Script> </mx:WindowedApplication>
748
recuperar la primera vez que se ejecuta la declaracin. Cuando llame al mtodo execute()de la instancia de
SQLStatement, especifique un valor de parmetro prefetch y solo se recupera dicho nmero de filas: var stmt:SQLStatement = new SQLStatement(); stmt.sqlConnection = conn; stmt.text = "SELECT ..."; stmt.addEventListener(SQLEvent.RESULT, selectResult); stmt.execute(20); // only the first 20 rows (or fewer) are returned
La declaracin distribuye el evento result, indicando que est disponible el primer conjunto de filas de resultados. La propiedad data de la instancia de SQLResult resultante contiene las filas de datos y la propiedad complete indica si hay filas de resultados adicionales para recuperar. Para recuperar filas de resultados adicionales, llame al mtodo next() de la instancia SQLStatement. Al igual que el mtodo execute(), se usa el primer parmetro del mtodo next() para indicar la cantidad de filas que se recuperan la prxima vez que se distribuye el evento result.
749
function selectResult(event:SQLEvent):void { var result:SQLResult = stmt.getResult(); if (result.data != null) { // ... loop through the rows or perform other processing ... if (!result.complete) { stmt.next(20); // retrieve the next 20 rows } else { stmt.removeEventListener(SQLEvent.RESULT, selectResult); } } }
El SQLStatement distribuye un evento result cada vez que el mtodonext() devuelve un conjunto posterior de filas de resultados. En consecuencia, la misma funcin del detector se puede usar para continuar procesando los resultados (de las llamadas a next()) hasta que se hayan recuperado todas las filas. Para obtener ms informacin, consulte las descripciones en la referencia de para el mtodo SQLStatement.execute() (la descripcin del parmetro prefetch) y el mtodo SQLStatement.next().
Insercin de datos
Adobe AIR 1.0 y posterior La adicin de datos a una base de datos implica ejecutar una declaracin SQL INSERT. Una vez que se termina de ejecutar la declaracin, puede acceder a la clave principal para la fila recientemente insertada si la base de datos gener la clave.
750
// ... create and open the SQLConnection instance named conn ... // create the SQL statement var insertStmt:SQLStatement = new SQLStatement(); insertStmt.sqlConnection = conn; // define the SQL text var sql:String = "INSERT INTO employees (firstName, lastName, salary) " + "VALUES ('Bob', 'Smith', 8000)"; insertStmt.text = sql; // register listeners for the result and failure (status) events insertStmt.addEventListener(SQLEvent.RESULT, insertResult); insertStmt.addEventListener(SQLErrorEvent.ERROR, insertError); // execute the statement insertStmt.execute(); function insertResult(event:SQLEvent):void { trace("INSERT statement succeeded"); } function insertError(event:SQLErrorEvent):void { trace("Error message:", event.error.message); trace("Details:", event.error.details); } <?xml version="1.0" encoding="utf-8"?> <mx:WindowedApplication xmlns:mx="http://www.adobe.com/2006/mxml" creationComplete="init()"> <mx:Script> <![CDATA[ import flash.data.SQLConnection; import flash.data.SQLResult; import flash.data.SQLStatement; import flash.events.SQLErrorEvent; import flash.events.SQLEvent; private function init():void { // ... create and open the SQLConnection instance named conn ... // create the SQL statement var insertStmt:SQLStatement = new SQLStatement(); insertStmt.sqlConnection = conn; // define the SQL text var sql:String = "INSERT INTO employees (firstName, lastName, salary) " +
751
"VALUES ('Bob', 'Smith', 8000)"; insertStmt.text = sql; // register listeners for the result and failure (status) events insertStmt.addEventListener(SQLEvent.RESULT, insertResult); insertStmt.addEventListener(SQLErrorEvent.ERROR, insertError); // execute the statement insertStmt.execute(); } private function insertResult(event:SQLEvent):void { trace("INSERT statement succeeded"); } private function insertError(event:SQLErrorEvent):void { trace("Error message:", event.error.message); trace("Details:", event.error.details); } ]]> </mx:Script> </mx:WindowedApplication>
En el siguiente ejemplo se aade una fila de datos a la tabla de empelados existente, usando el modo de ejecucin sincrnico. Observe que este cdigo supone que existe una instancia SQLConnection denominada conn que ya se ha creado y est conectada a una base de datos. Asimismo supone que la tabla employees ya ha sido creada.
752
// ... create and open the SQLConnection instance named conn ... // create the SQL statement var insertStmt:SQLStatement = new SQLStatement(); insertStmt.sqlConnection = conn; // define the SQL text var sql:String = "INSERT INTO employees (firstName, lastName, salary) " + "VALUES ('Bob', 'Smith', 8000)"; insertStmt.text = sql; try { // execute the statement insertStmt.execute(); trace("INSERT statement succeeded"); } catch (error:SQLError) { trace("Error message:", error.message); trace("Details:", error.details); }
753
<?xml version="1.0" encoding="utf-8"?> <mx:WindowedApplication xmlns:mx="http://www.adobe.com/2006/mxml" creationComplete="init()"> <mx:Script> <![CDATA[ import flash.data.SQLConnection; import flash.data.SQLResult; import flash.data.SQLStatement; import flash.errors.SQLError; private function init():void { // ... create and open the SQLConnection instance named conn ... // create the SQL statement var insertStmt:SQLStatement = new SQLStatement(); insertStmt.sqlConnection = conn; // define the SQL text var sql:String = "INSERT INTO employees (firstName, lastName, salary) " + "VALUES ('Bob', 'Smith', 8000)"; insertStmt.text = sql; try { // execute the statement insertStmt.execute(); trace("INSERT statement succeeded"); } catch (error:SQLError) { trace("Error message:", error.message); trace("Details:", error.details); } } ]]> </mx:Script> </mx:WindowedApplication>
Recuperacin de la clave principal generada por la base de datos de una fila insertada
Adobe AIR 1.0 y posterior A menudo, despus de insertar una fila de datos en una tabla, el cdigo necesita conocer una clave principal generada por la base de datos o un valor del identificador de fila para la fila recientemente insertada. Por ejemplo, una vez que inserta una fila en una tabla, puede aadir filas en una tabla relacionada. En ese caso querr insertar el valor de la clave principal como una clave externa en la tabla relacionada. La clave principal de la fila recientemente insertada se puede recuperar usando el objeto SQLResult asociado a la ejecucin de la declaracin. Este es el mismo objeto que se utiliza para acceder a los datos del resultado despus de ejecutar una declaracin SELECT. Como con cualquier declaracin SQL, cuando se completa la ejecucin de una declaracin INSERT el motor de ejecucin crea una instancia SQLResult. Se accede a la instancia de SQLResult llamando al mtodo getResult() del objeto SQLStatement si se usa un detector
754
de evento o si usa el modo de ejecucin sincrnico. Como alternativa, si usa el modo de ejecucin asncrono y pasa una instancia de Responder a la llamada execute(), la instancia SQLResult se pasa como un argumento a la funcin de control de resultados. En cualquier caso, la instancia SQLResult tiene una a propiedad, lastInsertRowID, que contiene el identificador de fila de la fila ms recientemente insertada si la declaracin SQL ejecutada es una declaracin INSERT. En el siguiente ejemplo se demuestra el acceso a la clave principal de una fila insertada en el modo de ejecucin asncrono:
insertStmt.text = "INSERT INTO ..."; insertStmt.addEventListener(SQLEvent.RESULT, resultHandler); insertStmt.execute(); function resultHandler(event:SQLEvent):void { // get the primary key var result:SQLResult = insertStmt.getResult(); var primaryKey:Number = result.lastInsertRowID; // do something with the primary key }
En el siguiente ejemplo se demuestra el acceso a la clave principal de una fila insertada en el modo de ejecucin sincrnico:
insertStmt.text = "INSERT INTO ..."; try { insertStmt.execute(); // get the primary key var result:SQLResult = insertStmt.getResult(); var primaryKey:Number = result.lastInsertRowID; // do something with the primary key } catch (error:SQLError) { // respond to the error }
Observe que el identificador de fila puede o no ser el valor de la columna que est designada como la columna de la clave principal en la definicin de la tabla, segn las siguientes reglas:
Si se define la tabla con una columna de clave principal cuya afinidad (tipo de datos de columna) es INTEGER, la
propiedad lastInsertRowID contiene el valor que se insert en esa fila (o el valor generado por el motor de ejecucin si es una columna AUTOINCREMENT).
Si se define la tabla con mltiples columnas de clave principal (una clave compuesta) o con una sola columna de
clave principal cuya afinidad no es INTEGER, en segundo plano la base de datos genera un valor del identificador de fila. Dicho valor generado es el valor de la propiedad lastInsertRowID.
El valor siempre es el identificador de fila de la fila ms recientemente insertada. Si una declaracin INSERT activa
un desencadenador y a su vez inserta una fila, la propiedad lastInsertRowID contiene el identificador de fila de la ltima fila insertada por el desencadenador en lugar de la fila creada por la declaracin INSERT.
755
Como consecuencia, si desea tener una columna de clave principal explcitamente definida cuya variable est disponible despus de un comando INSERT a travs de la propiedad SQLResult.lastInsertRowID, la columna debe estar definida como una columna INTEGER PRIMARY KEY. Aunque la tabla no incluye una columna explcita INTEGER PRIMARY KEY, resulta igualmente aceptable utilizar el identificador de fila generado por la base de datos como una clave principal para la tabla en el sentido de definir relaciones con tablas relacionadas. El valor de la columna del identificador de fila est disponible en cualquier declaracin SQL utilizando uno de los nombres especiales de columna ROWID, _ROWID_ o OID. Puede crear una columna de clave externa en una tabla relacionada y usar el valor del identificador de fila como el valor de la columna de la clave externa como lo hara con una columna INTEGER PRIMARY KEY explcitamente declarada. En ese sentido, si est usando una clave principal arbitraria en lugar de una clave natural y siempre y cuando no le importe que el motor de ejecucin genere el valor de la clave principal, no hay diferencia si utiliza una columna INTEGER PRIMARY KEY o el identificador de fila generado por el sistema como la clave principal de la tabla para definir una relacin de clave externa entre dos tablas. Para obtener ms informacin sobre las claves principales y los identificadores de fila generados, consulte Compatibilidad de SQL en bases de datos locales en la pgina 1125.
Para cambiar los datos existentes en una tabla, use una declaracin UPDATE. Para eliminar una o varias filas de datos de una tabla, use una declaracin DELETE.
Para ver las descripciones de estas declaraciones, consulte Compatibilidad de SQL en bases de datos locales en la pgina 1125.
756
Como alternativa, tambin puede crear mltiples instancias SQLConnection en una aplicacin, cada cual conectada a una o mltiples bases de datos. Sin embargo, si se utilizan mltiples conexiones a la misma base de datos tenga en cuenta que la transaccin de una base de datos no se comparte con otras instancias SQLConnection. En consecuencia, si se conecta al mismo archivo de base de datos usando mltiples instancias SQLConnection, no puede esperar que se apliquen los cambios de datos de ambas conexiones en la manera esperada. Por ejemplo, si dos declaraciones UPDATE o DELETE se ejecutan en la misma base de datos a travs de diferentes instancias SQLConnection y se produce un error de aplicacin despus de que se realiza una operacin, es posible que los datos de la base de datos queden en un estado intermedio que no es reversible y puede afectar la integridad de la base de datos (y, en consecuencia, a la aplicacin).
Errores de conexin
Adobe AIR 1.0 y posterior La mayora de los errores de la base de datos son errores de conexin y se pueden producir durante cualquier operacin. Aunque hay estrategias para prevenir errores de conexin, rara vez hay una manera fcil para recuperarse de un error de conexin si la base de datos es una parte vital de la aplicacin. La mayora de los errores de conexin estn relacionados con la manera en que el motor de ejecucin interacta con el sistema operativo, el sistema de archivos y el archivo de base de datos. Por ejemplo, un error de conexin se produce si el usuario no tiene permiso para crear un archivo de base de datos en una determinada ubicacin en el sistema de archivos. Las siguientes estrategias ayudan a prevenir errores de conexin:
Utilizar archivos de base de datos especficos del usuario En lugar de utilizar un slo archivo de base de datos para
todos los usuarios que usan la aplicacin en un slo equipo, proporcione a cada usuario su propio archivo de base de datos. El archivo se debe ubicar en un directorio asociado con la cuenta del usuario. Por ejemplo, puede estar en el directorio de almacenamiento de la aplicacin, en la carpeta de documentos del usuario, en el escritorio del usuario etc.
Considerar diferentes tipos de usuario Pruebe la aplicacin con diferentes tipos de cuentas de usuario, en diferentes
sistemas operativos. No suponga que el usuario tiene permiso de administrador en el equipo. Asimismo, no suponga que el individuo que instala la aplicacin es el usuario que ejecuta la aplicacin.
Considerar diferentes ubicaciones de archivo Si permite que un usuario especifique dnde guardar un archivo de base de datos o seleccionar un archivo para abrir, considere las posibles ubicaciones de archivo que puede utilizar el usuario. Adems, considere definir los lmites dnde los usuarios pueden almacenar (o desde donde pueden abrir) archivos de base de datos. Por ejemplo, podra slo permitir que los usuarios abran los archivos que se encuentran en la ubicacin de almacenamiento de sus cuentas de usuario.
Si se produce un error de conexin, muy probablemente ocurra en el primer intento de crear o abrir la base de datos. Esto significa que el usuario no puede realizar ninguna operacin relacionada con la base de datos en la aplicacin. Para ciertos tipos de errores, como errores de slo lectura o de permiso, una tcnica de recuperacin posible es copiar el archivo de la base de datos en una ubicacin diferente. La aplicacin puede copiar el archivo de la base de datos en una ubicacin diferente de la que el usuario tiene permiso para crear y escribir en los archivos y, en cambio, utilizar esa ubicacin.
757
Errores de sintaxis
Adobe AIR 1.0 y posterior Un error de sintaxis se produce cuando una declaracin SQL se forma incorrectamente y la aplicacin intenta ejecutar la declaracin. Dado que las declaraciones SQL de la base de datos local se crean como cadenas, no es posible verificar la sintaxis SQL durante el tiempo de compilacin. Se deben ejecutar todas las declaraciones SQL para verificar la sintaxis. Utilice las siguientes estrategias para prevenir errores de sintaxis SQL:
Probar detalladamente todas las declaraciones SQL Si es posible, mientras desarrolla la aplicacin pruebe las
declaraciones SQL de forma separada antes de codificarlas como texto de la declaracin en el cdigo de aplicacin. Adems, use un mtodo de prueba de cdigo como probar las unidades para crear un conjunto de pruebas que ejecutan todas las opciones y variaciones posibles en el cdigo.
Utilizar parmetros de declaracin y evitar la concatenacin SQL (generada dinmicamente). El uso de parmetros y evitar las declaraciones SQL creadas dinmicamente, significa que el mismo texto de la declaracin SQL se usa cada vez que se ejecuta una declaracin. En consecuencia, es ms fcil probar las declaraciones y limitar posibles variaciones. Si debe generar dinmicamente una declaracin SQL, reduzca al mnimo las partes dinmicas de la declaracin. Asimismo, valide cuidadosamente cualquier entrada del usuario para asegurarse de que no causar errores de sintaxis.
Para recuperarse de un error de sintaxis, una aplicacin necesitara una lgica compleja para poder examinar una declaracin SQL y corregir la sintaxis. Si se siguen las pautas anteriores para prevenir errores de sintaxis, el cdigo puede identificar cualquier origen de tiempo de ejecucin potencial de errores de sintaxis SQL (como entradas del usuario utilizadas en una declaracin). Para recuperarse de un error de sintaxis, debe asesorar al usuario. Indique lo que se debe corregir para que la declaracin se pueda ejecutar correctamente.
Errores de restriccin
Adobe AIR 1.0 y posterior Los errores de restriccin ocurren cuando una declaracin INSERT o UPDATE intenta aadir datos a una columna. El error se produce si los nuevos datos infringen una de las restricciones definidas para la tabla o columna. A continuacin se describe el conjunto de posibles restricciones:
Restriccin exclusiva Indica que en todas las filas de una tabla, no pueden haber valores repetidos en una columna.
Como alternativa, cuando se combinan mltiples columnas en una restriccin exclusiva, la combinacin de valores en dichas columnas no se debe repetir. Es decir, con respecto a la o las columnas exclusivas especificadas, cada fila debe ser diferente.
Restriccin de clave principal En cuanto a los datos que permite y no permite una restriccin, una restriccin de clave principal es idntica a una restriccin exclusiva. Restriccin de valor null Especifica que una sola columna no puede almacenar un valor NULL y, en consecuencia, en cada fila dicha columna debe tener un valor. Restriccin de verificacin Permite especificar una restriccin arbitraria en una o ms tablas. Una restriccin de
verificacin comn es una regla que define que el valor de una columna debe estar dentro de ciertos lmites (por ejemplo, que el valor numrico de una columna debe ser mayor que 0). Otro tipo comn de restriccin de verificacin especifica las relaciones entre valores de columna (por ejemplo, que el valor de una columna debe ser diferente al valor de otra columna en la misma fila).
Restriccin de tipos de datos (afinidad de columna) El motor de ejecucin impone el tipo de datos de los valores de las columnas y se produce un error si se intenta almacenar un valor del tipo incorrecto en una columna. Sin embargo, en muchas condiciones los valores se convierten para que coincidan con el tipo de datos declarados de la columna. Consulte Trabajo con tipos de datos de la base de datos en la pgina 759 para ms informacin.
758
El motor de ejecucin no impone restricciones en los valores de claves externas. Es decir, los valores de claves externas no tienen que coincidir con el valor de una clave principal existente. Adems de los tipos de restriccin predefinidos, el motor SQL de tiempo de ejecucin admite el uso de desencadenadores. Un desencadenador es similar a un controlador de eventos. Es un conjunto de instrucciones predefinidas que se llevan a cado cuando se produce una determinada accin. Por ejemplo, se puede definir un desencadenador para que se ejecute cuando se introducen o eliminan datos de una tabla en particular. Un uso posible de un desencadenador es examinar los cambios de datos y generar un error si no se cumplen determinadas condiciones. En consecuencia, un desencadenador puede tener el mismo fin que una restriccin y las estrategias para prevenir y recuperarse de errores de restriccin tambin se aplican a los errores generados por el desencadenador. Sin embargo, el ID de error para errores generados por el desencadenador es diferente del ID de error para errores de restriccin. El conjunto de restricciones que se aplica a una tabla en particular se determina mientras que se disea una aplicacin. La creacin consciente de restricciones facilita el diseo de la aplicacin para prevenir y recuperarse de errores de restriccin. Sin embargo, los errores de restriccin son difciles de predecir y prevenir sistemticamente. La prediccin es difcil porque los errores de restriccin no aparecen hasta que se aaden datos de aplicacin. Los errores de restriccin se generan con los datos que se aaden a una base de datos despus de que se crea. Estos errores con frecuencia son el resultado de la relacin entre los nuevos datos que ya existen en la base de datos. Las siguientes estrategias le pueden ayudar a evitar muchos errores de restriccin:
Planificar cuidadosamente la estructura y las restricciones de la base de datos El objetivo de las restricciones es
imponer las reglas de aplicacin y ayudar a proteger la integridad de los datos de la base de datos. Cuando est planificando la aplicacin, considere la manera de estructurar la base de datos para que sea compatible con la aplicacin. Como parte de ese proceso, identifique reglas para los datos, como por ejemplo si se requieren ciertos valores, si un valor tiene un valor predeterminado, si se permiten valores repetidos etc. Esas reglas lo guan para definir las restricciones de la base de datos.
Especificar explcitamente los nombres de las columnas Se puede escribir una declaracin INSERT sin especificar
explcitamente las columnas donde se deben insertar los valores, pero hacerlo es correr un riesgo innecesario. Al nombrar explcitamente las columnas donde se insertan los valores, se puede permitir el uso de valores generados automticamente, columnas con valores predeterminados y columnas que permiten valores NULL. Adems, al hacerlo garantiza que todas las columnas NOT NULL tienen insertadas un valor explicito.
Utilizar valores predeterminados Cuando especifica una restriccin NOT NULLpara una columna, si es posible,
especifique un valor predeterminado en la definicin de la columna. El cdigo de la aplicacin tambin puede proporcionar valores predeterminados. Por ejemplo, el cdigo puede verificar si una variable String es null y asignarle un valor antes de usarla para definir un valor al parmetro de declaracin.
Validar los datos introducidos por el usuario Verifique con antelacin los datos introducidos por el usuario para
asegurarse de cumplen con los lmites especificados por las restricciones, especialmente en el caso de las restricciones NOT NULL y CHECK. Naturalmente, una restriccin UNIQUE es ms difcil de verificar dado que al hacerlo se requiere la ejecucin de una consulta SELECT para determinar si los datos son exclusivos.
Utilizar desencadenadores Puede escribir un desencadenador que valida (y posiblemente remplaza) los datos
insertados o toma otras acciones para corregir los datos no vlidos. Esta validacin y correccin puede prevenir la generacin de un error de restriccin. En muchos sentidos los errores de restriccin son ms difciles de prevenir que otros tipos de errores. Afortunadamente, existen estrategias para recuperarse de errores de restriccin de manera que no desestabilice ni desactive la aplicacin:
Utilizar algoritmos de conflicto Cuando define una restriccin en una columna y cuando crea una declaracin INSERT
o UPDATE, tiene la opcin de especificar un algoritmo de conflicto. Un algoritmo de conflicto define la accin que implementa la base de datos cuando se genera una infraccin de restriccin. Existen varias acciones posibles que puede
759
implementar el motor de base de datos. El motor de base de datos puede terminar una sola declaracin o toda una transaccin. Puede omitir el error. Hasta puede quitar datos antiguos y reemplazarlos con los datos que el cdigo intenta almacenar. Para obtener ms informacin, consulte la seccin ON CONFLICT (algoritmos de conflicto) en Compatibilidad de SQL en bases de datos locales en la pgina 1125.
Proporcionar comentarios constructivos se puede identificar con antelacin el conjunto de restricciones que pueden
afectar un determinado SQL. En consecuencia, puede anticipar los errores de restriccin que podra generar una declaracin. Sabiendo esto, puede hacer que la lgica de la aplicacin responda a un error de restriccin. Por ejemplo, supongamos que una aplicacin incluye un formulario de entrada de datos para introducir nuevos productos. Si la columna del nombre del producto en la base de datos se define con una restriccin UNIQUE, la accin de insertar una nueva fila de producto en la base de datos podra generar un error de restriccin. En consecuencia, se disea la aplicacin para que anticipe un error de restriccin. Cuando se produce el error, la aplicacin alerta al usuario indicando que el nombre de producto especificado ya est en uso y le solicita al usuario que elija uno diferente. Otra respuesta posible es permitir que el usuario vea informacin sobre el otro producto con el mismo nombre.
760
761
var conn:SQLConnection = new SQLConnection(); // The database file is in the application storage directory var folder:File = File.applicationStorageDirectory; var dbFile:File = folder.resolvePath("DBSample.db"); // open the database conn.open(dbFile, OpenMode.UPDATE); // start a transaction conn.begin(); // add the customer record to the database var insertCustomer:SQLStatement = new SQLStatement(); insertCustomer.sqlConnection = conn; insertCustomer.text = "INSERT INTO customers (firstName, lastName) " + "VALUES ('Bob', 'Jones')"; insertCustomer.execute(); var customerId:Number = insertCustomer.getResult().lastInsertRowID; // add a related phone number record for the customer var insertPhoneNumber:SQLStatement = new SQLStatement(); insertPhoneNumber.sqlConnection = conn; insertPhoneNumber.text = "INSERT INTO customerPhoneNumbers (customerId, number) " + "VALUES (:customerId, '800-555-1234')"; insertPhoneNumber.parameters[":customerId"] = customerId; insertPhoneNumber.execute(); // commit the transaction conn.commit();
Como puede ver, se llama a los mismos mtodos para realizar las operaciones de base de datos independientemente si utiliza la ejecucin sincrnica o asncrona. Las diferencias principales entre los dos mtodos son ejecutar una operacin que depende de otra operacin y la gestin de errores.
762
var conn:SQLConnection = new SQLConnection(); // The database file is in the application storage directory var folder:File = File.applicationStorageDirectory; var dbFile:File = folder.resolvePath("DBSample.db"); // open the database conn.open(dbFile, SQLMode.UPDATE); // start a transaction conn.begin(); // add the customer record to the database var insertCustomer:SQLStatement = new SQLStatement(); insertCustomer.sqlConnection = conn; insertCustomer.text = "INSERT INTO customers (firstName, lastName) " + "VALUES ('Bob', 'Jones')"; insertCustomer.execute(); var customerId:Number = insertCustomer.getResult().lastInsertRowID; // add a related phone number record for the customer var insertPhoneNumber:SQLStatement = new SQLStatement(); insertPhoneNumber.sqlConnection = conn; insertPhoneNumber.text = "INSERT INTO customerPhoneNumbers (customerId, number) " + "VALUES (:customerId, '800-555-1234')"; insertPhoneNumber.parameters[":customerId"] = customerId; insertPhoneNumber.execute(); // commit the transaction conn.commit();
763
var conn:SQLConnection = new SQLConnection(); // The database file is in the application storage directory var folder:File = File.applicationStorageDirectory; var dbFile:File = folder.resolvePath("DBSample.db"); // open the database conn.open(dbFile, SQLMode.UPDATE); // start a transaction conn.begin(); try { // add the customer record to the database var insertCustomer:SQLStatement = new SQLStatement(); insertCustomer.sqlConnection = conn; insertCustomer.text = "INSERT INTO customers (firstName, lastName)" + "VALUES ('Bob', 'Jones')"; insertCustomer.execute(); var customerId:Number = insertCustomer.getResult().lastInsertRowID; // add a related phone number record for the customer var insertPhoneNumber:SQLStatement = new SQLStatement(); insertPhoneNumber.sqlConnection = conn; insertPhoneNumber.text = "INSERT INTO customerPhoneNumbers (customerId, number)" + "VALUES (:customerId, '800-555-1234')"; insertPhoneNumber.parameters[":customerId"] = customerId; insertPhoneNumber.execute(); // if we've gotten to this point without errors, commit the transaction conn.commit(); } catch (error:SQLError) { // rollback the transaction conn.rollback(); }
764
Internamente, cuando se ejecutan operaciones de base de datos usando el modo de ejecucin asncrono, cada conexin de base de datos (cada instancia de SQLConnection) tiene su propia cola o lista de operaciones que debe llevar a cabo. El motor de ejecucin ejecuta cada operacin en secuencia, en el orden en que se aaden a la cola. Cuando se crea una instancia SQLStatement y se llama al mtodo execute(), esa operacin de ejecucin de la declaracin se aade a la cola para la conexin. Si no se est ejecutando ninguna operacin en esa instancia SQLConnection, la declaracin comienza la ejecucin en segundo plano. Supongamos que dentro del mismo bloque de cdigo crea otra instancia SQLStatement y tambin llama al mtodo execute((). Esa segunda operacin de ejecucin de la declaracin se aade a la cola detrs de la primera declaracin. En cuanto termina la ejecucin de la primera declaracin, el motor de ejecucin se traslada a la siguiente operacin en la cola. El procesamiento de las operaciones posteriores en la cola ocurre en segundo plano, aun cuando el evento result para la primera operacin se est distribuyendo en el cdigo la aplicacin principal. En el siguiente cdigo se demuestra esta tcnica:
// Using asynchronous execution mode var stmt1:SQLStatement = new SQLStatement(); stmt1.sqlConnection = conn; // ... Set statement text and parameters, and register event listeners ... stmt1.execute(); // At this point stmt1's execute() operation is added to conn's execution queue. var stmt2:SQLStatement = new SQLStatement(); stmt2.sqlConnection = conn; // ... Set statement text and parameters, and register event listeners ... stmt2.execute(); // At this point stmt2's execute() operation is added to conn's execution queue. // When stmt1 finishes executing, stmt2 will immediately begin executing // in the background.
Hay un efecto colateral importante si la base de datos ejecuta automticamente declaraciones posteriores en la cola. Si una declaracin depende del resultado de otra operacin, no se puede aadir la declaracin a la cola (es decir, no se puede llamar al mtodo execute()) hasta que la primera operacin se complete. Esto se debe a que una vez que se ha llamado al mtodo execute() de la segunda declaracin no se pueden cambiar las propiedades text o parameters de la instruccin. En ese caso se debe esperar a que el evento indique que la primera operacin est completada antes de comenzar con la siguiente operacin. Por ejemplo, si desea ejecutar una declaracin en el contexto de una transaccin, la ejecucin de la declaracin depende de la operacin de abrir la transaccin. Despus de llamar al mtodo SQLConnection.begin() para abrir la transaccin, necesita esperar a que la instancia SQLConnection distribuya el evento begin. Solo entonces puede llamar al mtodo execute() de la instancia SQLStatement. En este ejemplo la manera ms fcil de organizar la aplicacin para asegurar que las operaciones se ejecutan correctamente es crear un mtodo que est registrado como un detector para el evento begin. El cdigo para llamar al mtodo SQLStatement.execute() se coloca dentro del mtodo del detector.
765
Una memoria cach de slo lectura de datos de aplicacin privada descargados desde un servidor. Un almacn de aplicacin local para datos privados que est sincronizado con un servidor (los datos se envan al
servidor y se descargan desde el mismo).
Archivos cifrados utilizados como formato de archivo para documentos creados y editados por la aplicacin. Los
archivos pueden ser privados para un usuario, o bien, pueden estar diseados para compartirse entre todos los usuarios de la aplicacin.
Cualquier otro uso de un almacn de datos local como, por ejemplo, los que se describen en Usos de las bases de
datos SQL locales en la pgina 720, donde los datos deben ser privados para los usuarios que disponen de acceso al equipo o a los archivos de la base de datos. Conocer el motivo por el que se desea utilizar una base de datos cifrada ayuda a decidir la forma en que se plantea la arquitectura de la aplicacin. En concreto, puede afectar al modo en que la aplicacin crea, obtiene o almacena la clave de cifrado para la base de datos. Para obtener ms informacin sobre estos puntos, consulte Consideraciones para el uso del cifrado con una base de datos en la pgina 769. Adems de una base de datos cifrada, un mecanismo alternativo para proteger la privacidad de datos importantes es el almacn local cifrado. Con el almacn local cifrado, se almacena un solo valor ByteArray utilizando una clave String. nicamente la aplicacin de AIR que almacen el valor puede acceder al mismo y slo en el equipo en el que est almacenado. Con el almacn local cifrado, no es necesario crear una clave de cifrado propia. Por estos motivos, el almacn local cifrado resulta ms adecuado para almacenar fcilmente un solo valor o conjunto de valores que se pueden codificar con facilidad en un objeto ByteArray. Una base de datos cifrada es ms apropiada para conjuntos de datos ms grandes donde el almacenamiento de datos estructurados y las consultas resultan ms recomendables. Para obtener ms informacin sobre el uso del almacn local cifrado, consulte Almacenamiento local cifrado en la pgina 715.
766
Para obtener un ejemplo que muestre un modo recomendado de generar una clave de cifrado, consulte Ejemplo: Generacin y uso de claves de cifrado en la pgina 770.
767
En el siguiente ejemplo se muestra la apertura de una base de datos cifrada en modo de ejecucin asncrono. Para que resulte ms fcil, en este ejemplo la clave de cifrado est programada en el cdigo de la aplicacin. Sin embargo, el uso de esta tcnica no es recomendable porque no es segura.
import import import import import flash.data.SQLConnection; flash.data.SQLMode; flash.events.SQLErrorEvent; flash.events.SQLEvent; flash.filesystem.File;
var conn:SQLConnection = new SQLConnection(); conn.addEventListener(SQLEvent.OPEN, openHandler); conn.addEventListener(SQLErrorEvent.ERROR, errorHandler); var dbFile:File = File.applicationStorageDirectory.resolvePath("DBSample.db"); var encryptionKey:ByteArray = new ByteArray(); encryptionKey.writeUTFBytes("Some16ByteString"); // This technique is not secure! conn.openAsync(dbFile, SQLMode.UPDATE, null, false, 1024, encryptionKey); function openHandler(event:SQLEvent):void { trace("the database opened successfully"); } function errorHandler(event:SQLErrorEvent):void { if (event.error.errorID == 3138) { trace("Incorrect encryption key"); } else { trace("Error message:", event.error.message); trace("Details:", event.error.details); } }
En el siguiente ejemplo se muestra la apertura de una base de datos cifrada en modo de ejecucin sincrnico. Para que resulte ms fcil, en este ejemplo la clave de cifrado est programada en el cdigo de la aplicacin. Sin embargo, el uso de esta tcnica no es recomendable porque no es segura.
768
import flash.data.SQLConnection; import flash.data.SQLMode; import flash.filesystem.File; var conn:SQLConnection = new SQLConnection(); var dbFile:File = File.applicationStorageDirectory.resolvePath("DBSample.db"); var encryptionKey:ByteArray = new ByteArray(); encryptionKey.writeUTFBytes("Some16ByteString"); // This technique is not secure! try { conn.open(dbFile, SQLMode.UPDATE, false, 1024, encryptionKey); trace("the database was created successfully"); } catch (error:SQLError) { if (error.errorID == 3138) { trace("Incorrect encryption key"); } else { trace("Error message:", error.message); trace("Details:", error.details); } }
Para obtener un ejemplo que muestre un modo recomendado de generar una clave de cifrado, consulte Ejemplo: Generacin y uso de claves de cifrado en la pgina 770.
Por otra parte, si la conexin de base de datos se abre usando el mtodo openAsync(), la operacin reencrypt() es asncrona. Al llamar a reencrypt(), comienza el proceso de nuevo cifrado. Cuando la operacin finaliza, el objeto SQLConnection distribuye un evento reencrypt. El detector de eventos se emplea para determinar cundo finaliza el nuevo cifrado:
769
var newKey:ByteArray = new ByteArray(); // ... generate the new key and store it in newKey conn.addEventListener(SQLEvent.REENCRYPT, reencryptHandler); conn.reencrypt(newKey); function reencryptHandler(event:SQLEvent):void { // save the fact that the key changed }
La operacin reencrypt() se ejecuta en su propia transaccin. Si la operacin se interrumpe o falla (por ejemplo, si la aplicacin se cierra antes de que finalice la operacin), la transaccin se deshace. En este caso, la clave de cifrado original es an la clave de cifrado para la base de datos. El mtodo reencrypt() no se puede utilizar para eliminar el cifrado de una base de datos. La transmisin de un valor
null o de una clave de cifrado que no es un objeto ByteArray de 16 bytes al mtodo reencrypt(), genera un error.
Para que cualquier usuario que tenga acceso a la aplicacin pueda acceder a una base de datos en cualquier equipo,
utilice una sola clave que est disponible en todas las instancias de la aplicacin. Por ejemplo, la primera vez que se ejecute una aplicacin, puede descargar la clave de cifrado compartida de un servidor mediante un protocolo seguro como, por ejemplo, SSL. Despus puede guardar la clave en el almacn local cifrado para su uso posterior. Como alternativa, cifre los datos por usuario en el equipo y sincroncelos con un almacn de datos remoto como, por ejemplo, un servidor para hacer que la informacin sea porttil.
Para que un solo usuario pueda acceder a una base de datos en cualquier equipo, genere la clave de cifrado a partir
de un secreto de usuario (por ejemplo, una contrasea). En especial, no utilice ningn valor que est asociado a un equipo concreto (por ejemplo, un valor almacenado en el almacn local cifrado) para generar la clave. Como alternativa, cifre los datos por usuario en el equipo y sincroncelos con un almacn de datos remoto como, por ejemplo, un servidor para hacer que la informacin sea porttil.
770
Para que nicamente un usuario concreto pueda acceder a una base de datos en un solo equipo, genere la clave a
partir de una contrasea y un valor salt generado. Para ver un ejemplo de esta tcnica, consulte Ejemplo: Generacin y uso de claves de cifrado en la pgina 770. A continuacin se incluyen consideraciones sobre seguridad adicionales que son importantes tener en cuenta a la hora de disear una aplicacin que utilice una base de datos cifrada:
Un sistema slo es seguro en su vnculo ms dbil. Si usa una contrasea introducida por el usuario para generar
una clave de cifrado, tenga en cuenta la aplicacin de restricciones de complejidad y longitud mnima en las contraseas. Una contrasea corta que slo utilice caracteres bsicos se puede adivinar rpidamente.
El cdigo fuente de una aplicacin de AIR se almacena en un equipo de usuario en texto sin formato (para
contenido HTML), o bien, en un formato binario que se puede descompilar (para contenido SWF). Debido a que es posible acceder al cdigo fuente, se deben recordar dos puntos:
No programe nunca una clave de cifrado en el cdigo fuente. Se debe tener siempre en cuenta que la tcnica empleada para generar una clave de cifrado (por ejemplo,
generador de caracteres aleatorios o un algoritmo hash concreto) puede ser desvelada fcilmente por un atacante.
El cifrado de base de datos de AIR utiliza el algoritmo AES (Advanced Encryption Standard, estndar de cifrado
avanzado) con modo de contador con CBC-MAC (CCM). Este sistema de cifrado requiere que una clave introducida por el usuario se combine con un valor salt para ser segura. Para ver un ejemplo, consulte Ejemplo: Generacin y uso de claves de cifrado en la pgina 770.
Si opta por cifrar una base de datos, se cifrarn todos los archivos de disco utilizados por el motor de la base de datos
junto con dicha base de datos. Sin embargo, el motor de base de datos retiene algunos datos temporalmente en una cach de memoria interna para mejorar el rendimiento de lectura y escritura en las transacciones. Los datos residentes en memoria no estn cifrados. Si un atacante puede acceder a la memoria utilizada por una aplicacin de AIR (por ejemplo, mediante un depurador), la informacin de una base de datos que est abierta y sin cifrar actualmente podra quedar expuesta.
771
EncryptionKeyGenerator se incluye en el proyecto (as) de biblioteca principal de ActionScript 3.0 de cdigo abierto (3corelib). Puede descargar el paquete as3corelib, incluyendo el cdigo fuente y la documentacin. Tambin puede descargar el archivo SWC o los archivos de cdigo fuente desde la pgina del proyecto.
2 Site el cdigo fuente de la clase (o el archivo SWC as3corelib) en una ubicacin donde el cdigo fuente de la
4 Antes del punto donde el cdigo crea la base de datos o abre una conexin con la misma, aada cdigo para crear
La instancia de EncryptionKeyGenerator utiliza esta contrasea como base para la clave de cifrado (se muestra en el siguiente paso). La instancia de EncryptionKeyGenerator comprueba la contrasea con determinados requisitos de validacin de contrasea segura. Si la validacin falla, se produce un error. Tal y como muestra el cdigo de ejemplo, puede comprobar la contrasea con anterioridad llamando al mtodo validateStrongPassword() del objeto EncryptionKeyGenerator. De este modo, puede determinar si la contrasea cumple con los requisitos mnimos de una contrasea segura y evitar un error.
6 Genere la clave de cifrado a partir de la contrasea:
var encryptionKey:ByteArray = keyGenerator.getEncryptionKey(password);
El mtodo getEncryptionKey() genera y devuelve la clave de cifrado(ByteArray de 16 bytes). Posteriormente la clave de cifrado se puede utilizar para crear una nueva base de datos cifrada o abrir una existente. El mtodo getEncryptionKey() cuenta con un parmetro necesario, que es la contrasea obtenida en el paso 5. Nota: para mantener el nivel ms alto de seguridad y privacidad de los datos, una aplicacin debe solicitar al usuario que indique una contrasea cada vez que la aplicacin se conecte a la base de datos. No almacene la contrasea de usuario ni la clave de cifrado de la base de datos directamente. De este modo se expone a riesgos de seguridad. Tal y como se muestra en este ejemplo, una aplicacin debe emplear la misma tcnica para derivar la clave de cifrado de la contrasea, tanto al crear la base de datos cifrada como al conectarse a ella ms adelante. El mtodo getEncryptionKey() tambin acepta un segundo parmetro(opcional); el parmetro
overrideSaltELSKey. EncryptionKeyGenerator crea un valor aleatorio (denominado valor salt) que se usa como
parte de la clave de cifrado. Para poder volver a crear la clave de cifrado, el valor salt se almacena en el almacn local cifrado (ELS) de la aplicacin de AIR. De forma predeterminada, la clase EncryptionKeyGenerator utiliza una cadena concreta como clave de ELS. Aunque es poco probable, es posible que la clave pueda entrar en conflicto con otra clave que utilice la aplicacin. En lugar de utilizar la clave predeterminada, puede que desee especificar su propia clave de ELS. En este caso, especifique una clave personalizada transmitindola como segundo parmetro getEncryptionKey(), tal y como se muestra a continuacin:
772
var customKey:String = "My custom ELS salt key"; var encryptionKey:ByteArray = keyGenerator.getEncryptionKey(password, customKey);
Con una clave de cifrado devuelta por el mtodo getEncryptionKey(), el cdigo puede crear una nueva base de datos cifrada o intentar abrir la base de datos cifrada existente. En cualquier caso, se utiliza el mtodo open() u openAsync() de la clase SQLConnection, tal y como se describe en Creacin de una base de datos cifrada en la pgina 766 y Conexin con una base de datos cifrada en la pgina 766. En este ejemplo, la aplicacin est diseada para abrir la base de datos en modo de ejecucin asncrono. El cdigo establece los detectores de eventos apropiados y llama al mtodo openAsync(), transmitiendo la clave de cifrado como argumento final:
conn.addEventListener(SQLEvent.OPEN, openHandler); conn.addEventListener(SQLErrorEvent.ERROR, openError); conn.openAsync(dbFile, SQLMode.CREATE, null, false, 1024, encryptionKey);
En los mtodos del detector, el cdigo elimina los registros del detector de eventos. Despus muestra un mensaje de estado que indica si se cre o se abri la base de datos o si se produjo un error. La parte ms notable de estos controladores de eventos est en el mtodo openError(). En ese mtodo, una declaracin if comprueba si existe la base de datos (lo que significa que el cdigo est intentando conectarse a una base de datos existente) y si el ID de error coincide con la constante EncryptionKeyGenerator.ENCRYPTED_DB_PASSWORD_ERROR_ID. Si ambas condiciones se definen como true, probablemente significa que la contrasea introducida por el usuario no es correcta. (Tambin podra significar que el archivo especificado no es un archivo de base de datos.) A continuacin se muestra el cdigo que comprueba el ID de error:
if (!createNewDB && event.error.errorID == EncryptionKeyGenerator.ENCRYPTED_DB_PASSWORD_ERROR_ID) { statusMsg.text = "Incorrect password!"; } else { statusMsg.text = "Error creating or opening database."; }
Para obtener el cdigo completo de los detectores de eventos de ejemplo, consulte Cdigo de ejemplo completo para generar y utilizar una clave de cifrado en la pgina 772.
773
<?xml version="1.0" encoding="utf-8"?> <mx:WindowedApplication xmlns:mx="http://www.adobe.com/2006/mxml" layout="vertical" creationComplete="init();"> <mx:Script> <![CDATA[ import com.adobe.air.crypto.EncryptionKeyGenerator; private const dbFileName:String = "encryptedDatabase.db"; private var dbFile:File; private var createNewDB:Boolean = true; private var conn:SQLConnection; // ------- Event handling ------private function init():void { conn = new SQLConnection(); dbFile = File.applicationStorageDirectory.resolvePath(dbFileName); if (dbFile.exists) { createNewDB = false; instructions.text = "Enter your database password to open the encrypted database."; openButton.label = "Open Database"; } } private function openConnection():void { var password:String = passwordInput.text; var keyGenerator:EncryptionKeyGenerator = new EncryptionKeyGenerator(); if (password == null || password.length <= 0) { statusMsg.text = "Please specify a password."; return; } if (!keyGenerator.validateStrongPassword(password)) { statusMsg.text = "The password must be 8-32 characters long. It must contain at least one lowercase letter, at least one uppercase letter, and at least one number or symbol."; return; } passwordInput.text = ""; passwordInput.enabled = false; openButton.enabled = false; var encryptionKey:ByteArray = keyGenerator.getEncryptionKey(password); conn.addEventListener(SQLEvent.OPEN, openHandler); conn.addEventListener(SQLErrorEvent.ERROR, openError);
774
conn.openAsync(dbFile, SQLMode.CREATE, null, false, 1024, encryptionKey); } private function openHandler(event:SQLEvent):void { conn.removeEventListener(SQLEvent.OPEN, openHandler); conn.removeEventListener(SQLErrorEvent.ERROR, openError); statusMsg.setStyle("color", 0x009900); if (createNewDB) { statusMsg.text = "The encrypted database was created successfully."; } else { statusMsg.text = "The encrypted database was opened successfully."; } } private function openError(event:SQLErrorEvent):void { conn.removeEventListener(SQLEvent.OPEN, openHandler); conn.removeEventListener(SQLErrorEvent.ERROR, openError); if (!createNewDB && event.error.errorID == EncryptionKeyGenerator.ENCRYPTED_DB_PASSWORD_ERROR_ID) { statusMsg.text = "Incorrect password!"; } else { statusMsg.text = "Error creating or opening database."; } } ]]> </mx:Script> <mx:Text id="instructions" text="Enter a password to create an encrypted database. The next time you open the application, you will need to re-enter the password to open the database again." width="75%" height="65"/> <mx:HBox> <mx:TextInput id="passwordInput" displayAsPassword="true"/> <mx:Button id="openButton" label="Create Database" click="openConnection();"/> </mx:HBox> <mx:Text id="statusMsg" color="#990000" width="75%"/> </mx:WindowedApplication>
Ejemplo de Flash Professional El archivo FLA de la aplicacin contiene el cdigo fuente para una aplicacin sencilla que crea o abre una conexin con una base de datos cifrada. El archivo FLA dispone de cuatro componentes situados en el escenario:
775
Nombre de la instancia
instructions passwordInput openButton
Tipo de componente
Descripcin
Contiene las instrucciones dadas al usuario. Campo de entrada donde el usuario indica la contrasea. Botn en el que el usuario hace clic una vez introducida la contrasea. Muestra mensajes de estado (errores u operaciones correctas).
statusMsg
Etiqueta
El cdigo para la aplicacin se define en el fotograma clave del fotograma 1 de la lnea de tiempo principal. A continuacin se incluye el cdigo para la aplicacin:
import com.adobe.air.crypto.EncryptionKeyGenerator; const dbFileName:String = "encryptedDatabase.db"; var dbFile:File; var createNewDB:Boolean = true; var conn:SQLConnection; init(); // ------- Event handling ------function init():void { passwordInput.displayAsPassword = true; openButton.addEventListener(MouseEvent.CLICK, openConnection); statusMsg.setStyle("textFormat", new TextFormat(null, null, 0x990000)); conn = new SQLConnection(); dbFile = File.applicationStorageDirectory.resolvePath(dbFileName); if (dbFile.exists) { createNewDB = false; instructions.text = "Enter your database password to open the encrypted database."; openButton.label = "Open Database"; } else { instructions.text = "Enter a password to create an encrypted database. The next time you open the application, you will need to re-enter the password to open the database again."; openButton.label = "Create Database"; } } function openConnection(event:MouseEvent):void { var keyGenerator:EncryptionKeyGenerator = new EncryptionKeyGenerator(); var password:String = passwordInput.text; if (password == null || password.length <= 0)
776
{ statusMsg.text = "Please specify a password."; return; } if (!keyGenerator.validateStrongPassword(password)) { statusMsg.text = "The password must be 8-32 characters long. It must contain at least one lowercase letter, at least one uppercase letter, and at least one number or symbol."; return; } passwordInput.text = ""; passwordInput.enabled = false; openButton.enabled = false; var encryptionKey:ByteArray = keyGenerator.getEncryptionKey(password); conn.addEventListener(SQLEvent.OPEN, openHandler); conn.addEventListener(SQLErrorEvent.ERROR, openError); conn.openAsync(dbFile, SQLMode.CREATE, null, false, 1024, encryptionKey); } function openHandler(event:SQLEvent):void { conn.removeEventListener(SQLEvent.OPEN, openHandler); conn.removeEventListener(SQLErrorEvent.ERROR, openError); statusMsg.setStyle("textFormat", new TextFormat(null, null, 0x009900)); if (createNewDB) { statusMsg.text = "The encrypted database was created successfully."; } else { statusMsg.text = "The encrypted database was opened successfully."; } } function openError(event:SQLErrorEvent):void { conn.removeEventListener(SQLEvent.OPEN, openHandler); conn.removeEventListener(SQLErrorEvent.ERROR, openError); if (!createNewDB && event.error.errorID == EncryptionKeyGenerator.ENCRYPTED_DB_PASSWORD_ERROR_ID) { statusMsg.text = "Incorrect password!"; } else { statusMsg.text = "Error creating or opening database."; } }
777
este ejemplo):
var keyGenerator:EncryptionKeyGenerator = new EncryptionKeyGenerator(); var encryptionKey:ByteArray = keyGenerator.getEncryptionKey(password);
El primer paso que adopta la clase EncryptionKeyGenerator cuando se llama al mtodogetEncryptionKey() consiste en comprobar la contrasea introducida por el usuario para garantizar que cumple con los requisitos de longitud de contrasea. La clase EncryptionKeyGenerator requiere que una contrasea incluya de 8 a 32 caracteres. La contrasea debe incluir una mezcla de letras maysculas y minsculas y al menos un nmero o carcter de smbolos. La expresin regular que comprueba este modelo se define como una constante denominada
STRONG_PASSWORD_PATTERN: private static const STRONG_PASSWORD_PATTERN:RegExp = /(?=^.{8,32}$)((?=.*\d)|(?=.*\W+))(?![.\n])(?=.*[A-Z])(?=.*[a-z]).*$/;
El cdigo que comprueba la contrasea se encuentra en el mtodo validateStrongPassword() de la clase EncryptionKeyGenerator. El cdigo se presenta del siguiente modo:
778
public function vaidateStrongPassword(password:String):Boolean { if (password == null || password.length <= 0) { return false; } return STRONG_PASSWORD_PATTERN.test(password)) }
Internamente, el mtodo getEncryptionKey() llama a validateStrongPassword() de la clase EncryptionKeyGenerator y, si la contrasea no es vlida, emite una excepcin. validateStrongPassword() es un mtodo pblico, por lo que el cdigo de la aplicacin puede comprobar una contrasea sin llamar al mtodo getEncryptionKey() para evitar que se produzca un error. Ampliacin de la contrasea a 256 bits Adobe AIR 1.5 y posterior Ms adelante en el proceso, es necesario que la contrasea tenga una longitud de 256 bits. En lugar de requerir que cada usuario indique una contrasea que sea exactamente de una longitud de 256 bits (32 caracteres), el cdigo crea una contrasea ms larga mediante la repeticin de sus caracteres. El mtodo getEncryptionKey() llama al mtodo concatenatePassword() para llevar a cabo la tarea de crear la contrasea larga.
var concatenatedPassword:String = concatenatePassword(password);
Si la contrasea es inferior a 256 bits, el cdigo concatena la contrasea con s misma para que tenga 256. Si la longitud no es la deseada exactamente, la ltima repeticin se reduce para que se obtengan justo 256 bits.
779
Generacin o recuperacin de un valor salt de 256 bits Adobe AIR 1.5 y posterior El siguiente paso consiste en obtener un valor salt de 256 bits que en un paso posterior se combina con la contrasea. Un valor salt es un valor aleatorio que se aade o se combina con un valor introducido por el usuario para formar una contrasea. El uso de un valor salt con una contrasea asegura que aunque un usuario elija una palabra real o un trmino comn como contrasea, la combinacin de contrasea y valor salt que utiliza el sistema sea un valor aleatorio. Esto ayuda de forma aleatoria en la proteccin frente a un ataque de diccionario, donde el atacante utiliza una lista de palabras para intentar adivinar una contrasea. Asimismo, con la generacin del valor salt y su almacenamiento en el almacn local cifrado, se asocia a la cuenta del usuario en el equipo en el que se ubica el archivo de base de datos. Si la aplicacin llama al mtodo getEncryptionKey() por primera vez, el cdigo crea un valor salt aleatorio de 256 bits. De lo contrario, el cdigo carga el valor salt desde el almacn local cifrado. El valor salt se almacena en una variable denominada salt. El cdigo determina si ya se ha creado un valor salt, intentando cargar el valor desde el almacn local cifrado:
var salt:ByteArray = EncryptedLocalStore.getItem(saltKey); if (salt == null) { salt = makeSalt(); EncryptedLocalStore.setItem(saltKey, salt); }
Si el cdigo crea un nuevo valor salt, el mtodo makeSalt() genera un valor aleatorio de 256 bits. Debido a que el valor se almacena finalmente en el almacn local cifrado, se genera como un objeto ByteArray. El mtodo makeSalt() utiliza el mtodo Math.random() para generar el valor de forma aleatoria. El mtodo Math.random() no puede generar 256 bits de una sola vez. El cdigo utiliza un bucle para llamar a Math.random() ocho veces. Cada vez, se genera un valor uint aleatorio entre 0 y 4294967295 (valor uint mximo). El valor uint se utiliza para mayor comodidad, ya que un valor de este tipo usa exactamente 32 bits. Al escribir ocho valores uint en ByteArray, se genera un valor de 256 bits. A continuacin se incluye el cdigo para el mtodo makeSalt():
private function makeSalt():ByteArray { var result:ByteArray = new ByteArray; for (var i:uint = 0; i < 8; i++) { result.writeUnsignedInt(Math.round(Math.random() * uint.MAX_VALUE)); } return result; }
Cuando el cdigo guarda el valor salt en el almacn local cifrado (ELS) o lo recupera desde ELS, necesita una clave String bajo la que se guarda el valor salt. Si no se conoce la clave, el valor salt no podr recuperarse. En este caso, la clave de cifrado no puede volver a crearse cada vez que se vuelva a abrir la base de datos. De forma predeterminada, EncryptionKeyGenerator utiliza una clave de ELS predefinida que se define en la constante SALT_ELS_KEY. En lugar de emplear la clave predeterminada, el cdigo de la aplicacin tambin puede especificar una clave de ELS para utilizarla en la llamada al mtodo getEncryptionKey(). Tanto la clave predeterminada como la clave de ELS del valor salt especificada por la aplicacin se almacenan en una variable denominada saltKey. Esa variable se utiliza en las llamadas a EncryptedLocalStore.setItem() y EncryptedLocalStore.getItem(), tal y como se ha mostrado anteriormente.
780
Combinacin de la contrasea de 256 bits y el valor salt utilizando el operador XOR Adobe AIR 1.5 y posterior El cdigo cuenta ahora con una contrasea de 256 bits y un valor salt de 256 bits. A continuacin utiliza una operacin XOR en modo bit para combinar el valor salt y la contrasea concatenada en un solo valor. Realmente, esta tcnica crea una contrasea de 256 bits que consta de caracteres procedentes del intervalo completo de caracteres posibles. Este principio es verdadero, aunque es ms probable que la entrada de contrasea real conste de caracteres alfanumricos principalmente. Con este grado aumentado de aleatoriedad se obtiene la ventaja de crear el conjunto de posibles contraseas largas sin que el usuario deba introducir una contrasea extensa y compleja. El resultado de la operacin XOR se almacena en la variable unhashedKey. El proceso real de realizar una operacin XOR en modo bit en los dos valores se produce en el mtodo xorBytes().
var unhashedKey:ByteArray = xorBytes(concatenatedPassword, salt);
El operador XOR en modo bit (^) adopta dos valores uint y devuelve un valor de este tipo. (Un valor uint contiene 32 bits.) Los valores input transmitidos como argumentos al mtodo xorBytes() son un elemento String (contrasea) y un objeto ByteArray (valor salt). Por lo tanto, el cdigo utiliza un bucle para extraer 32 bits cada vez de cada entrada para combinar utilizando el operador XOR.
private function xorBytes(passwordString:String, salt:ByteArray):ByteArray { var result:ByteArray = new ByteArray(); for (var i:uint = 0; i < 32; i += 4) { // ... } return result; }
En el bucle, en primer lugar se extraen 32 bits (4 bytes) del parmetro passwordString. Estos bits se extraen y se convierten en un valor uint (o1) en un proceso de dos partes. En primer lugar, el mtodo charCodeAt() obtiene el valor numrico de cada carcter. A continuacin, el valor se desplaza a la posicin adecuada en el valor uint utilizando el operador de desplazamiento a la izquierda en modo bit (<<) y el valor desplazado se aade a o1. Por ejemplo, el primer carcter (i) pasa a ser los primeros 8 bits, utilizando el operador de desplazamiento a la izquierda en modo bit (<<) para desplazar los bits a la izquierda 24 bits y asignado este valor a o1. El segundo carcter (i + 1) pasa a ser los segundos 8 bits, desplazando su valor a la izquierda 16 bits y aadiendo el resultado a o1. Los valores de los caracteres tercero y cuarto se agregan del mismo modo.
// ... // Extract 4 bytes from the password string and convert to a uint var o1:uint = passwordString.charCodeAt(i) << 24; o1 += passwordString.charCodeAt(i + 1) << 16; o1 += passwordString.charCodeAt(i + 2) << 8; o1 += passwordString.charCodeAt(i + 3); // ...
La variable o1 contiene ahora 32 bits a partir del parmetro passwordString. Posteriormente, se extraen 32 bits del parmetro salt llamando a su mtodo readUnsignedInt(). Los 32 bits se almacenan en la variable uint o2.
781
Finalmente, los dos valores (uint) de 32 bits se combinan mediante el operador XOR y el resultado se escribe en un objeto ByteArray llamado result.
// ... var xor:uint = o1 ^ o2; result.writeUnsignedInt(xor); // ...
Una vez completado el bucle, se devuelve el objeto ByteArray que contiene el resultado XOR.
// ... } return result; }
Operaciones hash de la clave Adobe AIR 1.5 y posterior Una vez combinados el valor salt y la contrasea concatenada, el siguiente paso consiste en asegurar este valor incluyndolo en hash mediante el algoritmo hash SHA-256. Al incluir en hash el valor, resulta ms difcil para un atacante aplicarle una ingeniera inversa. En este momento el cdigo cuenta con un elemento ByteArray denominado unhashedKey que contiene la contrasea concatenada combinada con el valor salt. El proyecto de biblioteca principal (as3corelib) de ActionScript 3.0 incluye una clase SHA256 en el paquete com.adobe.crypto. El mtodo SHA256.hashBytes() que realiza un algoritmo hash SHA-256 en ByteArray y devuelve una cadena que contiene el resultado hash de 256 bits como nmero hexadecimal. El cdigo utiliza la clase EncryptionKeyGenerator para realizar la operacin de hash de la clave:
var hashedKey:String = SHA256.hashBytes(unhashedKey);
Extraccin de la clave de cifrado del hash Adobe AIR 1.5 y posterior La clave de cifrado debe ser un objeto ByteArray que cuente exactamente con 16 bytes (128 bits). El resultado del algoritmo hash SHA-256 siempre es 256 bits. Por lo tanto, en el paso final se seleccionan 128 bits del resultado de la operacin de hash para utilizar como clave de cifrado real. En la clase EncryptionKeyGenerator, el cdigo reduce la clave a 128 bits llamando al mtodo generateEncryptionKey(): Despus devuelve el resultado de ese mtodo como resultado de getEncryptionKey():
var encryptionKey:ByteArray = generateEncryptionKey(hashedKey); return encryptionKey;
No es necesario utilizar los primeros 128 bits como clave de cifrado. Puede seleccionar un intervalo de bits comenzando en un punto arbitrario, puede optar por cualquier otro bit, o bien, usar otro modo de seleccionar bits. Lo ms importante es que el cdigo seleccione 128 bits distintos y que los mismos 128 bits se utilicen cada vez.
782
En este caso, el mtodo generateEncryptionKey() usa el intervalo de bits que comienza en el byte en posicin 18 como clave de cifrado. Tal y como se mencion anteriormente, la clase SHA256 devuelve una cadena que contiene un hash de 256 bits como nmero hexadecimal. Un solo bloque de 128 bits tiene demasiados bytes para aadir a un elemento ByteArray a la vez. Por ello, el cdigo utiliza un bucle for para extraer caracteres de la cadena hexadecimal, convertirlos en valores numricos reales y agregarlos a ByteArray. La cadena de resultado de SHA-256 tiene 64 caracteres. Un intervalo de 128 bits es igual a 32 caracteres en la cadena, por lo que cada carcter representa 4 bits. El incremento ms bajo de datos que se puede agregar a ByteArray es un byte (8 bits), lo que equivale a dos caracteres en la cadena hash. Por lo tanto, el bucle cuenta de 0 a 31 (32 caracteres) en incrementos de 2 caracteres. En el bucle, el cdigo determina en primer lugar la posicin de inicio del par actual de caracteres. Debido a que el intervalo deseado comienza en el carcter en la posicin de ndice 17 (byte 18), a la variable position se le asigna el valor del iterador actual (i) ms 17. El cdigo utiliza el mtodo substr() del objeto String para extraer los dos caracteres en la posicin actual. Estos caracteres se almacenan en la variable hex. A continuacin, el cdigo utiliza el mtodo parseInt() para convertir la cadena hex en un valor entero decimal. Almacena este valor en la variable int byte. Finalmente, el cdigo agrega el valor en byte al objeto ByteArrayresult utilizando su mtodo writeByte(). Cuando finaliza el bucle, el objeto ByteArray result contiene 16 bytes y est listo para utilizarse como clave de cifrado de la base de datos.
private function generateEncryptionKey(hash:String):ByteArray { var result:ByteArray = new ByteArray(); for (var i:uint = 0; i < 32; i += 2) { var position:uint = i + 17; var hex:String = hash.substr(position, 2); var byte:int = parseInt(hex, 16); result.writeByte(byte); } return result; }
783
784
Utilizar declaraciones SQL por separado y no cambiar la propiedad text de la declaracin SQLStatement
Adobe AIR 1.0 y posterior Para cualquier declaracin SQL que se ejecuta ms de una vez en una aplicacin, cree una instancia SQLStatement por separado para cada declaracin SQL. Use esa instancia SQLStatement cada vez que se ejecuta el comando SQL. Por ejemplo, supongamos que est creando una aplicacin que incluye cuatro operaciones SQL diferentes que se llevan a cabo mltiples veces. En ese caso, cree cuatro instancias SQLStatement por separado y llame al mtodo execute() de cada instancia para ejecutarla. Evite la alternativa de utilizar una sola instancia SQLStatement para todas las declaraciones SQL, redefiniendo la propiedad text cada vez antes de ejecutar la declaracin.
785
Ms temas de ayuda
flash.utils.ByteArray flash.utils.IExternalizable Especificacin de formato de mensaje de accin
Mtodos de ByteArray
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior Todo flujo de datos significativo se organiza en un formato que se pueda analizar para localizar la informacin deseada. Una ficha en un archivo sencillo de empleados, por ejemplo, probablemente incluira un nmero de ID, nombre, direccin, telfono, etc. Un archivo de audio MP3 contiene una etiqueta ID3 que identifica el ttulo, autor, lbum, fecha de edicin y gnero del archivo que se descarga. El formato permite saber el orden en que cabe esperar los datos en el flujo de datos. Permite leer el flujo de bytes con inteligencia.
786
La clase ByteArray incluye varios mtodos que facilitan la lectura y escritura en un flujo de datos, entre ellos: readBytes() y writeBytes(), readInt() y writeInt(), readFloat() y writeFloat(), readObject() y writeObject(), y readUTFBytes() y writeUTFBytes(). Estos mtodos permiten leer datos desde el flujo de datos en variables de tipos de datos especficos y escribir desde tipos de datos especficos directamente en el flujo de datos binarios. En el siguiente ejemplo el cdigo lee un conjunto sencillo de cadenas y nmeros de punto flotante y escribe cada elemento en un ByteArray. La organizacin del conjunto permite que el cdigo llame a los mtodos adecuados de ByteArray (writeUTFBytes() y writeFloat()) para escribir los datos. El patrn de datos reiterado hace posible leer el conjunto con un bucle.
// The following example reads a simple Array (groceries), made up of strings // and floating-point numbers, and writes it to a ByteArray. import flash.utils.ByteArray; // define the grocery list Array var groceries:Array = ["milk", 4.50, "soup", 1.79, "eggs", 3.19, "bread" , 2.35] // define the ByteArray var bytes:ByteArray = new ByteArray(); // for each item in the array for (var i:int = 0; i < groceries.length; i++) { bytes.writeUTFBytes(groceries[i++]); //write the string and position to the next item bytes.writeFloat(groceries[i]);// write the float trace("bytes.position is: " + bytes.position);//display the position in ByteArray } trace("bytes length is: " + bytes.length);// display the length
Propiedad position
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior La propiedad "position" guarda la posicin actual del puntero que indexa el ByteArray durante la lectura o escritura. El valor inicial de la propiedad "position" es 0 (cero) como se muestra en el cdigo siguiente:
var bytes:ByteArray = new ByteArray(); trace("bytes.position is initially: " + bytes.position); // 0
Cuando se lee o escribe en un ByteArray, el mtodo empleado actualiza la propiedad de posicin para que apunte al lugar inmediatamente despus del ltimo byte ledo o escrito. En el siguiente ejemplo, el cdigo escribe una cadena en un ByteArray y despus la propiedad de posicin apunta al byte que sigue a dicha cadena en el ByteArray:
var bytes:ByteArray = new ByteArray(); trace("bytes.position is initially: " + bytes.position); // 0 bytes.writeUTFBytes("Hello World!"); trace("bytes.position is now: " + bytes.position);// 12
Asimismo, una operacin de lectura incrementa la propiedad de posicin con el nmero de bytes ledos.
var bytes:ByteArray = new ByteArray(); trace("bytes.position is initially: " + bytes.position); // 0 bytes.writeUTFBytes("Hello World!"); trace("bytes.position is now: " + bytes.position);// 12 bytes.position = 0; trace("The first 6 bytes are: " + (bytes.readUTFBytes(6)));//Hello trace("And the next 6 bytes are: " + (bytes.readUTFBytes(6)));// World!
787
Obsrvese que se puede definir la propiedad de posicin en un lugar concreto del ByteArray para leer o escribir en esa posicin desplazada.
Propiedad endian
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior Los ordenadores pueden variar en la forma en que guardan nmeros que requieren varios bytes de memoria. Un entero, por ejemplo, puede necesitar 4 bytes (32 bits) de memoria. En alguno ordenadores se guarda primero el byte ms significativo del nmero, en la direccin de memoria ms baja, y en otros se guarda primero el byte menos significativo. Este atributo del ordenador, o de la ordenacin de bytes, se denomina big endian (primero el byte ms significativo) o little endian (primero el byte menos significativo). Por ejemplo: el nmero 0x31323334 se guardara de la forma siguiente con ordenacin de bytes big endian y little endian, en que a0 representa la direccin de memoria ms baja de los 4 bytes y a3 representa la ms alta:
Big endian a0 31 Big endian a1 32 Big endian a2 33 Big endian a3 34
Little endian a0 34
Little endian a1 33
Little endian a2 32
Little endian a3 31
La propiedad endian de la clase ByteArray permite indicar este orden de bytes para los nmeros de varios bytes que se procesen. Los valores aceptables para esta propiedad son "bigEndian" o "littleEndian" y la clase Endian define las constantes BIG_ENDIAN y LITTLE_ENDIAN para definir la propiedad endian con estas cadenas.
788
Los datos codificados siguen al marcador de tipo, a menos que el marcador represente un solo valor posible (como "null", "true" o "false"), en cuyo caso no se codifica nada ms. Existen dos versiones de AMF: AMF0 y AMF3. AMF 0 es compatible con la transmisin de objetos complejos por referencia y admite puntos finales para restaurar relaciones de objetos. AMF 3 representa una mejora de AMF 0 al enviar cadenas y caractersticas de objetos mediante referencia, adems de referencias de objetos, y al admitir nuevos tipos de datos que se introdujeron en ActionScript 3.0. La propiedad ByteArray.objectEcoding especifica la versin de AMF que se utiliza para codificar los datos de objeto. La clase flash.net.ObjectEncoding define las constantes para especificar la versin de AMF: ObjectEncoding.AMF0 y ObjectEncoding.AMF3. En el siguiente ejemplo se llama a writeObject() para escribir un objeto XML en un ByteArray, que a continuacin se comprime con el algoritmo deflate y se escribe en el archivo order en el escritorio. En el ejemplo se utiliza una etiqueta para presentar el mensaje Wrote order file to desktop! en la ventana de AIR una vez terminada la operacin.
789
/* The following lines, minus comment characters , are for Flex version: * <?xml version="1.0" encoding="utf-8"?> * <mx:WindowedApplication xmlns:mx="http://www.adobe.com/2006/mxml" layout="absolute" * creationComplete="init();"> * <mx:Script> * <![CDATA[ */ import flash.filesystem.*; import flash.utils.ByteArray; // import mx.controls.Label for Flex import fl.controls.Label // for Flash; Label component must be in Library // for Flex: private function init():void { var bytes:ByteArray = new ByteArray(); var myLabel:Label = new Label(); myLabel.move(150, 150); myLabel.width = 200; addChild(myLabel); var myXML:XML = <order> <item id='1'> <menuName>burger</menuName> <price>3.95</price> </item> <item id='2'> <menuName>fries</menuName> <price>1.45</price> </item> </order> // Write XML object to ByteArray bytes.writeObject(myXML); bytes.position = 0;//reset position to beginning bytes.compress(CompressionAlgorithm.DEFLATE);// compress ByteArray outFile("order", bytes); myLabel.text = "Wrote order file to desktop!"; // for Flex: } // end of init()function outFile(fileName:String, data:ByteArray):void { var outFile:File = File.desktopDirectory; // dest folder is desktop outFile = outFile.resolvePath(fileName); // name of file to write var outStream:FileStream = new FileStream(); // open output file stream in WRITE mode outStream.open(outFile, FileMode.WRITE); // write out the file outStream.writeBytes(data, 0, data.length); // close it outStream.close(); } /* Add the following lines for Flex, minus comment characters: * ]]> * </mx:Script> * </mx:WindowedApplication> */
790
El mtodo readObject() lee un objeto de un ByteArray en AMF serializado y lo guarda en un objeto del tipo especificado. En el siguiente ejemplo se lee el archivo order del escritorio para ponerlo en un ByteArray (inBytes), se descomprime y se llama a readObject() para guardarlo en el objeto XML orderXML. En el ejemplo se utiliza una construccin de bucle for each() para aadir cada nodo a un rea de texto para su visualizacin. En el ejemplo se muestra tambin el valor de la propiedad objectEncoding junto con una cabecera para el contenido del archivo order.
/* The following lines, minus comment characters, are for Flex version: * <?xml version="1.0" encoding="utf-8"?> * <mx:WindowedApplication xmlns:mx="http://www.adobe.com/2006/mxml" layout="absolute" * creationComplete="init();"> * <mx:Script> * <![CDATA[ */ import flash.filesystem.*; import flash.utils.ByteArray; import fl.controls.TextArea; // in Flash, TextArea component must be in Library // for Flex version: import mx.controls; // for Flex version: private function init():void {var inBytes:ByteArray = new ByteArray(); // define text area for displaying XML content var myTxt:TextArea = new TextArea(); myTxt.width = 550; myTxt.height = 400; addChild(myTxt); //display objectEncoding and file heading myTxt.text = "Object encoding is: " + inBytes.objectEncoding + "\n\n" + "order file: \n\n"; readFile("order", inBytes); inBytes.position = 0; // reset position to beginning inBytes.uncompress(CompressionAlgorithm.DEFLATE); inBytes.position = 0;//reset position to beginning // read XML Object var orderXML:XML = inBytes.readObject(); //for each node in orderXML for each(var child:XML in orderXML) { // append child node to text area myTxt.text += child + "\n"; } // for Flex version: } // end of init() // read specified file into byte array function readFile(fileName:String, data:ByteArray) { var inFile:File = File.desktopDirectory; // source folder is desktop inFile = inFile.resolvePath(fileName); // name of file to read var inStream:FileStream = new FileStream(); inStream.open(inFile, FileMode.READ); inStream.readBytes(data, 0, data.length); inStream.close(); } /* Add the following lines, minus comment characters, for Flex: * ]]> * </mx:Script> * * </mx:WindowedApplication> */
791
Despus de la cabecera del archivo vienen los datos del archivo, que pueden estar comprimidos o sin comprimir, segn el indicador de mtodo de compresin. El indicador ser 0 (cero) si los datos estn sin comprimir, u 8 si los datos estn comprimidos con el algoritmo DEFLATE, u otro valor para otros algoritmos de compresin. La interfaz de usuario para este ejemplo consta de una etiqueta y un rea de texto (taFiles). La aplicacin escribe la informacin siguiente en el rea de texto para cada archivo que encuentra en el archivo .zip: el nombre del archivo, el tamao comprimido y el tamao sin comprimir. El siguiente documento MXML define la interfaz de usuario para la versin Flex de la aplicacin:
792
<?xml version="1.0" encoding="utf-8"?> <mx:WindowedApplication xmlns:mx="http://www.adobe.com/2006/mxml" layout="vertical" creationComplete="init();"> <mx:Script> <![CDATA[ // The application code goes here ]]> </mx:Script> <mx:Form> <mx:FormItem label="Output"> <mx:TextArea id="taFiles" width="320" height="150"/> </mx:FormItem> </mx:Form> </mx:WindowedApplication>
Define los objetos File (zfile) y FileStream (zStream) para representar el archivo .zip, y especifica la ubicacin del
archivo .zip del que se extrajeron los archivos (un archivo llamado HelloAIR.zip en el directorio del escritorio).
// File variables for accessing .zip file var zfile:File = File.desktopDirectory.resolvePath("HelloAIR.zip"); var zStream:FileStream = new FileStream();
793
En Flex, el cdigo del programa empieza en el mtodo init(), al que se llama como controlador de creationComplete para la etiqueta raz mx:WindowedApplication.
// for Flex private function init():void {
A continuacin define la propiedad endian de bytes en LITTLE_ENDIAN para indicar que el orden de bytes de los campos numricos es con el byte menos significativo primero.
bytes.endian = Endian.LITTLE_ENDIAN;
Seguidamente, la sentencia while() inicia un bucle que contina hasta que la posicin actual en la secuencia de archivos sea superior o igual al tamao del archivo.
while (zStream.position < zfile.size) {
La primera sentencia del bucle lee los 30 primeros bytes de la secuencia de archivos para ponerlo en el ByteArray bytes. Los 30 primeros bytes conforman la parte de tamao fijo de la cabecera del primer archivo.
// read fixed metadata portion of local file header zStream.readBytes(bytes, 0, 30);
A continuacin el cdigo lee un entero (signature) en los primeros bytes de la cabecera de 30 bytes. La definicin del formato ZIP estipula que la firma de cada cabecera de archivo es el valor hexadecimal 0x04034b50; si la firma es distinta, significa que el cdigo se refiere a la parte del archivo .zip que es ajena a los archivos y no hay ms archivos que extraer. En ese caso el cdigo sale inmediatamente del bucle while en lugar de esperar hasta alcanzar el final del conjunto de bytes.
bytes.position = 0; signature = bytes.readInt(); // if no longer reading data files, quit if (signature != 0x04034b50) { break; }
La siguiente parte del bucle lee el byte de la cabecera en la posicin de desplazamiento 8 y guarda el valor en la variable compMethod. Este byte contiene un valor que indica el mtodo de compresin que se utiliz para comprimir este archivo. Se admiten varios mtodos de compresin, pero en la prctica para casi todos los archivos .zip se utiliza el algoritmo de compresin DEFLATE. Si el archivo actual est comprimido con compresin DEFLATE, compMethod es 8; si el archivo est sin comprimir, compMethod es 0.
bytes.position = 8; compMethod = bytes.readByte(); // store compression method (8 == Deflate)
A los 30 primeros bytes sigue una parte de longitud variable de la cabecera que contiene el nombre del archivo y, tal vez, un campo adicional. El tamao de esta parte se guarda en la variable offset. El tamao se calcula sumando la longitud del nombre del archivo y la longitud del campo adicional, ledas en la cabecera en las posiciones de desplazamiento 26 y 28.
794
offset = 0;// stores length of variable portion of metadata bytes.position = 26; // offset to file name length flNameLength = bytes.readShort();// store file name offset += flNameLength; // add length of file name bytes.position = 28;// offset to extra field length xfldLength = bytes.readShort(); offset += xfldLength;// add length of extra field
A continuacin el programa lee la parte de longitud variable de la cabecera de archivo donde se indica la cantidad de bytes guardados en la variable offset.
// read variable length bytes between fixed-length header and compressed file data zStream.readBytes(bytes, 30, offset);
El programa lee el nombre del archivo en la parte de longitud variable de la cabecera y lo muestra en el rea de texto junto con los tamaos del archivo comprimido (en el archivo zip) y sin comprimir (original).
// Flash version bytes.position = 30; fileName = bytes.readUTFBytes(flNameLength); // read file name taFiles.appendText(fileName + "\n"); // write file name to text area bytes.position = 18; compSize = bytes.readUnsignedInt(); // store size of compressed portion taFiles.appendText("\tCompressed size is: " + compSize + '\n'); bytes.position = 22; // offset to uncompressed size uncompSize = bytes.readUnsignedInt(); // store uncompressed size taFiles.appendText("\tUncompressed size is: " + uncompSize + '\n');
// Flex version bytes.position = 30; fileName = bytes.readUTFBytes(flNameLength); // read file name taFiles.text += fileName + "\n"; // write file name to text area bytes.position = 18; compSize = bytes.readUnsignedInt(); // store size of compressed portion taFiles.text += "\tCompressed size is: " + compSize + '\n'; bytes.position = 22; // offset to uncompressed size uncompSize = bytes.readUnsignedInt(); // store uncompressed size taFiles.text += "\tUncompressed size is: " + uncompSize + '\n';
En el ejemplo se lee el resto del archivo de la secuencia de archivos para ponerlo en bytes durante la longitud especificada por el tamao comprimido, sobrescribiendo la cabecera del archivo en los primeros 30 bytes. El tamao comprimido es exacto aunque el archivo est sin comprimir porque en ese caso el tamao comprimido es igual al tamao del archivo sin comprimir.
// read compressed file to offset 0 of bytes; for uncompressed files // the compressed and uncompressed size is the same if (compSize == 0) continue; zStream.readBytes(bytes, 0, compSize);
A continuacin el cdigo en el ejemplo descomprime el archivo comprimido y llama a la funcin outfile() para escribirlo en la secuencia de archivos de salida. Pasa a outfile() el nombre del archivo y el conjunto de bytes que contiene los datos del archivo.
if (compMethod == 8) // if file is compressed, uncompress { bytes.uncompress(CompressionAlgorithm.DEFLATE); } outFile(fileName, bytes); // call outFile() to write out the file
795
En el ejemplo mencionado anteriormente, bytes.uncompress(CompressionAlgorithm.DEFLATE) slo funcionar en las aplicaciones de AIR. Para no compimir los datos desinflados para AIR y Flash Player, invoque la funcin inflate() de ByteArray. Las llaves finales indican el final del bucle while y del mtodo init() y el cdigo de la aplicacin de Flex, excepto para el mtodo outFile(). La ejecucin regresa al principio del bucle while y sigue procesando los siguientes bytes del archivo .zip, sea extrayendo otro archivo o finalizando el procesamiento del archivo .zip si es que se ha procesado el ltimo archivo.
} // end of while loop } // for Flex version, end of init() method and application
La funcin outfile() abre un archivo de salida en modo WRITE (lectura) en el escritorio y le da el nombre suministrado por el parmetro filename. A continuacin escribe los datos de los archivos del parmetro data en la secuencia de archivos de salida (outStream) y cierra el archivo.
// Flash version function outFile(fileName:String, data:ByteArray):void { var outFile:File = File.desktopDirectory; // destination folder is desktop outFile = outFile.resolvePath(fileName); // name of file to write var outStream:FileStream = new FileStream(); // open output file stream in WRITE mode outStream.open(outFile, FileMode.WRITE); // write out the file outStream.writeBytes(data, 0, data.length); // close it outStream.close(); } private function outFile(fileName:String, data:ByteArray):void { var outFile:File = File.desktopDirectory; // dest folder is desktop outFile = outFile.resolvePath(fileName); // name of file to write var outStream:FileStream = new FileStream(); // open output file stream in WRITE mode outStream.open(outFile, FileMode.WRITE); // write out the file outStream.writeBytes(data, 0, data.length); // close it outStream.close(); }
796
URLLoader
HTTP, HTTPS
FileReference
Cualquiera
HTTP
NetConnection
Sound
HTTP
XMLSocket
XML
TCP
Socket
Cualquiera
TCP
SecureSocket (AIR)
Cualquiera
ServerSocket (AIR)
Cualquiera
TCP
DatagramSocket (AIR)
Cualquiera
UDP
797
A menudo, cuando se crea una aplicacin web resulta til almacenar informacin persistente sobre el estado de la aplicacin del usuario. Las pginas y las aplicaciones suelen usar cookies para esto. En Flash Player, puede utilizar la clase SharedObject para el mismo fin. Consulte Objetos compartidos en la pgina 706. (La clase SharedObject se puede utilizar en aplicaciones de AIR, pero hay menos restricciones cuando slo se guardan los datos en un archivo normal.) Cuando la aplicacin de Flash Player o de AIR necesita comunicarse con otra aplicacin de Flash Player o de AIR en el mismo equipo, puede utilizar la clase LocalConnection. Por ejemplo, dos (o ms) archivos SWF de la misma pgina web pueden comunicarse entre s. Del mismo modo, un archivo SWF que se ejecute en una pgina web puede comunicarse con una aplicacin de AIR. Consulte Conexin con otras instancias de Flash Player y AIR en la pgina 838. Cuando necesite comunicarse con otros procesos no SWF del equipo local, puede utilizar la clase NativeProcess aadida en AIR 2. La clase NativeProcess permite a la aplicacin de AIR iniciar y comunicarse con otras aplicaciones. Consulte Comunicacin con procesos nativos en AIR en la pgina 845. Cuando necesite informacin sobre el entorno de red del equipo en el que se ejecuta la aplicacin de AIR, puede utilizar las siguientes clases:
NetworkInfo: proporciona informacin sobre las interfaces de red disponibles, como la direccin IP del equipo.
Consulte Interfaces de red en la pgina 798.
DNSResolver: permite buscar en registros del DNS. Consulte Registros del sistema de nombres de dominio
(DNS) en la pgina 802.
URLMonitor: permite supervisar la disponibilidad de un recurso en una URL particular. Consulte Control de
HTTP en la pgina 801.
datos pueden estar almacenados en un archivo que se carga directamente o en una base de datos u otra forma, y se recuperan llamando a scripts o programas que se ejecutan en un servidor.
Variables con codificacin URL El formato de codificacin URL permite representar varias variables (pares de nombre y valor de variables) en una sola cadena de texto. Las variables individuales se escriben con el formato nombre=valor. Cada variable (es decir, cada par nombre-valor) se separa con caracteres ampersand del modo siguiente: variable1=valor1&variable2=valor2. De este modo, es posible enviar un nmero indefinido de variables en un nico mensaje. Tipo MIME Cdigo estndar empleado para identificar el tipo de un archivo determinado en comunicaciones de Internet. Cualquier tipo de archivo tiene un cdigo especfico que se utiliza para su identificacin. Cuando se enva un archivo o un mensaje, un programa (como un servidor web o la instancia de Flash Player o AIR de un usuario) especifica el tipo de archivo que se enva. HTTP protocolo de transferencia de hipertexto. Es un formato estndar para entregar pginas web y otros tipos de
798
Mtodo de peticin Cuando una aplicacin (como una aplicacin de AIR o un navegador web) enva un mensaje
(denominado solicitud HTTP) a un servidor web, los datos enviados pueden incorporarse en la solicitud de dos maneras distintas: los dos mtodos de solicitud GET y POST. En el extremo del servidor, el programa que recibe la solicitud tendr que mirar en la parte apropiada de la solicitud para encontrar los datos, por lo que el mtodo de solicitud utilizado para enviar datos desde ActionScript debe coincidir con el mtodo de solicitud utilizado para leer los datos en el servidor.
Conexin de socket Conexin constante para permitir la comunicacin entre dos ordenadores. Carga Envo de un archivo a otro equipo. Descarga Recuperacin de un archivo de otro equipo.
Interfaces de red
Adobe AIR 2 y posterior El objeto NetworkInfo se puede utilizar para descubrir las interfaces de red de hardware y software disponibles en la aplicacin. NetworkInfo es un objeto singleton y no es necesario crear uno. Utilice la propiedad de clase esttica, networkInfo, para acceder a un solo objeto NetworkInfo. El objeto NetworkInfo tambin distribuye un evento networkChange cuando cambia una de las interfaces disponibles. Llame al mtodo findInterfaces() para obtener una lista de objetos NetworkInterface. Cada objeto NetworkInterface de la lista describe una de las interfaces disponible. El objeto NetworkInterface proporciona informacin como la direccin IP, la direccin de hardware, la unidad de transmisin mxima y si la interfaz est activa. En el siguiente ejemplo de cdigo se realiza el seguimiento de las propiedades de NetworkInterface en cada interfaz del equipo cliente:
package { import flash.display.Sprite; import flash.net.InterfaceAddress; import flash.net.NetworkInfo; import flash.net.NetworkInterface; public class NetworkInformationExample extends Sprite { public function NetworkInformationExample() { var networkInfo:NetworkInfo = NetworkInfo.networkInfo; var interfaces:Vector.<NetworkInterface> = networkInfo.findInterfaces(); if( interfaces != null ) { trace( "Interface count: " + interfaces.length ); for each ( var interfaceObj:NetworkInterface in interfaces ) { trace( "\nname: " + interfaceObj.name ); trace( "display name: " + interfaceObj.displayName ); trace( "mtu: " + interfaceObj.mtu );
799
trace( "active?: " + interfaceObj.active ); trace( "parent interface: " + interfaceObj.parent ); trace( "hardware address: " + interfaceObj.hardwareAddress ); if( interfaceObj.subInterfaces != null ) { trace( "# subinterfaces: " + interfaceObj.subInterfaces.length ); } trace("# addresses: " + interfaceObj.addresses.length ); for each ( var address:InterfaceAddress in interfaceObj.addresses ) { trace( " type: " + address.ipVersion ); trace( " address: " + address.address ); trace( " broadcast: " + address.broadcast ); trace( " prefix length: " + address.prefixLength ); } } } } } }
NetworkInfo NetworkInterface InterfaceAddress Flexpert: Detecting the network connection type with Flex 4.5 (Flexpert: Deteccin del tipo de conexin de red con
Flex 4.5; en ingls)
800
El evento networkChange no indica un cambio en toda la actividad de la red, sino solamente que ha cambiado la conexin. AIR no intenta interpretar el significado del cambio en la red. Un ordenador conectado en red puede tener muchas conexiones reales y virtuales, de modo que si se pierde una conexin, no significa necesariamente que se pierde un recurso. Por otro lado, las conexiones nuevas tampoco garantizan una mejor disponibilidad del recurso. A veces una conexin nueva puede incluso bloquear el acceso a los recursos que antes estaban disponibles (por ejemplo, cuando se realiza una conexin a una VPN). En general, la nica forma de que una aplicacin determine si puede conectarse a un recurso remoto es intentar hacerlo. La arquitectura de supervisin del servicio proporciona medios basados en eventos para responder a los cambios de conectividad de red en un host especificado. Nota: el marco de supervisin del servicio detecta si un servidor responde a una peticin de forma aceptable. Una comprobacin correcta no garantiza la total conectividad. Los servicios web escalables hacen uso frecuente de los aparatos de cach y equilibrio de carga para redirigir el flujo de trfico a un grupo de servidores web. En esta situacin, los proveedores de servicios slo ofrecen un diagnstico parcial de la conectividad de la red.
Professional.
4 En esta carpeta, localice /frameworks/libs/air/aircore.swc (para AIR 2) o /frameworks/libs/air/servicemonitor.swc
801
Flash CS3 Professional Para utilizar estas clases en Adobe Flash CS3 Professional, arrastre el componente ServiceMonitorShim del panel Componentes a la Biblioteca y despus aada la siguiente sentencia import al cdigo ActionScript 3.0:
import air.net.*;
Control de HTTP
Adobe AIR 1.0 y posterior La clase URLMonitor determina si se pueden realizar peticiones de HTTP a una direccin especificada en el puerto 80 (el puerto habitual para la comunicacin con HTTP). El siguiente cdigo utiliza una instancia de la clase URLMonitor para detectar cambios de conectividad con el sitio web de Adobe:
import air.net.URLMonitor; import flash.net.URLRequest; import flash.events.StatusEvent; var monitor:URLMonitor; monitor = new URLMonitor(new URLRequest('http://www.example.com')); monitor.addEventListener(StatusEvent.STATUS, announceStatus); monitor.start(); function announceStatus(e:StatusEvent):void { trace("Status change. Current status: " + monitor.available); }
Control de Socket
Adobe AIR 1.0 y posterior Las aplicaciones de AIR tambin pueden utilizar conexiones de socket para la conectividad modelo "push". Por razones de seguridad, los cortafuegos y encaminadores de red suelen restringir la comunicacin por la red a travs de puertos no autorizados. Por este motivo los desarrolladores deben tener en cuenta la posibilidad de que los usuarios no puedan realizar conexiones de socket. El siguiente cdigo utiliza una instancia de la clase SocketMonitor para detectar cambios de conectividad en una conexin de socket. El puerto supervisado es 6667, un puerto comn para IRC:
import air.net.ServiceMonitor; import flash.events.StatusEvent; socketMonitor = new SocketMonitor('www.example.com',6667); socketMonitor.addEventListener(StatusEvent.STATUS, socketStatusChange); socketMonitor.start(); function announceStatus(e:StatusEvent):void { trace("Status change. Current status: " + socketMonitor.available); }
802
Si el servidor de socket requiere una conexin segura, puede utilizar la clase SecureSocketMonitor en vez de SocketMonitor.
ARecord: direccin IPv4 de un host. AAAARecord: direccin IPv6 de un host. MXRecord: registro de intercambio de correo para un host. PTRRecord: nombre de host para una direccin IP. SRVRecord: registro de servicio para un servicio..
Para buscar en un registro, se transmite una cadena de consulta y el objeto de la clase que representa el tipo de registro al mtodo lookup() del objeto DNSResolver. La cadena de consulta depende del tipo de registro:
Clase de registro Cadena de consulta Cadena de consulta de ejemplo example.com example.com example.com 208.77.188.166 _sip._tcp.example.com
Nombre de host Nombre de host Nombre de host Direccin IP Identificador de servicio: _service._protocol.host
803
public class DNSResolverExample extends Sprite { public function DNSResolverExample() { var resolver:DNSResolver = new DNSResolver(); resolver.addEventListener( DNSResolverEvent.LOOKUP, lookupComplete ); resolver.addEventListener( ErrorEvent.ERROR, lookupError ); resolver.lookup( "example.com.", ARecord ); } private function lookupComplete( event:DNSResolverEvent ):void { trace( "Query string: " + event.host ); trace( "Record count: " + event.resourceRecords.length ); for each( var record:* in event.resourceRecords ) { if( record is ARecord ) trace( record.address ); } } private function lookupError( error:ErrorEvent ):void { trace("Error: " + error.text ); } } }
804
Ms temas de ayuda
Paquete flash.net Conexin a sockets en la pgina 1087
Sockets TCP
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior El protocolo TCP (Transmission Control Protocol) proporciona un modo de intercambiar mensajes a travs de una conexin de red permanente. TCP garantiza que los mensajes enviados llegan en el orden adecuado (siempre y cuando no haya serios problemas de red). Las conexiones TCP requieren un cliente y un servidor. Flash Player puede crear sockets de cliente. Adobe AIR puede, adems, crear sockets de servidor. Las siguientes API de ActionScript proporcionan conexiones TCP:
Socket: permite que una aplicacin cliente pueda conectarse a un servidor. La clase Socket no detecta conexiones
entrantes.
SecureSocket (AIR): permite que una aplicacin cliente pueda conectarse a un servidor de confianza e iniciar una
comunicacin cifrada.
ServerSocket (AIR): permite que una aplicacin detecte conexiones entrantes y acte como servidor. XMLSocket: permite que una aplicacin cliente se conecte a un servidor XMLSocket.
805
Clase Socket
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior La clase Socket, introducida en ActionScript, permite que el cdigo ActionScript realice conexiones de socket, y que lea y escriba datos binarios sin formato. La clase Socket resulta til para interactuar con servidores que utilicen protocolos binarios. Se pueden utilizar conexiones de socket binario para escribir cdigo que permita la interaccin con varios protocolos de Internet distintos, como POP3, SMTP, IMAP y NNTP. Esto, a su vez, permite a las aplicaciones conectarse a servidores de correos y noticias. Flash Player puede interactuar con un servidor directamente mediante el protocolo binario de dicho servidor. Algunos servidores utilizan el orden de bytes big-endian y otros emplean little-endian. La mayora de los servidores de Internet utilizan big-endian, ya que es el "orden de bytes de la red". El orden de bytes littleEndian es popular porque la arquitectura Intel x86 lo utiliza. Debe utilizarse el orden de bytes Endian que coincida con el orden de bytes del servidor que enva o recibe los datos. Todas las operaciones que se realizan mediante las interfaces IDataInput e IDataOutput, y las clases que implementan dichas interfaces (ByteArray, Socket y URLStream) se codifican de forma predeterminada en formato bigEndian. Esto supone que el byte ms significativo va primero. El orden de bytes predeterminado se elige para que coincida con el de Java y con el orden de bytes de red oficial. Para cambiar entre el uso de orden de bytes bigEndian o littleEndian, se puede establecer la propiedad endian en Endian.BIG_ENDIAN o Endian.LITTLE_ENDIAN. La clase Socket hereda todos los mtodos definidos por las interfaces IDataInput e IDataOutput (ubicadas en el paquete flash.utils). Estos mtodos se deben utilizar para escribir y leer desde el socket. Para obtener ms informacin, consulte:
806
Cuando se realiza la conexin a un servidor utilizando el objeto SecureSocket, el motor de ejecucin valida el certificado del servidor utilizando el almacn de confianza del certificado. En Windows y Mac, el sistema operativo proporciona el almacn de confianza. En Linux, el motor de ejecucin de proporciona su propio almacn de confianza. Si el certificado del servidor no es vlido ni de confianza, el motor de ejecucin distribuye un evento ioError. Se puede comprobar la propiedad serverCertificateStatus del objeto SecureSocket para determinar por qu se ha producido un error de validacin. No existen previsiones para la comunicacin con un servidor que no disponga de un certificado de confianza vlido. La clase CertificateStatus define constantes de cadena que representan los posibles resultados de validacin:
Caducado: ha pasado la fecha de caducidad del certificado. No vlido: existen varios motivos por los que un certificado puede no ser vlido. Por ejemplo, el certificado puede
haber sido modificado, daado o ser de tipo incorrecto.
Cadena no vlida: uno o varios certificados de la cadena del servidor no son vlidos. Falta de coincidencia principal: el nombre de host del servidor y el nombre comn del certificado no coinciden. Es
decir, el servidor est utilizando el certificado incorrecto.
Revocado: la entidad emisora de certificados ha revocado el certificado. De confianza: el certificado es vlido y de confianza. Un objeto SecureSocket slo se puede conectar a un servidor
que utilice un certificado vlido y de confianza.
Firmantes que no son de confianza: el certificado no se vincula a un certificado raz de confianza en el almacn
de confianza del equipo cliente. La comunicacin con un objeto SecureSocket requiere que el servidor utilice un protocolo seguro y cuente con un certificado vlido y de confianza. En otros aspectos, el uso de un objeto SecureSocket es el mismo que la utilizacin de un objeto Socket. El objeto SecureSocket no se admite en todas las plataformas. Utilice la propiedad isSupported de la clase SecureSocket para comprobar si el motor de ejecucin admite el uso del objeto SecureSocket en el equipo cliente actual. Para obtener ms informacin, consulte:
Creacin de un cliente Telnet personalizado mediante la clase Socket Envo de texto al servidor remoto mediante un objeto ByteArray
807
com/example/programmingas3/Telnet/Telnet.as
Informacin general de la aplicacin de socket Telnet Flash Player 9 y posterior, Adobe AIR 1.0 y posterior El archivo principal TelnetSocket.mxml es responsable de crear la interfaz de usuario de toda la aplicacin. Adems de la interfaz de usuario, este archivo tambin define dos mtodos, login() y sendCommand(), para conectar el usuario al servidor especificado. A continuacin se muestra el cdigo ActionScript del archivo de la aplicacin principal:
import com.example.programmingas3.socket.Telnet; private var telnetClient:Telnet; private function connect():void { telnetClient = new Telnet(serverName.text, int(portNumber.text), output); console.title = "Connecting to " + serverName.text + ":" + portNumber.text; console.enabled = true; } private function sendCommand():void { var ba:ByteArray = new ByteArray(); ba.writeMultiByte(command.text + "\n", "UTF-8"); telnetClient.writeBytesToSocket(ba); command.text = ""; }
La primera lnea de cdigo importa la clase Telnet del paquete com.example.programmingas.socket personalizado. La segunda lnea de cdigo declara una instancia de la clase Telnet, telnetClient, que se inicializar posteriormente mediante el mtodo connect(). A continuacin, se declara el mtodo connect() e inicializa la variable telnetClient declarada previamente. Este mtodo pasa el nombre del servidor Telnet especificado por el usuario, el puerto del servidor Telnet y una referencia a un componente TextArea de la lista de visualizacin, que se utiliza para mostrar las respuestas de texto del servidor de socket. Las dos ltimas lneas del mtodo connect() establecen la propiedad title de Panel y activan el componente Panel, que permite al usuario enviar datos al servidor remoto. El mtodo final del archivo principal de la aplicacin, sendCommand(), se utiliza para enviar los comandos del usuario al servidor remoto como un objeto ByteArray.
808
Informacin general de la clase Telnet Flash Player 9 y posterior, Adobe AIR 1.0 y posterior La clase Telnet es la responsable de conectar con el servidor Telnet remoto, y de enviar y recibir datos. La clase Telnet declara las siguientes variables privadas:
private private private private private var var var var var serverURL:String; portNumber:int; socket:Socket; ta:TextArea; state:int = 0;
La primera variable, serverURL, contiene la direccin del servidor, especificada por el usuario, con la que se va a conectar. La segunda variable, portNumber, es el nmero de puerto en el que se est ejecutando el servidor Telnet. De forma predeterminada, el servicio Telnet se ejecuta en el puerto 23. La tercera variable, socket, es una instancia de Socket que intentar conectar con el servidor definido por las variables serverURL y portNumber. La cuarta variable, ta, es una referencia a una instancia del componente TextArea en el escenario. Este componente se utiliza para mostrar las respuestas del servidor Telnet remoto o cualquier posible mensaje de error. La ltima variable, state, es un valor numrico que se utiliza para determinar las opciones que admite el cliente Telnet. Tal y como se ha visto previamente, se llama a la funcin constructora de la clase Telnet a travs del mtodo connect() en el archivo de la aplicacin principal. El constructor Telnet adopta tres parmetros: server, port y output. Los parmetros server y port especifican el nombre de servidor y el nmero de puerto donde se ejecuta el servidor Telnet. El parmetro final, output, es una referencia a una instancia del componente TextArea en el escenario, donde los usuarios vern la salida del servidor.
public function Telnet(server:String, port:int, output:TextArea) { serverURL = server; portNumber = port; ta = output; socket = new Socket(); socket.addEventListener(Event.CONNECT, connectHandler); socket.addEventListener(Event.CLOSE, closeHandler); socket.addEventListener(ErrorEvent.ERROR, errorHandler); socket.addEventListener(IOErrorEvent.IO_ERROR, ioErrorHandler); socket.addEventListener(ProgressEvent.SOCKET_DATA, dataHandler); Security.loadPolicyFile("http://" + serverURL + "/crossdomain.xml"); try { msg("Trying to connect to " + serverURL + ":" + portNumber + "\n"); socket.connect(serverURL, portNumber); } catch (error:Error) { msg(error.message + "\n"); socket.close(); } }
809
Escritura de datos en un socket Flash Player 9 y posterior, Adobe AIR 1.0 y posterior Para escribir datos en una conexin de socket, es necesario llamar a cualquiera de los mtodos de la clase Socket. Entre estos mtodos de escritura se incluyen writeBoolean(), writeByte(), writeBytes() y writeDouble(), entre otros. Posteriormente, vace los datos en el bfer de salida con el mtodo flush(). En el servidor Telnet, los datos se escriben en la conexin de socket mediante el mtodo writeBytes(), que utiliza el conjunto de bytes como parmetro y lo enva al bfer de salida. La sintaxis del mtodo writeBytesToSocket() es la siguiente:
public function writeBytesToSocket(ba:ByteArray):void { socket.writeBytes(ba); socket.flush(); }
Este mtodo se llama mediante el mtodo sendCommand() del archivo de la aplicacin principal. Visualizacin de mensajes del servidor de socket Flash Player 9 y posterior, Adobe AIR 1.0 y posterior Cuando se recibe un mensaje del servidor de socket o se produce un evento, se llama al mtodo personalizado msg(). Este mtodo aade una cadena a TextArea en el escenario y llama a un mtodo personalizado setScroll(), que desplaza el componente TextArea hasta la parte ms baja. La sintaxis del mtodo msg() es la siguiente:
private function msg(value:String):void { ta.text += value; setScroll(); }
Si el contenido del componente TextArea no se desplaza automticamente, el usuario deber arrastrar manualmente las barras de desplazamiento en el rea de texto para ver la ltima respuesta del servidor. Desplazamiento de un componente TextArea Flash Player 9 y posterior, Adobe AIR 1.0 y posterior El mtodo setScroll() contiene una sola lnea de cdigo ActionScript que desplaza verticalmente el contenido del componente TextArea para que el usuario pueda ver la ltima lnea del texto devuelto. El siguiente fragmento de cdigo muestra el mtodo setScroll():
public function setScroll():void { ta.verticalScrollPosition = ta.maxVerticalScrollPosition; }
Este mtodo establece la propiedad verticalScrollPosition, que es el nmero de lnea de la fila superior de caracteres que se visualiza, con el valor de la propiedad maxVerticalScrollPosition.
810
Sockets XML
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior Un socket XML permite crear una conexin en un servidor remoto que permanece abierta hasta que se cierra explcitamente. Puede intercambiar datos de cadenas, como XML, entre el servidor y el cliente. Una ventaja de utilizar un servidor de socket XML es que el usuario no tiene que solicitar datos de forma explcita. El servidor enva datos sin esperar una solicitud, y puede enviar datos a cualquier cliente conectado. En Flash Player y en contenido de Adobe AIR fuera del entorno limitado de la aplicacin, las conexiones de socket XML requieren la presencia de un archivo de poltica de socket en el servidor de destino. Para obtener ms informacin, consulte Controles de sitio web (archivos de poltica) en la pgina 1069 y Conexin a sockets en la pgina 1087. La clase XMLSocket no puede atravesar cortafuegos automticamente, ya que, a diferencia del protocolo RTMP (RealTime Messaging Protocol), XMLSocket no dispone de prestaciones de tunelacin HTTP. Si es necesario utilizar tunelacin HTTP, debe considerarse la posibilidad de utilizar Flash Remoting o Flash Media Server (que admite RTMP). Las siguientes restricciones afectan a la forma y el lugar en que el contenido de Flash Player o de una aplicacin de AIR puede utilizar un objeto XMLSocket para conectarse con el servidor fuera del entorno limitado de seguridad de la aplicacin:
Para el contenido fuera del entorno limitado de seguridad de la aplicacin, el mtodo XMLSocket.connect() slo
puede conectarse a nmeros de puerto TCP superiores o iguales a 1024. Como consecuencia de esta limitacin, los dominios del servidor que se comunica con el objeto XMLSocket tambin deben asignarse a nmeros de puerto superiores o iguales a 1024. Los nmeros de puerto inferiores a 1024 suelen utilizarse para servicios del sistema como FTP (21), Telnet (23), SMTP (25), HTTP (80) y POP3 (110), por lo que los objetos XMLSocket no pueden utilizar estos puertos por razones de seguridad. La restriccin de nmero de puerto limita la posibilidad de que se pueda acceder y hacer un uso indebido de estos recursos.
Para el contenido fuera del entorno limitado de seguridad de la aplicacin, el mtodo XMLSocket.connect() slo
puede conectarse a equipos del mismo dominio en que reside el contenido. (Esta restriccin es idntica a la incluida en las reglas de seguridad establecidas para URLLoader.load().) Para conectar con un dominio de servidor que se ejecuta en un dominio diferente a aqul en el que reside el contenido, puede crear un archivo de poltica de seguridad de varios dominios que permita el acceso desde dominios especficos. Para ms informacin sobre archivos de poltica de varios dominios, consulte Seguridad en AIR en la pgina 1095. Nota: la configuracin de un servidor para que se comunique con el objeto XMLSocket puede resultar compleja. Si la aplicacin no requiere interactividad en tiempo real, utilice la clase URLLoader en vez de la clase XMLSocket. Puede utilizar los mtodos XMLSocket.connect() y XMLSocket.send() de la clase XMLSocket para transferir XML desde y hacia un servidor a travs de una conexin de socket. El mtodo XMLSocket.connect() establece una conexin de socket con un puerto de servidor web. El mtodo XMLSocket.end() pasa un objeto XML al servidor especificado en la conexin de socket. Cuando se invoca el mtodo XMLSocket.connect(), la aplicacin abre una conexin TCP/IP con el servidor y la mantiene abierta hasta que produce una de las condiciones que se indican a continuacin:
Se llama al mtodo XMLSocket.close() de la clase XMLSocket. No existen ms referencias al objeto XMLSocket. Se sale de Flash Player. Se interrumpe la conexin (por ejemplo, se desconecta el mdem).
811
Los mensajes XML se envan a travs de una conexin de socket ininterrumpida TCP/IP dplex. Cada mensaje XML es un documento XML completo terminado en un byte cero (0). Pueden enviarse y recibirse un nmero ilimitado de mensajes XML a travs de una misma conexin XMLSocket.
Creacin y conexin de un servidor de socket XML de Java Flash Player 9 y posterior, Adobe AIR 1.0 y posterior El siguiente cdigo muestra un sencillo servidor XMLSocket escrito en Java que acepta conexiones entrantes y muestra los mensajes recibidos en la ventana de smbolo del sistema. De forma predeterminada, se crea un nuevo servidor en el puerto 8080 del equipo local, aunque se puede especificar otro nmero de puerto cuando se inicia el servidor desde la lnea de comandos. Cree un nuevo documento de texto y aada el siguiente cdigo:
import java.io.*; import java.net.*; class SimpleServer { private static SimpleServer server; ServerSocket socket; Socket incoming; BufferedReader readerIn; PrintStream printOut; public static void main(String[] args) { int port = 8080; try { port = Integer.parseInt(args[0]); } catch (ArrayIndexOutOfBoundsException e) { // Catch exception and keep going. } server = new SimpleServer(port); } private SimpleServer(int port) { System.out.println(">> Starting SimpleServer"); try {
812
socket = new ServerSocket(port); incoming = socket.accept(); readerIn = new BufferedReader(new InputStreamReader(incoming.getInputStream())); printOut = new PrintStream(incoming.getOutputStream()); printOut.println("Enter EXIT to exit.\r"); out("Enter EXIT to exit.\r"); boolean done = false; while (!done) { String str = readerIn.readLine(); if (str == null) { done = true; } else { out("Echo: " + str + "\r"); if(str.trim().equals("EXIT")) { done = true; } } incoming.close(); } } catch (Exception e) { System.out.println(e); } } private void out(String str) { printOut.println(str); System.out.println(str); } }
Guarde el documento en el disco duro como SimpleServer.java y complelo con la ayuda de un compilador de Java para crear un archivo de clase de Java denominado SimpleServer.class. Para iniciar el servidor XMLSocket, abra un smbolo del sistema y escriba java SimpleServer. El archivo SimpleServer.class puede almacenarse en cualquier lugar del equipo local o la red; no es necesario que est en el directorio raz del servidor web. Si no puede iniciar el servidor porque los archivos no se encuentran en la ruta de clases de Java, intente iniciar el servidor con java -classpath. SimpleServer. Para conectarse a XMLSocket desde la aplicacin , es necesario crear una nueva instancia de la clase XMLSocket y llamar al mtodo XMLSocket.connect(), pasando un nombre de host y un nmero de puerto, del siguiente modo:
var xmlsock:XMLSocket = new XMLSocket(); xmlsock.connect("127.0.0.1", 8080);
813
xmlsock.addEventListener(DataEvent.DATA, onData); private function onData(event:DataEvent):void { trace("[" + event.type + "] " + event.data); }
Para enviar datos al servidor XMLSocket, se utiliza el mtodo XMLSocket.send() y se pasa una cadena u objeto XML. Flash Player convierte el parmetro suministrado en un objeto String y enva el contenido al servidor XMLSocket, seguido de un byte cero (0):
xmlsock.send(xmlFormattedData);
El mtodo XMLSocket.send() no devuelve ningn valor que indique si los datos se han transmitido correctamente. Si se produce un error al intentar enviar datos, se emite un error IOError. Cada mensaje que se enva al servidor de socket XML debe terminar con un carcter de nueva lnea (\n). Para obtener ms informacin, consulte XMLSocket.
Sockets de servidor
Adobe AIR 2 y posterior Utilice la clase ServerSocket para permitir que otro proceso se conecte a la aplicacin utilizando un socket TCP (Transport Control Protocol). El proceso de conexin se puede ejecutar en el equipo local o en otro equipo conectado a la red. Cuando un objeto recibe una solicitud de conexin, distribuye un evento connect. El objeto ServerSocketConnectEvent distribuido con el evento contiene un objeto Socket. Este objeto Socket se puede emplear para una comunicacin posterior con los dems procesos. Para detectar conexiones de socket entrantes:
1 Cree un objeto ServerSocket y vinclelo con un puerto local. 2 Aada detectores de eventos para el evento connect. 3 Llamada al mtodo listen() 4 Responda al evento connect, lo que proporciona un objeto Socket para cada conexin entrante.
El objeto ServerSocket sigue detectando conexiones adicionales hasta que se llama al mtodo close(). En el siguiente ejemplo de cdigo se muestra cmo crear una aplicacin de servidor de socket. En el ejemplo se detectan las conexiones entrantes en el puerto 8087. Cuando se recibe una conexin, el ejemplo enva un mensaje (cadena Connected.) al socket de cliente. Por lo tanto, el servidor reproduce todos los mensajes recibidos del cliente.
814
public class ServerSocketExample extends Sprite { private var serverSocket:ServerSocket; private var clientSockets:Array = new Array(); public function ServerSocketExample() { try { // Create the server socket serverSocket = new ServerSocket(); // Add the event listener serverSocket.addEventListener( Event.CONNECT, connectHandler ); serverSocket.addEventListener( Event.CLOSE, onClose ); // Bind to local port 8087 serverSocket.bind( 8087, "127.0.0.1" ); // Listen for connections serverSocket.listen(); trace( "Listening on " + serverSocket.localPort ); } catch(e:SecurityError) { trace(e); } } public function connectHandler(event:ServerSocketConnectEvent):void { //The socket is provided by the event object var socket:Socket = event.socket as Socket; clientSockets.push( socket ); socket.addEventListener( ProgressEvent.SOCKET_DATA, socketDataHandler); socket.addEventListener( Event.CLOSE, onClientClose ); socket.addEventListener( IOErrorEvent.IO_ERROR, onIOError ); //Send a connect message socket.writeUTFBytes("Connected."); socket.flush(); trace( "Sending connect message" ); }
815
public function socketDataHandler(event:ProgressEvent):void { var socket:Socket = event.target as Socket //Read the message from the socket var message:String = socket.readUTFBytes( socket.bytesAvailable ); trace( "Received: " + message); // Echo the received message back to the sender message = "Echo -- " + message; socket.writeUTFBytes( message ); socket.flush(); trace( "Sending: " + message ); } private function onClientClose( event:Event ):void { trace( "Connection to client closed." ); //Should also remove from clientSockets array... } private function onIOError( errorEvent:IOErrorEvent ):void { trace( "IOError: " + errorEvent.text ); } private function onClose( event:Event ):void { trace( "Server socket closed by OS." ); } }}
816
La aplicacin de AIR puede enviar y recibir mensajes UDP con las clases DatagramSocket y DatagramSocketDataEvent. Para enviar o recibir un mensaje UDP:
1 Cree un objeto DatagramSocket. 2 Aada un detector de eventos al evento data. 3 Enlace el socket a un puerto y direccin IP local utilizando el mtodo bind(). 4 Enve mensajes llamando al mtodo send() y transmitiendo el puerto y la direccin IP del equipo de destino. 5 Reciba mensajes respondiendo al evento data. El objeto DatagramSocketDataEvent distribuido para este evento
contiene un objeto ByteArray que incluye los datos del mensaje. El siguiente ejemplo de cdigo muestra el modo en que una aplicacin puede enviar y recibir mensajes UDP. El ejemplo enva un solo mensaje que contiene la cadena, Hello., al equipo de destino. Tambin realiza un seguimiento del contenido de todos los mensajes recibidos.
package { import flash.display.Sprite; import flash.events.DatagramSocketDataEvent; import flash.events.Event; import flash.net.DatagramSocket; import flash.utils.ByteArray; public class DatagramSocketExample extends Sprite { private var datagramSocket:DatagramSocket; //The IP and port for this computer private var localIP:String = "192.168.0.1"; private var localPort:int = 55555; //The IP and port for the target computer private var targetIP:String = "192.168.0.2"; private var targetPort:int = 55555; public function DatagramSocketExample() { //Create the socket datagramSocket = new DatagramSocket(); datagramSocket.addEventListener( DatagramSocketDataEvent.DATA, dataReceived ); //Bind the socket to the local network interface and port
817
datagramSocket.bind( localPort, localIP ); //Listen for incoming datagrams datagramSocket.receive(); //Create a message in a ByteArray var data:ByteArray = new ByteArray(); data.writeUTFBytes("Hello."); //Send the datagram message datagramSocket.send( data, 0, 0, targetIP, targetPort); } private function dataReceived( event:DatagramSocketDataEvent ):void { //Read the data from the datagram trace("Received from " + event.srcAddress + ":" + event.srcPort + "> " + event.data.readUTFBytes( event.data.bytesAvailable ) ); } }}
Un solo paquete de datos no puede ser superior a la unidad de transmisin mxima ms pequea (MTU) de la
interfaz de red o cualquier nodo de red entre el remitente y el destinatario. Todos los datos del objeto ByteArray transmitidos al mtodo send() se envan como un solo paquete. (En TCP, los mensajes grandes se dividen en paquetes independientes.)
No existe conexin entre el remitente y el destino. Los mensajes se descartan sin error si el destino no existe o no
dispone de un detector activo en el puerto especificado.
Si se utiliza el mtodo connect(), los mensajes enviados desde otros recursos se omitirn. Una conexin UDP slo
proporciona el filtrado de paquetes adecuado. No significa que sea necesariamente un proceso de deteccin vlido en la direccin y el puerto de destino.
El trfico UDP puede sobrecargar una red. Es posible que los administradores de red deban implementar controles
de calidad del servicio si se produce la saturacin en la red. (TCP dispone de control de trfico integrado para reducir el impacto de la saturacin de la red.) Para obtener ms informacin, consulte:
Direcciones IPv6
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior Flash Player 9.0.115.0 y las versiones posteriores admiten IPv6 (Protocolo de Internet versin 6). IPv6 es una versin del Protocolo de Internet que admite direcciones de 128 bits (una mejora con respecto al protocolo anterior IPv4 que admite direcciones de 32 bits). Es posible que tenga que activar IPv6 en sus interfaces de red. Para ms informacin, consulte la Ayuda del sistema operativo que aloja los datos.
818
Si se admite IPv6 en el sistema de host, puede especificar direcciones literales numricas de IPv6 en URL entre corchetes ([]), como se muestra a continuacin:
[2001:db8:ccc3:ffff:0:444d:555e:666f]
Flash Player devuelve valores IPv6 literales, en funcin de las siguiente reglas:
Flash Player devuelve el formulario largo de la cadena para las direcciones IPv6. El valor IP no tiene abreviaciones de dos puntos dobles. Los dgitos hexadecimales slo aparecen en minscula. Las direcciones IPv6 aparecen entre corchetes ([]). Cada cuarteto de direcciones se representa como dgitos hexadecimales de 0 a 4, donde se omiten los primeros
ceros.
Un cuarteto de direcciones de todos los ceros aparece como un solo cero (no dos puntos dobles), excepto donde se
indica en la siguiente lista de excepciones. Los valores IPv6 que devuelve Flash Player presentan las siguientes excepciones:
Una direccin IPv6 no especificada (todos los ceros) aparece como [::]. La direccin IPv6 de localhost o bucle invertido se presenta como [::1]. Las direcciones asignadas a IPv4 (convertidas a IPv6) se presentan como [::ffff:a.b.c.d], siendo a.b.c.d un valor tpico
decimal con puntos de IPv4.
Las direcciones compatibles con IPv4 aparecen como [::a.b.c.d], siendo a.b.c.d un valor tpico decimal con puntos
de IPv4.
819
Ms temas de ayuda
flash.net.URLLoader flash.net.URLStream flash.net.URLRequest flash.net.URLRequestDefaults flash.net.URLRequestHeader flash.net.URLRequestMethod flash.net.URLVariables
Propiedades de URLRequest
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior Puede utilizar las siguientes propiedades de un objeto URLRequest en cualquier entorno limitado de seguridad:
820
Propiedad contentType
Descripcin El tipo de contenido MIME de todos los datos enviados con la peticin de URL. Si no se establece contentType, los valores se envan como application/x-www-form-urlencoded. Un objeto que contiene datos que se van a transmitir con la peticin de URL. Una cadena que identifica de forma unvoca el componente firmado de la plataforma de Adobe que se va a almacenar (o recuperar) en la cach de Adobe Flash Player. El mtodo de peticin HTTP, por ejemplo, GET o POST. (El contenido ejecutado en el dominio de seguridad de la aplicacin de AIR puede especificar cadenas que no sean "GET" o "POST" como propiedad method. Se permite cualquier palabra clave HTTP, aunque "GET" es el mtodo predeterminado. Consulte Seguridad en AIR en la pgina 1095. El conjunto de encabezados de peticin HTTP que se aadirn a la peticin HTTP. Tenga en cuenta que el permiso para definir determinados encabezados en Flash Player y en contenido de AIR ejecutado fuera del entorno limitado de seguridad de la aplicacin est restringido. Especifica la direccin URL que se va a solicitar.
data digest
method
requestHeaders
url
En AIR, puede definir propiedades adicionales de la clase URLRequest que slo estn disponibles en contenido de AIR ejecutado fuera del entorno limitado de seguridad de la aplicacin. El contenido del entorno limitado de la aplicacin tambin puede definir las direcciones URL mediante los nuevos esquemas de URL (adems de los esquemas estndar como file y http).
Propiedad followRedirects Descripcin Especifica si se siguen las redirecciones (true, valor predeterminado) o no (false). Esto slo se admite en el entorno limitado de la aplicacin AIR. Especifica si la cola del protocolo HTTP debe gestionar las cookies (true, valor predeterminado) o no (false) en esta peticin. La configuracin de esta propiedad slo se admite en el entorno limitado de la aplicacin de AIR. Especifica si deben manejarse peticiones de autenticacin (true) en esta peticin. La configuracin de esta propiedad slo se admite en el entorno limitado de la aplicacin de AIR. El comportamiento predeterminado es autenticar peticiones. Esto puede provocar la aparicin de un cuadro de dilogo si el servidor requiere credenciales. Tambin puede establecer el nombre de usuario y la contrasea con la clase URLRequestDefaults; consulte Configuracin de los valores predeterminados de URLRequest (slo AIR) en la pgina 821. Especifica si los datos de respuesta de esta peticin se deben guardar en la memoria cach. La configuracin de esta propiedad slo se admite en el entorno limitado de la aplicacin de AIR. El valor predeterminado es guardar la respuesta en la memoria cach (true). Especifica si se debe consultar la memoria cach local antes de que el objeto URLRequest tome los datos. La configuracin de esta propiedad slo se admite en el entorno limitado de la aplicacin de AIR. El comportamiento predeterminado (true) es utilizar la versin guardada en la memoria local, si est disponible. Especifica la cadena de agente de usuario que se utiliza en la peticin HTTP.
manageCookies
authenticate
cacheResponse
useCache
userAgent
Nota: la clase HTMLLoader tiene propiedades relacionadas para ajustes que pertenecen al contenido cargado mediante un objeto HTMLLoader. Para obtener ms informacin, consulte Informacin sobre la clase HTMLLoader en la pgina 999.
821
Nota: la clase URLRequestDefaults se define para el contenido que se ejecuta nicamente en Adobe AIR. No se admite en Flash Player. La clase URLRequestDefaults contiene un mtodo setLoginCredentialsForHost() que permite especificar un nombre de usuario y una contrasea predeterminados para usarlos con un host especfico. El host, definido en el parmetro hostname del mtodo, puede ser un dominio (por ejemplo "www.example.com") o un dominio y un nmero de puerto (por ejemplo "www.example.com:80". Observe que "example.com", "www.example.com", y "sales.example.com" se consideran hosts nicos. Estas credenciales slo se utilizan si las requiere el servidor. Si el usuario ya se ha autenticado (por ejemplo, desde el cuadro de dilogo de autenticacin), llamar al mtodo setLoginCredentialsForHost() no cambiar al usuario autenticado. El siguiente cdigo establece el nombre de usuario y contrasea predeterminados para las peticiones enviadas a www.example.com:
URLRequestDefaults.setLoginCredentialsForHost("www.example.com", "Ada", "love1816$X");
La configuracin de URLRequestDefaults slo se aplica al dominio de la aplicacin actual con una excepcin. Las credenciales transferidas al mtodo setLoginCredentialsForHost() se utilizan para peticiones realizadas en cualquier dominio de aplicacin dentro de la aplicacin de AIR. Para obtener ms informacin, consulte la clase URLRequestDefaults en Referencia de ActionScript 3.0 para la plataforma de Adobe Flash.
Esquemas de URI
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior Los esquemas de URI estndar, como el siguiente, se pueden utilizar en peticiones realizadas desde cualquier entorno limitado de seguridad: http: y https: Utilice este esquema para URL de Internet estndar (del mismo modo que se utilizan en un navegador web). file: Utilice file: para especificar la URL de un archivo ubicado en el sistema de archivos local. Por ejemplo:
file:///c:/AIR Test/test.txt
En AIR, tambin se pueden utilizar los siguientes esquemas al definir una direccin URL para el contenido que se ejecuta en el entorno limitado de seguridad de la aplicacin:
822
app: Utilice app: para especificar una ruta relativa al directorio raz de la aplicacin instalada. Por ejemplo, la siguiente ruta apunta a un subdirectorio de recursos del directorio de la aplicacin instalada:
app:/resources
Cuando se inicia una aplicacin de AIR con AIR Debug Launcher (ADL), el directorio de la aplicacin es el directorio que contiene el archivo descriptor de la aplicacin. app-storage: Use app-storage: para especificar una ruta relativa al directorio de almacenamiento de datos de la aplicacin. AIR crea un directorio de almacenamiento exclusivo para cada una de las aplicaciones instaladas (y usuarios), lo cual proporciona un lugar til para guardar datos que son especficos para esa aplicacin. Por ejemplo, la ruta siguiente apunta a un archivo prefs.xml en un subdirectorio de configuracin del directorio de almacenamiento de la aplicacin:
app-storage:/settings/prefs.xml
La ubicacin del directorio de almacenamiento de la aplicacin se basa en el nombre de usuario, el ID de la aplicacin y el ID del editor (si procede):
Por ejemplo:
/Users/babbage/Library/Preferences/com.example.TestApp.02D88EEED35F84C264A183921344EEA353 A629FD.1/Local Store
En LinuxEn:
/home/user name/.appdata/applicationID.publisherID/Local Store/
Por ejemplo:
/home/babbage/.appdata/com.example.TestApp.02D88EEED35F84C264A183921344EEA353A629FD.1\Loc al Store
Nota: en AIR 1.5.3, no todas las aplicaciones de AIR tienen ID de editor. La direccin URL (y la propiedad url) de un objeto File creado con File.applicationStorageDirectory utiliza el esquema de URI app-storage, tal como se indica a continuacin:
var dir:File = File.applicationStorageDirectory; dir = dir.resolvePath("preferences"); trace(dir.url); // app-storage:/preferences
mailto: Puede utilizar el esquema mailto en objetos URLRequest transmitidos a la funcinnavigateToURL(). Consulte Apertura de una URL en otra aplicacin en la pgina 836.
823
Puede elegir un objeto URLRequest que utilice cualquiera de estos esquemas de URI para definir la peticin de URL para varios objetos, como FileStream o Sound. Tambin puede utilizar estos esquemas en contenido HTML que se ejecute en AIR; por ejemplo, es posible utilizarlos en el atributo src de una etiqueta img. No obstante, slo se pueden utilizar estos esquemas de URI especficos de AIR (app: y app-storage:) en contenido del entorno limitado de seguridad de la aplicacin. Para obtener ms informacin, consulte Seguridad en AIR en la pgina 1095. Esquemas de URI no admitidos (en AIR) Algunas de las siguientes API permiten lanzar contenido en un navegador web. Por motivos de seguridad, algunos esquemas de URI no estn permitidos cuando se utilizan estas API en AIR. La lista de esquemas no permitidos depende del entorno limitado de seguridad del cdigo que utilice la API. Para obtener ms informacin, consulte Apertura de una URL en otra aplicacin en la pgina 836.
En el constructor URLVariables Con el mtodo URLVariables.decode() Como propiedades dinmicas del propio objeto URLVariables
El siguiente ejemplo ilustra los tres mtodos y cmo asignar las variables a un objeto URLRequest:
var urlVar:URLVariables = new URLVariables( "one=1&two=2" ); urlVar.decode("amp=" + encodeURIComponent( "&" ) ); urlVar.three = 3; urlVar.amp2 = "&&"; trace(urlVar.toString()); //amp=%26&2=%26%26&one=1&two=2&three=3 var urlRequest:URLRequest = new URLRequest( "http://www.example.com/test.cfm" ); urlRequest.data = urlVar;
Cuando se definen variables en el constructor URLVariables o en el mtodo URLVariables.decode(), es importante codificar en la URL los caracteres que puedan tener tener un significado especial en una cadena URI. Por ejemplo, si utiliza un ampersand en un nombre de parmetro o valor, debe codificarlo cambiando su forma & por %26 para que el ampersand haga de delimitador en los parmetros. La funcin encodeURIComponent() de nivel superior se puede utilizar para este fin.
824
El modelo de gestin de eventos de ActionScript 3.0 difiere bastante del modelo de ActionScript 2.0, que utilizaba los controladores de eventos LoadVars.onData, LoadVars.onHTTPStatus y LoadVars.onLoad. Para obtener ms informacin sobre la gestin de eventos en ActionScript 3.0, consulte Gestin de eventos en la pgina 119 Los datos descargados no estn disponibles hasta que finaliza la descarga. Es posible supervisar el progreso de la descarga (bytes cargados y bytes totales) detectando el evento progress que se va a distribuir. No obstante, en ocasiones los archivos se cargan tan rpido que no se llega a distribuir ningn evento progress. Cuando el archivo se ha descargado correctamente, se distribuye el evento complete. Al establecer la propiedad dataFormat de URLLoader, puede recibir datos como texto, como datos binarios sin procesar o como un objeto URLVariables. El mtodo URLLoader.load() (y opcionalmente el constructor de la clase URLLoader) admite un solo parmetro, request, que es un objeto URLRequest. Un objeto URLRequest contiene toda la informacin de una sola peticin HTTP, como la URL de destino, el mtodo de peticin (GET o POST), informacin de encabezado adicional y el tipo MIME (por ejemplo, cuando se carga contenido XML. Por ejemplo, para cargar un paquete XML en un script de servidor, se podra usar el siguiente cdigo
var secondsUTC:Number = new Date().time; var dataXML:XML = <clock> <time>{secondsUTC}</time> </clock>; var request:URLRequest = new URLRequest("http://www.yourdomain.com/time.cfm"); request.contentType = "text/xml"; request.data = dataXML.toXMLString(); request.method = URLRequestMethod.POST; var loader:URLLoader = new URLLoader(); loader.load(request);
El fragmento de cdigo anterior crea un documento XML denominado dataXML que contiene el paquete XML que se enviar al servidor. El ejemplo establece la propiedad contentType de URLRequest como "text/xml" y asigna el documento XML a la propiedad data de URLRequest. Finalmente, este ejemplo crea un objeto URLLoader y enva la peticin al script remoto mediante el mtodo load().
825
De forma predeterminada, si no se define un mtodo de peticin, Flash Player y Adobe AIR cargan el contenido con el mtodo HTTP GET. Si se desea enviar los datos con el mtodo POST, es necesario establecer la propiedad request.method en POST con la constante esttica URLRequestMethod.POST, como se muestra en el siguiente cdigo:
var request:URLRequest = new URLRequest("sendfeedback.cfm"); request.method = URLRequestMethod.POST;
El documento externo (params.txt) que se carga en tiempo de ejecucin contiene los siguientes datos:
monthNames=January,February,March,April,May,June,July,August,September,October,November,Dece mber&dayNames=Sunday,Monday,Tuesday,Wednesday,Thursday,Friday,Saturday
El archivo contiene dos parmetros, monthNames y dayNames. Cada parmetro incluye una lista separada por comas que se analiza como cadenas. Se puede dividir esta lista en un conjunto con el mtodo String.split(). Conviene evitar la utilizacin de palabras reservadas y construcciones del lenguaje como nombres de variables en archivos de datos externos, ya que dificulta la lectura y depuracin del cdigo. Cuando se han cargado los datos, se distribuye el evento Event.COMPLETE y el contenido del documento externo est disponible para utilizarlo en la propiedad data de URLLoader, como se muestra en el siguiente cdigo:
function completeHandler(event) { var loader2 = event.target; air.trace(loader2.data); }
Si el documento remoto contiene pares nombre-valor, puede analizar los datos con la clase URLVariables analizando el contenido del archivo cargado del modo siguiente:
private function completeHandler(event:Event):void { var loader2:URLLoader = URLLoader(event.target); var variables:URLVariables = new URLVariables(loader2.data); trace(variables.dayNames); }
Cada par nombre-valor del archivo externo se crea como una propiedad en el objeto URLVariables. Cada propiedad del objeto variables del ejemplo de cdigo anterior se trata como una cadena. Si el valor del par nombre-valor es una lista de elementos, puede convertir la cadena en un conjunto llamando al mtodo String.split(), como se indica a continuacin:
826
Si se cargan datos numricos de archivos de texto externos, es necesario convertir los valores en valores numricos, mediante una funcin de nivel superior como int(), uint() o Number(). En lugar de cargar el contenido del archivo remoto como una cadena y crear un nuevo objeto URLVariables, se puede establecer la propiedad URLLoader.dataFormat en una de las propiedades estticas de la clase URLLoaderDataFormat. Los tres valores posibles para la propiedad URLLoader.dataFormat son los siguientes:
objeto ByteArray.
URLLoaderDataFormat.TEXT: la propiedad URLLoader.data contendr texto en un objeto String. URLLoaderDataFormat.VARIABLES: la propiedad URLLoader.data contendr variables con codificacin URL
almacenadas en un objeto URLVariables. En el cdigo siguiente se muestra que, al establecer la propiedad URLLoader.dataFormat en URLLoaderDataFormat.VARIABLES, se permite analizar automticamente los datos cargados en un objeto URLVariables:
package { import import import import import
public class URLLoaderDataFormatExample extends Sprite { public function URLLoaderDataFormatExample() { var request:URLRequest = new URLRequest("http://www.[yourdomain].com/params.txt"); var variables:URLLoader = new URLLoader(); variables.dataFormat = URLLoaderDataFormat.VARIABLES; variables.addEventListener(Event.COMPLETE, completeHandler); try { variables.load(request); } catch (error:Error) { trace("Unable to load URL: " + error); } } private function completeHandler(event:Event):void { var loader:URLLoader = URLLoader(event.target); trace(loader.data.dayNames); } } }
827
Como puede verse en el siguiente ejemplo, cargar XML desde un archivo externo es lo mismo que cargar URLVariables. Se puede crear una instancia de URLRequest y una instancia de URLLoader, y utilizarlas para descargar un documento XML remoto. Cuando el archivo se ha descargado completamente, se distribuye el evento Event.COMPLETE y el contenido del archivo externo se convierte en una instancia de XML, que puede analizarse con los mtodos y propiedades de XML.
package { import import import import import
public class ExternalDocs extends Sprite { public function ExternalDocs() { var request:URLRequest = new URLRequest("http://www.[yourdomain].com/data.xml"); var loader:URLLoader = new URLLoader(); loader.addEventListener(Event.COMPLETE, completeHandler); try { loader.load(request); } catch (error:ArgumentError) { trace("An ArgumentError has occurred."); } catch (error:SecurityError) { trace("A SecurityError has occurred."); } } private function completeHandler(event:Event):void { var dataXML:XML = XML(event.target.data); trace(dataXML.toXMLString()); } } }
828
El siguiente fragmento de cdigo crea un objeto URLVariables denominado variables, que crea una nueva variable denominada name. A continuacin, se crea un objeto URLRequest que especifica la direccin URL del script del servidor a la que se deben enviar las variables. Despus, establezca la propiedad method del objeto URLRequest para que enve las variables como una peticin HTTP POST. Para aadir el objeto URLVariables a la peticin de URL, establezca la propiedad data del objeto URLRequest como el objeto URLVariables creado anteriormente. Para terminar, se crea la instancia de URLLoader y se invoca el mtodo URLLoader.load(), inicindose as la peticin.
var variables:URLVariables = new URLVariables("name=Franklin"); var request:URLRequest = new URLRequest(); request.url = "http://www.[yourdomain].com/greeting.cfm"; request.method = URLRequestMethod.POST; request.data = variables; var loader:URLLoader = new URLLoader(); loader.dataFormat = URLLoaderDataFormat.VARIABLES; loader.addEventListener(Event.COMPLETE, completeHandler); try { loader.load(request); } catch (error:Error) { trace("Unable to load URL"); } function completeHandler(event:Event):void { trace(event.target.data.welcomeMessage); }
El cdigo siguiente incluye el contenido del documento greeting.cfm de Adobe ColdFusion utilizado en el ejemplo anterior:
<cfif NOT IsDefined("Form.name") OR Len(Trim(Form.Name)) EQ 0> <cfset Form.Name = "Stranger" /> </cfif> <cfoutput>welcomeMessage=#UrlEncodedFormat("Welcome, " & Form.name)# </cfoutput>
829
En aplicaciones de AIR basadas en HTML, puede usar las clases URLRequest y URLLoader, o bien la clase XMLHttpRequest de JavaScript. Si lo desea, tambin puede crear una biblioteca SWF que contenga los componentes de servicios web de la arquitectura de Flex y los ponga a disposicin del cdigo JavaScript. Cuando la aplicacin se ejecuta en un navegador, slo es posible utilizar servicios web del mismo dominio de Internet que el archivo SWF que llama, a no ser que el servidor que aloja el servicio web tambin tenga un archivo de poltica entre dominios para permitir el acceso desde otros dominios. Una tcnica que se suele utilizar cuando no hay archivo de poltica entre dominios disponible es pasar por el proxy las peticiones del propio servidor. Adobe Blaze DS y Adobe LiveCycle admiten proxy de servicios web. En aplicaciones de AIR, no se requiere un archivo de poltica entre dominios si la llamada al servicio web se origina en el entorno limitado de seguridad de la aplicacin. El contenido de la aplicacin de AIR nunca se ofrece desde un dominio remoto, por lo que no puede participar en tipos de ataques prevenidos por polticas entre dominios. En aplicaciones de AIR basadas en HTML, el contenido del entorno limitado de seguridad de la aplicacin puede realizar peticiones XMLHttpRequest entre dominios. Puede permitir que el contenido de otros entornos limitados de seguridad de la aplicacin realicen peticiones XMLHttpRequest entre dominios siempre y cuando el contenido se cargue en un iframe.
Ms temas de ayuda
Controles de sitio web (archivos de poltica) en la pgina 1069 Adobe BlazeDS Adobe LiveCycle ES2 Arquitectura REST XML-RPC Protocolo SOAP
Para acceder a un servicio web de tipo REST con ActionScript, puede utilizar las clases URLRequest, URLVariables y URLLoader. El cdigo JavaScript dentro de una aplicacin de AIR, tambin puede utilizar una peticin XMLHttpRequest. La programacin de llamadas a servicios web de tipo REST desde ActionScript suele implicar los pasos siguientes:
1 Cree un objeto URLRequest. 2 Establezca el mtodo HTTP y la URL del servicio en el objeto solicitado. 3 Cree un objeto URLVariables. 4 Establezca los parmetros de llamada al servicio como propiedades dinmicas del objeto variables. 5 Asigne el objeto variables a la propiedad data del objeto solicitado. 6 Enve la llamada al servicio con un objeto URLLoader.
830
7 Gestione el evento complete distribuido por URLLoader que indica que la llamada al servicio ha finalizado. Nunca
est de ms detectar diversos eventos de error que puedan ser distribuidos por un objeto URLLoader. Por ejemplo, considere un servicio web que exponga un mtodo de prueba que devuelva los parmetros de la llamada al solicitante. El siguiente cdigo ActionScript se puede utilizar para llamar al servicio:
import import import import import import import import flash.events.Event; flash.events.ErrorEvent; flash.events.IOErrorEvent; flash.events.SecurityErrorEvent; flash.net.URLLoader; flash.net.URLRequest; flash.net.URLRequestMethod; flash.net.URLVariables;
private var requestor:URLLoader = new URLLoader(); public function restServiceCall():void { //Create the HTTP request object var request:URLRequest = new URLRequest( "http://service.example.com/" ); request.method = URLRequestMethod.GET; //Add the URL variables var variables:URLVariables = new URLVariables(); variables.method = "test.echo"; variables.api_key = "123456ABC"; variables.message = "Able was I, ere I saw Elba."; request.data = variables; //Initiate the transaction requestor = new URLLoader(); requestor.addEventListener( Event.COMPLETE, httpRequestComplete ); requestor.addEventListener( IOErrorEvent.IOERROR, httpRequestError ); requestor.addEventListener( SecurityErrorEvent.SECURITY_ERROR, httpRequestError ); requestor.load( request ); } private function httpRequestComplete( event:Event ):void { trace( event.target.data ); } private function httpRequestError( error:ErrorEvent ):void{ trace( "An error occured: " + error.message ); }
En JavaScript, dentro de una aplicacin de AIR, puede hacer la misma peticin con el objeto XMLHttpRequest:
831
<html> <head><title>RESTful web service request</title> <script type="text/javascript"> function makeRequest() { var requestDisplay = document.getElementById( "request" ); var resultDisplay = document.getElementById( "result" ); //Create a conveninece object to hold the call properties var request = {}; request.URL = "http://service.example.com/"; request.method = "test.echo"; request.HTTPmethod = "GET"; request.parameters = {}; request.parameters.api_key = "ABCDEF123"; request.parameters.message = "Able was I ere I saw Elba."; var requestURL = makeURL( request ); xmlhttp = new XMLHttpRequest(); xmlhttp.open( request.HTTPmethod, requestURL, true); xmlhttp.onreadystatechange = function() { if (xmlhttp.readyState == 4) { resultDisplay.innerHTML = xmlhttp.responseText; } } xmlhttp.send(null); requestDisplay.innerHTML = requestURL; } //Convert the request object into a properly formatted URL function makeURL( request ) { var url = request.URL + "?method=" + escape( request.method ); for( var property in request.parameters ) { url += "&" + property + "=" + escape( request.parameters[property] ); } return url; } </script> </head> <body onload="makeRequest()"> <h1>Request:</h1> <div id="request"></div> <h1>Result:</h1> <div id="result"></div> </body> </html>
832
833
request.data = xmlRPC; //Initiate the request requestor = new URLLoader(); requestor.dataFormat = URLLoaderDataFormat.TEXT; requestor.addEventListener( Event.COMPLETE, xmlRPCRequestComplete ); requestor.addEventListener( IOErrorEvent.IO_ERROR, xmlRPCRequestError ); requestor.addEventListener( SecurityErrorEvent.SECURITY_ERROR, xmlRPCRequestError ); requestor.load( request ); } private function xmlRPCRequestComplete( event:Event ):void { trace( XML(event.target.data).toXMLString() ); } private function xmlRPCRequestError( error:ErrorEvent ):void { trace( "An error occurred: " + error ); }
WebKit en AIR no admite la sintaxis E4X, por lo que el mtodo utilizado para crear el documento XML del ejemplo anterior no funcionara con cdigo JavaScript. Deberan utilizarse mtodos DOM para crear el documento XML o crearlo como una cadena y utilizar la clase DOMParser de JavaScript para convertir la cadena en XML. El siguiente ejemplo utiliza mtodos DOM para crear un mensaje XML-RPC y un objeto XMLHttpRequest para llevar a cabo la transaccin del servicio web:
<html> <head> <title>XML-RPC web service request</title> <script type="text/javascript"> function makeRequest() { var requestDisplay = document.getElementById( "request" ); var resultDisplay = document.getElementById( "result" ); var request = {}; request.URL = "http://services.example.com/xmlrpc/"; request.method = "test.echo"; request.HTTPmethod = "POST"; request.parameters = {}; request.parameters.api_key = "123456ABC"; request.parameters.message = "Able was I ere I saw Elba."; var requestMessage = formatXMLRPC( request ); xmlhttp = new XMLHttpRequest(); xmlhttp.open( request.HTTPmethod, request.URL, true); xmlhttp.onreadystatechange = function() { if (xmlhttp.readyState == 4) { resultDisplay.innerText = xmlhttp.responseText; } } xmlhttp.send( requestMessage ); requestDisplay.innerText = xmlToString( requestMessage.documentElement );
834
} //Formats a request as XML-RPC document function formatXMLRPC( request ) { var xmldoc = document.implementation.createDocument( "", "", null ); var root = xmldoc.createElement( "methodCall" ); xmldoc.appendChild( root ); var methodName = xmldoc.createElement( "methodName" ); var methodString = xmldoc.createTextNode( request.method ); methodName.appendChild( methodString ); root.appendChild( methodName ); var params = xmldoc.createElement( "params" ); root.appendChild( params ); var param = xmldoc.createElement( "param" ); params.appendChild( param ); var value = xmldoc.createElement( "value" ); param.appendChild( value ); var struct = xmldoc.createElement( "struct" ); value.appendChild( struct ); for( var property in request.parameters ) { var member = xmldoc.createElement( "member" ); struct.appendChild( member ); var name = xmldoc.createElement( "name" ); var paramName = xmldoc.createTextNode( property ); name.appendChild( paramName ) member.appendChild( name ); var value = xmldoc.createElement( "value" ); var type = xmldoc.createElement( "string" ); value.appendChild( type ); var paramValue = xmldoc.createTextNode( request.parameters[property] ); type.appendChild( paramValue ) member.appendChild( value ); } return xmldoc; } //Returns a string representation of an XML node function xmlToString( rootNode, indent ) { if( indent == null ) indent = ""; var result = indent + "<" + rootNode.tagName + ">\n"; for( var i = 0; i < rootNode.childNodes.length; i++) { if(rootNode.childNodes.item( i ).nodeType == Node.TEXT_NODE ) { result += indent + " " + rootNode.childNodes.item( i ).textContent + "\n"; } } if( rootNode.childElementCount > 0 )
835
{ result += xmlToString( rootNode.firstElementChild, indent + " } if( rootNode.nextElementSibling ) { result += indent + "</" + rootNode.tagName + ">\n"; result += xmlToString( rootNode.nextElementSibling, indent ); } else { result += indent +"</" + rootNode.tagName + ">\n"; } return result; } </script> </head> <body onload="makeRequest()"> <h1>Request:</h1> <pre id="request"></pre> <h1>Result:</h1> <pre id="result"></pre> </body> </html> " );
Ms temas de ayuda
Uso del componente de servicio web de Flex en Flash Professional Cristophe Coenraets: Real-time Trader Desktop for Android
836
Nota: al utilizar la funcin navigateToURL(), el motor de tiempo de ejecucin trata un objeto URLRequest que utiliza el mtodo POST (un objeto con su propiedad method establecida como URLRequestMethod.POST) como si utilizara el mtodo GET. Cuando se utiliza la funcin navigateToURL(), se permiten esquemas de URI basados en el entorno limitado de seguridad del cdigo que llama a la funcin navigateToURL(). Algunas de las siguientes API permiten lanzar contenido en un navegador web. Por motivos de seguridad, algunos esquemas de URI no estn permitidos cuando se utilizan estas API en AIR. La lista de esquemas no permitidos depende del entorno limitado de seguridad del cdigo que utilice la API. (Para obtener ms informacin sobre los entornos limitados de seguridad, consulte Seguridad en AIR en la pgina 1095.) Entorno limitado de la aplicacin (slo AIR) Se permiten los siguientes esquemas. Utilice estos esquemas del mismo modo que lo hara en un navegador web.
http: https: file: mailto: AIR dirige estas peticiones a la aplicacin de correo registrada en el sistema app: app-storage: sms: En los dispositivos mviles, AIR redirige las solicitudes sms: a la aplicacin de mensajes de texto predeterminada. (Si no hay configurada ninguna aplicacin para administrar las URL sms:, la solicitud no tendr efecto.) El formato de URL se debe ajustar a las convenciones del sistema con las que se ejecuta la aplicacin. Por ejemplo, en Android, el esquema de URI debe escribirse en minsculas. navigateToURL( new URLRequest( "sms:+15555550101") );
tel: En los dispositivos mviles, AIR redirige las solicitudes tel: a la aplicacin de marcado telefnico
predeterminada. (Si no hay configurada ninguna aplicacin para administrar las URL tel:, la solicitud no tendr efecto.) El formato de URL se debe ajustar a las convenciones del sistema con las que se ejecuta la aplicacin. Por ejemplo, en Android, el esquema de URI debe escribirse en minsculas.
navigateToURL( new URLRequest( "tel:5555555555") );
837
market: En los dispositivos mviles, AIR redirige las solicitudes market: a la aplicacin de mercado predeterminada. navigateToURL( new URLRequest( "market://search?q=Adobe Flash") ); navigateToURL( new URLRequest( "market://search?q=pname:com.adobe.flashplayer") );
El resto de esquemas de URL no estn permitidos. Entornos limitados remotos Se permiten los siguientes esquemas. Utilice estos esquemas del mismo modo que lo hara en un navegador web.
http: https: mailto: AIR dirige estas peticiones a la aplicacin de correo registrada en el sistema
El resto de esquemas de URI no estn permitidos. Entorno limitado de archivos locales del sistema de archivos Se permiten los siguientes esquemas. Utilice estos esquemas del mismo modo que lo hara en un navegador web.
file: mailto: AIR dirige estas peticiones a la aplicacin de correo registrada en el sistema
El resto de esquemas de URI no estn permitidos. Entorno limitado de archivos locales de red Se permiten los siguientes esquemas. Utilice estos esquemas del mismo modo que lo hara en un navegador web.
http: https: mailto: AIR dirige estas peticiones a la aplicacin de correo registrada en el sistema
El resto de esquemas de URI no estn permitidos. Entorno limitado de archivos de confianza Se permiten los siguientes esquemas. Utilice estos esquemas del mismo modo que lo hara en un navegador web.
file: http:
https:
mailto: AIR dirige estas peticiones a la aplicacin de correo registrada en el sistema
838
Los objetos LocalConnection de ActionScript 3.0 pueden comunicarse con objetos LocalConnection creados con
ActionScript 1.0 2.0.
Los objetos LocalConnection de ActionScript 1.0 2.0 pueden comunicarse con objetos LocalConnection creados
con ActionScript 3.0. Flash Player controla automticamente esta comunicacin entre objetos LocalConnection de distintas versiones. La manera ms simple de utilizar un objeto LocalConnection es permitir la comunicacin slo entre objetos LocalConnection ubicados en el mismo dominio o en la misma aplicacin de AIR. De este modo no es necesario preocuparse por la seguridad. Sin embargo, si debe permitir la comunicacin entre dominios, tiene varias maneras de implementar medidas de seguridad. Para obtener informacin, consulte la descripcin del parmetro connectionName del mtodo send() y las entradas allowDomain() y domain en el listado de clases LocalConnection en Referencia de ActionScript 3.0 para la plataforma de Adobe Flash. Es posible utilizar objetos LocalConnection para enviar y recibir datos en un solo archivo SWF, pero Adobe no recomienda esta prctica. Utilice objetos compartidos. Hay tres formas de aadir mtodos callback a los objetos LocalConnection:
Crear una subclase de la clase LocalConnection y aadir mtodos. Establecer la propiedad LocalConnection.client en un objeto que implemente los mtodos. Crear una clase dinmica que ample LocalConnection y asociar mtodos de forma dinmica.
839
La primera forma de aadir mtodos callback consiste en ampliar la clase LocalConnection. Los mtodos se definen en la clase personalizada en lugar de aadirlos de forma dinmica a la instancia de LocalConnection. Este enfoque se muestra en el siguiente cdigo:
package { import flash.net.LocalConnection; public class CustomLocalConnection extends LocalConnection { public function CustomLocalConnection(connectionName:String) { try { connect(connectionName); } catch (error:ArgumentError) { // server already created/connected } } public function onMethod(timeString:String):void { trace("onMethod called at: " + timeString); } } }
Para crear una nueva instancia de la clase CustomLocalConnection, se puede usar el siguiente cdigo:
var serverLC:CustomLocalConnection; serverLC = new CustomLocalConnection("serverName");
La segunda forma de aadir mtodos callback consiste en utilizar la propiedad LocalConnection.client. Esto implica crear una clase personalizada y asignar una nueva instancia a la propiedad client, como se muestra en el siguiente cdigo:
var lc:LocalConnection = new LocalConnection(); lc.client = new CustomClient();
La propiedad LocalConnection.client indica los mtodos callback del objeto que deben llamarse. En el cdigo anterior, la propiedad client se estableci en una nueva instancia de una clase personalizada, CustomClient. El valor predeterminado de la propiedad client es la instancia de LocalConnection actual. Se puede utilizar la propiedad client si se tienen dos controladores de datos con el mismo conjunto de mtodos pero distintos comportamientos; por ejemplo, en una aplicacin donde un botn de una ventana activa o desactiva la visualizacin en una segunda ventana. Para crear la clase CustomClient, se podra usar el siguiente cdigo:
package { public class CustomClient extends Object { public function onMethod(timeString:String):void { trace("onMethod called at: " + timeString); } } }
840
La tercera forma de aadir mtodos callback, que consiste en crear una clase dinmica y asociar los mtodos de forma dinmica, es muy similar a la utilizacin de la clase LocalConnection en versiones anteriores de ActionScript, como se muestra en el siguiente cdigo:
import flash.net.LocalConnection; dynamic class DynamicLocalConnection extends LocalConnection {}
Los mtodos callback pueden aadirse de forma dinmica a esta clase con el siguiente cdigo:
var connection:DynamicLocalConnection = new DynamicLocalConnection(); connection.onMethod = this.onMethod; // Add your code here. public function onMethod(timeString:String):void { trace("onMethod called at: " + timeString); }
No se recomienda la anterior forma de aadir mtodos callback porque el cdigo tiene una escasa portabilidad. Adems, si se utiliza este mtodo de creacin de conexiones locales, podran surgir problemas de rendimiento debido a que el acceso a las propiedades dinmicas es considerablemente ms lento que el acceso a las propiedades cerradas. Propiedad isPerUser La propiedad isPerUser se aadi a Flash Player (10.0.32) y a AIR (1.5.2) para resolver un conflicto que se produca cuando ms de un usuario se conectaba a un ordenador Mac. En otros sistemas operativos, esta propiedad se omite porque la conexin local siempre est destinada a usuarios individuales. La propiedad isPerUser debe establecerse como true en cdigo nuevo. Sin embargo, el valor predeterminado es actualmente false para permitir compatibilidad con versiones anteriores. El valor predeterminado puede cambiar en versiones futuras del motor de ejecucin.
841
package { import flash.net.LocalConnection; import flash.display.Sprite; public class ServerLC extends Sprite { public function ServerLC() { var lc:LocalConnection = new LocalConnection(); lc.client = new CustomClient1(); try { lc.connect("conn1"); } catch (error:Error) { trace("error:: already connected"); } } } }
Este cdigo primero crea un objeto LocalConnection denominado lc y define la propiedad client a un objeto clientObject. Cuando otra aplicacin llama a un mtodo en esta instancia LocalConnection, el motor de ejecucin busca ese mtodo en el objeto clientObject. Si ya se dispone de una conexin con el nombre especificado, se genera una excepcin de error de argumento, que indica que el intento de conexin fall porque el objeto ya est conectado. Cuando una instancia de Flash Player se conecta a este archivo SWF e intenta llamar a cualquier mtodo en la conexin local especificada, la peticin se enva a la clase especificada por la propiedad client, que se establece en la clase CustomClient1:
package { import flash.events.*; import flash.system.fscommand; import flash.utils.Timer; public class CustomClient1 extends Object { public function doMessage(value:String = ""):void { trace(value); } public function doQuit():void { trace("quitting in 5 seconds"); this.close(); var quitTimer:Timer = new Timer(5000, 1); quitTimer.addEventListener(TimerEvent.TIMER, closeHandler); } public function closeHandler(event:TimerEvent):void { fscommand("quit"); } } }
842
Para crear un servidor LocalConnection, hay que llamar al mtodo LocalConnection.connect() y proporcionar un nombre de conexin exclusivo. Si ya se dispone de una conexin con el nombre especificado, se genera un error ArgumentError, que indica que el intento de conexin fall porque el objeto ya est conectado. El siguiente fragmento demuestra cmo crear un LocalConnection con el nombre conn1:
try { connection.connect("conn1"); } catch (error:ArgumentError) { trace("Error! Server already exists\n"); }
La conexin a una aplicacin principal desde una aplicacin secundaria requiere primero crear un objeto LocalConnection en el objeto LocalConnection que se enva y luego llamar al mtodo LocalConnection.send() con el nombre de la conexin y del mtodo para ejecutar. Por ejemplo, para enviar el mtodo doQuit al objeto LocalConnection que ha creado anteriormente, use el siguiente cdigo:
sendingConnection.send("conn1", "doQuit");
Este cdigo se conecta a un objeto LocalConnection existente con el nombre de conexin conn1 e invoca al mtodo doMessage() en la aplicacin remota. Si desea enviar parmetros a la aplicacin remota, especifique argumentos adicionales despus del nombre del mtodo en el mtodo send(), como muestra el siguiente fragmento:
sendingConnection.send("conn1", "doMessage", "Hello world");
843
Hay dos valores especiales que se pueden pasar a los mtodos LocalConnection.allowDomain() y LocalConnection.allowInsecureDomain(): * y localhost. El valor de asterisco (*) permite el acceso desde todos los dominios. La cadena localhost permite llamadas a la aplicacin desde el contenido localmente instalado, pero fuera del directorio de recursos de la aplicacin. Si el mtodo LocalConnection.send() intenta comunicarse con una aplicacin desde un entorno limitado de seguridad al que el cdigo de llamada no tiene acceso, se distribuye un evento securityError(SecurityErrorEvent.SECURITY_ERROR). Para solucionar este error, puede especificar el dominio del origen de llamada en el mtodoLocalConnection.allowDomain() del receptor. S slo va a implementar la comunicacin entre el contenido del mismo dominio, especifique un parmetro
connectionName que no comience por un guin bajo (_) y que no especifique un nombre de dominio (por ejemplo, myDomain:connectionName). Utilice la misma cadena en el comando LocalConnection.connect(connectionName).
Si implementa la comunicacin entre contenidos en diferentes dominios, especifique una parmetro connectionName que comienza con un guin bajo. La especificacin de los guiones bajos permite que el contenido con el objeto LocalConnection receptor tenga una mayor portabilidad entre dominios. Estos son los dos casos posibles:
Si la cadena para connectionName no comienza por un guin bajo, el motor de ejecucin aade un prefijo con el
nombre del superdominio y dos puntos (por ejemplo, myDomain:connectionName). Aunque esto garantiza que la conexin no entre en conflicto con conexiones de otros dominios que tengan el mismo nombre, los objetos LocalConnection emisores deben especificar este superdominio (por ejemplo, myDomain:connectionName). Si el archivo HTML o SWF que contiene el objeto LocalConnection receptor se traslada a otro dominio, el motor de ejecucin cambia el prefijo para reflejar el nuevo superdominio (por ejemplo, anotherDomain:connectionName). Se deben editar manualmente todos los objetos LocalConnection emisores para que apunten al nuevo superdominio.
Si la cadena de connectionName comienza por un guin bajo (por ejemplo, _connectionName"), el motor de
ejecucin no aade un prefijo a la cadena. Esto significa que los objetos LocalConnection receptores y emisores utilizan idnticas cadenas para connectionName. Si el objeto receptor utiliza LocalConnection.allowDomain() para especificar que se acepten las conexiones de cualquier dominio, el SWF que contiene el objeto LocalConnection receptor se puede trasladar a otro dominio sin modificar ningn objeto LocalConnection emisor. La desventaja de utilizar nombres con guin bajo en connectionName es la posibilidad de interferencias, como por ejemplo cuando dos aplicaciones intentan conectarse utilizando el mismo connectionName. Una segunda desventaja relacionada se refiere a la seguridad. Los nombres de conexin que usan la sintaxis de guin bajo no identifican el dominio de la aplicacin que se detecta. Por estas razones, se prefieren los nombres completos de dominio. Adobe AIR Para comunicarse con el contenido ejecutado en el entorno limitado de seguridad de la aplicacin de AIR (contenido instalado con la aplicacin de AIR), debe aadir un prefijo al nombre de conexin con un superdominio que identifique la aplicacin de AIR. La cadena de superdominio comienza con app# seguida del ID de aplicacin y un punto (.), y el ID del editor (si est definido). Por ejemplo, el superdominio correcto para utilizar en el parmetro connectionName de una aplicacin con ID de aplicacin com.example.air.MyApp y sin ID de editor sera: "app#com.example.air.MyApp". As, si el nombre de conexin base es appConnection, toda la cadena que se utilizar en el parmetro connectionName es: "app#com.example.air.MyApp:appConnection". Si la aplicacin tiene ID de editor, ste tambin debe incluirse en la cadena de superdominio: "app#com.example.air.MyApp.B146A943FBD637B68C334022D304CEA226D129B4.1".
844
Cuando se permite que otra aplicacin de AIR se comunique con la aplicacin a travs de la conexin local, se debe llamar a allowDomain() del objeto LocalConnection, pasando el nombre del dominio de conexin local. Para una aplicacin de AIR, este nombre de dominio se forma del ID de editor y de la aplicacin de la misma manera que la cadena de conexin. Por ejemplo, si la aplicacin de AIR de envo tiene un ID de aplicacin com.example.air.FriendlyApp y un ID de editor 214649436BD677B62C33D02233043EA236D13934.1, entonces el la cadena de dominio que se usa para permitir la conexin de esta aplicacin es: app##com.example.air.FriendlyApp.214649436BD677B62C33D02233043EA236D13934.1. (En AIR 1.5.3, no todas las aplicaciones de AIR tienen ID de editor.)
845
En Mac OS es un archivo DMG. En Windows es un archivo EXE. En Linux es un paquete RPM o DEB.
Estas aplicaciones se conocen como aplicaciones de perfil de escritorio ampliado. Un archivo de instalacin nativo se puede crear especificando la opcin -target native al llamar al comando -package con el uso de ADT.
Ms temas de ayuda
flash.filesystem.File.openWithDefaultApplication() flash.desktop.NativeProcess
846
var nativeProcessStartupInfo:NativeProcessStartupInfo = new NativeProcessStartupInfo(); var file:File = File.applicationDirectory.resolvePath("test.exe"); nativeProcessStartupInfo.executable = file; var processArgs:Vector.<String> = new Vector.<String>(); processArgs.push("hello"); nativeProcessStartupInfo.arguments = processArgs; process = new NativeProcess(); process.addEventListener(ProgressEvent.STANDARD_OUTPUT_DATA, onOutputData); process.start(nativeProcessStartupInfo); public function onOutputData(event:ProgressEvent):void { var stdOut:ByteArray = process.standardOutput; var data:String = stdOut.readUTFBytes(process.standardOutput.bytesAvailable); trace("Got: ", data); }
Seleccione el archivo que desee iniciar. Almacene argumentos de la lnea de comandos para transmitir el proceso cuando se inicie. (opcional) Establezca el directorio de trabajo del proceso (opcional)
Para iniciar el proceso nativo, transmita el objeto NativeProcessInfo como parmetro del mtodo start() de un objeto NativeProcess. Por ejemplo, el siguiente cdigo muestra cmo iniciar una aplicacin test.exe en el directorio de la aplicacin. La aplicacin transmite el argumento "hello" y establece el directorio de documentos del usuario como directorio de trabajo:
var nativeProcessStartupInfo:NativeProcessStartupInfo = new NativeProcessStartupInfo(); var file:File = File.applicationDirectory.resolvePath("test.exe"); nativeProcessStartupInfo.executable = file; var processArgs:Vector.<String> = new Vector.<String>(); processArgs[0] = "hello"; nativeProcessStartupInfo.arguments = processArgs; nativeProcessStartupInfo.workingDirectory = File.documentsDirectory; process = new NativeProcess(); process.start(nativeProcessStartupInfo);
Para terminar el proceso, llame al mtodo exit() del objeto NativeProcess. Si quiere que un archivo sea ejecutable en su aplicacin instalada, asegrese de que lo es en el sistema de archivos en el momento de empaquetar la aplicacin. (En Mac y Linux, puede utilizar chmod para establecer el indicador de ejecutable, si es necesario.)
847
standardInput: contiene acceso a los datos del flujo de entrada estndar. standardOutput: contiene acceso a los datos del flujo de salida estndar. standardError: contiene acceso a los datos del flujo de error estndar.
Escritura en el flujo de entrada estndar Los datos se pueden escribir en el flujo de entrada estndar utilizando los mtodos de escritura de la propiedad standardInput del objeto NativeProcess. A medida que la aplicacin de AIR escribe datos en el proceso, el objeto NativeProcess distribuye eventos standardInputProgress. Si se produce un error al escribir en el flujo de entrada estndar, el objeto NativeProcess distribuye un evento
ioErrorStandardInput.
El flujo de entrada se puede cerrar llamando al mtodo closeInput() del objeto NativeProcess. Cuando el flujo de entrada se cierra, el objeto NativeProcess distribuye un evento standardInputClose.
var nativeProcessStartupInfo:NativeProcessStartupInfo = new NativeProcessStartupInfo(); var file:File = File.applicationDirectory.resolvePath("test.exe"); nativeProcessStartupInfo.executable = file; process = new NativeProcess(); process.start(nativeProcessStartupInfo); process.standardInput.writeUTF("foo"); if(process.running) { process.closeInput(); }
Lectura en el flujo de salida estndar Los datos se pueden leer en el flujo de salida estndar utilizando los mtodos de lectura de esta propiedad. A medida que la aplicacin de AIR obtiene datos del flujo de salida del proceso, el objeto NativeProcess distribuye eventos standardOutputData. Si se produce un error al escribir en el flujo de salida estndar, el objeto NativeProcess distribuye un evento standardOutputError. Cuando el proceso cierra el flujo de salida, el objeto NativeProcess distribuye el evento standardOutputClose. Cuando se leen datos del flujo de entrada estndar, es muy importante leerlos a medida que se generan. Dicho de otro modo, aada un detector de eventos para el evento standardOutputData. En el detector de eventos standardOutputData, lea los datos de la propiedad standardOutput del objeto NativeProcess. No se limite a esperar a que el evento standardOutputClose o exit lea todos los datos. Si no lee los datos a medida que el proceso nativo los genera, el bfer podra llenarse y los datos podran perderse. Un bfer lleno puede provocar que el proceso nativo se bloquee al intentar escribir ms datos. Sin embargo, si no registra un detector de eventos para el evento standardOutputData, el bfer no se llenar y el proceso no se bloquear. En ese caso, no podr acceder a los datos.
848
var nativeProcessStartupInfo:NativeProcessStartupInfo = new NativeProcessStartupInfo(); var file:File = File.applicationDirectory.resolvePath("test.exe"); nativeProcessStartupInfo.executable = file; process = new NativeProcess(); process.addEventListener(ProgressEvent.STANDARD_OUTPUT_DATA, dataHandler); process.start(nativeProcessStartupInfo); var bytes:ByteArray = new ByteArray(); function dataHandler(event:ProgressEvent):void { bytes.writeBytes(process.standardOutput.readBytes(process.standardOutput.bytesAvailable); }
Lectura del flujo de error estndar Los datos se pueden leer en el flujo de error estndar utilizando los mtodos de lectura de esta propiedad. A medida que la aplicacin de AIR lee los datos del flujo de error del proceso, el objeto NativeProcess distribuye eventos standardErrorData. Si se produce un error al escribir en el flujo de error estndar, el objeto NativeProcess distribuye un evento standardErrorIoError. Cuando el proceso cierra el flujo de error, el objeto NativeProcess distribuye un evento standardErrorClose.. Cuando se leen datos del flujo de error estndar, es muy importante leerlos a medida que se generan. Dicho de otro modo, aada un detector de eventos para el evento standardErrorData. En el detector de eventos standardErrorData, lea los datos de la propiedad standardError del objeto NativeProcess. No se limite a esperar a que el evento standardErrorClose o exit lea todos los datos. Si no lee los datos a medida que el proceso nativo los genera, el bfer podra llenarse y los datos podran perderse. Un bfer lleno puede provocar que el proceso nativo se bloquee al intentar escribir ms datos. Sin embargo, si no registra un detector de eventos para el evento standardErrorData, el bfer no se llenar y el proceso no se bloquear. En ese caso, no podr acceder a los datos.
var nativeProcessStartupInfo:NativeProcessStartupInfo = new NativeProcessStartupInfo(); var file:File = File.applicationDirectory.resolvePath("test.exe"); nativeProcessStartupInfo.executable = file; process = new NativeProcess(); process.addEventListener(ProgressEvent.STANDARD_ERROR_DATA, errorDataHandler); process.start(nativeProcessStartupInfo); var errorBytes:ByteArray = new ByteArray(); function errorDataHandler(event:ProgressEvent):void { bytes.writeBytes(process.standardError.readBytes(process.standardError.bytesAvailable); }
849
Sin embargo, validar los datos entrantes puede resultar difcil. Para evitar esta dificultad, es mejor escribir una aplicacin nativa (como un archivo EXE en Windows) con API especficas. Estas API deben procesar slo dichos comandos definidos por la aplicacin. Por ejemplo, la aplicacin slo puede aceptar una serie limitada de instrucciones a travs de la secuencia de entrada estndar. En Windows, AIR no le permite ejecutar archivos .bat directamente. La aplicacin del interpretador de comandos (cmd.exe) ejecuta archivos .bat de Windows. Cuando se invoca un archivo .bat, esta aplicacin de comandos puede interpretar argumentos que se transfieren al comando como aplicaciones adicionales para iniciar. La presencia maliciosa de caracteres adicionales en la cadena del argumento puede provocar que un cmd.exe ejecute una aplicacin insegura o daina. Por ejemplo, sin una validacin adecuada de datos, la aplicacin de AIR puede llamar a myBat.bat myArguments c:/diablo.exe. La aplicacin de comandos iniciara la aplicacin diablo.exe adems de ejecutar el archivo por lotes.
850
Obtener informacin acerca de la aplicacin contenedora Utilizar ActionScript para llamar a cdigo de una aplicacin contenedora, incluida una pgina web o una aplicacin
de escritorio
Llamar a cdigo de ActionScript desde el cdigo de una aplicacin contenedora Crear un proxy para simplificar las llamadas al cdigo de ActionScript desde una aplicacin contenedora
Nota: esta seccin sobre la interfaz externa slo describe la comunicacin entre el cdigo ActionScript de un archivo SWF y la aplicacin contenedora que incluye una referencia a la instancia de Flash Player en la que se carga el archivo SWF. En esta documentacin no se tratan otros usos de Flash Player en una aplicacin. Flash Player se ha diseado para utilizarse como un complemento de navegador o un proyector (aplicacin autnoma). Puede haber compatibilidad limitada con otros escenarios de uso. Uso de la API externa en AIR Dado que una aplicacin de AIR no tiene ningn contenedor externo, esta interfaz externa no suele activarse (ni suele necesitarse). Si su aplicacin de AIR carga un archivo SWF directamente, el cdigo de la aplicacin puede comunicarse directamente con el cdigo ActionScript del SWF (sujeto a restricciones del entorno limitado de seguridad). No obstante, cuando su aplicacin de AIR carga un archivo SWF mediante una pgina HTML en un objeto HTMLLoader (o un componente HTML en Flex), el objeto HTMLLoader hace de contenedor externo. De este modo, puede utilizar la interfaz externa para comunicarse entre el cdigo ActionScript en el archivo SWF cargado y el cdigo JavaScript en la pgina HTML cargada en el objeto HTMLLoader.
851
Para simplificar el proceso de realizacin de llamadas a funciones externas, convirtiendo las llamadas a funciones
nativas de la aplicacin que llama en un formato comprensible por la aplicacin externa..
Para evitar limitaciones de seguridad u otras restricciones que impiden a la aplicacin que llama comunicarse
directamente con la aplicacin externa.
Serializar Convertir objetos o valores de datos a un formato que se pueda utilizar para transmitir los valores en
mensajes entre dos sistemas de programacin, como a travs de Internet o entre dos aplicaciones diferentes que se ejecutan en un mismo equipo. Ejecucin de los ejemplos del captulo Muchos de los ejemplos de cdigo proporcionados son pequeos fragmentos de cdigo incluidos con fines de demostracin, no ejemplos completos o cdigo de comprobacin de valores. Como el uso de la API externa requiere (por definicin) escribir cdigo ActionScript as como cdigo en una aplicacin contenedora, para probar los ejemplos hay que crear un contenedor (por ejemplo, una pgina web que contenga el archivo SWF) y utilizar los listados de cdigo para interactuar con el contenedor.
852
Para probar un ejemplo de comunicacin entre ActionScript y JavaScript: 1 Cree un nuevo documento utilizando Flash Professional y gurdelo en su equipo.
2 En el men principal, elija Archivo > Configuracin de publicacin. 3 En el cuadro de dilogo Configuracin de publicacin, en la ficha Formatos, compruebe que slo estn activadas
nombre que utiliz para guardar el documento de Haga clic en Aceptar para cerrar el cuadro de dilogo Configuracin de publicacin.
5 Desactive la casilla de verificacin HTML. Una vez generada la pgina HTML, va a modificarla para aadir el
cdigo JavaScript apropiado. Si desactiva la casilla de verificacin HTML, cuando modifique la pgina HTML, Flash no sobrescribir los cambios con una nueva pgina HTML al publicar el archivo SWF.
6 Haga clic en Aceptar para cerrar el cuadro de dilogo Configuracin de publicacin. 7 Con un editor de HTML o texto, abra el archivo HTML creado por Flash al publicar el archivo SWF. En el cdigo
fuente HTML, agregue etiquetas de apertura y cierre script y cpielas en el cdigo JavaScript del listado de cdigo de ejemplo:
<script> // add the sample JavaScript code here </script>
8 Guarde el archivo HTML y vuelva a Flash. 9 Seleccione el fotograma clave del Fotograma 1 de la lnea de tiempo y abra el panel Acciones. 10 Copie el listado de cdigo ActionScript en el panel Script. 11 En el men principal, elija Archivo > Publicar para actualizar el archivo SWF con los cambios realizados. 12 Abra la pgina HTML editada en un navegador web para verla y probar la comunicacin entre ActionScript y la
pgina HTML. Para probar un ejemplo de comunicacin entre ActionScript y un contenedor ActiveX: 1 Cree un nuevo documento utilizando Flash Professional y gurdelo en su equipo. Puede guardarlo en cualquier carpeta en la que la aplicacin contenedora espere encontrar el archivo SWF.
2 En el men principal, elija Archivo > Configuracin de publicacin. 3 En el cuadro de dilogo Configuracin de publicacin, en la ficha Formatos, compruebe que slo est activada la
la carpeta en la que desea que se publique el archivo SWF. Al establecer la ubicacin del archivo SWF se puede, por ejemplo, mantener el documento en una carpeta y colocar el archivo SWF publicado en otra carpeta, como la carpeta que contiene el cdigo fuente de la aplicacin contenedora.
5 Seleccione el fotograma clave del Fotograma 1 de la lnea de tiempo y abra el panel Acciones. 6 Copie el listado de cdigo ActionScript del ejemplo en el panel Script. 7 En el men principal, elija Archivo > Publicar para volver a publicar el archivo SWF. 8 Cree y ejecute la aplicacin contenedora para probar la comunicacin entre ActionScript y dicha aplicacin.
Para ver ejemplos completos del uso de la API externa para comunicarse con una pgina HTML y una aplicacin de escritorio escrita en C#, consulte los siguientes temas:
Ejemplo de API externa: Comunicacin entre ActionScript y JavaScript en un navegador web en la pgina 858
853
Ejemplo de API externa: Comunicacin entre ActionScript y una aplicacin de escritorio que utiliza el control
ActiveX en la pgina 864 Estos ejemplos incluyen el cdigo completo, incluido el cdigo de comprobacin de errores de ActionScript y de la aplicacin contenedora que se debe utilizar al escribir cdigo con la API externa. Otro ejemplo completo de uso de la API externa es el ejemplo de la clase ExternalInterface de la Referencia de ActionScript 3.0.
En todas las versiones compatibles de Internet Explorer para Windows (5.0 y versiones posteriores) En una aplicacin contenedora, como una aplicacin de escritorio que utilice una instancia del control ActiveX de
Flash Player
En cualquier navegador que admita la interfaz NPRuntime, que actualmente incluye Firefox 1.0 y posterior, Mozilla
1.7.5 y posterior, Netscape 8.0 y posterior y Safari 1.3 y posterior. En todas las dems situaciones (como al ejecutarse en un reproductor autnomo), la propiedad ExternalInterface.available devuelve el valor false. Desde ActionScript se puede llamar a una funcin de JavaScript en la pgina HTML. La API externa ofrece las siguientes mejoras con respecto a fscommand():
Se puede utilizar cualquier funcin de JavaScript, no slo que se usan con la funcin fscommand(). Se puede pasar un nmero arbitrario de argumentos y los argumentos pueden tener el nombre que se desee; no
existe la limitacin de pasar un comando con un nico argumento de tipo cadena. Esto hace que la API externa sea mucho ms flexible que fscommand().
Se pueden pasar diversos tipos de datos (como Boolean, Number y String); ya no se est limitado a los parmetros
de tipo String.
Se puede recibir el valor de una llamada y ese valor vuelve inmediatamente a ActionScript (como valor devuelto de
la llamada que se realiza).
854
Importante: si el nombre que se asigna a la instancia de Flash Player en una pgina HTML (el atributo id de la etiqueta object) incluye un guin (-) u otros caracteres que se definen como operadores en JavaScript (por ejemplo, +, *, /, \, ., etc), las llamadas a ExternalInterface desde ActionScript no funcionarn cuando la pgina web contenedora se visualice en Internet Explorer. Asimismo, si las etiquetas HTML que definen la instancia de Flash Player (etiquetas object y embed) se anidan en una etiqueta HTML form, las llamadas a ExternalInterface desde ActionScript no funcionarn.
Nota: la propiedad ExternalInterface.available indica si el contenedor que se est utilizando en esos momentos es de un tipo compatible con la conectividad mediante ExternalInterface. No indicar si JavaScript est habilitado en el navegador. La propiedad ExternalInterface.objectID permite determinar el identificador exclusivo de la instancia de Flash Player (especficamente, el atributo id de la etiqueta object en Internet Explorer o el atributo name de la etiqueta embed en los navegadores que usan la interfaz NPRuntime). Este identificador exclusivo representa al documento SWF actual en el navegador y se puede utilizar para hacer referencia al documento SWF (por ejemplo, al llamar a una funcin de JavaScript en una pgina HTML contenedora). Cuando el contenedor de Flash Player no es un navegador web, esta propiedad es null.
855
Si el contenedor es una pgina HTML, este mtodo invocar a la funcin de JavaScript con el nombre especificado, que debe estar definida en un elemento script en la pgina HTML contenedora. El valor devuelto por la funcin de JavaScript se devuelve a ActionScript.
<script language="JavaScript"> // adds two numbers, and sends the result back to ActionScript function addNumbers(num1, num2) { return (num1 + num2); } </script>
Si el contenedor es algn otro contenedor ActiveX, este mtodo hace que el control ActiveX de Flash Player distribuya su evento FlashCall. Flash Player serializa en una cadena XML el nombre de la funcin especificada y todos los parmetros. El contenedor puede acceder a esa informacin de la propiedad request del objeto de evento y utilizarla para determinar el modo en que se ejecutar su propio cdigo. Para devolver un valor a ActionScript, el cdigo del contenedor llama al mtodo SetReturnValue() del objeto ActiveX y pasa el resultado (serializado en una cadena XML) como parmetro de ese mtodo. Para obtener ms informacin sobre el formato XML utilizado para esta comunicacin, consulte Formato XML de la API externa en la pgina 856. Tanto si el contenedor es un navegador web como si otro contenedor ActiveX, en el caso de que se produzca un error en la llamada o el mtodo del contenedor no especifique un valor devuelto, se devolver null. El mtodo ExternalInterface.call() emite una excepcin SecurityError si el entorno contenedor pertenece a un entorno limitado de seguridad al que no tiene acceso el cdigo que realiza la llamada. Se puede solucionar esta limitacin asignando un valor adecuado a allowScriptAccess en el entorno contenedor. Por ejemplo, para cambiar el valor de allowScriptAccess en una pgina HTML, es necesario editar el atributo adecuado en las etiquetas object y embed.
856
El mtodo addCallback() utiliza dos parmetros: El primero, un nombre de funcin con formato String, es el nombre por el que se conocer a la funcin en el contenedor. El segundo parmetro es la funcin real de ActionScript que se ejecutar cuando el contenedor llame al nombre de funcin definido. Dado que estos dos nombres son distintos, se puede especificar un nombre de funcin que se utilizar en el contenedor incluso si la funcin real de ActionScript tiene un nombre distinto. Esto resulta especialmente til si no se conoce el nombre de la funcin (por ejemplo, cuando se especifica una funcin annima o cuando la funcin que ha de llamarse se determina en tiempo de ejecucin). Una vez que la funcin de ActionScript se registra en la clase ExternalInterface, el contenedor puede llamar a la funcin. La forma de realizar esto vara segn el tipo de contenedor. Por ejemplo, en el cdigo JavaScript en un navegador web, la funcin de ActionScript se llama utilizando el nombre de funcin registrado como si fuese un mtodo del objeto del navegador de Flash Player (es decir, un mtodo del objeto JavaScript que representa a la etiqueta object o embed). Dicho de otro modo, se pasan los parmetros y se devuelve el resultado como si se llamase a una funcin local.
<script language="JavaScript"> // callResult gets the value "busy signal" var callResult = flashObject.myFunction("my name"); </script> ... <object id="flashObject"...> ... <embed name="flashObject".../> </object>
Por otra parte, al llamar a una funcin de ActionScript en un archivo SWF que se ejecuta en una aplicacin de escritorio, el nombre de funcin registrado y los parmetros deben serializarse en una cadena con formato XML. A continuacin, se efecta la llamada llamando al mtodo CallFunction() del control ActiveX con la cadena XML como parmetro. Para obtener ms informacin sobre el formato XML utilizado para esta comunicacin, consulte Formato XML de la API externa en la pgina 856. En cualquiera de los dos casos, el valor devuelto por la funcin de ActionScript se pasa al cdigo del contenedor, ya sea directamente como un valor si la llamada se origina en el cdigo JavaScript de un navegador o serializado como una cadena con formato XML si la llamada se origina en un contenedor ActiveX.
857
<invoke name="functionName" returntype="xml"> <arguments> ... (individual argument values) </arguments> </invoke>
El nodo raz es invoke, Cuenta con dos atributos: name indica el nombre de la funcin que se va a llamar y returntype siempre es xml. Si la llamada a la funcin incluye parmetros, el nodo invoke tendr un nodo secundario arguments, cuyos nodos secundarios sern los valores de los parmetros a los que se ha dado el formato de valor individual que se explica a continuacin. Los valores individuales, incluidos los parmetros de las funciones y los valores devueltos por stas, utilizan un esquema de formato que, adems de los valores reales, incluye informacin sobre los tipos de datos. En la siguiente tabla se indican las clases de ActionScript y el formato XML utilizado para codificar los valores de ese tipo de datos:
Clase/Valor de ActionScript null Boolean true Boolean false String Number, int, uint Array (los elementos pueden ser de varios tipos) Clase/Valor de C# Formato Comentarios
null bool true bool false cadena single, double, int, uint
<array> Un conjunto que admite elementos de varios tipos, <property id="0"> como ArrayList u object[] <number>27.5</number>
</property> <property id="1"> <string>Hello there!</string> </property> ... </array> <object> <property id="name"> <string>John Doe</string> </property> <property id="age"> <string>33</string> </property> ... </object> <null/> or <object></object>
El nodo property define elementos individuales y el atributo id es el ndice numrico de base cero.
Object
Un diccionario con claves de tipo cadena y valores de objeto, como un objeto HashTable con claves de tipo cadena
El nodo property define propiedades individuales y el atributo id es el nombre de la propiedad (una cadena). ActionScript codifica otros objetos como null o como un objeto vaco. En ambos casos, los valores de la propiedad se pierden.
Nota: a modo de ejemplo, esta tabla muestra las clases de C# equivalentes adems de las clases de ActionScript; no obstante, la API externa se puede usar para comunicarse con cualquier lenguaje de programacin o entorno de tiempo de ejecucin compatible con los controles ActiveX y no se limita a las aplicaciones C#. Cuando se crean aplicaciones propias utilizando la API externa con una aplicacin contenedora ActiveX, suele resultar cmodo escribir un proxy encargado de la tarea de convertir las llamadas a funciones nativas en el formato XML serializado. Para ver un ejemplo de una clase proxy escrita en C#, consulte Dentro de la clase ExternalInterfaceProxy en la pgina 868.
858
Iniciacin adecuada de la comunicacin comprobando que el navegador est listo para ello antes de establecer la
comunicacin.
Comprobacin de que el contenedor es compatible con la API externa. Llamada a funciones de JavaScript desde ActionScript, paso de parmetros y recepcin de valores como respuesta. Preparacin de mtodos de ActionScript para que puedan ser llamados y ejecucin de dichas llamadas.
Para obtener los archivos de la aplicacin de este ejemplo, consulte www.adobe.com/go/learn_programmingAS3samples_flash_es. Los archivos de la aplicacin Introvert IM se encuentran en la carpeta Samples/IntrovertIM_HTML. La aplicacin consta de los siguientes archivos:
Archivo IntrovertIMApp.fla o IntrovertIMApp.mxml com/example/programmingas3/introvertIM/IMManager.as La clase que establece y gestiona la comunicacin entre ActionScript y el contenedor. Tipo de evento personalizado distribuido por la clase IMManager cuando se recibe un mensaje del contenedor. Enumeracin cuyos valores representan los distintos estados de "disponibilidad" que se pueden seleccionar en la aplicacin. La pgina HTML de la aplicacin para Flash (htmlflash/IntrovertIMApp.html) o la plantilla que se utiliza para crear la pgina HTML contenedora de la aplicacin para Adobe Flex (htmltemplate/index.template.html). Este archivo contiene todas las funciones de JavaScript que constituyen la parte contenedora de la aplicacin. Descripcin El archivo de aplicacin principal para Flash (FLA) o Flex (MXML).
com/example/programmingas3/introvertIM/IMMessageEvent.as
com/example/programmingas3/introvertIM/IMStatus.as
html-flash/IntrovertIMApp.html or html-template/index.template.html
859
860
En primer lugar, el cdigo comprueba si la API externa est disponible en el contendor actual utilizando la propiedad ExternalInterface.available. En caso afirmativo, inicia el proceso de establecimiento de la comunicacin. Dado que pueden producirse excepciones de seguridad y otros errores al intentar comunicarse con una aplicacin externa, el cdigo se escribe dentro de un bloque try (los bloques catch correspondientes se han omitido del listado en aras de la brevedad). A continuacin, el cdigo llama al mtodo isContainerReady(), que se muestra aqu:
private function isContainerReady():Boolean { var result:Boolean = ExternalInterface.call("isReady"); return result; }
El mtodo isContainerReady() usa a su vez el mtodo ExternalInterface.call() para llamar a la funcin de JavaScript isReady() del modo siguiente:
<script language="JavaScript"> <!-// ------- Private vars ------var jsReady = false; ... // ------- functions called by ActionScript ------// called to check if the page has initialized and JavaScript is available function isReady() { return jsReady; } ... // called by the onload event of the <body> tag function pageInit() { // Record that JavaScript is ready to go. jsReady = true; } ... //--> </script>
La funcin isReady() simplemente devuelve el valor de la variable jsReady . Inicialmente, la variable tiene el valor false; una vez que el evento onload de la pgina web se ha activado, el valor de la variable cambia a true. Dicho de otro modo, si ActionScript llama a la funcin isReady() antes de que se cargue la pgina, JavaScript devuelve false a ExternalInterface.call("isReady") y, por lo tanto, el mtodo isContainerReady() de ActionScript devuelve false. Una vez que la pgina se ha cargado, la funcin isReady() de JavaScript devuelve true, de modo que el mtodo isContainerReady() de ActionScript tambin devuelve true. De vuelta en el constructor de IMManager ocurre una de las dos cosas siguientes, en funcin de la disponibilidad del contenedor. Si isContainerReady() devuelve true, el cdigo simplemente llama al mtodo setupCallbacks(), que completa el proceso de configuracin de la comunicacin con JavaScript. Por otra parte, si isContainerReady() devuelve false, el proceso se pone en espera. Se crea un objeto Timer y se le indica que llame al mtodo timerHandler() cada 100 milisegundos del modo siguiente:
861
private function timerHandler(event:TimerEvent):void { // Check if the container is now ready. var isReady:Boolean = isContainerReady(); if (isReady) { // If the container has become ready, we don't need to check anymore, // so stop the timer. Timer(event.target).stop(); // Set up the ActionScript methods that will be available to be // called by the container. setupCallbacks(); } }
Cada vez que se llama al mtodo timerHandler(), ste vuelve a comprobar el resultado del mtodo isContainerReady(). Una vez que se inicializa el contenedor, el mtodo devuelve true. En ese momento, el cdigo detiene el temporizador y llama al mtodo setupCallbacks() para terminar el proceso de configuracin de las comunicaciones con el navegador.
El mtodo setCallBacks() finaliza la tarea de preparar la comunicacin con el contenedor llamando a ExternalInterface.addCallback() para registrar los dos mtodos que estarn disponibles para ser llamados desde JavaScript. En este cdigo, el primer parmetro (el nombre por el que el mtodo se conoce en JavaScript, "newMessage" y "getStatus") es el mismo que el nombre del mtodo en ActionScript (en este caso no haba ninguna ventaja en usar nombres distintos, as que se reutiliz el mismo nombre por simplificar). Por ltimo, el mtodo ExternalInterface.call() se utiliza para llamar a la funcin setSWFIsReady() de JavaScript, que notifica al contenedor que las funciones ActionScript se han registrado.
862
En otro ejemplo del mtodo isContainerReady(), ActionScript llama a la funcin isReady() y recibe un valor Boolean como respuesta:
var result:Boolean = ExternalInterface.call("isReady");
Tambin se puede pasar parmetros a funciones de JavaScript a travs de la API externa. Esto puede observarse, por ejemplo, en el mtodo sendMessage() de la clase IMManager, al que se llama cuando el usuario enva un mensaje nuevo a su "interlocutor":
public function sendMessage(message:String):void { ExternalInterface.call("newMessage", message); }
De nuevo se utiliza ExternalInterface.call() para llamar a la funcin de JavaScript designada, que notifica al navegador que hay un nuevo mensaje. Adems, el mensaje en s se pasa como un parmetro adicional a ExternalInterface.call() y, por lo tanto, se pasa como un parmetro a la funcin de JavaScript newMessage().
El cdigo comprueba el valor de la variable swfReady, que determina si el archivo SWF ha notificado al navegador que ste ha registrado sus mtodos en la clase ExternalInterface. Si el archivo SWF est listo para recibir comunicaciones, la siguiente lnea (var currentStatus = ...) llama al mtodo getStatus() de la clase IMManager. En esta lnea de cdigo ocurren tres cosas:
Se llama a la funcin getSWF() de JavaScript, que devuelve una referencia al objeto JavaScript que representa al
archivo SWF. El parmetro pasado a getSWF() determina qu objeto de navegador se devuelve en caso de que haya ms un archivo SWF en una pgina HTML. El valor pasado a ese parmetro debe coincidir con el atributo id de la etiqueta object y el atributo name de la etiqueta embed utilizada para incluir el archivo SWF.
Se utiliza la referencia al archivo SWF para llamar al mtodo getStatus() como si fuese un mtodo del objeto
SWF. En este caso, se utiliza el nombre de funcin "getStatus", ya que ese el nombre con el que se ha registrado la funcin de ActionScript mediante ExternalInterface.addCallback().
863
El mtodo getStatus() de ActionScript devuelve un valor, que se asigna a la variable currentStatus, que se
asigna a su vez como contenido (la propiedad value) del campo de texto status. Nota: si sigue el cdigo, probablemente se habr dado cuenta de que en el cdigo fuente de la funcin updateStatus(), la lnea de cdigo que llama a la funcin getSWF() en realidad se escribe del modo siguiente: var currentStatus = getSWF("${application}").getStatus(); El texto ${application} es un marcador de posicin de la plantilla de la pgina HTML; cuando Adobe Flex Builder genera la pgina HTML real de la aplicacin, este texto se sustituye por el texto utilizado como atributo id de la etiqueta object y como atributo name de la etiqueta embed (IntrovertIMApp en el ejemplo). Ese es el valor que espera la funcin getSWF(). En la funcin sendMessage() de JavaScript se muestra el modo de pasar un parmetro a una funcin de ActionScript sendMessage() es la funcin llamada cuando el usuario pulsa el botn Send de la pgina HTML).
<script language="JavaScript"> ... function sendMessage(message) { if (swfReady) { ... getSWF("IntrovertIMApp").newMessage(message); } } ... </script>
El mtodo newMessage() de ActionScript espera un parmetro, de modo que la variable message de JavaScript se pasa a ActionScript usndola como parmetro en la llamada al mtodo newMessage() en el cdigo JavaScript.
Si el script no detecta el tipo de navegador del usuario, puede producirse un comportamiento inesperado al reproducir archivos SWF en un contenedor HTML.
864
Ejemplo de API externa: Comunicacin entre ActionScript y una aplicacin de escritorio que utiliza el control ActiveX
Flash Player 9 y posterior En este ejemplo se muestra el uso de la API externa para establecer una comunicacin entre ActionScript y una aplicacin de escritorio que usa el control ActiveX. Para el ejemplo se reutiliza la aplicacin Introvert IM, incluido el cdigo ActionScript e incluso el mismo archivo SWF y, por lo tanto, no se describe el uso de la API externa en ActionScript. Para entender este ejemplo, resultar de utilidad estar familiarizado con el anterior. La aplicacin de escritorio de este ejemplo se ha escrito en C# con Microsoft Visual Studio .NET. El anlisis se centra en las tcnicas especficas para trabajar con la API externa usando el control ActiveX. En este ejemplo se muestran los siguientes procedimientos:
Llamar a funciones ActionScript desde una aplicacin de escritorio que aloja el control ActiveX de Flash Player. Recibir llamadas a funciones desde ActionScript y procesarlas en un contenedor ActiveX. Utilizar una clase proxy para ocultar los detalles del formato XML serializado que utiliza Flash Player para los
mensajes enviados a un contenedor ActiveX. Para obtener los archivos de la aplicacin de este ejemplo, consulte www.adobe.com/go/learn_programmingAS3samples_flash_es. Los archivos C# de Introvert IM se encuentran en la carpeta Samples/IntrovertIM_CSharp. La aplicacin consta de los siguientes archivos:
Archivo AppForm.cs bin/Debug/IntrovertIMApp.swf ExternalInterfaceProxy/ExternalInterfaceProxy.cs Descripcin El archivo de aplicacin principal con la interfaz Windows Forms en C#. El archivo SWF que carga la aplicacin. La clase que acta como envolvente del control ActiveX para la comunicacin con la interfaz externa. Proporciona mecanismos para llamar y recibir llamadas desde ActionScript. La clase que realiza la tarea de convertir los mensajes en formato XML de Flash Player en objetos .NET. Este archivo define dos tipos C# (clases): una clase de delegado personalizada y una clase de argumentos de evento, ambas utilizadas por la clase ExternalInterfaceProxy para notificar a un detector la existencia de una llamada a funcin desde ActionScript. Esta clase es un valor de objeto que representa una llamada a una funcin desde ActionScript al contenedor ActiveX, con propiedades para el nombre de funcin y los parmetros. El archivo SWF que carga la aplicacin. Ensamblados de envolventes creados por Visual Studio .NET que son necesarios para acceder al control ActiveX de Flash Player (Adobe Shockwave Flash) desde el cdigo administrado.
ExternalInterfaceProxy/ExternalInterfaceSerializer.cs
ExternalInterfaceProxy/ExternalInterfaceEventArgs.cs
ExternalInterfaceProxy/ExternalInterfaceCall.cs
865
Visual Studio 2005. En el men contextual, seleccione Agregar o quitar elementos en Visual Studio 2003 (Elegir elementos... en Visual Studio 2005). Se abrir el cuadro de dilogo Personalizar cuadro de herramientas (2003)/Elegir elementos del cuadro de herramientas (2005).
3 Seleccione la ficha Componentes COM, en la que aparecen todos los componentes COM disponibles en el equipo,
Si este elemento no aparece en la lista, compruebe que el control ActiveX de Flash Player est instalado en el equipo.
866
El ejemplo de Introvert IM en C# incluye un conjunto de clases que permiten evitar la tarea de dar formato a los mensajes; en vez de eso, es posible trabajar con tipos de datos estndar al llamar a funciones ActionScript y recibir llamadas a funciones desde ActionScript. La clase ExternalInterfaceProxy, junto con otras clases auxiliares, proporcionan esta funcionalidad y se pueden reutilizar en cualquier proyecto .NET para facilitar la comunicacin con la API externa. Las siguientes secciones de cdigo son extractos del formulario de aplicacin principal (AppForm.cs) que muestran la interaccin simplificada que se logra utilizando la clase ExternalInterfaceProxy:
public class AppForm : System.Windows.Forms.Form { ... private ExternalInterfaceProxy proxy; ... public AppForm() { ... // Register this app to receive notification when the proxy receives // a call from ActionScript. proxy = new ExternalInterfaceProxy(IntrovertIMApp); proxy.ExternalInterfaceCall += new ExternalInterfaceCallEventHandler(proxy_ExternalInterfaceCall); ... } ...
La aplicacin declara y crea una instancia de ExternalInterfaceProxy llamada proxy, que pasa una referencia al control ActiveX de Shockwave Flash que se encuentra en la interfaz de usuario (IntrovertIMApp). A continuacin, el cdigo registra el mtodo proxy_ExternalInterfaceCall() para recibir el evento ExternalInterfaceCall del proxy. La clase ExternalInterfaceProxy distribuye este evento cuando llega una llamada a una funcin desde Flash Player. Al suscribirse a este evento, el cdigo C# puede recibir llamadas a funciones (y responderlas) desde ActionScript. Cuando llega una llamada a una funcin desde ActionScript, la instancia de ExternalInterfaceProxy (proxy) recibe la llamada, convierte el formato XML y notifica a los objetos que son detectores del evento ExternalInterfaceCall de proxy. En el caso de la clase AppForm, el mtodo proxy_ExternalInterfaceCall() gestiona ese evento del modo siguiente:
867
/// <summary> /// Called by the proxy when an ActionScript ExternalInterface call /// is made by the SWF /// </summary> private object proxy_ExternalInterfaceCall(object sender, ExternalInterfaceCallEventArgs e) { switch (e.FunctionCall.FunctionName) { case "isReady": return isReady(); case "setSWFIsReady": setSWFIsReady(); return null; case "newMessage": newMessage((string)e.FunctionCall.Arguments[0]); return null; case "statusChange": statusChange(); return null; default: return null; } } ...
El mtodo pasa una instancia de ExternalInterfaceCallEventArgs llamada e en este ejemplo. Ese objeto, a su vez, tiene una propiedad FunctionCall que es una instancia de la clase ExternalInterfaceCall. Una instancia de ExternalInterfaceCall es un valor de objeto sencillo con dos propiedades. La propiedad
FunctionName contiene el nombre de la funcin especificado en la sentencia ExternalInterface.Call() de
ActionScript. Si se aaden ms parmetros en ActionScript, stos se incluirn en la propiedad Arguments del objeto ExternalInterfaceCall. En este caso, el mtodo que gestiona el evento es simplemente una sentencia switch que acta como un controlador de trfico. El valor de la propiedad FunctionName (e.FunctionCall.FunctionName) determina el mtodo de la clase AppForm al que se llamar. Las ramas de la sentencia switch del listado de cdigo anterior muestran situaciones comunes de llamadas a mtodos. Por ejemplo, todo mtodo debe devolver un valor a ActionScript (por ejemplo, la llamada al mtodo isReady()) o bien devolver null (segn se muestra en las dems llamadas a mtodos). En la llamada al mtodo newMessage() (que pasa un parmetro e.FunctionCall.Arguments[0], es decir, el primer elemento del conjunto Arguments) se muestra el acceso a los parmetros pasados desde ActionScript. Llamar a una funcin de ActionScript desde C# utilizando la clase ExternalInterfaceProxy es an ms sencillo que recibir una llamada a una funcin desde ActionScript. Para llamar a una funcin de ActionScript se utiliza el mtodo Call() de la instancia de ExternalInterfaceProxy de la siguiente forma:
868
/// <summary> /// Called when the "Send" button is pressed; the value in the /// MessageText text field is passed in as a parameter. /// </summary> /// <param name="message">The message to send.</param> private void sendMessage(string message) { if (swfReady) { ... // Call the newMessage function in ActionScript. proxy.Call("newMessage", message); } } ... /// <summary> /// Call the ActionScript function to get the current "availability" /// status and write it into the text field. /// </summary> private void updateStatus() { Status.Text = (string)proxy.Call("getStatus"); } ... }
Como muestra este ejemplo, el mtodo Call() de la clase ExternalInterfaceProxy es muy similar a su homlogo de ActionScript, ExternalInterface.Call(). El primer parmetro es una cadena, el nombre de la funcin que se va a llamar. Los parmetros adiciones (que no se muestran aqu) se pasan tambin a la funcin de ActionScript. Si la funcin de ActionScript devuelve un valor, ste se devuelve mediante el mtodo Call() (como puede verse en el ejemplo anterior).
En este fragmento de cdigo, _flashControl es el control ActiveX de Shockwave Flash. Para realzar las llamadas a funciones ActionScript se utiliza el mtodo CallFunction(). Este mtodo acepta un parmetro (request en el ejemplo), que es una cadena que contiene instrucciones en formato XML entre las que se incluye el nombre de la funcin de ActionScript que se llamar y los correspondientes parmetros. Todos los valores devueltos desde ActionScript se codifican como una cadena con formato XML y se envan como el valor devuelto de la llamada a CallFunction(). En este ejemplo, la cadena XML se almacena en la variable response.
869
Recibir una llamada a una funcin desde ActionScript es un proceso compuesto de varios pasos. Las llamadas a funciones desde ActionScript hacen que el control ActiveX de Shockwave Flash distribuya su evento FlashCall, de modo que una clase (como la clase ExternalInterfaceProxy) diseada para recibir llamadas desde un archivo SWF tiene que definir un controlador para ese evento. En la clase ExternalInterfaceProxy, la funcin de controlador de eventos se llama _flashControl_FlashCall() y est registrada para detectar el evento en el constructor de la clase del siguiente modo:
private AxShockwaveFlash _flashControl; public ExternalInterfaceProxy(AxShockwaveFlash flashControl) { _flashControl = flashControl; _flashControl.FlashCall += new _IShockwaveFlashEvents_FlashCallEventHandler(_flashControl_FlashCall); } ... private void _flashControl_FlashCall(object sender, _IShockwaveFlashEvents_FlashCallEvent e) { // Use the event object's request property ("e.request") // to execute some action. ... // Return a value to ActionScript; // the returned value must first be encoded as an XML-formatted string. _flashControl.SetReturnValue(encodedResponse); }
El objeto de evento (e) tiene una propiedad request (e.request) que es una cadena que contiene informacin en formato XML acerca de la llamada a la funcin, como el nombre de la funcin y los parmetros. El contenedor puede utilizar esta informacin para determinar qu cdigo se debe ejecutar. En la clase ExternalInterfaceProxy, request se convierte del formato XML a un objeto ExternalInterfaceCall, que proporciona la misma informacin con un formato ms accesible. El mtodo SetReturnValue() del control ActiveX se utiliza para devolver el resultado de una funcin al elemento que origina la llamada en ActionScript; de nuevo, el parmetro del resultado debe estar codificado en el formato XML utilizado por la API externa. En la comunicacin entre ActionScript y la aplicacin que aloja el control ActiveX de Shockwave Flash se utiliza un formato XML especfico para codificar las llamadas a las funciones y los valores. En el ejemplo en C# de Introvert IM, la clase ExternalInterfaceProxy posibilita que el cdigo del formulario de la aplicacin opere directamente sobre los valores enviados o recibidos desde ActionScript e ignore los detalles del formato XML utilizado por Flash Player. Para lograrlo, la clase ExternalInterfaceProxy usa los mtodos de la clase ExternalInterfaceSerializer para convertir los mensajes XML en objetos .NET. La clase ExternalInterfaceSerializer tiene cuatro mtodos pblicos:
EncodeInvoke(): codifica el nombre de una funcin y una lista de argumentos ArrayList de C# con el formato
XML adecuado.
EncodeResult(): codifica un valor de resultado con el formato XML apropiado. DecodeInvoke(): descodifica una llamada de funcin desde ActionScript. La propiedad request del objeto de
evento FlashCall se pasa al mtodo DecodeInvoke(), que convierte la llamada en un objeto ExternalInterfaceCall.
DecodeResult(): descodifica los datos XML recibidos como resultado de llamar a una funcin de ActionScript.
Estos mtodos codifican valores de C# en el formato XML de la API externa y descodifica el XML para transformarlo en objetos de C#. Para obtener informacin sobre el formato XML utilizado por Flash Player, consulte Formato XML de la API externa en la pgina 856.
870
Creating and validating XML signatures (Creacin y validacin de firmas XML, en ingls) (Flex) Creating and validating XML signatures (Creacin y validacin de firmas XML, en ingls) (Flash)
Adobe AIR proporciona la clase XMLSignatureValidator y la interfaz IURIDereferencer para validar firmas XML. La sintaxis XML aceptada por la clase XMLSignatureValidator es un subconjunto de la recomendacin W3C para el procesamiento y la sintaxis de la firma XML (XML Signature Syntax and Processing). (Debido a que slo se admite un subconjunto de la recomendacin, no todas las firmas legales se pueden validar.) AIR no proporciona ninguna API para crear firmas XML.
871
Paquete flash.security
Clases
Las constantes de la cadena XMLSignatureValidator se definen en las siguientes clases: ReferencesValidationSetting RevocationCheckSettings SignatureStatus SignerTrustSettings Evento ErrorEvent
flash.events
Cree un objeto XMLSignatureValidator. Proporcione una implementacin de la interfaz IURIDereferencer. El objeto XMLSignatureValidator llama al
mtodo dereference() de IURIDereferencer, transmitiendo el identificador URI para cada referencia de una firma. El mtodo dereference() debe resolver el URI y devolver los datos a los que se hace referencia (que pueden estar en el mismo documento como firma o encontrarse en un recurso externo).
Aada detectores de eventos para los eventos complete y error. Llame al mtodo verify(), transmitiendo la firma para validar. Controle los eventos complete y error e interprete los resultados.
El siguiente ejemplo implementa una funcin validate() que verifica la validez de una firma XML. Las propiedades XMLSignatureValidator se establecen de tal modo que el certificado de firma debe estar en el almacn de confianza del sistema, o bien, encadenarse a un certificado del almacn de confianza. En el ejemplo tambin se supone que existe una clase IURIDereferencer adecuada denominada XMLDereferencer.
872
private function validate( xmlSignature:XML ):void { var verifier:XMLSignatureValidator = new XMLSignatureValidator(); verifier.addEventListener(Event.COMPLETE, verificationComplete); verifier.addEventListener(ErrorEvent.ERROR, verificationError); try { verifier.uriDereferencer = new XMLDereferencer(); verifier.referencesValidationSetting = ReferencesValidationSetting.VALID_IDENTITY; verifier.revocationCheckSetting = RevocationCheckSettings.BEST_EFFORT; verifier.useSystemTrustStore = true; //Verify the signature verifier.verify( xmlSignature ); } catch (e:Error) { trace("Verification error.\n" + e); } } //Trace verification results private function verificationComplete(event:Event):void var signature:XMLSignatureValidator = event.target as XMLSignatureValidator; trace("Signature status: " + signature.validityStatus + "\n"); trace(" Digest status: " + signature.digestStatus + "\n"); trace(" Identity status: " + signature.identityStatus + "\n"); trace(" Reference status: " + signature.referencesStatus + "\n"); } private function verificationError(event:ErrorEvent):void { trace("Verification error.\n" + event.text); }
El motor de ejecucin verifica la integridad criptogrfica de la firma utilizando la clave pblica del certificado de
firma.
El motor de ejecucin establece la integridad criptogrfica, identidad y veracidad del certificado en funcin de la
configuracin actual del objeto XMLSignatureValidator. La confianza en el certificado de firma es fundamental para la integridad del proceso de validacin. La validacin de la firma se lleva a cabo mediante un proceso criptogrfico bien definido, pero la veracidad del certificado de firma es un criterio que no se puede adoptar mediante algoritmos. En general, existen tres formas de decidir si un certificado es de confianza:
Confiar en las entidades emisoras de certificados y el almacn de confianza del sistema operativo.
873
Obtener, directamente del firmante, una copia del certificado, otro certificado que sirva como delimitador de
confianza para el certificado, o bien, informacin suficiente para identificar de forma fiable el certificado como, por ejemplo, la clave pblica.
Preguntar al usuario final de la aplicacin si confa en el certificado. Esta consulta no es vlida en certificados
con firma automtica, ya que la informacin de identificacin del certificado no es fiable de forma inherente.
valid: si las propiedades digestStatus, identityStatus y referencesStatus son todas vlidas. invalid: si una o varias de las propiedades de estado individuales son no vlidas. unknown: si una o varias de las propiedades de estado individuales son unknown y ningn estado individual es invalid.
Propiedad digestStatus Adobe AIR 1.5 y posterior La propiedad digestStatus indica los resultados de la verificacin criptogrfica del resumen del mensaje. La propiedad digestStatus puede tener uno de los siguientes valores:
valid: si el propio documento no se ha modificado desde la firma. invalid: si el documento de firma se ha modificado o presenta un formato incorrecto.
874
Propiedad identityStatus Adobe AIR 1.5 y posterior La propiedad identityStatus notifica el estado del certificado de firma. El valor de esta propiedad depende de varios factores, entre los que se incluyen:
La integridad criptogrfica del certificado. Si el certificado ha caducado o se ha revocado. Si el certificado es de confianza en el equipo actual. El estado del objeto XMLSignatureValidator (por ejemplo, si los certificados adicionales se han agregado para crear
la cadena de confianza, si dichos certificados son de confianza y los valores de las propiedades useSystemTrustStore y revocationCheckSettings). La propiedad identityStatus puede contar con los siguientes valores:
valid: para considerarse vlida, el certificado de firma debe cumplir las siguientes condiciones:
El certificado no debe presentar modificaciones. El certificado de firma no debe haber caducado ni haber sido revocado, excepto cuando una marca de hora
vlida est presente en la firma.Si la firma incluye una marca de hora, el certificado se considerar vlido si ya lo era en el momento en que se firm el documento. (El certificado utilizado por el servicio de marca de hora para firmar la marca de hora debe encadenarse con un certificado raz de confianza en el equipo del usuario.)
se notificarn como unknown (a no ser que sean de confianza de forma explcita). identityStatus tambin se notifica como unknown si el mtodo verify() no se ha completado sin error o si la identidad no se ha comprobado porque el resumen de la firma no es vlido. Propiedad referencesStatus Adobe AIR 1.5 y posterior La propiedad referencesStatus indica la integridad criptogrfica de las referencias en el elemento SignedData de la firma.
valid: si el resumen calculado de todas las referencias de la firma coincide con el resumen correspondiente
registrado en la firma XML. Un estado valid indica que los datos firmados no se han modificado.
invalid: si algn resumen calculado no coincide con el resumen correspondiente en la firma. unknown: si los resmenes de referencia no se han comprobado. Las referencias no se comprueban si el resumen de
firma general es invalid o el certificado de firma no es vlido. Si identityStatus es unknown, las referencias slo se comprueban cuando referencesValidationSetting es validOrUnknown.
875
Firmas XML
Adobe AIR 1.5 y posterior Una firma XML es una firma digital representada mediante sintaxis XML. Los datos de una firma XML se pueden utilizar para validar la informacin firmada que no se haya modificado desde la firma. Asimismo, cuando una entidad emisora de certificados de confianza ha proporcionado el certificado de firma, la identidad del firmante se puede verificar a travs de la infraestructura de clave pblica. Una firma XML se puede aplicar a cualquier tipo de datos digitales (en formato binario o XML). Las firmas XML se suelen emplear en los siguientes escenarios:
Comprobacin de la modificacin de recursos descargados o externos. Verificacin para conocer si los mensajes proceden de un origen seguro. Validacin de la licencia de la aplicacin o de los privilegios de suscripcin.
Todos los elementos de la sintaxis de firma fundamentales (seccin 4 del documento de la recomendacin W3C),
excepto el elemento KeyInfo que no se admite por completo.
El elemento KeyInfo slo debe contener un elemento X509Data. Un elemento X509Data nicamente debe incluir un elemento X509Certificate. Mtodo de resumen SHA256. Algoritmo de firma RSA-SHA1 (PKCS1). El mtodo de cannico "Canonical XML without comments" (XML cannico sin comentarios) y la transformacin. La transformacin de firma protegida. marcas de hora
El siguiente documento muestra una firma XML estndar (la mayor parte de los datos criptogrficos se han eliminado para simplificar el ejemplo):
876
<Signature xmlns="http://www.w3.org/2000/09/xmldsig#"> <SignedInfo> <CanonicalizationMethod Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n20010315"/> <SignatureMethod Algorithm="http://www.w3.org/2000/09/xmldsig#rsa-sha1"/> <Reference URI="URI_to_signed_data"> <Transforms> <Transform Algorithm="http://www.w3.org/2000/09/xmldsig#envelopedsignature"/></Transforms> <DigestMethod Algorithm="http://www.w3.org/2001/04/xmlenc#sha256"/> <DigestValue>uoo...vY=</DigestValue> </Reference> </SignedInfo> <SignatureValue>Ked...w==</SignatureValue> <KeyInfo> <X509Data> <X509Certificate>i7d...w==</X509Certificate> </X509Data> </KeyInfo> </Signature>
SignedInfo: contiene referencias a los datos firmados y los valores de resumen calculados en el momento de la
firma. Los propios datos firmados se pueden incluir en el mismo documento que la firma XML o pueden ser externos.
SignatureValue: contiene un resumen del elemento SignedInfo cifrado con la clave privada del firmante. KeyInfo: incluye el certificado de firma, as como los certificados adicionales necesarios para establecer la cadena
de confianza. Se debe tener en cuenta que aunque el elemento KeyInfo es opcional desde el punto de vista tcnico, AIR no puede validar la firma si no se incluye. Existen tres tipos generales de firmas XML:
Protegidas: la firma se inserta dentro de los datos XML que se estn firmando. Con proteccin: los datos XML firmados se incluyen en un elemento Object en el elemento Signature. Separadas: los datos firmados son externos a la firma XML. La informacin firmada puede estar en un archivo
externo. Tambin puede estar en el mismo documento XML que la firma y no slo como elemento principal o secundario del elemento Signature. Las firmas XML utilizan los URI para hacer referencia a los datos firmados. Las aplicaciones de validacin y firma deben usar las mismas convenciones para resolver estos URI. Cuando se utiliza la clase XMLSignatureValidator, se debe proporcionar una implementacin de la interfaz IURIDereferencer. Esta implementacin es responsable de resolver el URI y devolver los datos firmados como objeto ByteArray. El objeto ByteArray devuelto se resume utilizando el mismo algoritmo que gener el resumen en la firma.
Certificados y confianza
Adobe AIR 1.5 y posterior Un certificado consta de una clave pblica, informacin de identificacin y posiblemente uno o varios certificados que pertenecen a la entidad emisora de certificados.
877
Existen dos modos de establecer la confianza en un certificado. Se puede obtener una copia del certificado directamente del firmante; por ejemplo, en soportes fsicos o a travs de una transmisin digital segura como, por ejemplo, una transaccin SSL. Tambin se puede confiar en una entidad emisora de certificados para determinar si el certificado de firma es de confianza. Para confiar en una entidad de este tipo, el certificado debe proceder de una autoridad de confianza para el equipo en el que se valida la firma. La mayor parte de los fabricantes de sistemas operativos sitan los certificados raz de una serie de entidades emisoras de certificados en el almacn de confianza del sistema operativo. Los usuarios tambin pueden aadir y eliminar certificados del almacn. Aunque un certificado proceda de una entidad de confianza, an debe decidir si el certificado pertenece a un usuario de confianza. En muchos casos esta decisin pertenece al usuario final. Por ejemplo, cuando se instala una aplicacin de AIR, el archivo de instalacin de AIR muestra informacin de identificacin del certificado del editor cuando solicita al usuario que confirme si desea instalar la aplicacin. En otros casos, se puede comparar la clave pblica u otra informacin del certificado con una lista de claves aceptables. (Esta lista se debe asegurar, quizs mediante su propia firma, o bien, almacenndola en el almacn local cifrado de AIR, con el fin de que no se pueda manipular.) Nota: aunque puede optar por confiar en el certificado de firma sin verificacin independiente (como cuando se trata de una firma automtica), de este modo no se obtienen muchas garantas de nada al verificar la firma. Si no se conoce quin cre una firma, la garanta de que sta no se ha manipulado no es una opcin muy eficaz, si es que esta opcin sirve de algo. La firma podra ser una falsificacin firmada con validez. Caducidad y revocacin de certificados Adobe AIR 1.5 y posterior Todos los certificados caducan. Los certificados tambin se pueden revocar mediante la entidad emisora de certificados si, por ejemplo, la clave privada relacionada con el certificado se ha robado o pierde su carcter de privacidad. Si una firma aparece en un certificado caducado o revocado, la firma se notificar como no vlida a no ser que se haya incluido una marca de hora como parte de la firma. Si se incluye una marca de hora, la clase XMLSignatureValidator validar la firma si el certificado era vlido en el momento de la firma. Una marca de hora es un mensaje digital firmado procedente de un servicio de marca de hora que certifica que los datos se firmaron en una fecha y horas concretas. Las marcas de hora provienen de entidades emisoras y se firman mediante el propio certificado de la entidad emisora de marcas de hora. El certificado de la entidad emisora incorporado a la marca de hora debe ser de confianza en el equipo actual para que la marca de hora se considere vlida. XMLSignatureValidator no proporciona ninguna API para designar un certificado diferente para su uso en la validacin de marcas de hora.
878
La interfaz IURIDerefencer tiene un solo mtodo, dereference(uri:String), que debe implementarse. El objeto XMLSignatureValidator llama a este mtodo para todas las referencias de la firma. El mtodo debe devolver los datos en un objeto ByteArray. En la mayora de los casos, tambin ser necesario agregar propiedades o mtodos que permitan al objeto dereferencer localizar los datos a los que se hace referencia. Por ejemplo, si los datos firmados se ubican en el mismo documento que la firma, puede aadir una variable miembro que proporcione una referencia al documento XML. El mtodo dereference() puede utilizar despus esta variable, junto con el URI, para localizar los datos a los que se hace referencia. Del mismo modo, si los datos firmados se encuentran en un directorio del sistema de archivos local, el mtodo dereference() puede necesitar una propiedad que proporcione la ruta al directorio para poder resolver los archivos a los que se hace referencia. XMLSignatureValidator confa por completo en el objeto dereferencer para interpretar las cadenas de URI. Las reglas estndar para eliminar las referencias de los URI se incluyen en la seccin 4.3.3 de la recomendacin del W3C para el procesamiento y la sintaxis de la firma XML.
Se debe tener en cuenta que la firma contiene un solo elemento Reference con una cadena vaca como su URI. Una cadena vaca en este contexto hace referencia a la raz del documento.
879
Tambin se debe observar que el algoritmo de transformacin especifica que se ha aplicado una transformacin de firma protegida. Cuando se aplica una transformacin de este tipo, XMLSignatureValidator elimina automticamente la firma del documento antes de calcular el resumen. Esto significa que el objeto dereferencer no necesita eliminar el elemento Signature al devolver los datos. El siguiente ejemplo muestra un elemento dereferencer para firmas protegidas:
package { import import import import import
public class EnvelopedDereferencer extends EventDispatcher implements IURIDereferencer { private var signedMessage:XML; public function EnvelopedDereferencer( signedMessage:XML ) { this.signedMessage = signedMessage; } public function dereference( uri:String ):IDataInput { try { if( uri.length != 0 ) { throw( new Error("Unsupported signature type.") ); } var data:ByteArray = new ByteArray(); data.writeUTFBytes( signedMessage.toXMLString() ); data.position = 0; } catch (e:Error) { var error:ErrorEvent = new ErrorEvent("Ref error " + uri + " ", false, false, e.message); this.dispatchEvent(error); data = null; throw new Error("Reference not resolvable: " + uri + ", " + e.message); } finally { return data; } } } }
Esta clase dereferencer utiliza una funcin constructora con un parmetro, signedMessage, para que el documento de firma protegida est disponible en el mtodo dereference(). Debido a que la referencia en una firma protegida siempre hace referencia a la raz de los datos firmados, el mtodo dereferencer() escribe el documento en un conjunto de bytes y lo devuelve.
880
881
Una clase dereferencer para validar esta firma debe tomar la cadena URI que contiene "#PackageContents" del elemento Reference y devolver el elemento Manifest en un objeto ByteArray. El smbolo # hace referencia al valor de un atributo Id. del elemento. El siguiente ejemplo implementa un elemento dereferencer para validar firmas de la aplicacin de AIR. La implementacin constituye un proceso sencillo al confiar en la estructura conocida de una firma de AIR. Un objeto dereferencer de uso general podra resultar mucho ms complejo.
package { import import import import
public class AIRSignatureDereferencer implements IURIDereferencer { private const XML_SIG_NS:Namespace = new Namespace( "http://www.w3.org/2000/09/xmldsig#" ); private var airSignature:XML; public function AIRSignatureDereferencer( airSignature:XML ) { this.airSignature = airSignature; } public function dereference( uri:String ):IDataInput { var data:ByteArray = null; try { if( uri != "#PackageContents" ) { throw( new Error("Unsupported signature type.") ); } var manifest:XMLList = airSignature.XML_SIG_NS::Object.XML_SIG_NS::Manifest; data = new ByteArray(); data.writeUTFBytes( manifest.toXMLString()); data.position = 0; } catch (e:Error) { data = null; throw new Error("Reference not resolvable: " + uri + ", " + e.message); } finally { return data; } } } }
Cuando se verifica este tipo de firma, nicamente se validan los datos del elemento Manifest. Los archivos reales del paquete no se comprueban. Para comprobar modificaciones en los archivos del paquete, debe leer los archivos, calcular el resumen SHA256 y comparar el resultado con el resumen registrado en el manifiesto. XMLSignatureValidator no comprueba automticamente estas referencias secundarias.
882
Nota: este ejemplo se incluye para mostrar el proceso de validacin de firma. No resulta muy til en una aplicacin de AIR que valida su propia firma. Si la aplicacin ya se ha manipulado, el agente de las alteraciones podra eliminar simplemente la comprobacin de validacin.
if( manifest.nameSpace::Reference.length() <= 0 ) { result = false; message = "Nothing to validate."; } for each (var reference:XML in manifest.nameSpace::Reference) { var file:File = sigFile.parent.parent.resolvePath( reference.@URI ); var stream:FileStream = new FileStream(); stream.open(file, FileMode.READ); var fileData:ByteArray = new ByteArray(); stream.readBytes( fileData, 0, stream.bytesAvailable ); var digestHex:String = SHA256.computeDigest( fileData ); //Convert hexidecimal string to byte array var digest:ByteArray = new ByteArray(); for( var c:int = 0; c < digestHex.length; c += 2 ){ var byteChar:String = digestHex.charAt(c) + digestHex.charAt(c+1); digest.writeByte( parseInt( byteChar, 16 )); } digest.position = 0;
883
var base64Encoder:Base64Encoder = new Base64Encoder(); base64Encoder.insertNewLines = false; base64Encoder.encodeBytes( digest, 0, digest.bytesAvailable ); var digestBase64:String = base64Encoder.toString(); if( digestBase64 == reference.nameSpace::DigestValue ) { result = result && true; message += " " + reference.@URI + " verified.\n"; } else { result = false; message += " ---- " + reference.@URI + " has been modified!\n"; } base64Encoder.reset(); } trace( message ); return result; }
La funcin recorre todas las referencias en el elemento Manifest. Para cada referencia, se calcula el resumen SHA256, codificado en formato base64, y se compara con el resumen en el manifiesto. Los URI de un paquete de AIR hacen referencia a las rutas relativas al directorio de la aplicacin. Las rutas se resuelven en funcin de la ubicacin del archivo de firma, que siempre est en el subdirectorio META-INF del directorio de la aplicacin. Se debe tener en cuenta que la clase SHA256 de Flex devuelve el resumen como una cadena de caracteres hexadecimales. Esta cadena se debe convertir en un objeto ByteArray que contenga los bytes representados mediante la cadena hexadecimal. Para utilizar las clases mx.utils.SHA256 y Base64Encoder en Flash CS4, puede ubicar y copiar estas clases en el directorio de desarrollo de la aplicacin o compilar un archivo SWF de biblioteca que incluya las clases utilizando el SDK de Flex.
Eliminacin de referencia de los URI en firmas separadas que hacen referencia a datos externos
Adobe AIR 1.5 y posterior Cuando un URI hace referencia a un recurso externo, se debe acceder a los datos y stos deben cargarse en un objeto ByteArray. Si el URI contiene una direccin URL absoluta, simplemente se debe leer un archivo o solicitar una URL. Probablemente el caso ms comn es que si el URI se contiene en una ruta relativa, la implementacin de IURIDereferencer debe incluir un modo de resolver las rutas a los archivos firmados. El siguiente ejemplo utiliza un objeto File inicializado cuando la instancia de dereferencer se crea como base para resolver los archivos firmados.
884
package { import flash.events.ErrorEvent; import flash.events.EventDispatcher; import flash.filesystem.File; import flash.filesystem.FileMode; import flash.filesystem.FileStream; import flash.security.IURIDereferencer; import flash.utils.ByteArray; import flash.utils.IDataInput; public class RelativeFileDereferencer extends EventDispatcher implements IURIDereferencer { private var base:File; public function RelativeFileDereferencer( base:File ) { this.base = base; } public function dereference( uri:String ):IDataInput { var data:ByteArray = null; try{ var referent:File = this.base.resolvePath( uri ); var refStream:FileStream = new FileStream(); data = new ByteArray(); refStream.open( referent, FileMode.READ ); refStream.readBytes( data, 0, data.bytesAvailable ); } catch ( e:Error ) { data = null; throw new Error("Reference not resolvable: " + referent.nativePath + ", " + e.message ); } finally { return data; } } } }
La funcin dereference() simplemente ubica el archivo al que se dirige el URI de referencia, carga el contenido del archivo en un conjunto de bytes y devuelve el objeto ByteArray. Nota: antes de validar las referencias externas remotas, tenga en cuenta si la aplicacin podra ser vulnerable a un ataque de tipo phone home o ataque similar por parte de un documento de firma creado de forma malintencionada.
885
Ms temas de ayuda
flash.system.System flash.system.Capabilities
Determinar la aplicacin y el dominio de seguridad en el que se est ejecutando cdigo SWF Determinar las capacidades de la instancia del motor de ejecucin de Flash del usuario (como Flash Player o
Adobe AIR), como el tamao de la pantalla (resolucin) y si determinadas funcionalidades, tales como el audio MP3, estn disponibles
Generar sitios multilinges con el IME Interactuar con el contenedor del motor de ejecucin de Flash (que puede ser una pgina HTML o una aplicacin
contenedora).
elementos en aplicaciones.
Dominio de aplicacin Mecanismo para separar clases utilizadas en distintos archivos SWF de forma que, si los archivos SWF incluyen distintas clases con el mismo nombre, no se sobrescriban unas a otras.
886
IME (editor de mtodo de entrada) Programa (o herramienta del sistema operativo) que se utiliza para introducir
que se ejecuta en un equipo individual y es utilizada por un solo usuario. El sistema del cliente es el sistema operativo subyacente en el equipo del usuario.
887
El cdigo siguiente ilustra cmo se puede copiar un mensaje de error al portapapeles del usuario cuando se produce un error de seguridad. El mensaje de error puede ser til si el usuario desea notificar un posible error con una aplicacin.
private function securityErrorHandler(event:SecurityErrorEvent):void { var errorString:String = "[" + event.type + "] " + event.text; trace(errorString); System.setClipboard(errorString); }
Flash Player 10 y AIR 1.0 La clase Clipboard se puede utilizar para leer y escribir datos del portapapeles como respuesta a un evento de usuario. En AIR, no se requiere ningn evento de usuario para que el cdigo que se ejecuta en el entorno limitado de la aplicacin pueda acceder al portapeles.
888
Si se desea enviar las caractersticas del sistema del usuario a un script de servidor de forma que se pueda almacenar la informacin en una base de datos, se puede utilizar el siguiente cdigo ActionScript:
var url:String = "log_visitor.cfm"; var request:URLRequest = new URLRequest(url); request.method = URLRequestMethod.POST; request.data = new URLVariables(Capabilities.serverString); var loader:URLLoader = new URLLoader(request);
Detectar las caractersticas de la versin del motor de ejecucin de Flash del usuario mediante la clase Capabilities. Utilizar la clase ExternalInterface para detectar la configuracin del navegador del usuario
Para obtener los archivos de la aplicacin para esta muestra, consulte www.adobe.com/go/learn_programmingAS3samples_flash_es. Los archivos de la aplicacin CapabilitiesExplorer se encuentran en la carpeta Samples/CapabilitiesExplorer. La aplicacin consta de los siguientes archivos:
Archivo CapabilitiesExplorer.fla o CapabilitiesExplorer.mxml com/example/programmingas3/capabilities/CapabilitiesGrabber.as La clase que proporciona la funcionalidad principal de la aplicacin, como aadir las caractersticas del sistema a un conjunto, ordenar los elementos y utilizar la clase ExternalInterface para obtener las caractersticas del navegador. Un contenedor HTML que contiene el cdigo JavaScript necesario para comunicarse con la API externa. Descripcin El archivo de aplicacin principal en Flash (FLA) o Flex (MXML).
capabilities.html
889
El mtodo CapabilitiesGrabber.getCapabilities() devuelve un conjunto ordenado de las capacidades del navegador y el motor de ejecucin de Flash, que despus se establece en la propiedad dataProvider de la instancia capabilitiesGrid del componente DataGrid en el escenario.
El mtodo getBrowserObjects() devuelve un conjunto que contiene cada una de las propiedades del objeto navigator del navegador. Si este conjunto tiene una longitud de uno o ms elementos, el conjunto de caractersticas del navegador (navArr) se aade a la matriz de caractersticas de Flash Player (capDP) y se ordena alfabticamente el conjunto completo. Por ltimo, el conjunto ordenado se devuelve al archivo de aplicacin principal, que llena a continuacin la cuadrcula de datos. El cdigo del mtodo getBrowserObjects() es el siguiente:
890
private static function getBrowserObjects():Array { var itemArr:Array = new Array(); var itemVars:URLVariables; if (ExternalInterface.available) { try { var tempStr:String = ExternalInterface.call("JS_getBrowserObjects"); itemVars = new URLVariables(tempStr); for (var i:String in itemVars) { itemArr.push({name:i, value:itemVars[i]}); } } catch (error:SecurityError) { // ignore } } return itemArr; }
Si la API externa est disponible en el entorno de usuario actual, el motor de ejecucin de Flash llama al mtodo JS_getBrowserObjects() de JavaScript, que recorre el objeto navigator del navegador y devuelve a ActionScript una cadena de valores codificados en URL. Esta cadena se convierte en un objeto URLVariables (itemVars) y se aade al conjunto itemArr, que se devuelve al script que hizo la llamada.
891
// escape() function. var tempStr = "navigator." + name + "=" + escape(value); // Push the URL-encoded name/value pair onto the array. tempArr.push(tempStr); break; } } // Loop over each item in the browser's screen object. for (var name in screen) { var value = screen[name]; // If the current value is a number, add it to the array, otherwise // ignore the item. switch (typeof(value)) { case "number": var tempStr = "screen." + name + "=" + escape(value); tempArr.push(tempStr); break; } } // Return the array as a URL-encoded string of name-value pairs. return tempArr.join("&"); } </script>
El cdigo empieza creando un conjunto temporal que contendr todos los pares nombre-valor del objeto navigator. A continuacin, el objeto navigator se somete a un bucle for..in y se evala el tipo de datos del valor actual para filtrar y omitir los valores no deseados. En esta aplicacin, slo estamos interesados en valores de cadena o booleanos, y los otros tipos de datos (como funciones o conjuntos) se omiten. Cada valor de tipo cadena o booleano del objeto navigator se aade al conjunto tempArr. A continuacin, el objeto screen del navegador se somete a un bucle for..in y se aaden los valores numricos encontrados al conjunto tempArr. Por ltimo, el conjunto se convierte en una cadena mediante el mtodo Array.join(). El conjunto usa un carcter ampersand (&) como delimitador, lo que permite a ActionScript analizar fcilmente los datos con la clase URLVariables.
892
Ms temas de ayuda
flash.desktop.NativeApplication flash.events.InvokeEvent flash.events.BrowserInvokeEvent
Invocacin de aplicaciones
Adobe AIR 1.0 y posterior Se invoca una aplicacin se AIR cuando el usuario (o el sistema operativo):
inicia la aplicacin desde el shell del escritorio; utiliza la aplicacin como comando en un shell de lnea de comandos; abre un tipo de archivo para el que la aplicacin es la aplicacin de apertura predeterminada; (Mac OS X) hace clic en el icono de la aplicacin en el Dock (est ejecutndose en ese momento o no la aplicacin); elige iniciar la aplicacin desde el programa de instalacin (al finalizar un nuevo proceso de instalacin o despus
de hacer doble clic en el archivo de AIR para una aplicacin ya instalada);
inicia una actualizacin de una aplicacin de AIR cuando la versin instalada ha sealado que est gestionando las
actualizaciones por su cuenta (al incluir la declaracin <customUpdateUI>true</customUpdateUI> en el archivo descriptor de la aplicacin);
visita una pgina web que contiene un logotipo o una aplicacin de Flash que llama al mtodo com.adobe.air.AIR
launchApplication() especificando la informacin de identificacin para la aplicacin de AIR. (Para que la
invocacin desde el navegador funcione, el descriptor de la aplicacin debe incluir adems una declaracin <allowBrowserInvocation>true</allowBrowserInvocation>).
893
Siempre que se invoca una aplicacin de AIR, AIR distribuye un objeto InvokeEvent del tipo invoke a travs del objeto NativeApplication de instancia nica. Para que la aplicacin tenga tiempo de inicializarse y registrar un detector de eventos, los eventos invoke pasan a la cola en lugar de ser desechados. En cuanto se haya registrado el detector, se entregan todos los eventos que estn en la cola. Nota: cuando se invoca una aplicacin con la funcin de invocacin desde el navegador, el objeto NativeApplication slo distribuye un evento invoke si la aplicacin no est ya ejecutndose. Para recibir eventos invoke, llame al mtodo addEventListener() del objeto NativeApplication (NativeApplication.nativeApplication). Cuando un detector de eventos se registra para un evento invoke, tambin recibe todos los eventos invoke que se produjeron antes de haberse registrado el detector. Los eventos invoke que estn en la cola se distribuyen uno a la vez en un breve intervalo tras la devolucin de la llamada a addEventListener(). Si se produce un nuevo evento invoke durante este proceso, puede que se distribuya antes de uno o varios de los eventos de la cola. Esta cola de eventos le permite controlar cualquier evento invoke que se haya producido antes de ejecutarse el cdigo de inicializacin. Tenga en cuenta que si se aade un detector de eventos ms adelante en la ejecucin (despus de inicializada la aplicacin), an recibir todos los eventos invoke que se hayan producido desde que se inici la aplicacin. Slo se inicia una instancia de una aplicacin de AIR. Si se vuelve a invocar una aplicacin que ya est en curso, AIR distribuye un nuevo evento invoke a la instancia que se est ejecutando. Es responsabilidad de una aplicacin de AIR responder a un evento invoke y tomar las medidas correspondientes (por ejemplo, abrir una nueva ventana para documentos). Un objeto InvokeEvent contiene los argumentos que se pasen a la aplicacin, adems del directorio desde el cual se invoc la aplicacin. Si la aplicacin se invoc debido a una asociacin de tipo de archivo, los argumentos de la lnea de comandos incluirn la ruta completa al archivo. Asimismo, si la aplicacin se invoc a raz de una actualizacin de la misma, se indica la ruta completa al archivo de actualizacin de AIR. Cuando se abren varios archivos en una operacin, se distribuye un solo objeto InvokeEvent en Mac OS X. Cada archivo se incluye en el conjunto arguments. En Windows y Linux, se distribuye un objeto InvokeEvent independiente para cada archivo. La aplicacin puede controlar eventos invoke registrando un detector con su objeto NativeApplication:
NativeApplication.nativeApplication.addEventListener(InvokeEvent.INVOKE, onInvokeEvent);
894
La propiedad currentDirectory contiene un objeto File que representa el directorio desde el cual se inici la aplicacin. Cuando se invoca una aplicacin porque se abre un archivo del tipo registrado por la aplicacin, la ruta nativa al archivo se incluye como cadena en los argumentos de la lnea de comandos. (La aplicacin se encarga de abrir el archivo y realizarle la operacin prevista). Asimismo, si una aplicacin est programada para actualizarse ella misma (en lugar de depender de la interfaz de usuario de actualizacin de AIR estndar), la ruta nativa al archivo de AIR se incluye cuando el usuario hace doble clic en un archivo de AIR que contenga una aplicacin con un ID de aplicacin igual. Se puede acceder al archivo con el mtodo resolve() del objeto File currentDirectory:
if((invokeEvent.currentDirectory != null)&&(invokeEvent.arguments.length > 0)){ dir = invokeEvent.currentDirectory; fileToOpen = dir.resolvePath(invokeEvent.arguments[0]); }
895
Ejemplo de ActionScript
package { import import import import
public class InvokeEventLogExample extends Sprite { public var log:TextField; public function InvokeEventLogExample() { log = new TextField(); log.x = 15; log.y = 15; log.width = 520; log.height = 370; log.background = true; addChild(log); NativeApplication.nativeApplication.addEventListener(InvokeEvent.INVOKE, onInvoke); } public function onInvoke(invokeEvent:InvokeEvent):void { var now:String = new Date().toTimeString(); logEvent("Invoke event received: " + now); if (invokeEvent.currentDirectory != null) { logEvent("Current directory=" + invokeEvent.currentDirectory.nativePath); } else {
896
logEvent("--no directory information available--"); } if (invokeEvent.arguments.length > 0) { logEvent("Arguments: " + invokeEvent.arguments.toString()); } else { logEvent("--no arguments--"); } } public function logEvent(entry:String):void { log.appendText(entry + "\n"); trace(entry); } } }
Ejemplo de Flex
<?xml version="1.0" encoding="utf-8"?> <mx:WindowedApplication xmlns:mx="http://www.adobe.com/2006/mxml" layout="vertical" invoke="onInvoke(event)" title="Invocation Event Log"> <mx:Script> <![CDATA[ import flash.events.InvokeEvent; import flash.desktop.NativeApplication; public function onInvoke(invokeEvent:InvokeEvent):void { var now:String = new Date().toTimeString(); logEvent("Invoke event received: " + now); if (invokeEvent.currentDirectory != null){ logEvent("Current directory=" + invokeEvent.currentDirectory.nativePath); } else { logEvent("--no directory information available--"); } if (invokeEvent.arguments.length > 0){ logEvent("Arguments: " + invokeEvent.arguments.toString()); } else { logEvent("--no arguments--"); } } public function logEvent(entry:String):void { log.text += entry + "\n"; trace(entry); } ]]> </mx:Script> <mx:TextArea id="log" width="100%" height="100%" editable="false" valueCommit="log.verticalScrollPosition=log.textHeight;"/> </mx:WindowedApplication>
897
898
public class StartAtLogin extends Sprite { public function StartAtLogin() { try { NativeApplication.nativeApplication.startAtLogin = true; } catch ( e:Error ) { trace( "Cannot set startAtLogin:" + e.message ); } NativeApplication.nativeApplication.addEventListener( InvokeEvent.INVOKE, onInvoke ); } private function onInvoke( event:InvokeEvent ):void { if( event.reason == InvokeEventReason.LOGIN ) { //do background processing... trace( "Running in background..." ); } else { this.stage.nativeWindow.activate(); } } } }
Nota: para ver la diferencia de comportamiento, empaquete e instale la aplicacin. La propiedad startAtLogin slo se puede definir para aplicaciones instaladas.
Cuando se invoca la aplicacin a travs del navegador, el objeto NativeApplication de la aplicacin distribuye un objeto BrowserInvokeEvent.
899
Para recibir eventos BrowserInvokeEvent, llame al mtodo addEventListener() del objeto NativeApplication (NativeApplication.nativeApplication) en la aplicacin de AIR. Cuando un detector de eventos se registra para un evento BrowserInvokeEvent, tambin recibe todos los eventos BrowserInvokeEvent que se produjeron antes de haberse registrado el detector. Estos eventos se distribuyen tras la devolucin de la llamada a addEventListener(), pero no necesariamente antes de otros eventos BrowserInvokeEvent que quiz se reciban despus de registrar el detector. Esto le permite controlar los eventos BrowserInvokeEvent que se hayan producido antes de ejecutarse el cdigo de inicializacin (por ejemplo, cuando la aplicacin se invoc desde el navegador). Tenga en cuenta que si se aade un detector de eventos ms adelante en la ejecucin (despus de inicializada la aplicacin), an recibir todos los eventos BrowserInvokeEvent que se hayan producido desde que se inici la aplicacin. El objeto BrowserInvokeEvent incluye las siguientes propiedades:
Propiedad arguments isHTTPS isUserEvent Descripcin Un conjunto de argumentos (cadenas) que se pasan a la aplicacin. Indica si el contenido en el navegador utiliza el esquema https de la URL (true) o no (false). Indica si la invocacin desde el navegador produjo un evento de usuario (hacer clic, por ejemplo). En AIR 1.0 siempre est definido en true; AIR requiere un evento de usuario para la funcin de invocacin desde el navegador. El tipo de entorno limitado para el contenido en el navegador. Los valores vlidos se definen igual que los que pueden utilizarse en la propiedad Security.sandboxType y pueden ser uno de los siguientes:
sandboxType
securityDomain
Security.APPLICATION: el contenido se encuentra en el entorno limitado de seguridad de la aplicacin. Security.LOCAL_TRUSTED: el contenido se encuentra en el entorno limitado de seguridad local de
confianza.
Security.LOCAL_WITH_FILE: el contenido se encuentra en el entorno limitado de seguridad local con
sistema de archivos.
Security.LOCAL_WITH_NETWORK: el contenido se encuentra en el entorno limitado de seguridad local
de red.
Security.REMOTE: el contenido se encuentra en un dominio remoto (en la red).
El dominio de seguridad para el contenido del navegador, por ejemplo "www.adobe.com" o "www.example.org". Esta propiedad slo se define para contenido en el entorno limitado de seguridad remota (para contenido procedente de un dominio de la red). No se define para contenido en un entorno limitado de seguridad local o de la aplicacin.
Si utiliza la funcin de invocacin desde el navegador, asegrese de tener en cuenta las posibles consecuencias para la seguridad. Cuando un sitio web inicia una aplicacin de AIR, puede enviar datos a travs de la propiedad arguments del objeto BrowserInvokeEvent. Tenga cuidado al utilizar estos datos en operaciones sensibles, como las API de carga de archivos o cdigo. El nivel de riesgo depender de lo que la aplicacin haga con los datos. Si se espera que un solo sitio web en particular invoque la aplicacin, sta debera comprobar la propiedad securityDomain del objeto BrowserInvokeEvent. Tambin se puede exigir que el sitio web que invoca la aplicacin utilice HTTPS, lo cual se puede verificar comprobando la propiedad isHTTPS del objeto BrowserInvokeEvent. La aplicacin debe validar los datos que le llegan. Por ejemplo, si una aplicacin espera recibir unas URL a un dominio concreto, debera validar que las URL apunten, efectivamente, a ese dominio. Esto puede evitar que un atacante logre engaar la aplicacin para que sta le mande datos sensibles. Ninguna aplicacin debera utilizar argumentos BrowserInvokeEvent que puedan apuntar a recursos locales. Por ejemplo: una aplicacin no debera crear objetos File basados en una ruta recibida del navegador. Si se espera recibir rutas remotas del navegador, la aplicacin debera asegurarse de que las rutas no utilicen el protocolo file:// en lugar de un protocolo remoto.
900
Seleccionando el comando de salir de la aplicacin en el sistema operativo; por ejemplo, cuando el usuario
selecciona en el men predeterminado el comando de salir de la aplicacin. (Esto slo sucede en Mac OS, ya que Windows y Linux no ofrecen un comando de salida de la aplicacin en el fondo cromtico del sistema).
Apagando el ordenador.
Cuando el comando de salir se ejecuta a travs del sistema operativo por una de estas vas, el objeto NativeApplication distribuye un evento exiting. Si ningn detector cancela el evento exiting, se cierran las ventanas que estn abiertas. Cada ventana distribuye un evento closing seguido de un evento close. Si alguna de las ventanas cancela el evento closing, se detiene el proceso de cierre. Si el orden de cierre de las ventanas es un problema para la aplicacin, detecte el evento exiting distribuido por el objeto NativeApplication y cierre usted mismo las ventanas en el orden correcto. Este podra ser el caso si, por ejemplo, hay una ventana de documento con paletas de herramientas. Puede resultar inapropiado, o peor, si el sistema cerrara las paletas, pero el usuario decidiera cancelar el comando de salir para guardar datos. En Windows, la nica vez que se produce el evento exiting es despus de cerrar la ltima ventana (cuando la propiedad autoExit del objeto NativeApplication est definida en true). Para obtener un comportamiento similar en todas las plataformas -independientemente de si la secuencia de cierre se inicia a travs del fondo cromtico del sistema operativo, los comandos de men o la lgica de la aplicacin- conviene observar las siguientes prcticas recomendadas para salir de la aplicacin:
1 Distribuya siempre un evento exiting a travs del objeto NativeApplication antes de llamar a exit() en el cdigo
controlador, cierre las ventanas abiertas que haya (distribuyendo primero un evento closing). Una vez cerradas todas las ventanas, realice las tareas de limpieza necesarias, como guardar los datos de la aplicacin o eliminar los archivos temporales. Utilice solamente mtodos sincrnicos durante la limpieza para estar seguro de que hayan finalizado antes de que se cierre la aplicacin.
901
Si no importa en qu orden se cierran las ventanas, se puede recorrer el conjunto NativeApplication.nativeApplication.openedWindows en un bucle y cerrar cada ventana a su vez. Si el orden s importa, facilite un medio de cerrar las ventanas en la secuencia correcta.
private function onExiting(exitingEvent:Event):void { var winClosingEvent:Event; for each (var win:NativeWindow in NativeApplication.nativeApplication.openedWindows) { winClosingEvent = new Event(Event.CLOSING,false,true); win.dispatchEvent(winClosingEvent); if (!winClosingEvent.isDefaultPrevented()) { win.close(); } else { exitingEvent.preventDefault(); } } if (!exitingEvent.isDefaultPrevented()) { //perform cleanup } }
3 Las ventanas deben siempre controlar su propia limpieza, detectando sus propios eventos closing. 4 Utilice un solo detector de eventos exiting en la aplicacin, ya que los controladores que se llamaron previamente
no pueden saber si los detectores posteriores cancelarn el evento exiting (y no conviene depender del orden de ejecucin).
902
Captulo 50: Trabajo con informacin sobre el motor de ejecucin de AIR y el sistema operativo
Adobe AIR 1.0 y posterior En esta seccin se discuten las formas en que una aplicacin de AIR puede gestionar la asociacin con archivos del sistema operativo, detectar la actividad de los usuarios y obtener informacin sobre el motor de ejecucin de Adobe AIR.
Ms temas de ayuda
flash.desktop.NativeApplication
903
AIR slo puede manejar asociaciones para los tipos de archivos originalmente declarados en el descriptor de la aplicacin. No se puede obtener informacin sobre las asociaciones de un tipo de archivo no declarado, aunque el usuario haya creado manualmente la asociacin entre ese tipo de archivo y la aplicacin. Si se llama a cualquiera de los mtodos de gestin de asociaciones con archivos con la extensin de un tipo de archivo que no est declarado en el descriptor de la aplicacin, sta emitir una excepcin del motor de ejecucin.
Todos los recursos que no se instalan con la aplicacin de AIR se asignan a los mismos entornos limitados de seguridad que asignara Adobe Flash Player en un navegador web. Los recursos remotos se ponen en entornos limitados de acuerdo con sus dominios de origen, y los recursos locales se ponen en el entorno limitado local de red, local con sistema de archivos o local de confianza. Se puede comprobar si la propiedad esttica est definida en Capabilities.playerType"Desktop" para ver si el contenido se est ejecutando en el motor de ejecucin (y no en Flash Player ejecutndose en un navegador). Para obtener ms informacin, consulte Seguridad en AIR en la pgina 1095.
904
Nota: slo se distribuye un evento userIdle entre dos eventos userPresent cualesquiera.
905
Creating a transparent window application (Creacin de una aplicacin de ventana transparente, en ingls) (Flex) Interacting with a window (Interaccin con una ventana, en ingls) (Flex) Customizing the look and feel of a native window (Personalizacin del aspecto de una ventana nativa, en ingls)
(Flex)
Launching windows (Inicio de ventanas, en ingls) (Flex) Creating toast-style windows (Creacin de ventanas superpuestas, en ingls) (Flex) Controlling the display order of windows (Control del orden de visualizacin de las ventanas, en ingls) (Flex) Creating resizable, non-rectangular windows (Creacin de ventanas no rectangulares de tamao variable, en
ingls) (Flex)
Interacting with a window (Interaccin con una ventana, en ingls) (Flash) Customizing the look and feel of a native window (Personalizacin del aspecto de una ventana nativa, en ingls)
(Flash)
Creating toast-style windows (Creacin de ventanas superpuestas, en ingls) (Flash) Controlling the display order of windows (Control del orden de visualizacin de las ventanas, en ingls) (Flash) Creating resizable, non-rectangular windows (Creacin de ventanas no rectangulares de tamao modificable, en
ingls) (Flash) AIR proporciona una API de ventana fcil de usar y vlida para todas las plataformas con la que es posible crear ventanas nativas de sistema operativo utilizando Flash, Flex y tcnicas de programacin HTML.
906
Con AIR, las posibilidades de desarrollar el aspecto de su aplicacin son enormes. Las ventanas que se crean pueden presentar un aspecto similar a una aplicacin de escritorio estndar, coincidiendo con el estilo de Apple cuando se ejecutan en Mac, ajustndose a las convenciones de Microsoft cuando se ejecutan en Windows y en armona con el administrador de ventanas de Linux; todo ello sin incluir ninguna lnea de cdigo de plataforma especfica. Tambin puede utilizar el fondo cromtico de aspecto configurable de la arquitectura de Flex para establecer su propio estilo sin importar dnde se ejecute la aplicacin. Incluso puede dibujar su propio fondo cromtico de ventana con ilustraciones vectoriales o de mapas de bits con compatibilidad total de transparencia y valores alfa que se fundan con el escritorio. Est cansado de tanta ventana rectangular? Dibuje una redondeada.
Ventanas de AIR
Adobe AIR 1.0 y posterior AIR admite tres API diferentes para trabajar con ventanas:
La clase NativeWindow orientada a ActionScript proporciona la API de gestin de ventanas de nivel ms bajo.
Utilice NativeWindows en ActionScript y aplicaciones creadas con Flash Professional. Considere la ampliacin de la clase NativeWindow para que se especialice en las ventanas utilizadas en la aplicacin.
En el entorno HTML, se puede usar la clase Window de JavaScript, tal y como se hara en una aplicacin web basada
en navegador. Las llamadas a los mtodos Window de JavaScript se reenvan al objeto de ventana nativa subyacente.
Las clases del marco de Flex, mx:WindowedApplication y mx:Window, proporcionan un envolvente de Flex para
la clase NativeWindow. El componente WindowedApplication sustituye al componente Application cuando se crea una aplicacin de AIR con Flex y siempre se debe usar como ventana inicial en la aplicacin de Flex. Ventanas de ActionScript Al crear ventanas con la clase NativeWindow, puede utilizar el escenario y la lista de visualizacin de Flash Player directamente. Para aadir un objeto visual a una ventana NativeWindow, aada el objeto a la lista de visualizacin del escenario de la ventana o a otro contenedor de objetos de visualizacin del escenario. Ventanas HTML Cuando se crean ventanas HTML, se utiliza HTML, CSS y JavaScript para visualizar el contenido. Para aadir un objeto visual a una ventana HTML, aada el contenido al DOM HTML. Las ventanas HTML son una categora especial de NativeWindow. El host de AIR define una propiedad nativeWindow en las ventanas HTML que proporciona acceso a la instancia subyacente de NativeWindow. Puede utilizar esta propiedad para acceder a las propiedades, mtodos y eventos de NativeWindow que se describen en esta seccin. Nota: el objeto Window de JavaScript tambin cuenta con mtodos para crear scripts de la ventana que los contiene, como por ejemplo, moveTo() y close(). Si dispone de varios mtodos al mismo tiempo, puede utilizar el que ms le convenga. Ventanas de la arquitectura de Flex Cuando se crean ventanas con la arquitectura de Flex, se suelen utilizar componentes MXML para llenar la ventana. Para aadir un componente de Flex a una ventana, aada el elemento del componente a la definicin MXML de la ventana. Tambin puede utilizar ActionScript para aadir contenido dinmicamente. Los componentes mx:WindowedApplication y mx:Window se disean como contenedores de Flex, por lo que pueden aceptar componentes de Flex directamente, mientras que los objetos NativeWindow no. Si es necesario, se puede acceder a los mtodos y propiedades de NativeWindow mediante los objetos WindowedApplication y Window, y la propiedad nativeWindow.
907
Ventana inicial de la aplicacin AIR crea para el usuario la primera ventana de la aplicacin automticamente. AIR define las propiedades y el contenido de la ventana a partir de los parmetros especificados en el elemento initialWindow del archivo descriptor de la aplicacin. Si el contenido raz es un archivo SWF, AIR crea una instancia de NativeWindow, carga el archivo SWF y lo aade al escenario de la ventana. Si el contenido raz es un archivo HTML, AIR crea una ventana HTML y carga el contenido HTML.
flash.events
Adems, el objeto NativeWindow tambin distribuye eventos para los cambios relacionados con el tamao y la posicin de la ventana. La ventana no distribuye eventos de advertencia para estos cambios relacionados. Los eventos relacionados son:
a Un evento move se distribuye si la esquina superior izquierda de la ventana se mueve por maximizacin. b Un evento resize se distribuye si el tamao de la ventana cambia por maximizacin.
Un objeto NativeWindow distribuye una secuencia similar de eventos cuando una ventana se minimiza, se restaura, se cierra, se mueve y se cambia de tamao.
908
Los eventos de advertencia slo se distribuyen si se inicia un cambio del fondo cromtico de la ventana o por cualquier otro mecanismo controlado por el sistema operativo. Cuando se llama a un mtodo de ventana para que cambie el tamao, la posicin o el estado de visualizacin de la ventana, sta slo distribuye un evento para anunciar el cambio. Si lo desea, puede distribuir un evento de advertencia con el mtodo dispatchEvent() de la ventana y, despus, ver si el evento de advertencia se ha cancelado antes de realizar el cambio. Para obtener ms informacin sobre las clases, mtodos, propiedades y eventos de API de ventana, consulte Referencia de ActionScript 3.0 para la plataforma de Adobe Flash.
Al crear una ventana, estas propiedades se establecen en el objeto NativeWindowInitOptions transferido al constructor de la ventana. AIR lee las propiedades de la ventana inicial de la aplicacin desde el descriptor de la aplicacin. (Salvo la propiedad type, que no se puede establecer en el descriptor de la aplicacin y siempre se define en normal.) Las propiedades no se pueden modificar una vez creada la ventana. Algunos ajustes de estas propiedades son incompatibles entre s: systemChrome no se puede establecer como standard si transparent es true o si type es lightweight.
Tipos de ventanas
Adobe AIR 1.0 y posterior Los tipos de ventanas de AIR combinan atributos de fondo cromtico y visibilidad del sistema operativo nativo para crear tres tipos de ventanas funcionales. Puede utilizar las constantes definidas en la clase NativeWindowType para hacer referencia a los nombres de los tipos en el cdigo. AIR proporciona los siguientes tipos de ventanas:
Tipo Normal Descripcin Una ventana normal. La ventanas normales utilizan el fondo cromtico de pantalla completa y se muestran en la barra de tareas de Windows o en el men Ventana de Mac OS X. Una paleta de herramientas. Las ventanas de utilidades utilizan una versin ms ligera del fondo cromtico del sistema y no se muestran en la barra de tareas de Windows ni en el men Ventana de Mac OS X. Las ventanas ligeras no tienen fondo cromtico y no aparecen en la barra de tareas de Windows ni en el men Ventana de Mac OS X. Adems, las ventanas ligeras no disponen de men Sistema (Alt+Barra espaciadora) en Windows. El uso de ventanas ligeras est recomendado para mensajes emergentes de notificacin o controles, como cuadros emergentes reas de visualizacin temporal. Si utiliza el type en ventanas ligeras, systemChrome debe establecerse como none.
Utilidades
Ligeras
909
Para obtener ms informacin, consulte Using Flex 4: About the AIR window containers: Controlling window chrome (en ingls) Fondo cromtico personalizado Cuando se crea una ventana sin fondo cromtico del sistema, es preciso aadir controles de fondo cromtico propios para controlar la interaccin entre el usuario y la ventana. Tambin, si lo desea, puede crear ventanas no rectangulares y transparentes. Para utilizar el fondo cromtico personalizado con los componentes mx:WindowedApplication o mx:Window, el estilo showFlexChrome se debe establecer en false. De lo contrario, Flex aadir su propio fondo cromtico a las ventanas.
910
Transparencia de la ventana
Adobe AIR 1.0 y posterior Para permitir la mezcla alfa en una ventana de escritorio o en cualquier otra, establezca la propiedad transparent de la ventana como true. Debe establecer la propiedad transparent antes de crear la ventana y no es posible modificarla. Una ventana transparente no tiene fondo predeterminado. Cualquier rea de la ventana que no contenga objetos dibujados por la aplicacin es invisible. Si un objeto visualizado tiene un valor alfa menor que uno, cualquier elemento debajo del objeto ser transparente, incluidos los dems objetos de visualizacin de la misma ventana, de otras ventanas y del escritorio. Las ventanas transparentes resultan tiles cuando se quieren crear aplicaciones con bordes de forma irregular, aplicaciones que desaparecen o aplicaciones invisibles. No obstante, la representacin de zonas grandes de mezcla alfa puede ser un proceso lento, por lo que el efecto debe utilizarse con precaucin. Importante: En Linux, los eventos de ratn no pasan por pxeles completamente transparentes. Se debe evitar la creacin de ventanas con reas grandes y completamente transparentes, ya que se puede bloquear de forma invisible el acceso del usuario a otras ventanas o elementos en su escritorio. En Mac OS X y Windows, los eventos de ratn no pasan por pxeles completamente transparentes. La transparencia no se puede aplicar a ventanas con fondo cromtico del sistema. Adems, el contenido SWF y PDF del HTML no se visualiza en las ventanas transparentes. Para obtener ms informacin, consulte Consideraciones al cargar el contenido SWF o PDF en una pgina HTML en la pgina 1025. La propiedad NativeWindow.supportsTransparency indica si la ventana puede ser transparente. Si no se admite transparencia, la aplicacin se compone con un fondo negro. En estos casos, cualquier rea transparente de la aplicacin se visualiza en negro opaco. Se recomienda ofrecer un recurso alternativo en caso de que esta propiedad sea false. Por ejemplo, puede mostrar un cuadro dilogo de advertencia al usuario o una interfaz rectangular no transparente. Tenga en cuenta que la transparencia se admite siempre en los sistemas operativos Mac y Windows. La compatibilidad con los sistemas operativos Linux requiere un administrador de ventanas de composicin, pero aunque este administrador est activo, la transparencia puede no estar disponible debido a las opciones de visualizacin del usuario o a la configuracin de hardware.
911
Este ejemplo utiliza JavaScript para desactivar el fondo predeterminado de una ventana HTML:
window.htmlLoader.paintsDefaultBackground = false;
Si un elemento del documento HTML establece un color de fondo, el fondo de dicho elemento no es transparente. No est permitido establecer un valor de transparencia (u opacidad) parcial. Sin embargo, se puede utilizar un grfico transparente en formato PNG como fondo de pgina o de elemento de pgina para conseguir un efecto visual parecido.
912
Mac OS X
Microsoft Windows
Linux*
913
Nota: los siguientes elementos del fondo cromtico del sistema no se admiten en AIR: la barra de herramientas de Mac OS X, el icono proxy de Mac OS X, los iconos de barra de ttulo de Windows y otros fondos cromticos alternativos.
Creacin de ventanas
Adobe AIR 1.0 y posterior AIR crea automticamente la primera ventana de la aplicacin, pero el usuario puede crear ms ventanas adicionales si lo necesita. Para crear una ventana nativa, utilice el mtodo NativeWindow. Para crear una ventana HTML, utilice el mtodo createRootWindow() de HTMLLoader o, desde un documento HTML, llame al mtodo window.open() de JavaScript. La ventana creada es un objeto NativeWindow cuya lista de visualizacin contiene un objeto HTMLLoader. El objeto HTMLLoader interpreta y muestra el contenido HTML y JavaScript para la ventana. Se puede acceder a las propiedades del objeto NativeWindow subyacente desde JavaScript usando la propiedad window.nativeWindow. (A esta propiedad slo puede acceder el cdigo que se ejecuta en el entorno limitado de la aplicacin AIR.) Cuando se inicializa una ventana (incluida la ventana inicial de la aplicacin), debe considerar la creacin de la ventana en estado invisible, cargar el contenido o ejecutar actualizaciones grficas y, despus, hacer la ventana visible. Esta secuencia impide que se produzcan fallos visuales en el proceso y que el usuario pueda verlos. Puede especificar que la ventana inicial de la aplicacin se cree en estado invisible especificando la etiqueta <visible>false</visible> en el descriptor de la aplicacin (o dejando la etiqueta fuera, ya que false es el valor predeterminado). Los nuevos objetos NativeWindow son invisibles de forma predeterminada. Cuando se crea una ventana HTML con el mtodo HTMLLoader createRootWindow(), se puede establecer el argumento visible como false. Llame al mtodo NativeWindow activate() o establezca la propiedad visible como true para hacer la ventana visible.
Establezca las propiedades de la ventana inicial creada por AIR en el archivo descriptor de la aplicacin. La ventana principal de una aplicacin de AIR siempre es de tipo normal. (Se pueden especificar propiedades adicionales de la ventana en el archivo descriptor, por ejemplo, visible, width y height; estas propiedades se pueden modificar en cualquier momento.)
914
Puede establecer las propiedades de otras ventanas nativas y HTML creadas por la aplicacin mediante la clase NativeWindowInitOptions. Cuando se crea una ventana, se debe transferir un objeto NativeWindowInitOptions especificando las propiedades de la ventana en la funcin constructora NativeWindow o en el mtodo createRootWindow() de HTMLLoader. El siguiente cdigo crea un objeto NativeWindowInitOptions para una ventana de utilidades:
var options:NativeWindowInitOptions = new NativeWindowInitOptions(); options.systemChrome = NativeWindowSystemChrome.STANDARD; options.type = NativeWindowType.UTILITY options.transparent = false; options.resizable = false; options.maximizable = false;
No est permitido establecer systemChrome como standard si transparent es true o type es lightweight. Nota: no es posible definir las propiedades de inicializacin de una ventana creada con la funcin window.open() de JavaScript. Sin embargo, s se puede anular el modo en que se crean estas ventanas implementando su propia clase HTMLHost. Consulte Gestin de llamadas JavaScript a window.open() en la pgina 1037 para obtener ms informacin. Cuando se crea una ventana con la clase mx:Window de Flex, se especifican las propiedades de inicializacin en el propio objeto window, bien en la declaracin MXML de la ventana o en el cdigo que la crea. El objeto subyacente NativeWindow no se crea hasta que se llama al mtodoopen(). Una vez abierta la ventana, estas propiedades de inicializacin ya no se pueden modificar.
915
package { import flash.display.NativeWindow; import flash.display.Sprite; import flash.events.Event; public class MainClass extends Sprite { private var mainWindow:NativeWindow; public function MainClass(){ this.addEventListener(Event.ADDED_TO_STAGE, initialize); } private function initialize(event:Event):void{ mainWindow = this.stage.nativeWindow; //perform initialization... mainWindow.activate(); //show the window } } }
Nota: tcnicamente, se PUEDE acceder a la la propiedad nativeWindow en la funcin constructora de la clase principal. Sin embargo, se trata de un caso especial que slo se aplica a la ventana inicial de la aplicacin. Al crear una aplicacin en Flash Professional, la clase del documento principal se crea automticamente si no se crea una clase propia en un archivo independiente de ActionScript. Es posible acceder al objeto NativeWindow de la ventana inicial utilizando la propiedad nativeWindow del escenario. Por ejemplo, el siguiente cdigo activa la ventana principal en estado maximizado (desde la lnea de tiempo):
import flash.display.NativeWindow; var mainWindow:NativeWindow = this.stage.nativeWindow; mainWindow.maximize(); mainWindow.activate();
916
<?xml version="1.0" encoding="utf-8"?> <mx:WindowedApplication xmlns:mx="http://www.adobe.com/2006/mxml" applicationComplete="placeWindow()"> <mx:Script> <![CDATA[ private function placeWindow():void{ this.nativeWindow.x = 300; this.nativeWindow.y = 300; } ]]> </mx:Script> <mx:Label text="Hello World" horizontalCenter="0" verticalCenter="0"/> </mx:WindowedApplication>
La ventana no se muestra hasta que se establece la propiedad visible como true o se llama al mtodo activate(). Una vez creada la ventana, puede inicializar sus propiedades y cargar contenido utilizando la propiedad de escenario y tcnicas de lista de visualizacin de Flash. En casi todos los casos, debe establecer la propiedad scaleMode del escenario de una nueva ventana nativa como
noScale (utilice la constante StageScaleMode.NO_SCALE). Los modos de escala de Flash estn diseados para
situaciones en las que el autor de la aplicacin desconoce la relacin de aspecto del espacio de visualizacin de la aplicacin. Los modos de escala permiten al autor escoger la opcin menos arriesgada: recortar el contenido, estrecharlo o apretarlo, o incluso llenarlo con un espacio vaco. Como el desarrollador controla el espacio de visualizacin en AIR (el marco de la ventana), es posible cambiar el tamao de la ventana para que se ajuste al contenido, o cambiar el tamao sin aplicar ningn ajuste. El modo de escala de ventanas de Flex y HTML se establece como noScale automticamente. Nota: para determinar los tamaos mximo y mnimo de ventana admitidos en el sistema operativo actual, utilice las siguientes propiedades estticas de NativeWindow:
var maxOSSize:Point = NativeWindow.systemMaxSize; var minOSSize:Point = NativeWindow.systemMinSize;
917
El contenido HTML de cualquier entorno limitado de seguridad puede utilizar el mtodo Window.open() estndar de JavaScript. Si el contenido se ejecuta fuera del entorno limitado de la aplicacin, se puede llamar al mtodo open() slo como respuesta a la interaccin del usuario, por ejemplo, cuando hace clic con el ratn o cuando pulsa una tecla. Cuando se llama a open(), se crea una ventana con fondo cromtico del sistema para visualizar el contenido en la direccin URL especificada. Por ejemplo:
newWindow = window.open("xmpl.html", "logWindow", "height=600, width=400, top=10, left=10");
Nota: puede ampliar la clase HTMLHost en ActionScript para personalizar la ventana creada con la funcin window.open() de JavaScript. Consulte Ampliacin de la clase HTMLHost en la pgina 1029. El contenido del entorno limitado de seguridad de la aplicacin tiene acceso al mtodo ms potente para la creacin de ventanas: HTMLLoader.createRootWindow(). Con este mtodo, es posible especificar todas las opciones de creacin de una ventana nueva. El siguiente cdigo JavaScript, por ejemplo, crea una ventana ligera sin fondo cromtico del sistema de 300x400 pxeles de tamao:
var options = new air.NativeWindowInitOptions(); options.systemChrome = "none"; options.type = "lightweight"; var windowBounds = new air.Rectangle(200,250,300,400); newHTMLLoader = air.HTMLLoader.createRootWindow(true, options, true, windowBounds); newHTMLLoader.load(new air.URLRequest("xmpl.html"));
Nota: si el contenido cargado por una nueva ventana se encuentra fuera del entorno limitado de seguridad de la aplicacin, el objeto window no tiene las siguientes propiedades de AIR: runtime, nativeWindow o htmlLoader. Si crea una ventana transparente, el contenido SWF incorporado en el HTML cargado en la ventana no siempre se visualizar. Debe establecer el parmetro wmode del objeto o etiqueta incorporada para que haga referencia al archivo SWF de opaque o transparent. El valor predeterminado de wmode es window, por lo que el contenido SWF no se visualiza en ventanas transparentes. Un PDF no puede visualizarse en ventanas transparentes, independientemente del valor de wmode. (Antes de AIR 1.5.2, el contenido SWF tampoco se poda visualizar en ventanas transparentes.) Las ventanas creadas con el mtodo createRootWindow() son independientes de la ventana que se abre. Las propiedades parent y opener del objeto Window de JavaScript son null. La ventana que se abre puede acceder al objeto Window de la nueva ventana utilizando la referencia a HTMLLoader devuelta por la funcin createRootWindow(). En el contexto del ejemplo anterior, la sentencia newHTMLLoader.window hara referencia al objeto Window de JavaScript de la ventana creada. Nota: se puede llamar a la funcin createRootWindow() desde JavaScript y ActionScript.
918
public class LoadedSWF extends Sprite { public function LoadedSWF(){ var loader:Loader = new Loader(); loader.load(new URLRequest("visual.swf")); loader.contentLoaderInfo.addEventListener(Event.COMPLETE,loadFlash); } private function loadFlash(event:Event):void{ addChild(event.target.loader); } } }
Nota: los archivos SWF antiguos creados con ActionScript 1 2 comparten estados globales, como definiciones de clases, objetos singleton y variables globales si estn cargados en la misma ventana. Si este tipo de archivo SWF depende de estados globales sin modificar para que funcione correctamente, no podr cargarse ms de una vez en la misma ventana, ni cargarse otro archivo SWF en la misma ventana con las mismas definiciones de clases y variables. Este contenido se puede cargar en ventanas separadas.
919
Carga de contenido HTML en una ventana NativeWindow Para cargar contenido HTML en una ventana NativeWindow, puede aadir un objeto HTMLLoader al escenario de la ventana y cargar el contenido HTML en HTMLLoader, o bien crear una ventana que ya contenga un objeto HTMLLoader utilizando el mtodo HTMLLoader.createRootWindow(). El siguiente ejemplo muestra contenido HTML en un rea de visualizacin de 300 x 500 pxeles en el escenario de una ventana nativa:
//newWindow is a NativeWindow instance var htmlView:HTMLLoader = new HTMLLoader(); htmlView.width = 300; htmlView.height = 500; //set the stage so display objects are added to the top-left and not scaled newWindow.stage.align = "TL"; newWindow.stage.scaleMode = "noScale"; newWindow.stage.addChild( htmlView ); //urlString is the URL of the HTML page to load htmlView.load( new URLRequest(urlString) );
Para cargar una pgina HTML en una aplicacin de Flex, puede utilizar el componente HTML de Flex. El contenido SWF de un archivo HTML no se visualiza si la ventana utiliza transparencia (es decir, si la propiedad transparent de la ventana es true) a no ser que el parmetro wmode del objeto o la etiqueta incorporada para hacer referencia al archivo SWF se establezca en opaque o en transparent. Como el valor predeterminado de wmode es window, el contenido SWF no se visualiza en una ventana transparente. El contenido PDF no se visualiza en una ventana transparente independientemente del valor utilizado para wmode. Del mismo modo, ni el contenido SWF ni PDF se visualiza cuando se escala o gira el control HTMLLoader, o si la propiedad alpha de HTMLLoader se establece en un valor distinto de 1.0. Cmo aadir contenido SWF como superposicin en una ventana HTML Dado que las ventanas HTML estn contenidas en una instancia de NativeWindow, es posible aadir objetos de visualizacin de Flash delante y detrs de la capa HTML en la lista de visualizacin. Para aadir un objeto de visualizacin sobre la capa HTML, utilice el mtodo addChild() de la propiedad window.nativeWindow.stage. El mtodo addChild() aade contenido en capas sobre cualquier contenido existente en la ventana. Para aadir un objeto de visualizacin debajo de la capa HTML, utilice el mtodo addChildAt() de la propiedad window.nativeWindow.stage, transfiriendo un valor de cero para el parmetro index. Si coloca un objeto en el ndice cero, se mueve el contenido existente (incluida la visualizacin HTML) una capa ms arriba y se inserta el nuevo contenido en el capa inferior. Para que el contenido distribuido en capas debajo de la pgina HTML sea visible, debe establecer la propiedad paintsDefaultBackground del objeto HTMLlLoader como false. Adems, todos los elementos de la pgina que establezcan un color de fondo no sern transparentes. Si, por ejemplo, establece un color de fondo para el elemento "body" de la pgina, ninguna parte de la pgina ser transparente. El siguiente ejemplo muestra cmo aadir objetos de visualizacin de Flash como superposiciones y como capas inferiores en una pgina HTML. El ejemplo crea dos objetos de formas sencillas, y aade uno debajo de contenido HTML y el otro encima. El ejemplo tambin actualiza la posicin de la forma en funcin del evento enterFrame.
920
<html> <head> <title>Bouncers</title> <script src="AIRAliases.js" type="text/javascript"></script> <script language="JavaScript" type="text/javascript"> air.Shape = window.runtime.flash.display.Shape; function Bouncer(radius, color){ this.radius = radius; this.color = color; //velocity this.vX = -1.3; this.vY = -1; //Create a Shape object and draw a circle with its graphics property this.shape = new air.Shape(); this.shape.graphics.lineStyle(1,0); this.shape.graphics.beginFill(this.color,.9); this.shape.graphics.drawCircle(0,0,this.radius); this.shape.graphics.endFill(); //Set the starting position this.shape.x = 100; this.shape.y = 100;
//Moves the sprite by adding (vX,vY) to the current position this.update = function(){ this.shape.x += this.vX; this.shape.y += this.vY; //Keep the sprite within the window if( this.shape.x - this.radius < 0){ this.vX = -this.vX; } if( this.shape.y - this.radius < 0){ this.vY = -this.vY; } if( this.shape.x + this.radius > window.nativeWindow.stage.stageWidth){ this.vX = -this.vX; } if( this.shape.y + this.radius > window.nativeWindow.stage.stageHeight){ this.vY = -this.vY; } }; } function init(){ //turn off the default HTML background window.htmlLoader.paintsDefaultBackground = false; var bottom = new Bouncer(60,0xff2233); var top = new Bouncer(30,0x2441ff); //listen for the enterFrame event window.htmlLoader.addEventListener("enterFrame",function(evt){
921
bottom.update(); top.update(); }); //add the bouncing shapes to the window stage window.nativeWindow.stage.addChildAt(bottom.shape,0); window.nativeWindow.stage.addChild(top.shape); } </script> <body onload="init();"> <h1>de Finibus Bonorum et Malorum</h1> <p>Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo.</p> <p style="background-color:#FFFF00; color:#660000;">This paragraph has a background color.</p> <p>At vero eos et accusamus et iusto odio dignissimos ducimus qui blanditiis praesentium voluptatum deleniti atque corrupti quos dolores et quas molestias excepturi sint occaecati cupiditate non provident, similique sunt in culpa qui officia deserunt mollitia animi, id est laborum et dolorum fuga.</p> </body> </html>
Este ejemplo proporciona una introduccin rudimentaria a algunas tcnicas avanzadas que utilizan tanto JavaScript como ActionScript en AIR. Si no est familiarizado con el uso de objetos de visualizacin de ActionScript consulte Programacin de la visualizacin en la pgina 146 en la Gua del desarrollador de ActionScript 3.0.
922
Gestin de ventanas
Adobe AIR 1.0 y posterior Puede utilizar las propiedades y mtodos de la clase NativeWindow para gestionar el aspecto, el comportamiento y el ciclo de vida de las ventanas de escritorio. Nota: al utilizar Flex, suele ser mejor administrar el comportamiento de la ventana utilizando las clases de la arquitectura. A la mayora de los mtodos y propiedades de NativeWindow se puede acceder mediante las clases mx:WindowedApplication y mx:Window.
(pero devuelve null si la ventana activa no es una ventana de esta aplicacin de AIR). El conjunto NativeApplication.nativeApplication.openedWindows contiene todas las ventanas de una aplicacin de AIR que no se han cerrado. Dado que los objetos Application, WindowedApplication y Window de Flex son objetos de visualizacin a los que es muy sencillo hacer referencia a la ventana de aplicacin desde un archivo MXML mediante la propiedad stage, como puede verse a continuacin:
923
<?xml version="1.0" encoding="utf-8"?> <mx:WindowedApplication xmlns:mx="http://www.adobe.com/2006/mxml" applicationComplete="init();"> <mx:Script> <![CDATA[ import flash.display.NativeWindow; public function init():void{ var appWindow:NativeWindow = this.stage.nativeWindow; //set window properties appWindow.visible = true; } ]]> </mx:Script> </WindowedApplication
Nota: hasta que se aade el componente WindowedApplication o Window al escenario de la ventana por la arquitectura de Flex, la propiedad stage del componente es null. Este comportamiento es coherente con el del componente Application de Flex, pero no significa que sea imposible acceder al escenario o a la instancia de NativeWindow en detectores de eventos anteriores al ciclo de inicializacin de los componentes WindowedApplication y Window, por ejemplo, creationComplete. Es seguro acceder al escenario y a la instancia de NativeWindow cuando se distribuye el evento applicationComplete.
924
Puede mantener una ventana delante del resto si establece su propiedad alwaysInFront como true. Si hay ms de una ventana con este ajuste, el orden de visualizacin de las ventanas se ajustar entre s, pero siempre se visualizarn delante de ventanas que tengan la propiedad alwaysInFront como false. Las ventanas del grupo superior tambin se visualizan sobre el resto de las aplicaciones, incluso si la aplicacin de AIR no est activa. Como este comportamiento no es el habitual del resto de usuarios, slo se debe establecer alwaysInFront como true cuando sea realmente necesario. Entre los ejemplos de usos justificados se incluyen:
Ventanas emergentes temporales para controles como sugerencias, listas, mens personalizados o cuadros
combinados. Como estas ventanas se cierran cuando dejan de recibir la seleccin, est justificado el comportamiento para evitar que el usuario no pueda ver las ventanas.
Mensajes de error y alertas realmente importantes. Si se produce un cambio irrevocable y el usuario no responde a
tiempo, est justificado el comportamiento para poner la alerta en primer plano. Sin embargo, la mayora de los errores y alertas se pueden gestionar con el orden de visualizacin normal de las ventanas.
Nota: si una ventana est oculta (visible es false) o minimizada, llamar a los mtodos de orden de visualizacin no produce ningn efecto.
925
En el sistema operativo Linux, los diferentes administradores de ventana aplican reglas distintas relacionadas con el orden de visualizacin de la ventana:
En algunos administradores, las ventanas de utilidades siempre se muestran delante de las ventanas normales. En algunos administradores de ventanas, una ventana de pantalla completa con alwaysInFront establecido en true,
siempre se muestra delante de otras ventanas que tambin tienen el valor alwaysInFront definido como true.
926
El mtodo dispatchEvent() devuelve false si un detector llama al mtodo preventDefault() del evento. No obstante, tambin puede devolver false por otros motivos. Por ello, es mejor utilizar explcitamente el mtodo isDefaultPrevented() para probar si se debe cancelar o no el cambio.
Para restaurar la ventana (es decir, hacer que recupere el tamao que tena antes de maximizarla o minimizarla), utilice el mtodo restore() de NativeWindow.
myWindow.restore();
Una venta que tenga una propietaria se minimiza y se restaura cuando la ventana propietaria se minimice o se restaure. La ventana incluida no distribuye eventos cuando se minimiza, ya que su propietaria tambin se minimiza. Nota: el comportamiento resultante de maximizar una ventana de AIR es distinto al comportamiento estndar de Mac OS X. En vez de alternar entre el tamao estndar definido por la aplicacin y el ltimo tamao establecido por el usuario, las ventanas de AIR alternan entre el ltimo tamao establecido por la aplicacin y el tamao completo utilizable de la pantalla. En el sistema operativo Linux, los diferentes administradores de ventana aplican reglas distintas relacionadas con la configuracin del estado de visualizacin de la ventana:
En algunos administradores, las ventanas de utilidades no se puede maximizar. Si se define un tamao mximo para la ventana, algunas ventanas no permiten que se maximice una ventana. Otros
administradores de ventanas establecen el estado de visualizacin como maximizado, pero no cambian el tamao de la ventana. En cualquier caso, no se distribuye ningn evento de cambio de estado de visualizacin.
927
<mx:Script> <![CDATA[ public function minimizeWindow():void { this.stage.nativeWindow.minimize(); } public function maximizeWindow():void { this.stage.nativeWindow.maximize(); } public function restoreWindow():void { this.stage.nativeWindow.restore(); } public function closeWindow():void { this.stage.nativeWindow.close(); } ]]> </mx:Script> <mx:VBox> <mx:Button <mx:Button <mx:Button <mx:Button </mx:VBox>
</mx:WindowedApplication>
El siguiente ejemplo de ActionScript para Flash crea cuatro campos de texto en los que se puede hacer clic y que activan los mtodos minimize(), maximize(), restore() y close() de NativeWindow:
928
package { import flash.display.Sprite; import flash.events.MouseEvent; import flash.text.TextField; public class MinimizeExample extends Sprite { public function MinimizeExample():void { var minTextBtn:TextField = new TextField(); minTextBtn.x = 10; minTextBtn.y = 10; minTextBtn.text = "Minimize"; minTextBtn.background = true; minTextBtn.border = true; minTextBtn.selectable = false; addChild(minTextBtn); minTextBtn.addEventListener(MouseEvent.CLICK, onMinimize); var maxTextBtn:TextField = new TextField(); maxTextBtn.x = 120; maxTextBtn.y = 10; maxTextBtn.text = "Maximize"; maxTextBtn.background = true; maxTextBtn.border = true; maxTextBtn.selectable = false; addChild(maxTextBtn); maxTextBtn.addEventListener(MouseEvent.CLICK, onMaximize); var restoreTextBtn:TextField = new TextField(); restoreTextBtn.x = 230; restoreTextBtn.y = 10; restoreTextBtn.text = "Restore"; restoreTextBtn.background = true; restoreTextBtn.border = true; restoreTextBtn.selectable = false; addChild(restoreTextBtn); restoreTextBtn.addEventListener(MouseEvent.CLICK, onRestore); var closeTextBtn:TextField = new TextField(); closeTextBtn.x = 340; closeTextBtn.y = 10; closeTextBtn.text = "Close Window"; closeTextBtn.background = true; closeTextBtn.border = true; closeTextBtn.selectable = false; addChild(closeTextBtn);
929
closeTextBtn.addEventListener(MouseEvent.CLICK, onCloseWindow); } function onMinimize(event:MouseEvent):void { this.stage.nativeWindow.minimize(); } function onMaximize(event:MouseEvent):void { this.stage.nativeWindow.maximize(); } function onRestore(event:MouseEvent):void { this.stage.nativeWindow.restore(); } function onCloseWindow(event:MouseEvent):void { this.stage.nativeWindow.close(); } } }
930
Nota: en Linux, las propiedades de la ventana se modifican de forma asincrnica. Si cambia el tamao de una ventana en una lnea del programa y lee las dimensiones en la siguiente, an se reflejar la configuracin anterior. En todas las plataformas, el objeto NativeWindow distribuye el evento resize cuando se cambia el tamao de la ventana. Si se necesita realizar alguna operacin, como distribuir controles en la ventana, en funcin del nuevo tamao o estado de la ventana, siempre se debe llevar a cabo en un controlador de eventos resize. Consulte Deteccin de eventos de ventanas en la pgina 932. El modo de escala del escenario determina cmo se comporta el escenario de la ventana y su contenido cuando se cambia la ventana de tamao. No olvide que los modos de escala del escenario estn diseados para situaciones (como un navegador web) en las que la aplicacin no controla el tamao ni la relacin de aspecto de la visualizacin. En general, los mejores resultados se obtienen estableciendo la propiedad scaleMode como StageScaleMode.NO_SCALE. Si quiere escalar tambin el contenido de la ventana, debe establecer los parmetros scaleX y scaleY del contenido como respuesta a los cambios de los lmites de la ventana. Desplazamiento de una ventana Para desplazar una ventana sin cambiar su tamao, utilice el mtodo startMove() de NativeWindow. Al igual que el mtodo startResize(), cuando se llama a startMove() desde un evento mouseDown, el proceso de desplazamiento corre a cargo del ratn y finaliza cuando el sistema operativo recibe un evento mouseUp. Para obtener ms informacin sobre los mtodos startResize() y startMove(), consulte Referencia de ActionScript 3.0 para la plataforma de Adobe Flash. Para mover una ventana mediante programacin, establezca las propiedades x, y o bounds de la ventana en la posicin deseada. Si se establecen los lmites, la posicin y el tamao de la ventana se pueden modificar al mismo tiempo. Nota: en Linux, las propiedades de la ventana se modifican de forma asincrnica. Si se mueve una ventana en una lnea del programa y se lee la posicin en la siguiente, el valor ledo an reflejar la configuracin anterior. En todas las plataformas, el objeto NativeWindow distribuye el evento move cuando cambia la posicin. Si se necesita realizar alguna operacin en funcin de la nueva posicin de la ventana, siempre se debe llevar a cabo en un controlador de eventos move. Consulte Deteccin de eventos de ventanas en la pgina 932.
931
package { import flash.display.Sprite; import flash.events.MouseEvent; import flash.display.NativeWindowResize; public class NativeWindowResizeExample extends Sprite { public function NativeWindowResizeExample():void { // Fills a background area. this.graphics.beginFill(0xFFFFFF); this.graphics.drawRect(0, 0, 400, 300); this.graphics.endFill(); // Creates a square area where a mouse down will start the resize. var resizeHandle:Sprite = createSprite(0xCCCCCC, 20, this.width - 20, this.height - 20); resizeHandle.addEventListener(MouseEvent.MOUSE_DOWN, onStartResize); // Creates a square area where a mouse down will start the move. var moveHandle:Sprite = createSprite(0xCCCCCC, 20, this.width - 20, 0); moveHandle.addEventListener(MouseEvent.MOUSE_DOWN, onStartMove); } public function createSprite(color:int, size:int, x:int, y:int):Sprite { var s:Sprite = new Sprite(); s.graphics.beginFill(color); s.graphics.drawRect(0, 0, size, size); s.graphics.endFill(); s.x = x; s.y = y; this.addChild(s); return s; } public function onStartResize(event:MouseEvent):void { this.stage.nativeWindow.startResize(NativeWindowResize.BOTTOM_RIGHT); } public function onStartMove(event:MouseEvent):void { this.stage.nativeWindow.startMove(); } } }
932
Cuando se distribuye un evento, la propiedad target hace referencia a la ventana que enva el evento. La mayora de eventos de ventanas tienen dos mensajes relacionados. El primer mensaje indica que el cambio en la ventana es inminente (se puede cancelar), mientras que el segundo mensaje indica que el cambio ya se ha producido. Por ejemplo, si el usuario hace clic en el botn de cierre de una ventana, de distribuye el mensaje del evento closing. Si ningn detector cancela el evento, la ventana se cierre y el evento close se distribuye a todos los detectores. Normalmente, los eventos de advertencia como closing slo se distribuyen si se utiliza el fondo cromtico del sistema para activar un evento. Si se llama al mtodo close() de la ventana, por ejemplo, no se distribuye automticamente el evento closing (slo el evento close). Sin embargo, es posible construir un objeto de evento de cierre y distribuirlo mediante el mtodo dispatchEvent() de ventana. Los eventos de ventana que distribuye un objeto Event son:
Evento activate deactivate closing Descripcin Se distribuye cuando la ventana recibe la seleccin. Se distribuye cuando la ventana deja de recibir la seleccin. Se distribuye cuando la ventana va a cerrarse. Esto slo ocurre automticamente al pulsar el botn de cierre del fondo cromtico o, en Mac OS X, al invocar el comando Salir. Se distribuye cuando la ventana se ha cerrado.
close
move resizing
resize
En eventos NativeWindowBoundsEvent, puede utilizar las propiedades beforeBounds y afterBounds para determinar los lmites de la ventana antes y despus el cambio. Los eventos de ventana que distribuye un objeto NativeWindowDisplayStateEvent son:
Evento displayStateChanging displayStateChange Descripcin Se distribuye inmediatamente antes de que cambie el estado de visualizacin de la ventana. Se distribuye una vez ha cambiado el estado de visualizacin de la ventana.
933
En eventos NativeWindowDisplayStateEvent, puede utilizar las propiedades beforeDisplayState y afterDisplayState para determinar el estado de visualizacin de la ventana antes y despus del cambio. En algunos administradores de ventanas de Linux, no se distribuye ningn evento de cambio de estado de visualizacin cuando se maximiza una ventana con una configuracin de tamao mximo. (La ventana se establece en el estado de visualizacin maximizado, pero no se cambia el tamao.)
El siguiente ejemplo de ActionScript para Flash simula un terminal simple de texto a pantalla completa:
934
public class FullScreenTerminalExample extends Sprite { public function FullScreenTerminalExample():void { var terminal:TextField = new TextField(); terminal.multiline = true; terminal.wordWrap = true; terminal.selectable = true; terminal.background = true; terminal.backgroundColor = 0x00333333; this.stage.displayState = StageDisplayState.FULL_SCREEN_INTERACTIVE; addChild(terminal); terminal.width = 550; terminal.height = 400; terminal.text = "Welcome to the dumb terminal application. Press the ESC key to exit.\n_"; var tf:TextFormat = new TextFormat(); tf.font = "Courier New"; tf.color = 0x00CCFF00; tf.size = 12; terminal.setTextFormat(tf); terminal.setSelection(terminal.text.length - 1, terminal.text.length); } }
935
Ms temas de ayuda
flash.display.Screen
Measuring the virtual desktop (Medicin del escritorio virtual, en ingls) (Flex) Measuring the virtual desktop (Medicin del escritorio virtual, en ingls) (Flash)
La API de la pantalla contiene una sola clase, Screen, que proporciona miembros estticos para obtener informacin sobre las pantallas del sistema y miembros de instancia para describir una pantalla en particular. Un sistema informtico puede tener conectados varios monitores que se corresponden con diversas pantallas de escritorio dispuestas en un espacio virtual. La clase Screen de AIR facilita informacin sobre las pantallas, la disposicin y el espacio aprovechable de las mismas. Si hay ms de un monitor que se corresponde con la misma pantalla, es que existe una sola pantalla. Si el tamao de la pantalla es superior a la superficie de visualizacin del monitor, no hay manera de determinar qu parte de la pantalla est visible en este momento. Una pantalla representa una superficie independiente de visualizacin del escritorio. Las pantallas se describen como rectngulos dentro del escritorio virtual. El punto cero del sistema de coordenadas del escritorio virtual es el ngulo superior izquierdo de la pantalla designada como pantalla principal. Todos los valores que se utilizan para describir una pantalla se expresan en pxeles.
936
Lmites de pantalla Pantalla virtual Lmites tiles En esta disposicin de pantallas, hay dos pantallas en el escritorio virtual. Las coordenadas del ngulo superior izquierdo de la pantalla principal (n 1) son siempre (0,0). Si se modifica la disposicin de pantallas para designar la pantalla n 2 como pantalla principal, las coordenadas de la pantalla n 1 pasan a ser cifras negativas. Las barras de mens, las barras de tareas y los docks se excluyen al notificar los lmites utilizables para una pantalla.
Para obtener ms informacin sobre la clase de API de pantalla, sus mtodos, propiedades y eventos, consulte Referencia de ActionScript 3.0 para la plataforma de Adobe Flash.
Screen.mainScreen
Screen.getScreensForRectangle() Proporciona un conjunto de objetos Screen que describen las pantallas a las que cruza el rectngulo determinado. El rectngulo que se pasa a este mtodo tiene las coordenadas en pxeles en el escritorio virtual. Si el rectngulo no forma interseccin con ninguna pantalla, el conjunto estar vaco. Este mtodo puede emplearse para averiguar en qu pantallas se muestra una ventana.
Los valores que producen los mtodos y propiedades de la clase Screen no deben guardarse. El usuario o el sistema operativo puede modificar en cualquier momento las pantallas disponibles y la disposicin de las mismas. En el ejemplo siguiente se utiliza la API de la pantalla para desplazar una ventana entre varias pantallas en funcin de la pulsacin de las teclas de flecha. Para desplazar la ventana a la siguiente pantalla, el ejemplo obtiene el conjunto screens y lo ordena en sentido vertical u horizontal (dependiendo de la tecla de flecha que se pulse). El cdigo pasa por el conjunto ordenado y compara cada pantalla con las coordenadas de la pantalla actual. Para identificar la pantalla actual de la ventana, el ejemplo llama a Screen.getScreensForRectangle() y se pasan los lmites de la ventana.
937
public class ScreenExample extends Sprite { public function ScreenExample() { stage.align = StageAlign.TOP_LEFT; stage.scaleMode = StageScaleMode.NO_SCALE; stage.addEventListener(KeyboardEvent.KEY_DOWN,onKey); } private function onKey(event:KeyboardEvent):void{ if(Screen.screens.length > 1){ switch(event.keyCode){ case Keyboard.LEFT : moveLeft(); break; case Keyboard.RIGHT : moveRight(); break; case Keyboard.UP : moveUp(); break; case Keyboard.DOWN : moveDown(); break; } } } private function moveLeft():void{ var currentScreen = getCurrentScreen(); var left:Array = Screen.screens; left.sort(sortHorizontal); for(var i:int = 0; i < left.length - 1; i++){ if(left[i].bounds.left < stage.nativeWindow.bounds.left){ stage.nativeWindow.x += left[i].bounds.left - currentScreen.bounds.left; stage.nativeWindow.y += left[i].bounds.top - currentScreen.bounds.top; } } } private function moveRight():void{ var currentScreen:Screen = getCurrentScreen(); var left:Array = Screen.screens; left.sort(sortHorizontal); for(var i:int = left.length - 1; i > 0; i--){ if(left[i].bounds.left > stage.nativeWindow.bounds.left){ stage.nativeWindow.x +=
938
left[i].bounds.left - currentScreen.bounds.left; stage.nativeWindow.y += left[i].bounds.top - currentScreen.bounds.top; } } } private function moveUp():void{ var currentScreen:Screen = getCurrentScreen(); var top:Array = Screen.screens; top.sort(sortVertical); for(var i:int = 0; i < top.length - 1; i++){ if(top[i].bounds.top < stage.nativeWindow.bounds.top){ stage.nativeWindow.x += top[i].bounds.left - currentScreen.bounds.left; stage.nativeWindow.y += top[i].bounds.top - currentScreen.bounds.top; break; } } } private function moveDown():void{ var currentScreen:Screen = getCurrentScreen(); var top:Array = Screen.screens; top.sort(sortVertical); for(var i:int = top.length - 1; i > 0; i--){ if(top[i].bounds.top > stage.nativeWindow.bounds.top){ stage.nativeWindow.x += top[i].bounds.left - currentScreen.bounds.left; stage.nativeWindow.y += top[i].bounds.top - currentScreen.bounds.top; break; } } } private function sortHorizontal(a:Screen,b:Screen):int{ if (a.bounds.left > b.bounds.left){ return 1; } else if (a.bounds.left < b.bounds.left){ return -1; } else {return 0;} } private function sortVertical(a:Screen,b:Screen):int{ if (a.bounds.top > b.bounds.top){ return 1; } else if (a.bounds.top < b.bounds.top){ return -1; } else {return 0;} } private function getCurrentScreen():Screen{ var current:Screen; var screens:Array = Screen.getScreensForRectangle(stage.nativeWindow.bounds); (screens.length > 0) ? current = screens[0] : current = Screen.mainScreen; return current; } } }
939
Fundamentos de impresin
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior En ActionScript 3.0 se utiliza la clase PrintJob para crear instantneas de contenido de la pantalla con el fin de convertirlas en las representaciones en tinta y papel de una copia impresa. En cierto modo, configurar contenido para imprimir es lo mismo que configurarlo para la visualizacin en pantalla: se disponen los elementos y se ajusta su tamao para crear el diseo deseado. Sin embargo, la impresin tiene peculiaridades que la distinguen de la visualizacin en pantalla. Por ejemplo, la resolucin de las impresoras es distinta de la de los monitores de ordenador, el contenido de una pantalla de ordenador es dinmico y puede cambiar mientras que el contenido impreso es esttico, y al planificar la impresin hay que tener en cuenta las restricciones de un tamao fijo de pgina y la posibilidad de la impresin de varias pginas. Aunque estas diferencias pueden parecer obvias, es importante tenerlas en cuenta al configurar la impresin con ActionScript. La precisin de la impresin depende de una combinacin de los valores especificados por el programador y las caractersticas de la impresora del usuario. La clase PrintJob incluye propiedades que permiten determinar las caractersticas importantes de la impresora del usuario. Conceptos y trminos importantes La siguiente lista de referencia contiene trminos importantes relacionados con la impresin:
Cola de impresin Parte del sistema operativo o software controlador de impresora que hace un seguimiento de las pginas en espera de ser impresas y las enva a la impresora cuando sta disponible. Orientacin de la pgina Rotacin del contenido impreso con relacin al papel (horizontal o vertical). Trabajo de impresin Pgina o conjunto de pginas que constituyen una impresin individual.
940
new PrintJob(): crea una nueva instancia de trabajo de impresin con el nombre especificado por el usuario. PrintJob.start(): inicia el proceso de impresin en el sistema operativo, llama al cuadro de dilogo de impresin
para el usuario y llena los valores de las propiedades de slo lectura del trabajo de impresin.
PrintJob.addPage(): contiene los detalles relativos al contenido del trabajo de impresin, como el objeto Sprite
(y sus elementos secundarios), el tamao del rea de impresin y si la impresora debe imprimir la imagen como un vector o un mapa de bits. Se pueden utilizar llamadas sucesivas a addPage() para imprimir varios objetos Sprite en varias pginas.
Por ejemplo, un script de un trabajo de impresin sencillo es el siguiente (incluyendo las sentencias package, import yclass para la compilacin):
package { import flash.printing.PrintJob; import flash.display.Sprite; public class BasicPrintExample extends Sprite { var myPrintJob:PrintJob = new PrintJob(); var mySprite:Sprite = new Sprite(); public function BasicPrintExample() { myPrintJob.start(); myPrintJob.addPage(mySprite); myPrintJob.send(); } } }
Nota: este ejemplo pretende mostrar los elementos bsicos de un script de trabajo de impresin y no contiene gestin de errores. Para generar un script que responda adecuadamente a la cancelacin de un trabajo de impresin por parte del usuario, consulte Trabajo con excepciones y valores devueltos en la pgina 941. Si es necesario borrar las propiedades de un objeto PrintJob por algn motivo, debe establecerse la variable PrintJob en null (por ejemplo, myPrintJob = null).
941
Si PrintJob.start() es true, el usuario seleccion Print (o un motor de ejecucin de Flash, como as Flash Player o AIR, ha iniciado un comando Print). Por lo tanto, se puede llamar a los mtodos addPage() y send(). Asimismo, para ayudar a administrar el proceso de impresin, los motores de ejecucin de Flash emiten excepciones para el mtodo PrintJob.addPage(), de forma que es posible capturar errores y proporcionar informacin y opciones al usuario. Si un mtodo PrintJob.addPage() no se ejecuta correctamente, se puede llamar a otra funcin o detener el trabajo de impresin actual. Estas excepciones se pueden capturar incorporando llamadas addPage() en una sentencia try..catch, tal y como se muestra en el siguiente ejemplo. En el ejemplo, [params] es un marcador de posicin para los parmetros, que especifica el contenido real que se desea imprimir:
if (myPrintJob.start()) { try { myPrintJob.addPage([params]); } catch (error:Error) { // Handle error, } myPrintJob.send(); }
942
Cuando se inicia el trabajo de impresin, se puede aadir contenido mediante PrintJob.addPage() y ver si se genera una excepcin (por ejemplo, si el usuario ha cancelado el trabajo de impresin). Si es as, se puede aadir lgica a la sentencia catch para proporcionar al usuario (o el motor de ejecucin de Flash) informacin y opciones, o bien, se puede detener el trabajo de impresin actual. Si se aade la pgina correctamente, se puede continuar enviando las pginas a la impresora mediante PrintJob.send(). Si los motores de ejecucin de Flash encuentran un problema al enviar el trabajo de impresin a la impresora (por ejemplo, si la impresora est sin conexin), se puede capturar tambin dicha excepcin y proporcionar al usuario informacin o ms opciones (por ejemplo, mostrar el texto de un mensaje o proporcionar una alerta en una animacin). Por ejemplo, puede asignar texto nuevo a un campo de texto en una sentencia if..else, tal y como se indica en el siguiente cdigo:
if (myPrintJob.start()) { try { myPrintJob.addPage([params]); } catch (error:Error) { // Handle error. } myPrintJob.send(); } else { myAlert.text = "Print job canceled"; }
Para ver ejemplos de uso, consulte Ejemplo de impresin: Ajuste de escala, recorte y respuesta en la pgina 951.
943
Para especificar la impresin de mapa de bits, pase un objeto PrintJobOptions como tercer parmetro de PrintJob.addPage(). Para Flash Player y AIR anterior a AIR 2, defina el parmetro printAsBitmap del objeto PrintJobOptions como true del modo siguiente:
var options:PrintJobOptions = new PrintJobOptions(); options.printAsBitmap = true; myPrintJob.addPage(mySprite, null, options);
Si no se especifica un valor para el tercer parmetro, el trabajo de impresin utilizar el valor predeterminado, que es la impresin vectorial. Para AIR 2 y posterior, utilice la propiedad printMethod del objeto PrintJobOptions para especificar el mtodo de impresin. Esta propiedad acepta tres valores que se definen como constantes en la clase PrintMethod:
va a imprimir. Por ejemplo, si la pgina contiene texto, se elige el mtodo de impresin vectorial. Sin embargo, si hay una imagen con marca de agua y transparencia alfa sobre el texto, se opta por la impresin de mapa de bits para conservar la transparencia.
PrintMethod.BITMAP: fuerza la impresin de mapa de bits sin importar el contenido PrintMethod.VECTOR: fuerza la impresin vectorial sin importar el contenido
Entre PrintJob.start() y el primer PrintJob.addPage() Entre PrintJob.addPage() y el siguiente PrintJob.addPage() Entre el ltimo PrintJob.addPage() y PrintJob.send()
Si alguno de los intervalos anteriores dura ms de 15 segundos, la siguiente llamada a PrintJob.start() en la instancia de PrintJob devolver false y el siguiente PrintJob.addPage() de la instancia de PrintJob har que Flash Player o AIR emitan una excepcin de tiempo de ejecucin.
944
Crear un objeto Rectangle con propiedades especficas y luego utilizar el rectngulo en la llamada a addPage(),
como en el siguiente ejemplo:
private var rect1:Rectangle = new Rectangle(0, 0, 400, 200); myPrintJob.addPage(sheet, rect1);
Si no se ha especificado todava un objeto Rectangle, puede hacerse en la propia llamada, como en el siguiente
ejemplo:
myPrintJob.addPage(sheet, new Rectangle(0, 0, 100, 100));
Si se ha previsto proporcionar valores para el tercer parmetro en la llamada a addPage(), pero no se desea
especificar un rectngulo, se puede utilizar null para el segundo parmetro, como en el siguiente ejemplo:
myPrintJob.addPage(sheet, null, options);
945
Puede utilizar las equivalencias siguientes para convertir los valores en pulgadas o centmetros en twips o puntos (un twip es 1/20 de un punto):
1 punto = 1/72 pulgadas =20 twips 1 pulgada = 72 puntos = 1440 twips 1 centmetro = 567 twips
Si se omite o pasa de forma incorrecta el parmetro printArea, se imprime el rea completa del objeto Sprite.
Escala
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior Si desea realizar un ajuste de escala en un objeto Sprite antes de imprimirlo, establezca las propiedades de escala (consulte Manipulacin del tamao y ajuste de escala de los objetos en la pgina 175) antes de llamar al mtodo PrintJob.addPage() y restablezca los valores originales despus de imprimir. La escala de un objeto Sprite no tiene relacin con la propiedad printArea. En otras palabras, si se especifica un rea de impresin de 50 por 50 pxeles, se imprimen 2500 pxeles. Si se cambia la escala del objeto Sprite, se seguirn imprimiendo 2500 pxeles, pero el objeto Sprite se imprimir con el tamao con la escala ajustada. Para ver un ejemplo, consulte Ejemplo de impresin: Ajuste de escala, recorte y respuesta en la pgina 951.
Nota: si va a leer la configuracin del sistema para la orientacin de contenido en papel, recuerde importar la clase PrintJobOrientation. La clase PrintJobOrientation proporciona valores constantes que definen la orientacin del contenido en la pgina. La case se importa utilizando la siguiente instruccin:
import flash.printing.PrintJobOrientation;
946
Adems, la configuracin de mrgenes de una pgina puede determinarse comparando las dimensiones de la pgina y del papel, como se muestra en el siguiente ejemplo:
margin_height = (myPrintJob.paperHeight - myPrintJob.pageHeight) / 2; margin_width = (myPrintJob.paperWidth - myPrintJob.pageWidth) / 2;
Dilogos de configuracin de pgina: se pueden ver dilogos estndar y personalizados para la configuracin de
pgina. El usuario puede definir rangos de pginas, tamao del papel, orientacin y escala antes de imprimir.
Vista de impresin: es posible crear un modo de visualizacin para mostrar con precisin el tamao del papel, los
mrgenes y la posicin del contenido en la pgina.
Impresin restringida: los autores pueden restringir las opciones de impresin, como el rango de pginas
imprimibles.
Opciones de calidad: los autores pueden ajustar la calidad de impresin de un documento y permitir que los
usuarios puedan seleccionar la resolucin y las opciones de color.
Multisesiones de impresin: ahora es posible utilizar una sola instancia de PrintJob para multisesiones de
impresin. Las aplicaciones pueden proporcionar ajustes coherentes cada vez que se muestran los dilogos de configuracin de pgina e impresin.
new PrintJob(): crea una instancia de PrintJob (o reutiliza una existente). Muchas propiedades y mtodos PrintJob nuevos, como selectPaperSize(), estn disponibles antes de que se inicie el trabajo de impresin o durante el proceso. PrintJob.showPageSetupDialog(): (opcional) muestra el dilogo Configurar pgina sin iniciar un trabajo de
impresin.
PrintJob.start() o PrintJob.start2(): adems del mtodo start(), el mtodo start2() se utiliza para
iniciar el proceso de cola de impresin. El mtodo start2() permite elegir si se muestra el dilogo Imprimir y personalizarlo en caso de que se visualice.
PrintJob.addPage(): aade contenido al trabajo de impresin. No cambia en el proceso existente. PrintJob.send() o PrintJob.terminate(): enva las pginas a la impresora seleccionada o finaliza el trabajo
sin enviar nada. Los trabajos de impresin finalizan como respuesta a un error. Si se cancela una instancia de PrintJob, puede reutilizarse. Independientemente de si el trabajo de impresin se ha enviado a la impresora o se ha cancelado, se conserva la configuracin actual de la impresora para cuando reutilice la instancia de PrintJob.
947
Opcionalmente, se puede llamar a este mtodo con una propiedad de la clase PrintUIOptions para controlar qu opciones aparecen en el dilogo Configuracin de pgina. Es posible establecer los nmeros de pgina mx. y mn. El siguiente ejemplo limita la impresin a las tres primeras pginas:
import flash.printing.PrintJob; var myPrintJob:PrintJob = new PrintJob(); if (PrintJob.supportsPageSetupDialog) { var uiOpt:PrintUIOptions = new PrintUIOptions(); uiOpt.minPage = 1; uiOpt.maxPage = 3; myPrintJob.showPageSetupDialog(uiOpt); }
Utilice la propiedad printer para obtener o definir el nombre de la impresora del trabajo de impresin actual. De forma predeterminada, se establece como el nombre de la impresora predeterminada. La propiedad printer es null si no hay ninguna impresora disponible o si el sistema no admite impresin. Para cambiar la impresora, primero obtenga la lista de impresoras disponibles mediante la propiedad printers. Dicha propiedad es un vector cuyos elementos de cadena son nombres de impresoras disponibles. Defina la propiedad printer como uno de los valores de cadena que hacen que la impresora deseada sea la activa. La propiedad printer de un trabajo de impresin activo no se puede cambiar. Intente cambiarlo tras una llamada correcta a start() o start2(), y antes de que se enve el trabajo o de que finalice. Aqu tiene un ejemplo para establecer esta propiedad:
948
La propiedad copies obtiene el valor del nmero de copias establecido en el dilogo Imprimir del sistema operativo. Las propiedades firstPage y lastPage obtienen el rango de pginas. La propiedad orientation obtiene el parmetro de orientacin del papel. Estas propiedades se pueden establecer para que anulen los valores del dilogo Imprimir. El siguiente ejemplo establece estas propiedades:
import flash.printing.PrintJob; import flash.printing.PrintJobOrientation; var myPrintJob:PrintJob = new PrintJob(); myPrintJob.copies = 3; myPrintJob.firstPage = 1; myPrintJob.lastPage = 3; myPrintJob.orientation = PrintJobOrientation.LANDSCAPE;
Los siguientes ajustes de slo lectura asociados a PrintJob proporcionan informacin til sobre la configuracin de la impresora actual:
paperArea: lmites rectangulares del medio de impresin, en puntos. printableArea: lmites rectangulares del rea de impresin, en puntos. maxPixelsPerInch: resolucin fsica de la impresora actual, en pxeles por pulgada. isColor: capacidad de la impresora actual para imprimir en color (devuelve true si la impresora actual puede
imprimir en color). Consulte Ejemplo de impresin: Configuracin de pgina y opciones de impresin en la pgina 952.
949
public class PrintMultiplePages extends MovieClip { private var sheet1:Sprite; private var sheet2:Sprite; public function PrintMultiplePages():void { init(); printPages(); } private function init():void { sheet1 = new Sprite(); createSheet(sheet1, "Once upon a time...", {x:10, y:50, width:80, height:130}); sheet2 = new Sprite(); createSheet(sheet2, "There was a great story to tell, and it ended quickly.\n\nThe end.", null); } private function createSheet(sheet:Sprite, str:String, imgValue:Object):void { sheet.graphics.beginFill(0xEEEEEE); sheet.graphics.lineStyle(1, 0x000000); sheet.graphics.drawRect(0, 0, 100, 200); sheet.graphics.endFill(); var txt:TextField = new TextField(); txt.height = 200; txt.width = 100; txt.wordWrap = true; txt.text = str; if (imgValue != null) { var img:Sprite = new Sprite(); img.graphics.beginFill(0xFFFFFF); img.graphics.drawRect(imgValue.x, imgValue.y, imgValue.width, imgValue.height); img.graphics.endFill(); sheet.addChild(img); } sheet.addChild(txt); } private function printPages():void { var pj:PrintJob = new PrintJob();
950
var pagesToPrint:uint = 0; if (pj.start()) { if (pj.orientation == PrintJobOrientation.LANDSCAPE) { throw new Error("Page is not set to an orientation of portrait."); } sheet1.height = pj.pageHeight; sheet1.width = pj.pageWidth; sheet2.height = pj.pageHeight; sheet2.width = pj.pageWidth; try { pj.addPage(sheet1); pagesToPrint++; } catch (error:Error) { // Respond to error. } try { pj.addPage(sheet2); pagesToPrint++; } catch (error:Error) { // Respond to error. } if (pagesToPrint > 0) { pj.send(); } } } } }
951
public class PrintScaleExample extends Sprite { private var bg:Sprite; private var txt:TextField; public function PrintScaleExample():void { init(); draw(); printPage(); } private function printPage():void { var pj:PrintJob = new PrintJob(); txt.scaleX = 3; txt.scaleY = 2; if (pj.start()) { trace(">> pj.orientation: " + pj.orientation); trace(">> pj.pageWidth: " + pj.pageWidth); trace(">> pj.pageHeight: " + pj.pageHeight); trace(">> pj.paperWidth: " + pj.paperWidth); trace(">> pj.paperHeight: " + pj.paperHeight); try { pj.addPage(this, new Rectangle(0, 0, 100, 100));
952
} catch (error:Error) { // Do nothing. } pj.send(); } else { txt.text } // Reset the txt.scaleX = txt.scaleY = } private function init():void { bg = new Sprite(); bg.graphics.beginFill(0x00FF00); bg.graphics.drawRect(0, 0, 100, 200); bg.graphics.endFill(); txt = new TextField(); txt.border = true; txt.text = "Hello World"; } private function draw():void { addChild(bg); addChild(txt); txt.x = 50; txt.y = 50; } } }
953
public class PrintAdvancedExample extends Sprite { private var bg:Sprite = new Sprite(); private var txt:TextField = new TextField(); private var pj:PrintJob = new PrintJob(); private var uiOpt:PrintUIOptions = new PrintUIOptions(); public function PrintAdvancedExample():void { initPrintJob(); initContent(); draw(); printPage(); } private function printPage():void { //test for dialog support as a static property of PrintJob class if (PrintJob.supportsPageSetupDialog) { pj.showPageSetupDialog(); } if (pj.start2(uiOpt, true)) { try { pj.addPage(this, new Rectangle(0, 0, 100, 100)); } catch (error:Error) { // Do nothing. } pj.send(); } else { txt.text = "Print job terminated"; pj.terminate(); } } private function initContent():void { bg.graphics.beginFill(0x00FF00); bg.graphics.drawRect(0, 0, 100, 200); bg.graphics.endFill();
954
txt.border = true; txt.text = "Hello World"; } private function initPrintJob():void { pj.selectPaperSize(PaperSize.LEGAL); pj.orientation = PrintJobOrientation.LANDSCAPE; pj.copies = 2; pj.jobName = "Flash test print"; } private function draw():void { addChild(bg); addChild(txt); txt.x = 50; txt.y = 50; } } }
955
Ms temas de ayuda
flash.sensors.Geolocation flash.events.GeolocationEvent Flex Pasta: Using Geolocation(GPS) on a mobile device (Uso de GPS en un dispositivo mvil; en ingls)
altitude: la altitud, en metros. heading: la direccin de movimiento (con respecto al norte verdadero), en grados. horizontalAccuracy: la precisin horizontal, en metros. latitude: la latitud, en grados. longitude: la longitud, en grados. speed: la velocidad, en metros por segundo. timestamp: el nmero de milisegundos en el momento del evento desde que se inicializ el motor de ejecucin. verticalAccuracy: la precisin vertical, en metros.
La propiedad timestamp es un objeto int. El resto son objetos Number. A continuacin incluimos un ejemplo bsico que muestra datos de geolocalizacin en un campo de texto:
956
var geo:Geolocation; if (Geolocation.isSupported) { geo = new Geolocation(); geo.addEventListener(GeolocationEvent.UPDATE, updateHandler); } else { geoTextField.text = "Geolocation feature not supported"; } function updateHandler(event:GeolocationEvent):void { geoTextField.text = "latitude: " + event.latitude.toString() + "\n" + "longitude: " + event.longitude.toString() + "\n" + "altitude: " + event.altitude.toString() + "speed: " + event.speed.toString() + "heading: " + event.heading.toString() + "horizontal accuracy: " + event.horizontalAccuracy.toString() + "vertical accuracy: " + event.verticalAccuracy.toString() }
Para usar este ejemplo, debe crear un campo de texto geoTextField y aadirlo a la lista de visualizacin antes de utilizar este cdigo. Puede ajustar el intervalo de tiempo que desee para los eventos de geolocalizacin llamando al mtodo
setRequestedUpdateInterval() del objeto Geolocation. Este mtodo toma un parmetro, interval, que es el
El tiempo real entre las actualizaciones de geolocalizacin puede ser mayor o menor que este valor. Cualquier cambio en el intervalo de actualizacin afecta a todos los detectores registrados. Si no llama al mtodo setRequestedUpdateInterval(), la aplicacin recibe actualizaciones basadas en el intervalo predeterminado del dispositivo. El usuario puede impedir que la aplicacin acceda a los datos de geolocalizacin. Por ejemplo, el iPhone muestra un mensaje al usuario cuando una aplicacin intenta obtener datos de geolocalizacin. Como respuesta al mensaje, el usuario puede denegar el acceso de la aplicacin a los datos de geolocalizacin. El objeto Geolocation distribuye un evento status cuando el usuario impide el acceso a los datos de geolocalizacin. Asimismo, el objeto Geolocation cuenta con una propiedad muted que se establece en true cuando el sensor de geolocalizacin no est disponible. El objeto Geolocation distribuye un evento status cuando la propiedad muted cambia. El siguiente cdigo muestra cmo detectar cundo los datos de geolocalizacin no estn disponibles:
957
var geo:Geolocation; var latitude:Number; var longitude:Number; if (Geolocation.isSupported) { geo = new Geolocation(); if (!geo.muted) { geo.addEventListener(GeolocationEvent.UPDATE, updateHandler); geo.addEventListener(StatusEvent.STATUS, geoStatusHandler); } } else { trace("not supported"); } function updateHandler(event:GeolocationEvent):void { latitude = event.latitude; longitude = event.longitude; } function geoStatusHandler(event:StatusEvent):void { geo.removeEventListener(GeolocationEvent.UPDATE, updateHandler); }
Nota: los iPhone de primera generacin, que no incluyen unidad GPS, distribuyen eventos update de forma ocasional. En estos dispositivos, un objeto Geolocation inicialmente distribuye uno o dos eventos update. Seguidamente, distribuye eventos update cuando cambia notablemente la informacin.
Actualmente, la geolocalizacin slo se admite en aplicaciones basadas en ActionScript para iPhone y en Flash Lite 4. Si Geolocation.isSupported es true en tiempo de ejecucin, se admite la geolocalizacin. Algunos modelos de iPhone no disponen de unidad GPS. Estos modelos utilizan otros medios (como triangulizacin de telfonos mviles) para obtener los datos de geolocalizacin. Para estos modelos, o para iPhone con GPS desactivado, un objeto Geolocation slo puede distribuir uno o dos eventos update iniciales.
958
Ms temas de ayuda
Paquete flash.globalization Localizacin de aplicaciones en la pgina 976 Charles Bihis: Want to Localize your Flex/AIR Apps? (Desea localizar sus aplicaciones de Flex/AIR; en ingls)
actividades de la empresa globalmente. La globalizacin consiste en actividades de ingeniera, como la internacionalizacin, la localizacin y la culturizacin, as como actividades de la empresa como gestin de productos, planificacin econmica, marketing y aspectos legales. La globalizacin a veces se abrevia como G11n (que representa la letra G, 11 letras ms y por ltimo la letra n). La globalizacin es lo que hacen los negocios.
Internacionalizacin Un proceso de ingeniera para generalizar un producto de modo que pueda aceptar varios
idiomas, scripts y convenciones culturales (incluidas divisas, reglas de ordenacin, formatos de nmero y fecha, etc.) sin necesidad de redisear ni recompilar. Este proceso se puede dividir en dos conjuntos de actividades: habilitacin y localizacin. La internacionalizacin a veces se denomina listo para el mundo y suele abreviarse como I18n. La internacionalizacin es lo que hacen los ingenieros.
Localizacin Un proceso de adaptacin de productos o servicios a un idioma, cultura o aspecto final determinado. La
localizacin a veces se abrevia como L10n. La localizacin es lo que hacen los traductores.
Culturizacin Un proceso de ingeniera que desarrolla o adapta funciones concretas a las necesidades especficas de una cultura. Algunos ejemplos son las funciones de edicin en japons de Adobe InDesign o la funcin de compatibilidad con Hanko de Adobe Acrobat.
959
Ordenacin Ordenacin del texto segn un orden correcto dado por una configuracin regional. Configuracin local Valor que refleja el idioma y las convenciones culturales aplicadas a una regin cultural, poltica
o geogrfica (que, en muchos casos, suele indicar un pas). Un identificador de configuracin regional exclusivo (ID de configuracin regional) representa este valor. El ID de configuracin regional se utiliza para buscar un conjunto de datos de configuracin regional que sean compatibles. Esta compatibilidad se aplica a unidades de medida, anlisis y formato de nmeros y fechas, etc.
Paquete de recursos Conjunto guardado de elementos especficos de una configuracin regional en la que se utilizar
la aplicacin. Un paquete de recursos suele contener todos los elementos de texto de la interfaz de usuario de la aplicacin. Dentro del paquete, estos elementos se convierten al lenguaje adecuado para la configuracin regional correspondiente. Tambin puede contener otros parmetros que alteren el diseo o el comportamiento de la interfaz de usuario en una configuracin regional concreta. Un paquete de recursos puede contener otros tipos de medios o referencias a otros tipos de medios con configuracin regional especfica.
La clase Collator que rige la ordenacin y la coincidencia de las cadenas La clase CurrencyFormatter que da formato a nmeros de cadenas de cantidad de divisa y analiza las cantidades y
los smbolos en las cadenas de entrada
La clase DateTimeFormatter que da formato a valores de fecha La clase LocaleID para recuperar informacin sobre una configuracin regional especfica La clase NumberFormatter que da formato y analiza valores numricos La clase StringTools que gestiona la conversin tipogrfica de cadenas para distinguir entre maysculas y
minsculas
960
o StringTools).
3 Busque errores y repuestos con las propiedades lastOperationStatus. 4 D formato y visualice informacin con ajustes especficos de una configuracin regional.
El siguiente paso es cargar y visualizar cadenas y recursos de la interfaz de usuario especficos de la configuracin regional. Este paso puede incluir tareas como:
Usar las funciones autolayout para cambiar la UI de tamao y poder admitir la longitud de la cadenas Elegir las fuentes adecuadas y las de repuesto Usar el motor de texto FTE para admitir otros sistemas de escritura Garantizar que los editores de mtodo de entrada se gestionan correctamente
Este ejemplo simplemente traza un mensaje si se utiliza un ID de configuracin regional de repuesto o si se produce un error. Su aplicacin puede aplicar lgica de gestin de errores adicional, si es necesario. Por ejemplo, puede mostrar un mensaje al usuario o hacer que la aplicacin utilice una configuracin regional especfica admitida.
961
Una vez creado el objeto LocaleID, puede recuperar los datos de su ID de configuracin regional. Utilice los mtodos getKeysAndValues(), getLanguage(), getRegion(), getScript(), getVariant() y isRightToLeft(), y la propiedad name. Los valores recuperados de estos mtodos y propiedades pueden contener informacin adicional que no podra extraerse directamente del identificador de configuracin regional. Cuando una aplicacin crea un servicio con deteccin de configuracin regional, como un formateador de datos, debe especificar la configuracin regional que se va a utilizar. La lista de configuraciones regionales admitidas vara segn el sistema operativo; por ello, es posible que la configuracin regional solicitada no siempre est disponible. Flash Player primero intenta buscar coincidencias del cdigo de idioma de la configuracin regional solicitada. Seguidamente, intenta afinar la bsqueda de configuracin regional y busca un sistema de escritura (script) y una regin. Por ejemplo:
var loc:LocaleID = new LocaleID("es"); trace(loc.getLanguage()); // es trace(loc.getScript()); // Latn trace(loc.getRegion()); // ES
En este ejemplo, el constructor LocaleID() recupera datos sobre la configuracin regional que coincide con el cdigo de idioma es de dicho usuario.
Incluir un ID de configuracin regional nico en el cdigo de la aplicacin. Es una tctica habitual, pero no permite
la internacionalizacin de la aplicacin.
Utilizar las preferencias del ID de configuracin regional del sistema operativo del usuario, o del navegador, u otro
conjunto de preferencias del usuario. Normalmente esta tcnica produce los mejores resultados de coincidencia de configuracin regional para el usuario, aunque no es totalmente preciso. Existe el riesgo de que la configuracin del sistema operativo no refleje las preferencias reales del usuario. Por ejemplo, el usuario puede estar utilizando un equipo compartido y no poder cambiar las configuraciones regionales preferidas del sistema operativo.
Tras definir el ID de configuracin regional en las preferencias del usuario, deje que el usuario seleccione la
configuracin regional que desee en una lista. Esta estrategia suele ser la mejor opcin si la aplicacin admite ms de una configuracin regional.
962
configuracin del navegador, la configuracin del sistema operativo o desde una cookie. (Su aplicacin debera poder implementar esta lgica pos s misma. La biblioteca flash.globalization no admite leer directamente preferencias de este tipo.)
2 Determine qu configuracin regional de las mostradas se admite en la aplicacin y seleccione la mejor como
predeterminada. Utilice el mtodo LocaleID.determinePreferredLocales() para encontrar las mejores configuraciones regionales para un usuario en funcin de sus configuraciones regionales preferidas y de las admitidas por el sistema operativo.
3 Deje que el usuario pueda cambiar la configuracin predeterminada de la configuracin regional en caso de que la
Formato de nmeros
Flash Player 10.1 y posterior, Adobe AIR 2.0 y posterior El formato de visualizacin de valores numricos vara sustancialmente entre las regiones. Por ejemplo, el nmero 123456.78 se escribira del modo siguiente en determinadas configuraciones regionales:
Configuracin local en-US (ingls, EE.UU.) de-DE (alemn, Alemania) fr-FR (francs, Francia) de-CH (alemn, Suiza) en-IN (ingls, India) Varias configuraciones regionales rabes Formato de nmero -123,456.78 -123.456,78 -123 456,78 -123'456.78 -1,23,456.78 123,456.78-
963
Existen muchos factores que influyen en los formatos de nmeros, por ejemplo:
Separadores. El separador decimal se coloca entre el entero y la fraccin de un nmero. Puede ser un punto, una
coma u otro carcter. El separador de agrupacin o separador de miles puede ser un punto, una coma, un espacio duro u otro carcter.
Patrones de agrupacin. El nmero de dgitos entre cada separador de agrupacin a la izquierda de la coma decimal
puede ser dos, tres u otro valor.
Indicadores de nmeros negativos. Los nmeros negativos se pueden escribir con un signo menos a la izquierda o
a la derecha del nmero, o entre parntesis en aplicaciones financieras. Por ejemplo, un 19 negativo se puede escribir como -19, 19- o (19).
Ceros a la derecha y a la izquierda. Algunas convenciones culturales aaden ceros a la derecha o a la izquierda para
escribir nmeros. Por ejemplo, el valor 0.17 puede escribirse como .17, 0.17 o 0.170, entre otras posibilidades.
Conjuntos de caracteres de dgitos. Muchos idiomas, como el hindi, el rabe y el japons, utilizan distintos
conjuntos de caracteres de dgitos. El paquete flash.globalization admite todos los conjuntos de caracteres de dgitos que representan los dgitos 0-9. La clase NumberFormatter considera todos los factores al dar formato a valores numricos.
El resultado variar en funcin de la configuracin regional del usuario y de sus preferencias. Por ejemplo, si la configuracin regional del usuario es fr-FR, el valor con formato sera: -123.456,789 Si slo quiere dar formato a un nmero para una configuracin regional especfica, independientemente de la configuracin del usuario, defina el nombre de la configuracin regional exacta que desee. Por ejemplo:
var nf:NumberFormatter = new NumberFormatter("de-CH"); trace(nf.formatNumber(-123456.789));
Los resultados en este caso son: -123'456.789 El mtodo formatNumber() toma un objeto Number como parmetro. La clase NumberFormatter tambin tiene un mtodo formatInt() que toma un objeto int como entrada, y un mtodo formatUint() que toma un objeto uint. Puede controlar de forma explcita la lgica de formato estableciendo propiedades de la clase NumberFormatter, tal como puede verse en este ejemplo:
var nf:NumberFormatter = new NumberFormatter("de-CH"); nf.negativeNumberFormat = 0; nf.fractionalDigits = 5; nf.trailingZeros = true; nf.decimalSeparator = ","; nf.useGrouping = false; trace(nf.formatNumber(-123456.789)); //(123456.78900)
964
establece el formato de nmero negativo con parntesis (como en aplicaciones financieras); establece el nmero de dgitos detrs del separador decimal en 5; especifica los ceros a la derecha que deben usarse para garantizar cinco posiciones decimales; define el separador decimal en una coma; pide al aplicador de formato no utilizar separadores de agrupacin.
Nota: al cambiar algunas de estas propiedades, el formato de nmero resultante ya no corresponder al formato preferido en la configuracin regional especificada. Utilice algunas de estas propiedades slo si no es importante la configuracin regional; si necesita control preciso sobre algn aspecto de formato, como el nmero de ceros a la derecha; o si el usuario solicita el cambio directamente, por ejemplo, desde el Panel de control de Windows.
El mtodo parseNumber() controla cadenas que slo contienen dgitos y caracteres de formato de nmeros, como signos negativos y separadores. Si la cadena contiene otros caracteres, se define un cdigo de error:
var nf:NumberFormatter = new NumberFormatter( "en-US" ); var inputNumberString:String = "The value is 1,234,567.890" var parsedNumber:Number = nf.parseNumber(inputNumberString); trace("Value:" + parsedNumber); // NaN trace("Status:" + nf.lastOperationStatus); // parseError
Para extraer nmeros de cadenas con caracteres alfabticos adicionales, utilice el mtodo NumberFormatter.parse():
var nf:NumberFormatter = new NumberFormatter( "en-US" ); var inputNumberString:String = "The value is 123,456,7.890"; var parseResult:NumberParseResult = nf.parse(inputNumberString); trace("Value:" + parseResult.value); // 1234567.89 trace("startIndex: " + parseResult.startIndex); // 14 trace("Status:" + nf.lastOperationStatus); // noError
El mtodo parse() devuelve un objeto NumberParseResult que contiene el valor numrico analizado en su propiedad value. La propiedad startIndex indica el ndice del primer carcter numrico encontrado. Puede utilizar las propiedades startIndex y endIndex para extraer las partes de la cadena que van antes y despus de los dgitos.
965
Configuracin local en-US (ingls, EE.UU.) de-DE (alemn, Alemania) en-IN (ingls, India)
El formato de divisa implica los mismos factores que el de nmeros, adems de algunos adicionales:
Cdigo ISO de divisa. El cdigo de divisa ISO 4217 de tres letras para la configuracin regional real que se utiliza,
por ejemplo, USD o EUR.
Smbolo de divisa. El smbolo o cadena de divisa para la configuracin regional real que se utiliza, por ejemplo, $ o . Formato de divisa negativa. Define la ubicacin del smbolo de divisa y del smbolo negativo o el parntesis en
relacin con la parte numrica de la cantidad de divisa con formato.
Formato de divisa positiva. Define la ubicacin del smbolo de divisa relativo a la parte numrica de la cantidad de
divisa.
En la mayora de los casos no se debe depender de la divisa predeterminada en una configuracin regional. Si la configuracin regional del usuario no se admite, la clase CurrencyFormatter asigna una configuracin regional de repuesto. La configuracin regional de repuesto puede tener una divisa predeterminada distinta. Adems, normalmente querr que los formatos de divisa tengan un aspecto correcto para el usuario, incluso si las cantidades no estn en la divisa local del usuario. Por ejemplo, un usuario canadiense quiere ver los precios de una empresa alemana en euros, pero con formato canadiense. El mtodo CurrencyFormatter.setCurrency() especifica la cadena de divisa exacta y el smbolo que debe utilizarse. El siguiente ejemplo muestra cantidades de divisa en euros a usuarios en la parte francfona de Canad:
var cf:CurrencyFormatter = new CurrencyFormatter( "fr-CA" ); cf.setCurrency("EUR", ""); trace(cf.format(1234567.89)); // 1.234.567,89 EUR
El mtodo setCurrency() tambin se puede utilizar para reducir la confusin y establecer smbolos de divisa sin ambigedades. Por ejemplo:
cf.setCurrency("USD","US$");
De forma predeterminada, el mtodo format() muestra un cdigo de divisa ISO 4217 de tres caracteres en vez del smbolo de la divisa. Los cdigos ISO 4217 son inequvocos y no requieren localizacin. Sin embargo, muchos usuarios prefieren utilizar los smbolos de divisa en vez de los cdigos ISO.
966
La clase CurrencyFormatter puede ayudarle a decidir si una cadena de divisa con formato debe utilizar un smbolo de divisa, como el smbolo del dlar o del euro, o si debe utilizar una cadena de divisa ISO de tres caracteres, como USD o EUR. Por ejemplo, una cantidad en dlares canadienses puede visualizarse como $200 para un usuario en Canad. Para un usuario en Espaa, sin embargo, se visualizara como CAD 200. Utilice el mtodo formattingWithCurrencySymbolIsSafe() para determinar si el smbolo de divisa de la cantidad ser ambiguo o incorrecto teniendo en cuenta la configuracin regional del usuario. El siguiente ejemplo aplica formato de configuracin regional en-US a un valor en euros. En funcin de la configuracin regional del usuario, la cadena de salida usar el cdigo de divisa ISO o el smbolo de la divisa.
var cf:CurrencyFormatter = new CurrencyFormatter( "en-CA"); if (cf.formattingWithCurrencySymbolIsSafe("USD")) { trace(cf.format(1234567.89, true)); // $1,234,567.89 } else { cf.setCurrency("USD", "$"); trace(cf.format(1234567.89)); // USD1,234,567.89 }
La parte de cadena de divisa de la cadena de entrada puede contener un smbolo de divisa, un cdigo ISO de divisa y caracteres de texto adicionales. Las posiciones de la cadena de divisa, el indicador de nmero negativo y el valor numrico deben coincidir con los formatos especificados en las propiedades negativeCurrencyFormat y positiveCurrencyFormat. Por ejemplo:
var cf:CurrencyFormatter = new CurrencyFormatter( "en-US" ); var inputCurrencyString:String = "Total $-123,56,7.890"; var parseResult:CurrencyParseResult = cf.parse(inputCurrencyString); trace("status: " + cf.lastOperationStatus ); // parseError trace("parsed amount: " + parseResult.value); // NaN trace("currencyString: " + parseResult.currencyString ); // cf.negativeCurrencyFormat = 2; parseResult = cf.parse(inputCurrencyString); trace("status: " + cf.lastOperationStatus ); // noError trace("parsed amount: " + parseResult.value); // -123567.89 trace("currencyString: " + parseResult.currencyString ); // Total $
En este ejemplo, la cadena de entrada tiene una cadena de divisa seguida de un signo menos y de un nmero. Sin embargo, el valor predeterminado de negativeCurrencyFormat para la configuracin regional en-US especifica que el indicador negativo debe ir primero. Como resultado, el mtodo parse() genera un error y el valor analizado es NaN.
967
Tras definir negativeCurrencyFormat como 2, que especifica que la cadena de divisa va primero, el mtodo parse() se ejecuta correctamente.
968
El mtodo DateTimeFormatter.getWeekdayNames() proporciona una lista localizada de los nombres de los das de la semana. El mtodo getWeekdayNames() acepta los mismos parmetros nameStyle y context que el mtodo getMonthNames().
var dtf:DateTimeFormatter = new DateTimeFormatter("fr-FR"); var weekdays:Vector.<String> = dtf.getWeekdayNames(DateTimeNameStyle.FULL, DateTimeNameContext.STANDALONE); trace(weekdays[0]); // dimanche weekdays = dtf.getWeekdayNames(DateTimeNameStyle.LONG_ABBREVIATION, DateTimeNameContext.STANDALONE); trace(weekdays[0]); // dim.
Adems, el mtodo getFirstWeekday() devuelve el valor de ndice del da que suele marcar el inicio de la semana en la configuracin regional seleccionada.
969
Al hacer bsquedas, normalmente se omiten las diferencias entre mayscula y minscula o los signos diacrticos para aumentar la posibilidad de encontrar coincidencias relevantes. Por ejemplo, una bsqueda de los caracteres cote en un documento en francs probablemente devolver coincidencias para cote, cte y cot.
var sorter:Collator = new Collator("fr-FR", CollatorMode.SORTING); words.sort(sorter.compare); trace(words); // cte,cot var matcher:Collator = new Collator("fr-FR", CollatorMode.MATCHING); if (matcher.equals(words[0], words[1])) { trace(words[0] + " = " + words[1]); // cte = cot }
El ejemplo primer crea un objeto Collator en modo SORTING para la configuracin regional de francs de Francia. Seguidamente, ordena dos palabras que se distinguen nicamente en signos diacrticos. Esto muestra que la comparacin SORTING distingue entre caracteres con y sin acentos. La ordenacin se realiza pasando una referencia al mtodo sort() del objeto Collator como un parmetro al mtodo Array.sort(). Esta tcnica es una de las formas ms eficaces de utilizar un objeto Collator para controlar la ordenacin. Seguidamente, el ejemplo crea un objeto en modo MATCHING. Cuando dicho objeto Collator compara las palabras, las trata como iguales. Esto muestra que los valores de comparacin MATCHING son los mismos en caracteres con y sin acento.
ignoreDiacritics
ignoreKanaType
ignoreSymbols
970
El siguiente cdigo muestra que establecer la propiedad ignoreDiacritics en true, cambia el orden de una lista de palabras en francs:
var words:Array = new Array("COTE", "cot", "cte", "Cot","cote"); var sorter:Collator = new Collator("fr-CA", CollatorMode.SORTING); words.sort(sorter.compare); trace(words); // cote,COTE,cte,cot,Cot sorter.ignoreDiacritics = true; words.sort(sorter.compare); trace(words); // cte,cot,cote,Cot,COTE
Conversin tipogrfica
Flash Player 10.1 y posterior, Adobe AIR 2.0 y posterior Los idiomas tambin tienen reglas distintas para convertir letras de caja alta (maysculas) y de caja baja (minsculas). Por ejemplo, la mayora de los idiomas que utilizan el alfabeto latino, la caja baja de la I mayscula es i. Sin embargo, algunos idiomas (como el turco o el azeri) existe otra i sin punto: la letra . Como resultado, en esos idiomas una minscula sin punto se transforma en una I mayscula. Una i minscula se transforma en una mayscula con un punto. La clase StringTools proporciona mtodos que utilizan reglas especficas de un idioma para llevar a cabo dichas transformaciones.
El mtodo toUpperCase() transforma la letra minscula en las letras SS maysculas. Esta transformacin no es bidireccional. Cuando las letras SS se convierten otra vez a minscula, el resultado es ss, no .
971
Formato de nmeros segn configuracin regional Formato de divisas segn configuracin regional Definicin del cdigo ISO de divisa y de smbolos de divisa Formato de fechas segn configuracin regional Recuperacin y visualizacin de abreviaturas correctas de nombres de meses
Para obtener los archivos de la aplicacin de este ejemplo, consulte www.adobe.com/go/learn_programmingAS3samples_flash_es. Los archivos de la aplicacin Global Stock Ticker se encuentran en la carpeta Samples/GlobalStockTicker. La aplicacin consta de los siguientes archivos:
Archivo Descripcin
GlobalStockTicker.mxm La interfaz de usuario de la aplicacin para Flex (MXML) o Flash (FLA). l o GlobalStockTicker.fla styles.css Estilos de la interfaz de usuario de la aplicacin (slo Flex).
com/example/program Un componente MXML que muestra un grfico con la simulacin de los datos de las acciones (slo Flex). mingas3/stockticker/fle x/FinGraph.mxml com/example/program Clase de documento que contiene la lgica de la interfaz de usuario para la aplicacin (slo Flash). mingas3/stockticker/fla sh/GlobalStockTicker.as comp/example/progra Procesador de celdas personalizado para el componente DataGrid de Flash (slo Flash). mmingas3/stockticker/f lash/RightAlignedColu mn.as com/example/program Clase de ActionScript que dibuja un grfico con la simulacin de los datos de las acciones. mingas3/stockticker/Fi nancialGraph.as com/example/program Clase de ActionScript que administra la configuracin regional y la divisa, y gestiona el formato localizado de mingas3/stockticker/Lo nmeros, cantidades de divisa y fechas. calizer.as com/example/program Clase de ActionScript que guarda los datos de muestra del ejemplo de la aplicacin Global Stock Ticker. mingas3/stockticker/St ockDataModel.as
972
un cuadro combinado para seleccionar una configuracin regional un cuadro combinado para seleccionar un mercado un objeto DataGrid que muestra datos de seis empresas en cada mercado un grfico que muestre la simulacin de datos histricos de las acciones de la empresa seleccionada
La aplicacin guarda todos estos datos de muestra sobre las configuraciones regionales, los mercados y las acciones de las empresas en la clase StockDataModel. Una aplicacin real como esta recuperara datos de un servidor y los guardara en una clase como StockDataModel. En este ejemplo, todos los datos se incluyen en la clase StockDataModel en el cdigo. Nota: los datos visualizados en el grfico financiero no coinciden necesariamente con los del control DataGrid. El grfico se dibuja de nuevo de forma aleatoria cada vez que se selecciona una empresa. Se ha diseado as nicamente con fines ilustrativos.
973
{ trace("Warning - Fallback locale ID used by " + serviceName + ": " + localeID); } else if (status == LastOperationStatus.UNSUPPORTED_ERROR) { trace("Error in " + serviceName + ": " + status); //abort application throw(new Error("Fatal error", 0)); } else { trace("Error in " + serviceName + ": " + status); } } else { trace(serviceName + " created for locale ID: " + localeID); } }
Primero, el mtodo setLocale() crea un objeto LocaleID. Este objeto facilita la obtencin de detalles sobre la configuracin regional real ms adelante, si fuera necesario. A continuacin, crea nuevos objetos NumberFormatter, CurrencyFormatter y DateTimeFormatter para la configuracin regional. Tras crear cada objeto formatter, llama al mtodo traceError(). Este mtodo muestra mensajes de error y de advertencia en la consola si se detecta un problema con la configuracin regional solicitada. (Una aplicacin real iniciara alguna accin a partir de estos errores, no se limitara a detectarlos). Una vez creado el objeto CurrencyFormatter, el mtodo setLocale() define el cdigo ISO de divisa de formato, el smbolo de divisa y las propiedades fractionalDigits en valores determinados previamente. (Estos valores se establecen cada vez que el usuario selecciona un mercado en el cuadro combinado de mercados). Tras crear el objeto DateTimeFormatter, el mtodo setLocale() tambin recupera un conjunto de abreviaturas de nombres de meses localizados.
974
var col1:DataGridColumn = new DataGridColumn("ticker"); col1.headerText = "Company"; col1.sortOptions = Array.NUMERIC; col1.width = 200; var col2:DataGridColumn = new DataGridColumn("volume"); col2.headerText = "Volume"; col2.width = 120; col2.cellRenderer = RightAlignedCell; col2.labelFunction = displayVolume; var col3:DataGridColumn = new DataGridColumn("price"); col3.headerText = "Price"; col3.width = 70; col3.cellRenderer = RightAlignedCell; col3.labelFunction = displayPrice; var col4:DataGridColumn = new DataGridColumn("change"); col4.headerText = "Change"; col4.width = 120; col4.cellRenderer = RightAlignedCell; col4.labelFunction = displayPercent;
La versin para Flex del ejemplo declara su DataGrid en MXML. Tambin define funciones label similares para cada columna. Las propiedades labelFunction hacen referencia a las siguientes funciones, que llaman a mtodos de formato de la clase Localizer:
private function displayVolume(item:Object):String { return localizer.formatNumber(item.volume, 0); } private function displayPercent(item:Object):String { return localizer.formatPercent(item.change ) ; } private function displayPrice(item:Object):String { return localizer.formatCurrency(item.price); }
Seguidamente, los mtodos Localizer establecen y llaman a los objetos de formato apropiados:
975
public function formatNumber(value:Number, fractionalDigits:int = 2):String { nf.fractionalDigits = fractionalDigits; return nf.formatNumber(value); } public function formatPercent(value:Number, fractionalDigits:int = 2):String { // HACK WARNING: The position of the percent sign, and whether a space belongs // between it and the number, are locale-sensitive decisions. For example, // in Turkish the positive format is %12 and the negative format is -%12. // Like most operating systems, flash.globalization classes do not currently // provide an API for percentage formatting. nf.fractionalDigits = fractionalDigits; return nf.formatNumber(value) + "%"; } public function formatCurrency(value:Number):String { return cf.format(value, symbolIsSafe); } public function formatDate(dateValue:Date):String { return df.format(dateValue); } |
976
Paquete flash.globalization: utilice las clases segn la configuracin regional en el paquete flash.globalization para
recuperar la configuracin regional predeterminada para el usuario a partir del sistema operativo y sus preferencias. ste es el enfoque preferido para aplicaciones que se ejecutarn en Flash Player 10.1 o posterior o en AIR 2.0 o motores de ejecucin posteriores. Consulte Determinacin de la configuracin regional en la pgina 961 para obtener ms informacin.
Solicitud al usuario: se puede iniciar la aplicacin con una configuracin regional predeterminada y despus pedir
al usuario que seleccione la que prefiera.
idiomas disponibles en los idiomas preferidos del usuario, segn se configuran en el sistema operativo. Las cadenas contienen etiquetas de idioma (as como informacin sobre la regin y los scripts, si procede), tal como se define en RFC4646 (http://www.ietf.org/rfc/rfc4646.txt). En las cadenas se utiliza como delimitador un guin (por ejemplo: "es-ES" o "ja-JP"). La primera entrada del conjunto devuelto tiene el mismo ID de idioma principal que la propiedad de idioma ("language"). Por ejemplo: si languages[0] est definido en "es-ES", la propiedad language se define en"es". Sin embargo, si se define la propiedad de idioma en "xu" (especificando un idioma desconocido), el primer elemento del conjunto languages es distinto.
977
Capabilities.language: la propiedadCapabilities.language proporciona el cdigo del idioma de la interfaz de usuario tal y como figura en el sistema operativo. No obstante, esta propiedad est limitada a 20 idiomas conocidos. En los sistemas anglosajones, esta propiedad slo devuelve el cdigo de idioma, no el cdigo del pas. Por estos motivos resulta ms conveniente utilizar el primer elemento del conjunto Capabilities.languages.
Ms temas de ayuda
http://code.google.com/p/as3localelib/
Ms temas de ayuda
http://code.google.com/p/as3localelib/
978
ADOBE FLEX La arquitectura de Flex incluye controles para dar formato a fechas, horas y monedas, entre ellos los controles DateFormatter y CurrencyFormatter.
mx:DateFormatter mx:CurrencyFormatter
979
Siempre es posible determinar qu versin de WebKit hay instalada: basta con examinar la cadena de agente del usuario predeterminado devuelta por un objeto HTMLLoader:
var htmlLoader:HTMLLoader = new HTMLLoader(); trace( htmlLoader.userAgent );
Recuerde que la versin de WebKit empleada en AIR no es la misma que la versin de cdigo abierto. Algunas funciones no se admiten en AIR y la versin de AIR puede incluir soluciones a errores y problemas de seguridad an no disponibles en la versin correspondiente de WebKit. Consulte Funciones de WebKit no admitidas en AIR en la pgina 995. Al ejecutarse las aplicaciones de AIR directamente en el escritorio con pleno acceso al sistema de archivos, el modelo de seguridad para el contenido HTML es ms estricto que el modelo de seguridad de los navegadores web habituales. En AIR slo se pone en el entorno limitado de la aplicacin contenido cargado desde el directorio de instalacin de la aplicacin. El entorno limitado de la aplicacin tiene el mximo nivel de privilegio y permite tener acceso a las API de AIR. AIR coloca otros tipos de contenido en entornos limitados aislados en funcin de la procedencia del contenido. Los archivos cargados desde el sistema de archivos pasan a un entorno limitado local. El entorno limitado al que pasan los archivos cargados desde la red mediante uso de los protocolos http: o https: depende del dominio del servidor remoto. El contenido de estos entornos limitados ajenos a la aplicacin no tiene acceso a ninguna API de AIR y en esencia funciona tal y como lo hara en un navegador web habitual.
980
El contenido HTML en AIR no muestra contenido SWF o PDF si se aplican opciones de alfa, escala o transparencia. Para obtener ms informacin, consulte Consideraciones al cargar el contenido SWF o PDF en una pgina HTML en la pgina 1025 y Transparencia de la ventana en la pgina 910.
Ms temas de ayuda
Referencia del DOM de Webkit Referencia de HTML de Safari Referencia de CSS de Safari www.webkit.org
981
NativeWindow
document
htmlLoader
body
head
nativeWindow
El entorno JavaScript tiene sus propios objetos Document y Window. El cdigo JavaScript puede interactuar con el entorno del motor de ejecucin de AIR a travs de las propiedades runtime, nativeWindow y htmlLoader. El cdigo ActionScript puede interactuar con el entorno JavaScript a travs de la propiedad de ventana ("window") de un objeto HTMLLoader, que es una referencia al objeto Window de JavaScript. Adems, tanto los objetos ActionScript como los objetos JavaScript pueden detectar eventos distribuidos por objetos de AIR y JavaScript.
La propiedad runtime facilita el acceso a las clases API de AIR, lo cual permite crear nuevos objetos de AIR adems de acceder a miembros estticos. Para tener acceso a una API de AIR se aade el nombre de la clase, con el paquete, a la propiedad runtime. Por ejemplo, para crear un objeto File se utilizara la sentencia:
var file = new window.runtime.filesystem.File();
Nota: el SDK de AIR proporciona un archivo JavaScript, AIRAliases.js, que define los alias ms convenientes para las clases de AIR de uso ms frecuente. Al importar este archivo se puede utilizar la forma abreviada air.Class en lugar de window.runtime.package.Class. Por ejemplo, se podra crear el objeto File con new air.File(). El objeto NativeWindow proporciona propiedades para controlar la ventana del escritorio. Desde una pgina HTML se puede tener acceso al objeto NativeWindow contenedor con la propiedad window.nativeWindow. El objeto HTMLLoader proporciona propiedades, mtodos y eventos para controlar cmo se carga y representa el contenido. Desde una pgina HTML se puede tener acceso al objeto HTMLLoader principal con la propiedad window.htmlLoader.
982
Importante: slo las pginas instaladas como parte de una aplicacin tienen las propiedades htmlLoader, nativeWindow o runtime y slo cuando se cargan como documento del nivel superior. Estas propiedades no se aaden cuando se carga un documento en un fotograma o en un iframe. (Un documento secundario tiene acceso a estas propiedades en el documento principal siempre que se encuentre en el mismo entorno limitado de seguridad. Por ejemplo, un documento cargado en un fotograma tiene acceso a la propiedad runtime del documento principal con parent.runtime).
Ms temas de ayuda
Seguridad HTML en Adobe AIR en la pgina 1099 Entornos limitados en HTML en la pgina 983 Elementos frame e iframe de HTML en la pgina 991 Objeto Window en JavaScript en la pgina 989
983
Objeto XMLHttpRequest en la pgina 985 Cmo aadir contenido PDF en AIR en la pgina 552
AIR y WebKit
Adobe AIR 1.0 y posterior Adobe AIR utiliza el motor WebKit de cdigo abierto que tambin se utiliza en el navegador web Safari. AIR aade varias extensiones que facilitan el acceso a las clases y los objetos del motor de ejecucin, adems de aumentar la seguridad. Por otra parte, el propio Webkit aade funciones que no estn incluidas en las normas W3C para HTML, CSS y JavaScript. Aqu slo se tratan los complementos de AIR y las extensiones de WebKit ms notables. Para ver documentacin suplementaria sobre HTML, CSS y JavaScript no estndar, visite www.webkit.org y developer.apple.com (en ingls). Para obtener informacin sobre las normas, visite el sitio web de W3C en. Mozilla tambin proporciona una valiosa referencia general sobre temas relacionados con HTML, CSS y DOM (naturalmente, los motores de Webkit y Mozilla no son idnticos).
JavaScript en AIR
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior AIR modifica de varias maneras el comportamiento tpico de objetos comunes de JavaScript. Muchas de estas modificaciones tienen la finalidad de facilitar la escritura de aplicaciones seguras en AIR. Al mismo tiempo, debido a estas diferencias de comportamiento es posible que algunos patrones de codificacin de JavaScript, as como las aplicaciones web existentes que utilicen esos patrones, no siempre se ejecutan de la forma prevista en AIR. Para obtener informacin sobre la correccin de este tipo de problema, consulte Cmo evitar errores de JavaScript relacionados con la seguridad en la pgina 1001.
984
El origen del contenido de una pgina determina el entorno limitado al que se consigna. En el entorno limitado de la aplicacin slo se pone el contenido cargado desde el directorio de la aplicacin (el directorio de instalacin al que remite el esquema app: de URL). El contenido cargado desde el sistema de archivos se pone en el entorno limitado local con sistema de archivos o local de confianza, que permite el acceso y la interaccin con el contenido del sistema de archivos local, pero no con el contenido remoto. El contenido cargado desde la red se pone en un entorno limitado remoto que corresponde con su dominio de origen. Para que una pgina de una aplicacin pueda interactuar libremente con el contenido de un entorno limitado remoto, la pgina se puede asignar al mismo dominio que el contenido remoto. Por ejemplo, si es escribe una aplicacin que muestra datos de mapas de un servicio de Internet, la pgina de la aplicacin que descarga el contenido del servicio y lo presenta puede asignarse al dominio del servicio. Los atributos para asignar pginas en un entorno limitado remoto y un dominio son atributos nuevos que se aaden a los elementos de frame e iframe en HTML. Para que el contenido de un entorno limitado ajeno a la aplicacin pueda utilizar las funciones de AIR de forma segura, se puede establecer un puente de entorno limitado principal. Para que el contenido de la aplicacin pueda llamar a mtodos y tener acceso a propiedades del contenido de otros entornos limitados, se puede establecer un puente de entorno limitado secundario. La seguridad en este contexto significa que el contenido remoto no puede obtener accidentalmente referencias a objetos, propiedades o mtodos que no estn expuestos de forma explcita. Slo pueden pasar por el puente los tipos de datos, funciones y objetos annimos sencillos. No obstante, aun as debe evitarse exponer explcitamente las funciones que sean potencialmente peligrosas. Por ejemplo: si expusiera una interfaz que permite que un contenido remoto lea y escriba archivos en cualquier parte del sistema del usuario, podra estar facilitando al contenido remoto los medios para causar graves daos al usuario.
Constructores Function
Adobe AIR 1.0 y posterior En el entorno limitado de la aplicacin pueden utilizarse constructores de funcin antes de que se termine de cargar una pgina. Una vez que han terminado todos los controladores de eventos load de la pgina, no se pueden crear funciones nuevas.
985
Objeto XMLHttpRequest
Adobe AIR 1.0 y posterior AIR proporciona un objeto XMLHttpRequest (XHR) que pueden utilizar las aplicaciones para realizar peticiones de datos. El ejemplo siguiente ilustra una peticin de datos sencilla:
xmlhttp = new XMLHttpRequest(); xmlhttp.open("GET", "http:/www.example.com/file.data", true); xmlhttp.onreadystatechange = function() { if (xmlhttp.readyState == 4) { //do something with data... } } xmlhttp.send(null);
A diferencia de los navegadores, AIR permite que el contenido que se ejecuta en el entorno limitado de la aplicacin solicite datos de cualquier dominio. El resultado de una peticin XHR que contiene una cadena JSON puede producir objetos de datos, a menos que el resultado tambin contenga cdigo ejecutable. Si hay sentencias ejecutables en el resultado de la XHR, se emite un error y el intento de evaluacin falla. Para evitar la inyeccin accidental de cdigo desde fuentes remotas, las XHR sincrnicas devuelven un resultado vaco si se realizan antes de haberse terminado de cargar la pgina. Las XHR asncronas siempre devuelven un resultado despus de haberse cargado una pgina. De forma predeterminada, AIR bloquea las peticiones XMLHttpRequest entre dominios en los entornos limitados ajenos a la aplicacin. Una ventana principal en el entorno limitado de la aplicacin puede optar por permitir las peticiones entre dominios en un fotograma secundario que contenga contenido en un entorno limitado ajeno a la aplicacin definiendo allowCrossDomainXHR -un atributo que aade AIR- en true en el elemento frame o iframe contenedor:
<iframe id="mashup" src="http://www.example.com/map.html" allowCrossDomainXHR="true" </iframe>
Nota: si conviene, la clase URLStream de AIR tambin puede utilizarse para descargar datos. Si se distribuye una peticin XMLHttpRequest a un servidor remoto desde un fotograma o iframe que contenga contenido de la aplicacin que se ha asignado a un entorno limitado remoto, asegrese de que la URL de asignacin no oculte la direccin del servidor que se utiliza en la XHR. Tomemos por ejemplo la siguiente definicin de iframe, que asigna contenido de la aplicacin a un entorno limitado remoto para el dominio example.com:
<iframe id="mashup" src="http://www.example.com/map.html" documentRoot="app:/sandbox/" sandboxRoot="http://www.example.com/" allowCrossDomainXHR="true" </iframe>
Debido a que el atributo sandboxRoot reasigna la URL raz de la direccin www.example.com, todas las peticiones se cargan desde el directorio de la aplicacin y no desde el servidor remoto. Las peticiones se reasignan independientemente de si derivan de haber visitado distintas pginas o de una peticin XMLHttpRequest. Para evitar bloquear accidentalmente las peticiones de datos al servidor remoto, asigne sandboxRoot a un subdirectorio de la URL remota y no a la raz. No es necesario que exista el directorio. Por ejemplo, para permitir que las peticiones a www.example.com se carguen desde el servidor remoto en lugar del directorio de la aplicacin, cambie el iframe anterior a:
986
En este caso, slo se carga localmente el contenido del subdirectorio air. Para obtener ms informacin, consulte Elementos frame e iframe de HTML en la pgina 991 y Seguridad HTML en Adobe AIR en la pgina 1099.
Cookies
Adobe AIR 1.0 y posterior En las aplicaciones de AIR slo el contenido de los entornos limitados remotos (contenido cargado desde fuentes http: y https:) puede utilizar cookies (la propiedad document.cookie). En el entorno limitado de la aplicacin, existen otros medios para almacenar datos persistentes, incluyendo las clases EncryptedLocalStore, SharedObject y FileStream.
Objeto Clipboard
Adobe AIR 1.0 y posterior La API Clipboard del WebKit funciona con los eventos copy, cut y paste. El objeto de evento que se pasa en estos eventos proporciona acceso al portapapeles a travs de la propiedad clipboardData. Para leer o escribir datos en el portapapeles, utilice los siguientes mtodos del objeto clipboardData:
Mtodo clearData(mimeType) getData(mimeType) Descripcin Borra los datos del portapapeles. Defina el parmetro mimeType en el tipo MIME de los datos a borrar. Obtiene los datos del portapapeles. Este mtodo slo se puede llamar en un controlador del evento paste. Defina el parmetro mimeType en el tipo MIME de los datos a devolver. Copia datos en el portapapeles. Defina el parmetro mimeType en el tipo MIME de los datos.
setData(mimeType, data)
El cdigo JavaScript que est fuera del entorno limitado de la aplicacin slo tiene acceso al portapapeles a travs de estos eventos. No obstante, el contenido del entorno limitado de la aplicacin tiene acceso directo al portapapeles del sistema a travs de la clase Clipboard de AIR. Por ejemplo, se puede utilizar la siguiente sentencia para obtener datos en formato de texto del portapapeles:
var clipping = air.Clipboard.generalClipboard.getData("text/plain", air.ClipboardTransferMode.ORIGINAL_ONLY);
987
Importante: nicamente el contenido del entorno limitado de la aplicacin tiene acceso a los datos de archivo que hay en el portapapeles. Si un contenido ajeno a la aplicacin intenta acceder a un objeto de archivo desde el portapapeles, se emite un error de seguridad. Para obtener ms informacin sobre el uso del portapapeles, consulte Copiar y pegar en la pgina 597 y Using the Pasteboard from JavaScript (Uso del Pasteboard de JavaScript) (Centro de desarrollo de Apple).
Arrastrar y colocar
Adobe AIR 1.0 y posterior Los gestos de arrastrar y colocar hacia dentro y hacia fuera de HTML producen los siguientes eventos del DOM: dragstart, drag, dragend, dragenter, dragover, dragleave y drop. El objeto de evento que se pasa en estos eventos proporciona acceso a los datos arrastrados a travs de la propiedad dataTransfer. La propiedad dataTransfer hace referencia a un objeto que proporciona los mismos mtodos que el objeto clipboardData asociado con un evento clipboard. Por ejemplo, se puede utilizar la siguiente funcin para obtener datos en formato de texto de un evento drop:
function onDrop(dragEvent){ return dragEvent.dataTransfer.getData("text/plain", air.ClipboardTransferMode.ORIGINAL_ONLY); }
effectsAllowed
dropEffect
mover, que a su vez tiene prioridad sobre el efecto de vinculacin. El usuario puede modificar la prioridad determinada con el teclado.
Para obtener ms informacin sobre cmo ampliar la compatibilidad con arrastrar y colocar en una aplicacin de AIR, consulte Operacin de arrastrar y colocar en AIR en la pgina 609 y Using the Drag-and-Drop from JavaScript (Uso de arrastrar y colocar de JavaScript) (Centro de desarrollo de Apple).
988
Propiedad Document.designMode
Adobe AIR 1.0 y posterior Defina la propiedad document.designMode en on para que todos los elementos del documento sean editables. Entre las funciones integradas del editor se encuentran las de editar texto, copiar, pegar, y arrastrar y pegar. Definir designMode en on equivale a definir la propiedad contentEditable del elemento body en true. La propiedad contentEditable puede utilizarse en la mayora de los elementos HTML para definir qu secciones de un documento son editables. Para obtener ms informacin, consulte Atributo HTML contentEditable en la pgina 994.
No obstante, los scripts s pueden responder satisfactoriamente al evento unload provocado por la navegacin por el contenido de un fotograma, iframe o ventana de nivel superior. Nota: es posible que estas limitaciones se eliminen en una versin futura de Adobe AIR.
989
entorno limitado de la aplicacin. Estas clases incluyen las API de AIR y Flash Player (pero no, por ejemplo, la arquitectura de Flex). Por ejemplo, la sentencia siguiente crea un objeto de archivo de AIR:
var preferencesFile = new window.runtime.flash.filesystem.File();
El archivo AIRAliases.js, incluido con el SDK de AIR, contiene definiciones de alias que permiten abreviar estas referencias. Por ejemplo, cuando se importa AIRAliases.js en una pgina, se puede crear un objeto File con la sentencia siguiente:
var preferencesFile = new air.File();
La propiedad window.runtime slo se define para contenido que se encuentra en el entorno limitado de la aplicacin, y slo para el documento principal de una pgina con fotogramas o iframes. Consulte el apartado Uso del archivo AIRAliases.js en la pgina 1007.
Propiedad Window.nativeWindow La propiedad nativeWindow proporciona una referencia al objeto de ventana
nativa subyacente. Con esta propiedad se pueden programar funciones y propiedades de ventanas como posicin en la pantalla, tamao y visibilidad, as como controlar eventos de ventanas como cerrar, redimensionar y trasladar. Por ejemplo, la sentencia siguiente cierra la ventana:
window.nativeWindow.close();
Nota: las funciones de control de ventanas que ofrece el objeto NativeWindow coinciden en parte con las funciones que brinda el objeto Window de JavaScript. En estos casos, se puede utilizar el mtodo que ms convenga. La propiedad window.nativeWindow slo se define para contenido que se encuentra en el entorno limitado de la aplicacin, y slo para el documento principal de una pgina con fotogramas o iframes.
Propiedad Window.htmlLoader La propiedad htmlLoader proporciona una referencia al objeto HTMLLoader de AIR que contiene el contenido HTML. Con esta propiedad se puede programar el aspecto y comportamiento del entorno HTML. Por ejemplo, se puede utilizar la propiedad htmlLoader.paintsDefaultBackground para determinar si el control pinta un fondo blanco predeterminado:
window.htmlLoader.paintsDefaultBackground = false;
Nota: el objeto HTMLLoader en s tiene una propiedad window que hace referencia al objeto Window de JavaScript del contenido HTML que contiene. Esta propiedad puede utilizarse para acceder al entorno JavaScript a travs de una referencia al HTMLLoader contenedor. La propiedad window.htmlLoader slo se define para contenido que se encuentra en el entorno limitado de la aplicacin, y slo para el documento principal de una pgina con fotogramas o iframes.
Propiedades Window.parentSandboxBridge y Window.childSandboxBridge Las propiedades parentSandboxBridge
y childSandboxBridge permiten definir una interfaz entre un fotograma principal y uno secundario. Para obtener ms informacin, consulte Uso de scripts entre contenidos en diferentes entornos limitados de seguridad en la pgina 1018.
990
Funciones Window.setTimeout() y Window.setInterval() AIR impone restricciones de seguridad en el uso de las funciones setTimeout() y setInterval() en el entorno limitado de la aplicacin. Cuando se llama a setTimeout() o setInterval(), el cdigo a ejecutarse no se puede definir en forma de cadena, sino que se debe utilizar una referencia a una funcin. Para obtener ms informacin, consulte el apartado setTimeout() y setInterval() en la pgina 1004. Funcin Window.open() Cuando lo llama un cdigo que se ejecuta en un entorno limitado ajeno a la aplicacin, el
mtodo open() slo abre una ventana si la llamada es el resultado de una interaccin del usuario (por ejemplo, tras haber pulsado una tecla o el botn del ratn). Adems, el ttulo de la ventana tiene como prefijo el ttulo de la aplicacin (para evitar que las ventanas abiertas por contenido remoto se hagan pasar por ventanas abiertas por la aplicacin). Para obtener ms informacin, consulte Restricciones para llamar al mtodo window.open() JavaScript en la pgina 1105.
Objeto air.NativeApplication
Adobe AIR 1.0 y posterior El objeto NativeApplication facilita informacin sobre el estado de la aplicacin, distribuye varios eventos importantes a nivel de aplicacin y ofrece funciones de utilidad para controlar el comportamiento de la aplicacin. Se crea automticamente una nica instancia del objeto NativeApplication, a la que se tiene acceso a travs de la propiedad NativeApplication.nativeApplication definida por la clase. Para acceder al objeto desde el cdigo JavaScript se puede usar:
var app = window.runtime.flash.desktop.NativeApplication.nativeApplication;
Slo se tiene acceso al objeto NativeApplication desde el entorno limitado de la aplicacin. Para obtener ms informacin sobre el objeto NativeApplication, consulte Trabajo con informacin sobre el motor de ejecucin de AIR y el sistema operativo en la pgina 902.
HTML en AIR
Adobe AIR 1.0 y posterior AIR y WebKit definen algunos elementos y atributos de HTML que no son estndar, entre ellos: Elementos frame e iframe de HTML en la pgina 991 Controladores de eventos de elementos HTML en la pgina 993
991
archivo especificado por el atributo src del fotograma. El archivo se carga en el entorno limitado externo que corresponde al dominio especificado. El contenido del archivo y el contenido cargado desde el dominio especificado pueden usar scripts entre s. Importante: si se define el valor de sandboxRoot en la URL de base del dominio, toda peticin de contenido desde ese dominio se carga desde el directorio de la aplicacin en lugar del servidor remoto (sea esa peticin el resultado de visitas a distintas pginas, de una peticin XMLHttpRequest o de cualquier otro medio de cargar contenido).
Atributo documentRoot El atributo documentRoot especifica el directorio local del cual cargar las URL que se
resuelven en archivos en el lugar especificado en sandboxRoot. Al resolver las URL, sea en el atributo src del fotograma o en contenido cargado en el fotograma, la parte de la URL que coincide con el valor especificado en sandboxRoot se sustituye por el valor especificado en documentRoot. Por lo tanto, en la siguiente etiqueta de fotograma:
<iframe src="http://www.example.com/air/child.html" documentRoot="app:/sandbox/" sandboxRoot="http://www.example.com/air/"/> child.html se carga desde el subdirectorio sandbox de la carpeta de instalacin de la aplicacin. Las URL relativas
en child.html se resuelven partiendo de la base del directorio sandbox. Obsrvese que no se tiene acceso desde el fotograma a los archivos que se encuentren en el servidor remoto en www.example.com/air, puesto que AIR intentara cargarlos desde el directorio app:/sandbox/.
Atributo allowCrossDomainXHR Para permitir que el contenido del fotograma realice peticiones del tipo
contenido ajeno a la aplicacin slo puede realizar estas peticiones a su propio dominio de origen. Admitir peticiones XHR entre dominios conlleva graves implicaciones para la seguridad. El cdigo de la pgina puede intercambiar datos con cualquier dominio. Si llegara a infiltrarse contenido malintencionado en la pgina, podran verse comprometidos los datos que son accesibles al cdigo en el entorno limitado actual. Habilite las peticiones XHR entre dominios solamente para las pginas que cree y controle usted mismo y slo cuando realmente resulte necesario cargar datos entre distintos dominios. Tambin conviene validar cuidadosamente todos los datos externos que cargue la pgina para impedir la infiltracin de cdigo daino u otra clase de ataque. Importante: si el elemento frame o iframe incluye el atributo allowCrossDomainXHR, significa que estn habilitadas las peticiones XHR entre dominios (a menos que el valor asignado sea "0" o empiece con la letra "f" o "n"). Por ejemplo, si se define allowCrossDomainXHR en "deny", an estaran habilitadas las XHR entre dominios. Si no desea habilitar las peticiones entre dominios, omita el atributo de la declaracin del elemento.
Atributo ondominitialize Especifica un controlador de eventos para el evento dominitialize de un fotograma. Este evento es especfico de AIR y se activa cuando se han creado los objetos de ventana y de documento del fotograma, pero antes de que se hayan analizado los scripts o creado los elementos de documento.
El fotograma distribuye el evento dominitialize lo bastante temprano en la secuencia de carga para que todo script en la pgina secundaria pueda hacer referencia a los objetos, variables y funciones que aada al documento secundario el controlador del evento dominitialize. Para poder aadir o tener acceso a los objetos de un documento secundario, la pgina principal debe encontrarse en el mismo entorno limitado que la pgina secundaria. No obstante, una pgina
992
principal que est en el entorno limitado de la aplicacin puede establecer un puente de entorno limitado para tener comunicacin con el contenido de un entorno limitado externo. Los ejemplos siguientes muestran el uso de la etiqueta iframe en AIR: Para colocar el documento child.html en un entorno limitado remoto sin asignarlo a un dominio real en un servidor remoto:
<iframe src="http://localhost/air/child.html" documentRoot="app:/sandbox/" sandboxRoot="http://localhost/air/"/>
Para colocar el documento child.html en un entorno limitado remoto y habilitar las peticiones del tipo XMLHttpRequests solamente a www.example.com:
<iframe src="http://www.example.com/air/child.html" documentRoot="app:/sandbox/" sandboxRoot="http://www.example.com/air/"/>
Para colocar el documento child.html en un entorno limitado remoto y habilitar las peticiones del tipo XMLHttpRequests a cualquier dominio remoto:
<iframe src="http://www.example.com/air/child.html" documentRoot="app:/sandbox/" sandboxRoot="http://www.example.com/air/" allowCrossDomainXHR="allowCrossDomainXHR"/>
Para colocar el documento child.html en un entorno limitado local con sistema de archivos:
<iframe src="file:///templates/child.html" documentRoot="app:/sandbox/" sandboxRoot="app-storage:/templates/"/>
Para colocar el documento child.html en un entorno limitado remoto, utilizando el evento dominitialize para establecer un puente de entorno limitado:
<html> <head> <script> var bridgeInterface = {}; bridgeInterface.testProperty = "Bridge engaged"; function engageBridge(){ document.getElementById("sandbox").parentSandboxBridge = bridgeInterface; } </script> </head> <body> <iframe id="sandbox" src="http://www.example.com/air/child.html" documentRoot="app:/" sandboxRoot="http://www.example.com/air/" ondominitialize="engageBridge()"/> </body> </html>
El siguiente documento child.html muestra cmo el contenido secundario puede acceder al puente de entorno limitado principal:
993
Para obtener ms informacin, consulte Uso de scripts entre contenidos en diferentes entornos limitados de seguridad en la pgina 1018 y Seguridad HTML en Adobe AIR en la pgina 1099.
Se llama cuando se invoca un men contextual, por ejemplo cuando se hace clic en texto seleccionado con el botn derecho o con la tecla Comando pulsada. Se llama al copiar una seleccin en un elemento. Se llama al cortar una seleccin en un elemento. Se llama al crear el DOM de un documento cargado en un fotograma o iframe, pero antes de crear los elementos del DOM o de analizar los scripts. Se llama al arrastrar un elemento. Se llama al soltar un elemento arrastrado. Se llama cuando un gesto de arrastrar entra en un elemento. Se llama cuando un gesto de arrastrar sale de un elemento. Se llama continuamente cuando un gesto de arrastrar se encuentra dentro de los lmites de un elemento. Se llama al iniciarse un gesto de arrastrar. Se llama al soltarse el gesto de arrastrar estando sobre un elemento. Se llama cuando se produce un error al cargar un elemento. Se llama al introducir texto en un elemento de formulario. Se llama al pegar un artculo en un elemento. Se llama al desplazarse el contenido de un elemento desplazable. Se llama al iniciarse una seleccin.
994
Nota: si la propiedad document.designMode se define en on, todos los elementos del documento sern modificables, independientemente de la configuracin de contentEditable para un elemento individual. Sin embargo, la definicin de designMode en off, no inhabilita la edicin de elementos para los que el atributo contentEditable est definido en true. Para obtener ms informacin, consulte Propiedad Document.designMode en la pgina 988.
URL data:
Adobe AIR 2 y posterior AIR admite URL data: para los siguientes elementos:
img input type=image Reglas CSS que admitan imgenes (como background-image)
Las URL data: permiten insertar datos de imagen binarios directamente en un documento CSS o HTML como cadena con codificacin base64. El siguiente ejemplo utiliza una URL data: como fondo repetido:
<html> <head> <style> body { backgroundimage:url('data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAGQAAABkCAMAAABHPGVmAAAAGXRFWHRTb2Z 0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAAZQTFRF%2F6cA%2F%2F%2F%2Fgxp3lwAAAAJ0Uk5T%2FwDltzBKAAA BF0lEQVR42uzZQQ7CMAxE0e%2F7X5oNCyRocWzPiJbMBZ6qpIljE%2BnwklgKG7kwUjc2IkIaxkY0CPdEsCCasws6ShX BgmBBmEagpXQQLAgWBAuSY2gaKaWPYEGwIEwg0FRmECwIFoQeQjJlhJWUEFazjFDJCkI5WYRWMgjtfEGYyQnCXD4jTCd m1zmngFpBFznwVNi5RPSbwbWnpYr%2BBHi%2FtCTfgPLEPL7jBctAKBRptXJ8M%2BprIuZKu%2BUKcg4YK1PLz7kx4bS qHyPaT4d%2B28OCJJiRBo4FCQsSA0bziT3XubMgYUG6fc5fatmGBQkL0hoJ1IaZMiQsSFiQ8vRscTjlQOI2iHZwtpHuf %2BJAYiOiJSkj8Z%2FIQ4ABANvXGLd3%2BZMrAAAAAElFTkSuQmCC'); background-repeat:repeat; } </style> </head> <body> </body> </html>
995
Cuando utilice URL data:, no olvide que un espacio en blanco tiene importancia. Por ejemplo, la cadena de datos debe introducirse como una sola lnea sin saltos. En caso contrario, los saltos de lnea se tratan como parte de los datos y no es posible descodificar la imagen.
CSS en AIR
Adobe AIR 1.0 y posterior WebKit admite varias propiedades de CSS ampliadas. Muchas de estas extensiones utilizan el prefijo: -webkit. Tenga en cuenta que algunas de estas extensiones son experimentales y podran desaparecer en futuras versiones de WebKit. Para obtener ms informacin sobre la compatibilidad de Webkit con CSS y sus extensiones en CSS, consulte la referencia de CSS de Safari.
Mensajes entre dominios mediante window.postMessage (AIR suministra sus propias API de comunicacin entre
dominios)
Variables CSS Fuentes SVG y Web Open Font Format (WOFF). Vdeo HTML y etiquetas de audio Consultas de dispositivos multimedia Cach de aplicaciones sin conexin Impresin (AIR proporciona su propia API PrintJob) Correctores ortogrfico y gramatical SVG WAI-ARIA WebSockets (AIR proporciona sus propias API de socket) Trabajadores web API SQL de WebKit (AIR suministra su propia API) API de geolocalizacin de WebKit (AIR suministra su propia API de geolocalizacin en dispositivos que as lo
admitan)
API de carga de varios archivos de WebKit Eventos tctiles de WebKit (AIR suministra sus propios eventos tctiles) Lenguaje de marcado inalmbrico (WML)
A continuacin se detallan API concretas de JavaScript, elementos HTML y propiedades CSS, as como valores no admitidos por AIR: Miembros de objetos Window de JavaScript no admitidos: applicationCache()
996
video
Atributos HTML no admitidos: aria-*
draggable formnovalidate list novalidate onbeforeload onhashchange onorientationchange onpagehide onpageshow onpopstate ontouchstart ontouchmove ontouchend ontouchcancel onwebkitbeginfullscreen onwebkitendfullscreen pattern required sandbox
Eventos de JavaScript no admitidos: beforeload
hashchange orientationchange pagehide pageshow popstate touchstart touchmove ltima modificacin 20/6/2011
997
background-origin (usar -webkit-background-origin) background-repeat-x background-repeat-y background-size (usar -webkit-background-size) border-bottom-left-radius border-bottom-right-radius border-radius border-top-left-radius border-top-right-radius text-rendering -webkit-animation-play-state -webkit-background-clip -webkit-color-correction -webkit-font-smoothing
Valores CSS no admitidos: valores de la propiedad appearance:
media-volume-slider-container media-volume-slider media-volume-sliderthumb outer-spin-button border-box (background-clip y background-origin) contain (background-size) content-box (background-clip y background-origin) cover (background-size) valores de la propiedad list: afar amharic amharic-abegede cjk-earthly-branch cjk-heavenly-stem
998
ethiopic ethiopic-abegede ethiopic-abegede-am-et ethiopic-abegede-gez ethiopic-abegede-ti-er ethiopic-abegede-ti-et ethiopic-halehame-aa-er ethiopic-halehame-aa-et ethiopic-halehame-am-et ethiopic-halehame-gez ethiopic-halehame-om-et ethiopic-halehame-sid-et ethiopic-halehame-so-et ethiopic-halehame-ti-er ethiopic-halehame-ti-et ethiopic-halehame-tig hangul hangul-consonant lower-norwegian oromo sidama somali tigre tigrinya-er tigrinya-er-abegede tigrinya-et tigrinya-et-abegede upper-greek upper-norwegian -wap-marquee (propiedad display)
999
Las propiedades width y height de un objeto HTMLLoader se definen en 0 como valor predeterminado. Se deben definir estas dimensiones cuando se aade un objeto HTMLLoader al escenario. El HTMLLoader distribuye varios eventos cuando se carga una pgina. Se pueden utilizar estos eventos para determinar cundo es seguro interactuar con la pgina cargada. Estos eventos se describen en Gestin de eventos relacionados con HTML en AIR en la pgina 1042. Nota: en la arquitectura de Flex, solo se pueden aadir las clases que amplan la clase UIComponent como elementos secundarios de los componentes de contenedor Flex. Por esta razn, no se puede aadir directamente un HTMLLoader como un elemento secundario de un componente de contenedor Flex; sin embargo, se puede utilizar el control Flex mx:HTML, se puede crear una clase personalizada que ampla UIComponent y contiene un HTMLLoader como un elemento secundario de UIComponent o se puede aadir el HTMLLoader como un elemento secundario de un UIComponent y aadir el UIComponent al contenedor Flex.
1000
Tambin se puede representar texto HTML utilizando la clase TextField, pero sus prestaciones son limitadas. La clase TextField de Adobe Flash Player admite un subconjunto de marcado HTML, pero dadas las limitaciones de tamao, las prestaciones son limitadas. (La clase HTMLLoader incluida en Adobe AIR no est disponible en Flash Player).
De forma predeterminada, el contenido cargado a travs del mtodo loadString() se sita en un entorno limitado ajeno a la aplicacin con las siguientes caractersticas:
Tiene acceso para cargar contenido desde la red (pero no desde el sistema de archivos). No puede cargar datos utilizando XMLHttpRequest. La propiedad window.location se establece en "about:blank". El contenido no puede acceder a la propiedad window.runtime (al igual que puede el contenido de cualquier
entorno limitado ajeno a la aplicacin). En AIR 1.5, la clase HTMLLoader incluye una propiedad placeLoadStringContentInApplicationSandbox. Cuando esta propiedad se establece en true para un objeto HTMLLoader, el contenido cargado a travs del mtodo loadString() se sita en el entorno limitado de la aplicacin. (El valor predeterminado es false.) Con ello se proporciona acceso al contenido cargado con el mtodo loadString() a la propiedad window.runtime y a todas las API de AIR. Si esta propiedad se define como true, compruebe que el origen de datos de una cadena utilizada en una llamada al mtodo loadString() sea de confianza. Las instrucciones de cdigo de la cadena HTML se ejecutan con todos los privilegios de la aplicacin si esta propiedad se establece en true. nicamente defina esta propiedad como true si est seguro de que la cadena no contiene cdigo daino. En las aplicaciones compiladas con los SDK de AIR 1.0 o AIR 1.1, el contenido cargado a travs del mtodo loadString() se sita en el entorno limitado de la aplicacin.
1001
Para estructurar el contenido adecuadamente para que funcione en una aplicacin de AIR, se deben tener en cuenta las reglas de las restricciones de seguridad en el contenido proveniente de diferentes fuentes. El contenido que procede de diferentes fuentes se sita en clasificaciones de seguridad independientes, denominadas entornos limitados (consulte Entornos limitados de seguridad en la pgina 1061). Como valor predeterminado, el contenido instalado con la aplicacin se instala en un entorno limitado denominado entorno limitado de aplicacin y este entorno le concede acceso a las API de AIR. El entorno limitado de la aplicacin normalmente es el entorno limitado ms seguro, con restricciones diseadas para prevenir la ejecucin de cdigo sospechoso. El motor de ejecucin permite cargar el contenido instalado con la aplicacin en un entorno limitado diferente del entorno limitado de la aplicacin. El contenido en los entornos limitados que no pertenecen a la aplicacin funciona en un entorno de seguridad similar al de un tpico navegador web. Por ejemplo, el cdigo en entornos limitados que no pertenecen a la aplicacin puede utilizar el mtodo eval() y mtodos relacionados (pero a la vez no puede acceder a las API de AIR). El motor de ejecucin incluye maneras para que el contenido en diferentes entornos limitados se comuniquen de modo seguro (sin exponer a las API de AIR a contenidos que no sean de la aplicacin). Para ms informacin, consulte Uso de scripts entre contenidos en diferentes entornos limitados de seguridad en la pgina 1018. Si se llama al cdigo que no se puede utilizar en un entorno limitado por razones de seguridad, el tiempo de ejecucin distribuye un error de JavaScript: Adobe AIR runtime security violation for JavaScript code in the application security sandbox (Infraccin de seguridad del motor de ejecucin de Adobe AIR para el cdigo JavaScript en el entorno limitado de seguridad de la aplicacin). Para evitar este error, siga las prcticas de codificacin que se describen en la siguiente seccin, Cmo evitar errores de JavaScript relacionados con la seguridad en la pgina 1001. Para obtener ms informacin, consulte Seguridad HTML en Adobe AIR en la pgina 1099.
1002
Constructor Function
Adems, los siguientes tipos de sentencias JavaScript fallan sin generar un error JavaScript no seguro:
URL de JavaScript Callbacks de eventos asignados a travs de atributos onevent en sentencias innerHTML y outerHTML Carga de archivos JavaScript desde fuera del directorio de instalacin de la aplicacin document.write() y document.writeln() XMLHttpRequests sincrnicos antes del evento load o durante un controlador de evento load Elementos de script creados dinmicamente
Nota: en algunos casos restringidos, se permite la evaluacin de cadenas. Para ms informacin, consulte Restricciones de cdigo del contenido en entornos limitados diferentes en la pgina 1102. Adobe dispone de una lista de arquitecturas de Ajax que admiten el entorno limitado de seguridad de aplicacin, en http://www.adobe.com/go/airappsandboxframeworks_es. Las siguientes secciones describen la manera de reescribir los scripts para evitar estos errores de JavaScript no seguros y fallos sin mensaje para el cdigo que se ejecuta en el entorno limitado de la aplicacin.
Funcin eval()
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior En el entorno limitado de la aplicacin, la funcin eval() solo se puede utilizar antes de un evento load de pgina o durante un controlador de evento load. Una vez que la pgina se haya cargado, las llamadas a eval() no ejecutarn el cdigo. Sin embargo, en los siguientes casos se puede reescribir el cdigo para evitar el uso de eval().
1003
con:
function compile(var1, var2){ var self = this; return function(){ self[var1](var2) }; }
Sin embargo, puede evitar la llamada a eval() analizando cada componente de la clase name y crear un nuevo objeto utilizando la sintaxis de corchete:
1004
function getter(str) { var obj = window; var names = str.split('.'); for(var i=0;i<names.length;i++){ if(typeof obj[names[i]]=='undefined'){ var undefstring = names[0]; for(var j=1;j<=i;j++) undefstring+="."+names[j]; throw new Error(undefstring+" is undefined"); } obj = obj[names[i]]; } return obj; }
setTimeout() y setInterval()
Adobe AIR 1.0 y posterior Reemplace la cadena analizada como la funcin de controlador con un objeto o referencia de funcin. Por ejemplo, reemplace una sentencia como:
setTimeout("alert('Timeout')", 100);
con:
setTimeout(function(){alert('Timeout')}, 100);
O bien, cuando la funcin requiere que el autor de llamada defina el objeto this, reemplace una sentencia como:
this.appTimer = setInterval("obj.customFunction();", 100);
con la siguiente:
var _self = this; this.appTimer = setInterval(function(){obj.customFunction.apply(_self);}, 100);
Constructor Function
Adobe AIR 1.0 y posterior Las llamadas a new Function(param, body) se pueden reemplazar con una declaracin de funcin en lnea o utilizar solo antes de que se haya controlado el evento de pgina load.
1005
URL de JavaScript
Adobe AIR 1.0 y posterior El cdigo definido en un vnculo utilizando el esquema de URL javascript: se omite en el entorno limitado de la aplicacin. No se genera ningn error de JavaScript de seguridad. Se pueden reemplazar vnculos utilizando URL javascript:, como:
<a href="javascript:code()">Click Me</a>
con:
<a href="#" onclick="code()">Click Me</a>
con:
document.getElementById('container').innerHTML = '<a href="#" id="smith">Click Me.</a>'; document.getElementById('smith').addEventListener("click", function() { code(); });
1006
document.write() y document.writeln()
Adobe AIR 1.0 y posterior Se omiten las llamadas a document.write() o document.writeln() despus de que se haya controlado el evento de pgina load. No se genera ningn error de seguridad. Como alternativa, se puede cargar un nuevo archivo o reemplazar el cuerpo del documento utilizando tcnicas de manipulacin DOM.
XMLHttpRequests sincrnicos antes del evento load o durante un controlador de evento load
Adobe AIR 1.0 y posterior XMLHttpRequests sincrnicos iniciados antes del evento de pgina load o durante un controlador de eventos load no devuelven contenido. Se pueden iniciar XMLHttpRequests asncronos pero no devuelven contenido hasta despus del evento load. Despus de que se haya controlado el evento load, los XMLHttpRequests sincrnicos se comportan normalmente.
Acceso al sistema de archivos Uso de las bases de datos SQL locales Control de los mens de aplicacin y de ventana Acceso a los sockets para red Uso de clases y objetos definidos por el usuario Prestaciones de sonido
Por ejemplo, la API del archivo de AIR incluye una clase File, contenida en el paquete flash.filesystem. Se puede crear un objeto File en JavaScript de la siguiente manera:
var myFile = new window.runtime.flash.filesystem.File();
1007
El objeto runtime es un objeto especial de JavaScript, disponible para el contenido HTML ejecutndose en AIR en el entorno limitado de la aplicacin. Permite acceder a las clases runtime desde JavaScript. La propiedad flash del objeto runtime proporciona acceso al paquete flash. A su vez, la propiedad flash.filesystem del objeto runtime proporciona acceso al paquete flash.filesystem (y este paquete incluye la clase File). Los paquetes son una manera de organizar las clases que se utilizan en ActionScript. Nota: la propiedad runtime no se aade automticamente a los objetos window de las pginas en un fotograma o iframe. Sin embargo, mientras que el documento secundario se encuentra en el entorno limitado de la aplicacin, el elemento secundario puede acceder a la propiedad runtime del elemento principal. Dado que la estructura del paquete de las clases runtime requieren que los desarrolladores escriban largas cadenas de cdigo JavaScript para acceder a cada clase (como en window.runtime.flash.desktop.NativeApplication) AIR SDK incluye un archivo AIRAliases.js que permite acceder a las clases runtime de forma ms fcil (por ejemplo, simplemente escribiendo air.NativeApplication). Las clases API de AIR se describen en esta gua. Otras clases de la API de Flash Player, que pueden ser de inters para los desarrolladores de HTML, se describen en Adobe AIR API Reference for HTML Developers (slo disponible en ingls). ActionScript es el lenguaje que se utiliza en el contenido SWF (Flash Player). Sin embargo, las sintaxis de JavaScript y ActionScript son similares. (Ambas se basan en versiones del lenguaje ECMAScript.) Todas las clases incorporadas estn disponibles en JavaScript (en el contenido HTML) y en ActionScript (en el contenido SWF). Nota: el cdigo JavaScript no puede utilizar las clases Dictionary, XML y XMLList, que estn disponibles en ActionScript.
En AIR SDK se incluye un archivo AIRAliases.js que proporciona definiciones de alias que permiten acceder a las clases runtime sin tener que escribir tanto. Por ejemplo, se puede acceder a las clases listadas arriba simplemente escribiendo:
Esta lista es solo un breve subconjunto de las clases en el archivo AIRAliases.js. La lista completa de las funciones a nivel de paquete y clases se suministra en Adobe AIR API Reference for HTML Developers (slo disponible en ingls).
1008
Adems de las clases runtime comnmente utilizadas, el AIRAliases.js incluye aliases para funciones a nivel de paquete comnmente utilizadas: window.runtime.trace(), window.runtime.flash.net.navigateToURL() y window.runtime.flash.net.sendToURL(), que forman alises como air.trace(), air.navigateToURL() y air.sendToURL(). Para utilizar el archivo AIRAliases.js, se debe incluir la siguiente referencia script en la pgina HTML:
<script src="AIRAliases.js"></script>
Si es necesario, ajuste la ruta en la referencia src. Importante: excepto donde se notifica, el cdigo de ejemplo de JavaScript en esta documentacin supone que se ha incluido el archivo AIRAliases.js en la pgina HTML.
app-storage:/settings/prefs.xml Una ruta relativa al directorio de almacenamiento de aplicacin. Para cada aplicacin instalada, AIR define un directorio de almacenamiento de aplicacin exclusivo, que es un lugar til para almacenar datos especficos a esa aplicacin.
http https
http://www.adobe.com https://secure.example.com
Para ms informacin sobre el uso de esquemas de URL en AIR, consulte Esquemas de URI en la pgina 821. Muchas de las API de AIR, incluyendo las clases File, Loader, URLStream y Sound, utilizan un objeto URLRequest en lugar de una cadena que contiene la URL. El objeto URLRequest mismo se inicializa con una cadena, que puede utilizar cualquiera de los mismos esquemas de URL. Por ejemplo, la siguiente sentencia crea un objeto URLRequest que se puede utilizar para solicitar la pgina de inicio de Adobe:
var urlReq = new air.URLRequest("http://www.adobe.com/");
Para ms informacin sobre objetos URLRequest, consulte Comunicaciones HTTP en la pgina 819.
1009
El contenido HTML (en un archivo denominado test.html) cargado en el objeto HTMLLoader en el ejemplo anterior puede acceder a la propiedad foo y al mtodo helloFromJS() definido en el archivo principal SWF:
<html> <script> function alertFoo() { alert(foo); } </script> <body> <button onClick="alertFoo()"> What is foo? </button> <p><button onClick="helloFromJS('Hi.')"> Call helloFromJS() function. </button></p> </body> </html>
Cuando se accede al contexto JavaScript de un documento cargado, se puede utilizar el evento htmlDOMInitialize para crear objetos con suficiente anticipacin en la secuencia de construccin de la pgina que cualquier script definido en la pgina puede acceder a los mismos. Si se espera para el evento complete, slo los scripts en la pgina que se ejecutan despus del evento de pgina load pueden acceder a los objetos aadidos.
1010
Una vez que la propiedad runtimeApplicationDomain se define, el contexto de JavaScript comparte las definiciones de clase con el dominio asignado. Para crear una instancia de una clase personalizada en JavaScript, se debe hacer referencia a la definicin de clase a travs de la propiedad window.runtime y utilizar el operador new:
var customClassObject = new window.runtime.CustomClass();
El contenido HTML debe ser de un dominio de seguridad compatible. Si el contenido HTML es de un dominio de seguridad diferente al del dominio de aplicacin que asigna, la pgina utiliza un dominio de aplicacin predeterminado. Por ejemplo, si carga una pgina remota de Internet, no podr asignar ApplicationDomain.currentDomain como el dominio de aplicacin de la pgina.
1011
<html> <script> foo = 333; function test() { return "OK."; } </script> <body> <p id="p1">Hi.</p> </body> </html>
Esta simple pgina HTML define una variable JavaScript denominada foo y una funcin JavaScript denominada test(). Ambas son propiedades del objeto global window de la pgina. Asimismo, el objeto window.document incluye un elemento P (con el ID p1), que se puede acceder utilizando el mtodo getElementById(). Una vez que se carga la pgina (cuando el objeto HTMLLoader distribuye el evento complete), se puede acceder a cada uno de estos objetos desde ActionScript, como se muestra en el siguiente cdigo ActionScript:
var html:HTMLLoader = new HTMLLoader(); html.width = 300; html.height = 300; html.addEventListener(Event.COMPLETE, completeHandler); var xhtml:XML = <html> <script> foo = 333; function test() { return "OK."; } </script> <body> <p id="p1">Hi.</p> </body> </html>; html.loadString(xhtml.toString()); function completeHandler(e:Event):void { trace(html.window.foo); // 333 trace(html.window.document.getElementById("p1").innerHTML); // Hi. trace(html.window.test()); // OK. }
Para acceder al contenido de un elemento HTML, utilice la propiedad innerHTML. Por ejemplo, el cdigo anterior utiliza html.window.document.getElementById("p1").innerHTML para obtener el contenido del elemento HTML denominado p1. Tambin se pueden definir propiedades de la pgina HTML desde ActionScript. Por ejemplo, en el siguiente ejemplo se define el contenido del elemento p1 y el valor de la variable JavaScript foo en la pgina utilizando una referencia al objeto HTMLLoader que lo contiene:
html.window.document.getElementById("p1").innerHTML = "Goodbye"; html.window.foo = 66;
1012
Tambin puede utilizar un script para cargar el contenido de forma dinmica. En el siguiente ejemplo se crea un nodo object para mostrar el archivo SWF especificado en el parmetro urlString. En el ejemplo se aade el nodo de un elemento secundario con el ID especificado por el parmetro elementID:
<script> function showSWF(urlString, elementID){ var displayContainer = document.getElementById(elementID); var flash = createSWFObject(urlString, 'opaque', 650, 650); displayContainer.appendChild(flash); } function createSWFObject(urlString, wmodeString, width, height){ var SWFObject = document.createElement("object"); SWFObject.setAttribute("type","application/x-shockwave-flash"); SWFObject.setAttribute("width","100%"); SWFObject.setAttribute("height","100%"); var movieParam = document.createElement("param"); movieParam.setAttribute("name","movie"); movieParam.setAttribute("value",urlString); SWFObject.appendChild(movieParam); var wmodeParam = document.createElement("param"); wmodeParam.setAttribute("name","wmode"); wmodeParam.setAttribute("value",wmodeString); SWFObject.appendChild(wmodeParam); return SWFObject; } </script>
1013
El contenido SWF no se visualiza si el objeto HTMLLoader se escala o se gira, o si la propiedad alpha se establece en un valor que no sea 1.0. Antes de AIR 1.5.2, el contenido SWF no se visualizaba en ventanas transparentes independientemente del valor dado wmode. Nota: cuando un objeto SWF incorporado intenta cargar un activo externo (por ejemplo, un archivo de vdeo), el contenido SWF podra no procesarse correctamente si no se proporciona una ruta absoluta al vdeo en el archivo HTML. Sin embargo, un objeto SWF incorporado s puede cargar un archivo de imagen externa con una ruta relativa. El siguiente ejemplo describe cmo se pueden cargar activos externos a travs de un objeto SWF incorporado en contenido HTML:
var imageLoader; function showSWF(urlString, elementID){ var displayContainer = document.getElementById(elementID); imageLoader = createSWFObject(urlString,650,650); displayContainer.appendChild(imageLoader); } function createSWFObject(urlString, width, height){ var SWFObject = document.createElement("object"); SWFObject.setAttribute("type","application/x-shockwave-flash"); SWFObject.setAttribute("width","100%"); SWFObject.setAttribute("height","100%"); var movieParam = document.createElement("param"); movieParam.setAttribute("name","movie"); movieParam.setAttribute("value",urlString); SWFObject.appendChild(movieParam); var flashVars = document.createElement("param"); flashVars.setAttribute("name","FlashVars"); //Load the asset inside the SWF content. flashVars.setAttribute("value","imgPath=air.jpg"); SWFObject.appendChild(flashVars); return SWFObject; } function loadImage() { showSWF("ImageLoader.swf", "imageSpot"); }
En el siguiente ejemplo de ActionScript, la ruta de imagen transferida por el archivo HTML se lee y la imagen se carga en el escenario
1014
public class ImageLoader extends Sprite { public function ImageLoader() { var flashvars = LoaderInfo(this.loaderInfo).parameters; if(flashvars.imgPath){ var imageLoader = new Loader(); var image = new URLRequest(flashvars.imgPath); imageLoader.load(image); addChild(imageLoader); imageLoader.x = 0; imageLoader.y = 0; stage.scaleMode=StageScaleMode.NO_SCALE; stage.align=StageAlign.TOP_LEFT; } } } }
Importante: el atributo type debe ser type="application/x-shockwave-flash" para que la biblioteca se cargue correctamente. Si el contenido SWF se compila como un archivo SWF de Flash Player 10 o AIR 1.5, debe establecer el espacio de nombres XML del archivo descriptor de la aplicacin en el espacio de nombres de AIR 1.5. El directorio liby el archivo myClasses.swf tambin se deben incluir cuando se empaqueta el archivo de AIR. Acceda a las clases importadas a travs de la propiedad runtime del objeto Window de JavaScript:
var libraryObject = new window.runtime.LibraryClass();
1015
Si las clases en el archivo SWF se organizan en paquetes, debe tambin incluir el nombre del paquete. Por ejemplo, si la definicin LibraryClass est en un paquete denominado utilities, crear una instancia de la clase con la siguiente sentencia:
var libraryObject = new window.runtime.utilities.LibraryClass();
Nota: para compilar una biblioteca SWF ActionScript para usar como parte de una pgina HTML en AIR, utilice el compilador acompc. La utilidad acompc forma parte de Flex SDK y se describe en la documentacin de Flex SDK.
Esta simple pgina HTML tiene una variable JavaScript denominada num y una funcin JavaScript denominada getStatus(). Ambas son propiedades del objeto window de la pgina. Asimismo, el objeto window.document incluye un elemento P (con el ID p1). La pgina carga un archivo ActionScript, ASLibrary.swf, que contiene una clase, ASClass. ASClass define una funcin denominada accessDOM() que simplemente rastrea los valores de estos objetos JavaScript. El mtodo accessDOM() toma al objeto Window de JavaScript como un argumento. Utilizando esta referencia Window, se puede acceder a otros objetos en la pgina incluyendo variables, funciones y elementos DOM como se muestra en la siguiente definicin:
public class ASClass{ public function accessDOM(window:*):void { trace(window.num); // 254 trace(window.document.getElementById("p1").innerHTML); // Body text.. trace(window.getStatus()); // OK. } }
1016
Se pueden obtener y definir las propiedades de la pgina HTML de una clase ActionScript importada. Por ejemplo, la siguiente funcin define el contenido del elemento p1 en la pgina y define el valor de la variable foo de JavaScript en la pgina:
public function modifyDOM(window:*):void { window.document.getElementById("p1").innerHTML = "Bye"; window.foo = 66;
Por ejemplo, el siguiente cdigo ActionScript convierte un objeto RegExp de JavaScript denominado jsRegExp a un objeto RegExp de ActionScript:
var flags:String = ""; if (jsRegExp.dotAll) flags += "s"; if (jsRegExp.extended) flags += "x"; if (jsRegExp.global) flags += "g"; if (jsRegExp.ignoreCase) flags += "i"; if (jsRegExp.multiline) flags += "m"; var asRegExp:RegExp = new RegExp(jsRegExp.source, flags);
1017
<html> <style> .style1A { font-family:Arial; font-size:12px } .style1B { font-family:Arial; font-size:24px } </style> <style> .style2 { font-family:Arial; font-size:12px } </style> <body> <p class="style1A"> Style 1A </p> <p class="style1B"> Style 1B </p> <p class="style2"> Style 2 </p> </body> </html>
Una vez que un objeto HTMLLoader cargue este contenido, puede manipular los estilos CSS en la pgina a travs del conjunto cssRules del conjunto window.document.styleSheets, tal y como se muestra a continuacin:
var html:HTMLLoader = new HTMLLoader( ); var urlReq:URLRequest = new URLRequest("test.html"); html.load(urlReq); html.addEventListener(Event.COMPLETE, completeHandler); function completeHandler(event:Event):void { var styleSheet0:Object = html.window.document.styleSheets[0]; styleSheet0.cssRules[0].style.fontSize = "32px"; styleSheet0.cssRules[1].style.color = "#FF0000"; var styleSheet1:Object = html.window.document.styleSheets[1]; styleSheet1.cssRules[0].style.color = "blue"; styleSheet1.cssRules[0].style.font-family = "Monaco"; }
Este cdigo ajusta los estilos CSS para que el documento HTML resultante se asemeje al siguiente:
Tenga en cuenta que el cdigo puede aadir estilos a la pgina despus de que el objeto HTMLLoader distribuye el evento complete.
1018
1019
La pgina ui.html podra cargar un archivo javascript desde la carpeta local sandbox utilizando la siguiente etiqueta de script:
<script src="http://www.example.com/local/ui.js"></script>
Asimismo, podra cargar el contenido desde un directorio en el servidor remoto utilizando una etiqueta de script como la siguiente:
<script src="http://www.example.com/remote/remote.js"></script>
La URL sandboxRoot enmascara cualquier contenido en la misma URL en el servidor remoto. En el ejemplo anterior, no se podra acceder a ningn contenido remoto en www.example.com/local/ (ni a ninguno de los subdirectorios) dado que AIR vuelve a asignar la peticin al directorio local de la aplicacin. Se vuelven a asignar las peticiones independientemente si derivan de la navegacin de una pgina, de XMLHttpRequest o de cualquier otro medio de carga de contenido.
1020
Si este contenido secundario se carg en un iframe y se le asign un ID de elemento secundario, se puede acceder a la interfaz desde el contenido principal leyendo la propiedad childSandboxBridge del fotograma:
var childInterface = document.getElementById("child").contentWindow.childSandboxBridge; air.trace(childInterface.calculatePrice()); //traces ".45 cents" air.trace(childInterface.storeID)); //traces "abc"
Utilizando esta interfaz, el contenido en un fotograma secundario puede guardar el texto en un archivo denominado save.txt, pero no tiene ningn otro acceso al sistema de archivos. El contenido secundario puede llamar a la funcin save de la siguiente manera:
1021
El contenido de aplicacin debe exponer una interfaz lo ms limitada posible a otros entornos limitados. Se debera considerar el contenido que no pertenece a la aplicacin intrnsicamente sospechoso ya que puede estar sujeto a la insercin de cdigo accidental o malintencionado. Se debe establecer una proteccin adecuada para evitar el mal uso de la interfaz que se expone a travs del puente de entorno limitado principal.
El siguiente documento child.html muestra cmo el contenido secundario puede acceder al puente de entorno limitado principal:
<html> <head> <script> document.write(window.parentSandboxBridge.testProperty); </script> </head> <body></body> </html>
Para detectar el evento dominitialize en un objeto window secundario, en lugar de un objeto frame, se debe aadir el detector al nuevo objeto secundario window creado por la funcin window.open():
1022
En este caso, no hay modo de asignar el contenido de aplicacin en un entorno limitado que no pertenece a la aplicacin. Esta tcnica slo es til cuando se carga child.html desde fuera del directorio de la aplicacin. An se puede asignar el contenido de aplicacin del objeto window a un entorno limitado que no pertenece a la aplicacin, pero primero se debe cargar una pgina intermedia que utiliza fotogramas para cargar el documento secundario y asignarla al entorno limitado deseado. Si se utiliza la funcin createRootWindow() de la clase HTMLLoader para crear una ventana, la nueva ventana no es un elemento secundario del documento desde donde se llama createRootWindow(). Por consiguiente, no se puede crear un puente de entorno limitado desde la ventana llamada al contenido que no pertenece a la aplicacin cargado en la nueva ventana. En cambio, se debe cargar una pgina intermedia en la nueva ventana que utiliza fotogramas para cargar el documento secundario. Entonces se puede establecer el puente desde el documento principal de la nueva ventana al documento secundario cargado en el fotograma.
1023
1024
Propiedad
x, y width, height visible
Notas Coloca el objeto dentro del contenedor principal. Cambia las dimensiones del rea de visualizacin. Controla la visibilidad del objeto y el contenido que tenga.
Fuera de una ventana HTML, las propiedades width y height de un objeto HTMLLoader tienen el valor predeterminado de 0. Se debe establecer la anchura y altura antes de que se pueda ver el contenido HTML cargado. El contenido HTML se dibuja acorde al tamao de HTMLLoader, dispuesto segn las propiedades HTML y CSS en el contenido. Si se cambia el tamao de HTMLLoader se vuelve a fluir el contenido. Cuando se carga el contenido en un nuevo objeto HTMLLoader (con width an definido en 0), puede ser tentador definir las propiedades de visualizacin width y height del HTMLLoader usando las propiedades contentWidth y contentHeight. Esta tcnica funciona para las pginas que tienen una anchura mnima razonable cuando se disponen segn las reglas de flujo HTML y CSS. Sin embargo, algunas pginas fluyen con un diseo largo y angosto en la ausencia de una anchura razonable proporcionada por HTMLLoader. Nota: cuando se cambia la anchura y altura de un objeto HTMLLoader, los valores de scaleX y scaleY no cambian, como sucedera con la mayora de los otros tipos de objetos de visualizacin.
1025
Si se ajusta la escala del objeto HTMLLoader a un factor diferente de 1,0. Si se establece la propiedad alfa del objeto HTMLLoader a un valor diferente de 1,0. Si se rota el contenido HTMLLoader.
El contenido vuelve a aparecer si se quita el parmetro incorrecto de la propiedad y se quitan los filtros activos. Adems, el motor de ejecucin no puede mostrar el contenido PDF en ventanas transparentes. El motor de ejecucin slo muestra contenido SWF incorporado en una pgina HTML si el parmetro wmode del objeto o de la etiqueta incorporada se establece en opaque o transparent. Dado que el valor predeterminado de wmode es window, el contenido SWF no se visualiza en ventanas transparentes a no ser que se establezca el parmetro wmode de forma explcita. Nota: antes de AIR 1.5.2, el contenido SWF incorporado en HTML no se poda visualizar independientemente del valor usado en wmode. Para ms informacin sobre la carga de estos tipos de medios en un HTMLLoader, consulte Incorporacin de contenido SWF en HTML en la pgina 1012 y Cmo aadir contenido PDF en AIR en la pgina 552.
Limitaciones Puede reducir la lectura del contenido HTML En una ventana HTML, los efectos exteriores estn recortados por el borde de la ventana Las formas dibujadas con los comandos grficos aparecen debajo del contenido HTML, incluyendo el fondo predeterminado. La propiedad paintsDefaultBackground debe tener el valor false para que las formas dibujadas sean visibles. No cambia el color del fondo predeterminado. La propiedad paintsDefaultBackground debe tener el valor false para que esta capa de color sea visible.
graphics
opaqueBackground
1026
Propiedad
rotation
Limitaciones Las esquinas del rea HTMLLoader rectangular se pueden recortar por el borde de la ventana. El contenido SWF y PDF cargado en el contenido HTML no se muestra. La visualizacin representada puede aparecer pixelada en factores de escala mayores que 1. El contenido SWF y PDF cargado en el contenido HTML no se muestra. Puede reducir la legibilidad del contenido HTML El borde de la ventana puede recortar la visualizacin HTML. El contenido SWF y PDF cargado en el contenido HTML no se muestra si la transformacin involucra rotacin, ajuste de escala o sesgado.
scaleX, scaleY
transform
En el siguiente ejemplo se muestra la manera de establecer el conjunto de filters para desenfocar toda la visualizacin HTML:
var html:HTMLLoader = new HTMLLoader(); var urlReq:URLRequest = new URLRequest("http://www.adobe.com/"); html.load(urlReq); html.width = 800; html.height = 600; var blur:BlurFilter = new BlurFilter(8); var filters:Array = [blur]; html.filters = filters;
Descripcin La altura, en pxeles, del contenido HTML. La anchura, en pxeles, del contenido HTML. La posicin de desplazamiento horizontal del contenido HTML en el objeto HTMLLoader. La posicin de desplazamiento vertical del contenido HTML en el objeto HTMLLoader.
El siguiente cdigo define la propiedad scrollV para que el contenido HTML se desplace a la parte inferior de la pgina:
1027
var html:HTMLLoader = new HTMLLoader(); html.addEventListener(Event.HTML_BOUNDS_CHANGE, scrollHTML); const SIZE:Number = 600; html.width = SIZE; html.height = SIZE; var urlReq:URLRequest = new URLRequest("http://www.adobe.com"); html.load(urlReq); this.addChild(html); function scrollHTML(event:Event):void { html.scrollV = html.contentHeight - SIZE; }
El HTMLLoader no incluye barras de desplazamiento horizontal y vertical. Se pueden implementar barras de desplazamiento en ActionScript o utilizando un componente Flex. El componente HTML de Flex automticamente incluye barras de desplazamiento para el contenido HTML. Asimismo, se puede usar el mtodo HTMLLoader.createRootWindow() para crear una ventana que contiene un objeto HTMLLoader con barras de desplazamiento (consulte Creacin de ventanas con contenido HTML de desplazamiento en la pgina 1039).
Descripcin La longitud total de la lista del historial, incluyendo las entradas hacia atrs y hacia adelante. La posicin actual en la lista del historial. Los elementos del historial antes de esta posicin representan la navegacin hacia atrs y los elementos despus de esta posicin representan la navegacin hacia adelante. Devuelve el objeto URLRequest que corresponde a la entrada del historial en la posicin especfica en la lista del historial. Navega hacia atrs en la lista del historial, si es posible. Navega hacia adelante en la lista del historial, si es posible. Navega la cantidad indicada de pasos en el historial del navegador. Navega hacia adelante si es positivo y hacia atrs si es negativo. La navegacin a cero vuelve a cargar la pgina. La especificacin de una posicin ms all del final navega hasta el final de la lista.
getHistoryAt()
Los elementos del historial se almacenan como objetos de tipo HTMLHistoryItem. La clase HTMLHistoryItem tiene las siguientes propiedades:
1028
Propiedad
isPost originalUrl title url
Descripcin Est definida en true si la pgina HTML incluye datos POST. La URL original de la pgina HTML, antes de cualquier redireccin. El ttulo de la pgina HTML. La URL de la pgina HTML.
"Mozilla/5.0 (Macintosh; U; PPC Mac OS X; en) AppleWebKit/420+ (KHTML, like Gecko) AdobeAIR/1.0" "Mozilla/5.0 (Windows; U; en) AppleWebKit/420+ (KHTML, like Gecko) AdobeAIR/1.0"
Sustituya la configuracin de la pgina para asegurar la utilizacin de una codificacin de caracteres especfica configurando la propiedad textEncodingOverride del objeto HTMLLoader:
1029
Especifique la codificacin de caracteres que el contenido HTMLLoader utilizar cuando una pgina HTML no especifica una configuracin con la propiedad textEncodingFallback del objeto HTMLLoader:
var html:HTMLLoader = new HTMLLoader(); html.textEncodingFallback = "ISO-8859-1";
La propiedad textEncodingOverride sustituye la configuracin en la pgina HTML. Y la propiedad textEncodingOverride y la configuracin en la pgina HTML sustituye la propiedad textEncodingFallback. Configure la propiedad textEncodingOverride o la propiedad textEncodingFallback antes de cargar el contenido HTML.
window.status window.document.title window.location window.blur() window.close() window.focus() window.moveBy() window.moveTo() window.open() window.resizeBy() window.resizeTo()
1030
Cuando se crea un objeto HTMLLoader usando new HTMLLoader(), las propiedades o mtodos listados de JavaScript no se activan. La clase HTMLHost proporciona una implementacin predeterminada de navegador de estas API de JavaScript. Asimismo se puede ampliar la clase HTMLHost para personalizar el comportamiento. Para crear un objeto HTMLHost que admite el comportamiento predeterminado, configure el parmetro defaultBehaviors en true en el constructor HTMLHost:
var defaultHost:HTMLHost = new HTMLHost(true);
Cuando se crea una ventana HTML en AIR con el mtodo createRootWindow() de la clase HTMLLoader, se asigna inmediatamente una instancia HTMLHost que admite comportamientos predeterminados. Es posible cambiar el comportamiento del objeto host asignando una implementacin HTMLHost diferente a la propiedad htmlHost de HTMLLoader o asignar null para desactivar las funciones completamente. Nota: AIR asigna un objeto HTMLHost predeterminado a la ventana inicial creada para una aplicacin de AIR basada en HTML y cualquier ventana creada por la implementacin predeterminada del mtodo window.open() de JavaScript.
usuario. Por ejemplo, la siguiente clase, CustomHost, define los comportamientos para las llamadas a window.open() y cambia a window.document.title. Las llamadas a window.open() abren la pgina HTML en una nueva ventana, y los cambios en window.document.title (incluyendo la configuracin del elemento <title> de una pgina HTML) definen el ttulo de dicha ventana.
1031
public class CustomHost extends HTMLHost { import flash.html.*; override public function createWindow(windowCreateOptions:HTMLWindowCreateOptions):HTMLLoader { var initOptions:NativeWindowInitOptions = new NativeWindowInitOptions(); var bounds:Rectangle = new Rectangle(windowCreateOptions.x, windowCreateOptions.y, windowCreateOptions.width, windowCreateOptions.height); var htmlControl:HTMLLoader = HTMLLoader.createRootWindow(true, initOptions, windowCreateOptions.scrollBarsVisible, bounds); htmlControl.htmlHost = new HTMLHostImplementation(); if(windowCreateOptions.fullscreen){ htmlControl.stage.displayState = StageDisplayState.FULL_SCREEN_INTERACTIVE; } return htmlControl; } override public function updateTitle(title:String):void { htmlLoader.stage.nativeWindow.title = title; } } }
3 En el cdigo que contiene el HTMLLoader (no el cdigo de la nueva subclase de HTMLHost), cree un objeto de la
nueva clase. Asigne el nuevo objeto a la propiedad htmlHost de HTMLLoader. El siguiente cdigo Flex usa la clase CustomHost definida en el paso anterior:
1032
<?xml version="1.0" encoding="utf-8"?> <mx:WindowedApplication xmlns:mx="http://www.adobe.com/2006/mxml" layout="vertical" applicationComplete="init()"> <mx:Script> <![CDATA[ import flash.html.HTMLLoader; import CustomHost; private function init():void { var html:HTMLLoader = new HTMLLoader(); html.width = container.width; html.height = container.height; var urlReq:URLRequest = new URLRequest("Test.html"); html.htmlHost = new CustomHost(); html.load(urlReq); container.addChild(html); } ]]> </mx:Script> <mx:UIComponent id="container" width="100%" height="100%"/> </mx:WindowedApplication>
Para probar el cdigo descrito aqu, incluya un archivo HTML con el siguiente contenido en el directorio de la aplicacin:
<html> <head> <title>Test</title> </head> <script> function openWindow() { window.runtime.trace("in"); document.title = "foo" window.open('Test.html'); window.runtime.trace("out"); } </script> <body> <a href="#" onclick="openWindow()">window.open('Test.html')</a> </body> </html>
Ejemplo de Flash Professional: 1 Cree un archivo Flash para AIR. Defina la clase de documento a CustomHostExample y guarde el archivo como CustomHostExample.fla.
2 Cree un archivo ActionScript llamado CustomHost como que contiene una clase que ampla la clase HTMLHost
(una subclase). Esta clase anula ciertos mtodos de la nueva clase para gestionar cambios en los parmetros relacionados con la interfaz de usuario. Por ejemplo, la siguiente clase, CustomHost, define los comportamientos para las llamadas a window.open() y cambia a window.document.title. Las llamadas al mtodo window.open() abren la pgina HTML en una nueva ventana, y los cambios en la propiedad window.document.title (incluyendo la configuracin del elemento <title> de una pgina HTML) definen el ttulo de dicha ventana.
1033
package { import import import import import import import import import import
flash.display.StageScaleMode; flash.display.NativeWindow; flash.display.NativeWindowInitOptions; flash.events.Event; flash.events.NativeWindowBoundsEvent; flash.geom.Rectangle; flash.html.HTMLLoader; flash.html.HTMLHost; flash.html.HTMLWindowCreateOptions; flash.text.TextField;
public class CustomHost extends HTMLHost { public var statusField:TextField; public function CustomHost(defaultBehaviors:Boolean=true) { super(defaultBehaviors); } override public function windowClose():void { htmlLoader.stage.nativeWindow.close(); } override public function createWindow( windowCreateOptions:HTMLWindowCreateOptions ):HTMLLoader { var initOptions:NativeWindowInitOptions = new NativeWindowInitOptions(); var bounds:Rectangle = new Rectangle(windowCreateOptions.x, windowCreateOptions.y, windowCreateOptions.width, windowCreateOptions.height); var htmlControl:HTMLLoader = HTMLLoader.createRootWindow(true, initOptions, windowCreateOptions.scrollBarsVisible, bounds); htmlControl.htmlHost = new HTMLHostImplementation(); if(windowCreateOptions.fullscreen){ htmlControl.stage.displayState = StageDisplayState.FULL_SCREEN_INTERACTIVE; } return htmlControl; } override public function updateLocation(locationURL:String):void { trace(locationURL); } override public function set windowRect(value:Rectangle):void { htmlLoader.stage.nativeWindow.bounds = value;
1034
} override public function updateStatus(status:String):void { statusField.text = status; trace(status); } override public function updateTitle(title:String):void { htmlLoader.stage.nativeWindow.title = title + "- Example Application"; } override public function windowBlur():void { htmlLoader.alpha = 0.5; } override public function windowFocus():void { htmlLoader.alpha = 1; } } }
3 Cree otro archivo ActionScript denominado CustomHostExample para que contenga la clase de documento para
la aplicacin. Esta clase crea un objeto HTMLLoader y define la propiedad del host a una instancia de la clase CustomHost definida en el paso anterior:
1035
public class CustomHostExample extends Sprite { function CustomHostExample():void { var html:HTMLLoader = new HTMLLoader(); html.width = 550; html.height = 380; var host:CustomHost = new CustomHost(); html.htmlHost = host; var urlReq:URLRequest = new URLRequest("Test.html"); html.load(urlReq); addChild(html); var statusTxt:TextField = new TextField(); statusTxt.y = 380; statusTxt.height = 20; statusTxt.width = 550; statusTxt.background = true; statusTxt.backgroundColor = 0xEEEEEEEE; addChild(statusTxt); host.statusField = statusTxt; } } }
Para probar el cdigo descrito aqu, incluya un archivo HTML con el siguiente contenido en el directorio de la aplicacin:
1036
<html> <head> <title>Test</title> <script> function openWindow() { document.title = "Test" window.open('Test.html'); } </script> </head> <body bgColor="#EEEEEE"> <a href="#" onclick="window.open('Test.html')">window.open('Test.html')</a> <br/><a href="#" onclick="window.document.location='http://www.adobe.com'"> window.document.location = 'http://www.adobe.com'</a> <br/><a href="#" onclick="window.moveBy(6, 12)">moveBy(6, 12)</a> <br/><a href="#" onclick="window.close()">window.close()</a> <br/><a href="#" onclick="window.blur()">window.blur()</a> <br/><a href="#" onclick="window.focus()">window.focus()</a> <br/><a href="#" onclick="window.status = new Date().toString()">window.status=new Date().toString()</a> </body> </html>
Nota: puede utilizar la propiedad htmlLoader del objeto HTMLHost para hacer referencia al objeto HTMLLoader actual.
1037
Nota: este ejemplo asigna la implementacin HTMLHost personalizada a cualquier ventana nueva creada con window.open(). Asimismo, si se desea se puede usar una implementacin diferente o definir la propiedad htmlHost en null para nuevas ventanas. El objeto transferido como parmetro al mtodo createWindow() es un objeto HTMLWindowCreateOptions. La clase HTMLWindowCreateOptions incluye propiedades que informan sobre los valores definidos en la cadena de parmetro features en la llamada a window.open():
Propiedad HTMLWindowCreateOptions Parmetro correspondiente en la cadena de funciones en la llamada JavaScript a window.open()
fullscreen height location menubar resizable scrollbars status toolbar width left o screenX top o screenY
1038
La clase HTMLLoader no implementa todas las funciones que se pueden especificar en la cadena de funcin. La aplicacin debe proporcionar barras de desplazamiento, barras de ubicacin, barras de mens, barras de estado y barras de herramientas segn corresponda. Los otros argumentos al mtodo window.open() JavaScript los gestiona el sistema. Una implementacin createWindow() no debe cargar contenido en el objeto HTMLLoader ni definir el ttulo de la ventana.
Las llamadas JavaScript a window.close() no tienen que cerrar la ventana. Podra, por ejemplo, quitar el HTMLLoader de la lista de visualizacin, dejando la ventana abierta (que puede tener otro contenido), como en el siguiente cdigo:
override public function windowClose():void { htmlLoader.parent.removeChild(htmlLoader); }
El estado requerido se pasa como una cadena al mtodo updateStatus(). El objeto HTMLLoader no proporciona una barra de estado.
1039
Cuando se define document.title en una pgina HTML, el ttulo solicitado se pasa como una cadena al mtodo updateTitle(). Los cambios en document.title no tienen que cambiar el ttulo de la ventana que contiene el objeto HTMLLoader. Podra, por ejemplo, cambiar otro elemento de la interfaz como un campo de texto.
Nota: AIR no proporciona una API para desactivar una ventana o aplicacin.
Descripcin Un valor Boolean que especifica si la ventana est inicialmente visible (true) o no (false). Un objeto NativeWindowInitOptions. La clase NativeWindowInitOptions define las opciones de inicializacin de un objeto NativeWindow, incluyendo: si se puede minimizar, maximizar o cambiar el tamao de la ventana, si la ventana tiene fondo cromtico del sistema o fondo cromtico personalizado, si la ventana es transparente o no (para las ventanas que no usan fondo cromtico) y el tipo de ventana. Si hay barras de desplazamiento (true) o no (false). Un objeto Rectangle que define la posicin y el tamao de la nueva ventana.
scrollBarsVisible bounds
Por ejemplo, el siguiente cdigo usa el mtodo HTMLLoader.createRootWindow() para crear una ventana con contenido HTMLLoader que usa barras de desplazamiento.
var initOptions:NativeWindowInitOptions = new NativeWindowInitOptions(); var bounds:Rectangle = new Rectangle(10, 10, 600, 400); var html2:HTMLLoader = HTMLLoader.createRootWindow(true, initOptions, true, bounds); var urlReq2:URLRequest = new URLRequest("http://www.example.com"); html2.load(urlReq2); html2.stage.nativeWindow.activate();
1040
Nota: las ventanas creadas llamando a createRootWindow() directamente en JavaScript permanecen independientes de la ventana HTML abierta. Las propiedades de la ventana JavaScript opener y parent, por ejemplo, son null. Sin embargo, se llama a createRootWindow() indirectamente anulando el mtodo createWindow() de HTMLHost para llamar a createRootWindow(), entonces las propiedades opener y parent s hacen referencia a la ventana HTML abierta.
El siguiente ejemplo define una subclase de la clase HTMLLoader que asigna un objeto MyHTMLHost a la propiedad htmlHost:
1041
package { import flash.html.HTMLLoader; import MyHTMLHost; import HTMLLoader; public class MyHTML extends HTMLLoader { public function MyHTML() { super(); htmlHost = new MyHTMLHost(); } } }
Para ms informacin sobre la clase HTMLHost y el mtodo HTMLLoader.createRootWindow() usado en este ejemplo, consulte Definicin de interfaces de usuario del navegador para el contenido HTML en la pgina 1029.
1042
Eventos HTMLLoader
Adobe AIR 1.0 y posterior Un objeto HTMLLoader distribuye los siguientes eventos de Adobe ActionScript 3.0:
Evento
htmlDOMInitialize
Descripcin Se distribuye al crearse el documento HTML, pero antes de que se analicen scripts o se aadan a la pgina nodos del DOM. Se distribuye cuando se ha creado el DOM de HTML como respuesta a una operacin de cargar, inmediatamente despus del evento onload en la pgina HTML. Se distribuye cuando ha cambiado al menos una de las propiedades contentWidth o contentHeight. Se distribuye cuando ha cambiado la propiedad de ubicacin de HTMLLoader. Se distribuye antes de que cambie la ubicacin de HTMLLoader debido a la navegacin del usuario, una llamada a JavaScript o un redireccionamiento. El evento locationChanging no se distribuye cuando se llama a los mtodos load(), loadString(), reload(), historyGo(), historyForward() o historyBack(). Llamar al mtodo preventDefault() del objeto de evento distribuido cancelar la navegacin. Si se abre un vnculo en el navegador del sistema, no se distribuye un evento locationChanging, ya que la ubicacin de HTMLLoader no cambia.
complete
htmlBoundsChanged
locationChange locationChanging
scroll
Se distribuye siempre que el motor de HTML cambia la posicin de desplazamiento. Los eventos de desplazamiento pueden deberse a la navegacin a vnculos de anclaje (vnculos #) en la pgina o a llamadas al mtodo window.scrollTo(). Escribir texto en una zona de entrada de texto tambin puede dar lugar a un evento de desplazamiento. Se distribuye cuando se produce una excepcin de JavaScript en HTMLLoader y la excepcin no se captura en cdigo JavaScript.
uncaughtScriptException
Tambin se puede registrar una funcin de ActionScript para un evento de JavaScript (por ejemplo, onClick). Para obtener ms informacin, consulte Gestin de eventos DOM con ActionScript en la pgina 1043.
1043
Se puede registrar una funcin de ActionScript como controlador de cualquier evento de la pgina. En el siguiente ejemplo el cdigo aade la funcin clickHandler() como detector del evento onclick del elemento testLink de la pgina HTML:
var html:HTMLLoader = new HTMLLoader( ); var urlReq:URLRequest = new URLRequest("test.html"); html.load(urlReq); html.addEventListener(Event.COMPLETE, completeHandler); function completeHandler(event:Event):void { html.window.document.getElementById("testLink").onclick = clickHandler; } function clickHandler( event:Object ):void { trace("Event of type: " + event.type ); }
El objeto de evento distribuido no es de tipo flash.events.Event ni una de las subclases Event. Utilice la clase Object para declarar un tipo para el argumento de funcin del controlador de eventos. Tambin se puede utilizar el mtodo addEventListener() para registrarlo para estos eventos. Por ejemplo, se podra sustituir el mtodo completeHandler() del ejemplo anterior con el cdigo siguiente:
function completeHandler(event:Event):void { var testLink:Object = html.window.document.getElementById("testLink"); testLink.addEventListener("click", clickHandler); }
Cuando un detector hace referencia a un elemento DOM concreto, conviene esperar a que el objeto HTMLLoader principal distribuya el evento complete antes de aadir los detectores de eventos. Las pginas HTML cargan a menudo varios archivos y el DOM de HTML no se termina de crear hasta no haberse cargado y analizado todos los archivos. HTMLLoader distribuye el evento complete una vez creados todos los elementos.
1044
<html> <head> <script> function throwError() { var x = 400 * melbaToast; } </script> </head> <body> <a href="#" onclick="throwError()">Click me.</a> </html>
Contiene una funcin de JavaScript, throwError(), que hace referencia a una variable desconocida, melbaToast:
var x = 400 * melbaToast;
Si una operacin de JavaScript se encuentra con una operacin no vlida que no es capturada en el cdigo JavaScript con una estructura try/catch, el objeto HTMLLoader que contiene la pgina distribuye un evento HTMLUncaughtScriptExceptionEvent. Se puede registrar un controlador para este evento, como en el cdigo siguiente:
var html:HTMLLoader = new HTMLLoader(); var urlReq:URLRequest = new URLRequest("test.html"); html.load(urlReq); html.width = container.width; html.height = container.height; container.addChild(html); html.addEventListener(HTMLUncaughtScriptExceptionEvent.UNCAUGHT_SCRIPT_EXCEPTION, htmlErrorHandler); function htmlErrorHandler(event:HTMLUncaughtJavaScriptExceptionEvent):void { event.preventDefault(); trace("exceptionValue:", event.exceptionValue) for (var i:int = 0; i < event.stackTrace.length; i++) { trace("sourceURL:", event.stackTrace[i].sourceURL); trace("line:", event.stackTrace[i].line); trace("function:", event.stackTrace[i].functionName); } }
1045
<html> <head> <script language="javascript" type="text/javascript" src="AIRAliases.js"></script> <script> function throwError() { var x = 400 * melbaToast; } function htmlErrorHandler(event) { event.preventDefault(); var message = "exceptionValue:" + event.exceptionValue + "\n"; for (var i = 0; i < event.stackTrace.length; i++){ message += "sourceURL:" + event.stackTrace[i].sourceURL +"\n"; message += "line:" + event.stackTrace[i].line +"\n"; message += "function:" + event.stackTrace[i].functionName + "\n"; } alert(message); } window.htmlLoader.addEventListener("uncaughtScriptException", htmlErrorHandler); </script> </head> <body> <a href="#" onclick="throwError()">Click me.</a> </html>
El controlador de eventos htmlErrorHandler() cancela el comportamiento predeterminado del evento (que es enviar el mensaje de error de JavaScript a la salida de la sentencia trace de AIR) y genera su propio mensaje de salida. Presenta el valor exceptionValue del objeto HTMLUncaughtScriptExceptionEvent. Presenta las propiedades de cada objeto del conjunto stackTrace:
exceptionValue: ReferenceError: Can't find variable: melbaToast sourceURL: app:/test.html line: 5 function: throwError sourceURL: app:/test.html line: 10 function: onclick
1046
Cuando el usuario desplaza la ventana, los elementos "textarea" muestran las posiciones X e Y actualizadas de la ventana: Obsrvese que el objeto de evento se pasa como argumento al mtodo moveHandler(). El parmetro de evento permite que la funcin de controlador examine el objeto de evento. En este ejemplo se utiliza la propiedad type del objeto de evento para notificar que se trata de un evento move.
1047
Para evitar que se produzca el error al cerrar ventanas con contenido HTML, llame a una funcin "cleanup" (limpieza) como respuesta al evento closing del objeto NativeWindow (window.nativeWindow). En el siguiente ejemplo, el cdigo JavaScript elimina un detector de eventos para un evento uncaughtScriptException:
window.nativeWindow.addEventListener(air.Event.CLOSING, cleanup); function cleanup() { window.htmlLoader.removeEventListener('uncaughtScriptException', uncaughtScriptExceptionHandler); }
Este error se puede evitar eliminando un detector de eventos cuando se ejecute (si el evento slo se debe gestionar una vez). En el siguiente ejemplo, el cdigo JavaScript crea una ventana html llamando al mtodo createRootWindow() de la clase HTMLLoader y aade un detector de eventos para el evento complete. Cuando se llama al controlador de eventos complete, elimina su propio detector de eventos con la funcin removeEventListener():
var html = runtime.flash.html.HTMLLoader.createRootWindow(true); html.addEventListener('complete', htmlCompleteListener); function htmlCompleteListener() { html.removeEventListener(complete, arguments.callee) // handler code.. } html.load(new runtime.flash.net.URLRequest("second.html"));
La eliminacin de detectores de eventos que ya no se necesitan permite al recolector de datos innecesarios del sistema recuperar la memoria asociada con esos detectores.
1048
Ms temas de ayuda
Sean Voisen: Making the Most of StageWebView Mark Doherty: StageWebView demo - OAuth Support (Demostracin de StageWebView - Compatibilidad con OAuth; en ingls) Jonathan Campos: HTML Web View in AIR for Android (Vista web HTML en AIR para Android; en ingls) Rich Tretola: Create a basic web browser with StageWebView (Creacin de un navegador web bsico con StageWebView; en ingls) Snke Rohde: AIR Mobile StageWebView UIComponent Judah Frangipane: Using StageWebView within a UIComponent in Mobile
Objetos StageWebView
El objeto StageWebView no es un objeto de visualizacin y no se puede aadir a la lista de visualizacin. Funciona como ventana grfica aadida directamente al escenario. El contenido de StageWebView se dibuja sobre la parte superior de cualquier contenido de la lista de visualizacin. No hay ninguna manera de controlar el orden de dibujo de diferentes objetos StageWebView. Para mostrar un objeto StageWebView, se asigna el escenario en el que va a aparecer el objeto a la propiedad stage de StageWebView. Establezca el tamao de la visualizacin utilizando la propiedad viewPort. Establezca las coordenadas x e y de la propiedad viewPort entre -8192 y 8191. El valor mximo de la anchura y la altura del escenario es 8191. Si el tamao sobrepasa los valores mximos, se emitir una excepcin. En el siguiente ejemplo se crea un objeto StageWebView, se establecen las propiedades stage y viewPort y se muestra una cadena de HTML:
1049
var webView:StageWebView = new StageWebView(); webView.viewPort = new Rectangle( 0, 0, this.stage.stageWidth, this .stage.stageHeight); webView.stage = this.stage; var htmlString:String = "<!DOCTYPE HTML>" + "<html><body>" + "<p>King Philip could order five good steaks.</p>" + "</body></html>"; webView.loadString( htmlString );
Para ocultar un objeto StageWebView, establezca su propiedad stage en null. Para destruir todo el objeto, llame al mtodo dispose(). La llamada a dispose() es opcional, pero ayuda al recolector de elementos no utilizados a recuperar antes la memoria utilizada por el objeto.
Contenido
Se puede cargar el contenido en un objeto StageWebView utilizando dos mtodos: loadURL() y loadString(). El mtodo loadURL() carga un recurso en la URL especificada. Es posible utilizar cualquier esquema de URI admitido por el control de navegador web del sistema, incluyendo: data:, file:, http:, https: y javascript:. No se admiten los esquemas app: y app-storage:. AIR no valida la cadena URL. El mtodo loadString() carga una cadena literal que incluye contenido HTML. La ubicacin de la pgina cargada con este mtodo se expresa de la siguiente manera:
En el escritorio: about:blank En iOS: htmlString En Android: el formato de URI de datos del htmlString codificado
El esquema de URI determina las reglas para cargar los datos o el contenido incorporado.
Esquema de URI Carga de recursos locales No S No No Carga de recursos remotos S S S S XMLHttpRequest local XMLHttpRequest remota
No S No No
No S Mismo dominio No
Nota: si la propiedad displayState del escenario se establece en FULL_SCREEN, en Desktop, no se puede escribir en un campo de texto mostrado en StageWebView. No obstante, en iOS y Android, es posible escribir en un campo de texto en StageWebView aunque la propiedad displayState del escenario sea FULL_SCREEN. En el siguiente ejemplo se utiliza un objeto StageWebView para mostrar un sitio web de Adobe:
1050
package { import flash.display.MovieClip; import flash.media.StageWebView; import flash.geom.Rectangle; public class StageWebViewExample extends MovieClip{ var webView:StageWebView = new StageWebView(); public function StageWebViewExample() { webView.stage = this.stage; webView.viewPort = new Rectangle( 0, 0, stage.stageWidth, stage.stageHeight ); webView.loadURL( "http://www.adobe.com" ); } } }
En los dispositivos de Android, se debe especificar el permiso de INTERNET de Android para que la aplicacin pueda cargar correctamente los recursos remotos. En Android 3.0+, una aplicacin debe activar la aceleracin de hardware en el elemento manifestAdditions de Android del descriptor de la aplicacin de AIR para mostrar contenido de plug-in en un objeto StageWebView. Consulte Activacin de Flash Player y otros plug-ins en un objeto StageWebView.
URI de JavaScript
Se puede utilizar un URI de JavaScript para llamar a una funcin definida en la pgina HTML que se cargue mediante un objeto StageWebView. La funcin que se llama utilizando el URI de JavaScript se ejecuta en el contexto de la pgina web cargada. En el siguiente ejemplo se utiliza un objeto StageWebView para llamar a una funcin de JavaScript:
package { import flash.display.*; import flash.geom.Rectangle; import flash.media.StageWebView; public class WebView extends Sprite { public var webView:StageWebView = new StageWebView(); public function WebView() { var htmlString:String = "<!DOCTYPE HTML>" + "<html><script type=text/javascript>" + "function callURI(){" + "alert(\"You clicked me!!\");"+ "}</script><body>" + "<p><a href=javascript:callURI()>Click Me</a></p>" + "</body></html>"; webView.stage = this.stage; webView.viewPort = new Rectangle( 0, 0, stage.stageWidth, stage.stageHeight ); webView.loadString( htmlString ); } } }
Ms temas de ayuda
Sean Voisen: Making the Most of StageWebView
1051
Eventos de navegacin
Cuando un usuario hace clic en un vnculo en HTML, el objeto StageWebView distribuye un evento locationChanging. Se puede llamar al mtodo preventDefault() del objeto de evento para detener la navegacin. De lo contrario, el objeto StageWebView se desplaza a la nueva pgina y distribuye un evento locationChange. Una vez finalizada la carga de la pgina, StageWebView distribuye un evento complete. Un evento locationChanging se distribuye en cada redireccin HTML. Los eventos locationChange y complete se distribuyen en el momento adecuado. En iOS, se distribuye un evento locationChanging antes de locationChange, excepto en el primer mtodo
loadURL() o loadString(). Un evento locationChange tambin se distribuye para los cambios de navegacin
mediante iFrames y Frames. En el siguiente ejemplo se muestra cmo se puede evitar un cambio de ubicacin y abrir la nueva pgina en el navegador del sistema.
package { import import import import import import flash.display.MovieClip; flash.media.StageWebView; flash.events.LocationChangeEvent; flash.geom.Rectangle; flash.net.navigateToURL; flash.net.URLRequest;
public class StageWebViewNavEvents extends MovieClip{ var webView:StageWebView = new StageWebView(); public function StageWebViewNavEvents() { webView.stage = this.stage; webView.viewPort = new Rectangle( 0, 0, stage.stageWidth, stage.stageHeight ); webView.addEventListener( LocationChangeEvent.LOCATION_CHANGING, onLocationChanging ); webView.loadURL( "http://www.adobe.com" ); } private function onLocationChanging( event:LocationChangeEvent ):void { event.preventDefault(); navigateToURL( new URLRequest( event.location ) ); } } }
Historial
Conforme un usuario hace clic en los vnculos del contenido mostrado en un objeto StageWebView, el control guarda las pilas de historial de hacia atrs y hacia delante. El siguiente ejemplo muestra cmo desplazarse en las dos pilas del historial. En el ejemplo se utilizan las teclas programadas Back y Search.
1052
public class StageWebViewExample extends MovieClip{ var webView:StageWebView = new StageWebView(); public function StageWebViewExample() { webView.stage = this.stage; webView.viewPort = new Rectangle( 0, 0, stage.stageWidth, stage.stageHeight ); webView.loadURL( "http://www.adobe.com" ); stage.addEventListener( KeyboardEvent.KEY_DOWN, onKey ); } private function onKey( event:KeyboardEvent ):void { if( event.keyCode == Keyboard.BACK && webView.isHistoryBackEnabled ) { trace("back"); webView.historyBack(); event.preventDefault(); } if( event.keyCode == Keyboard.SEARCH && webView.isHistoryForwardEnabled ) { trace("forward"); webView.historyForward(); } } } }
Seleccin
Aunque no es un objeto de visualizacin, la clase StageWebView contiene miembros que permiten administrar las transiciones seleccionadas dentro y fuera del control. Cuando el objeto StageWebView se selecciona, distribuye un evento focusIn. Este evento se utiliza para administrar los elementos seleccionados en la aplicacin, si es necesario. Cuando StageWebView pierde la seleccin, distribuye un evento focusOut. Una instancia de StageWebView puede perder la seleccin si un usuario pasa el primer o el ltimo control de la pgina web utilizando una bola de seguimiento de dispositivo o las flechas de direccin. La propiedad direction del objeto event permite saber si el flujo de seleccin sube y sobrepasa la parte superior de la pgina o desciende a la parte inferior. Utilice esta informacin para asignar la seleccin al objeto de visualizacin adecuado en la parte superior o inferior de StageWebView. En iOS, la seleccin no se puede establecer mediante programacin. StageWebView distribuye eventos focusIn y focusOut con la propiedad direction de FocusEvent establecida en none. Si el usuario toca dentro de StageWebView, se distribuye el evento focusIn. Si el usuario toca fuera de StageWebView, se distribuye el evento focusOut.
1053
El siguiente ejemplo ilustra el modo en que la seleccin pasa del objeto StageWebView a los objetos de visualizacin de Flash:
package { import import import import import import import import import import flash.display.MovieClip; flash.media.StageWebView; flash.geom.Rectangle; flash.events.KeyboardEvent; flash.ui.Keyboard; flash.text.TextField; flash.text.TextFieldType; flash.events.FocusEvent; flash.display.FocusDirection; flash.events.LocationChangeEvent;
public class StageWebViewFocusEvents extends MovieClip{ var webView:StageWebView = new StageWebView(); var topControl:TextField = new TextField(); var bottomControl:TextField = new TextField(); public function StageWebViewFocusEvents() { trace("Starting"); topControl.type = TextFieldType.INPUT; addChild( topControl ); topControl.height = 60; topControl.width = stage.stageWidth; topControl.background = true; topControl.text = "One control on top."; topControl.addEventListener( FocusEvent.FOCUS_IN, flashFocusIn ); topControl.addEventListener( FocusEvent.FOCUS_OUT, flashFocusOut ); webView.stage = this.stage; webView.viewPort = new Rectangle( 0, 60, stage.stageWidth, stage.stageHeight - 120 ); webView.addEventListener( FocusEvent.FOCUS_IN, webFocusIn ); webView.addEventListener(FocusEvent.FOCUS_OUT, webFocusOut ); webView.addEventListener(LocationChangeEvent.LOCATION_CHANGING, function( event:LocationChangeEvent ):void { event.preventDefault(); } ); webView.loadString("<form action='#'><input/><input/><input/></form>"); webView.assignFocus(); bottomControl.type = TextFieldType.INPUT; addChild( bottomControl ); bottomControl.y = stage.stageHeight - 60; bottomControl.height = 60; bottomControl.width = stage.stageWidth; bottomControl.background = true; bottomControl.text = "One control on the bottom."; bottomControl.addEventListener( FocusEvent.FOCUS_IN, flashFocusIn ); bottomControl.addEventListener( FocusEvent.FOCUS_OUT, flashFocusOut );} private function webFocusIn( event:FocusEvent ):void {
1054
trace("Web focus in"); } private function webFocusOut( event:FocusEvent ):void { trace("Web focus out: " + event.direction); if( event.direction == FocusDirection.TOP ) { stage.focus = topControl; } else { stage.focus = bottomControl; } } private function flashFocusIn( event:FocusEvent ):void { trace("Flash focus in"); var textfield:TextField = event.target as TextField; textfield.backgroundColor = 0xff5566; } private function flashFocusOut( event:FocusEvent ):void { trace("Flash focus out"); var textfield:TextField = event.target as TextField; textfield.backgroundColor = 0xffffff; } } }
1055
package { import flash.display.Bitmap; import flash.display.BitmapData; import flash.display.Sprite; import flash.events.*; import flash.geom.Rectangle; import flash.media.StageWebView; import flash.net.*; import flash.text.TextField; public class stagewebview extends Sprite { public var webView:StageWebView=new StageWebView(); public var textGoogle:TextField=new TextField(); public var textFacebook:TextField=new TextField(); public function stagewebview() { textGoogle.htmlText="<b>Google</b>"; textGoogle.x=300; textGoogle.y=-80; addChild(textGoogle); textFacebook.htmlText="<b>Facebook</b>"; textFacebook.x=0; textFacebook.y=-80; addChild(textFacebook); textGoogle.addEventListener(MouseEvent.CLICK,goGoogle); textFacebook.addEventListener(MouseEvent.CLICK,goFaceBook); webView.stage = this.stage; webView.viewPort = new Rectangle(0, 0, stage.stageWidth, stage.stageHeight); } public function goGoogle(e:Event):void { webView.loadURL("http://www.google.com"); webView.stage = null; webView.addEventListener(Event.COMPLETE,handleLoad); } public function goFaceBook(e:Event):void { webView.loadURL("http://www.facebook.com"); webView.stage = null; webView.addEventListener(Event.COMPLETE,handleLoad); } public function handleLoad(e:Event):void { var bitmapData:BitmapData = new BitmapData(webView.viewPort.width, webView.viewPort.height); webView.drawViewPortToBitmapData(bitmapData); var webViewBitmap:Bitmap=new Bitmap(bitmapData); addChild(webViewBitmap); } } }
1056
Visualizacin de anuncios
Es posible utilizar la clase StageWebView para visualizar anuncios de servicios publicitarios que contengan una interfaz JavaScript/HTML. Defina el visor del objeto StageWebView para que cubra toda el rea de la aplicacin en la que quiera visualizarse el anuncio. Despus, cargue una pgina HTML que contenga el cdigo para solicitar y visualizar anuncios. El siguiente ejemplo muestra una pgina HTML que carga la biblioteca JavaScript Admob y solicita la visualizacin de un anuncio. Un mecanismo similar funciona para otros servicios publicitarios. Incluso para solicitar anuncios de prueba con este ejemplo, primero es preciso tener una cuenta de Admob y asignar su ID de publicacin de Admob a la variable pubid.
<html> <head> <title>Ad jig</title> <script type="text/javascript"> var admob_vars = { pubid: 'admob_pubID', // change to your publisher id bgcolor: 'ffffff', // background color (hex) text: '000000', // font-color (hex) test: true, // test mode, set to false if non-test mode manual_mode: true }; function showAd() { _admob.fetchAd(document.getElementById('adspace')); } </script> <script type="text/javascript" src="http://mm.admob.com/static/iphone/iadmob.js"></script> <style type="text/css"> body { margin-left: 0px; margin-top: 0px; margin-right: 0px; margin-bottom: 0px; } </style> </head> <body onload="showAd()"> <div id="adspace"></div> </body> </html>
El siguiente cdigo ActionScript muestra una pgina de anuncio en una aplicacin de AIR para mvil. El ejemplo tiene el formato necesario para usarlo en la lnea de tiempo de Flash Professional. Si est usando Flash Builder o quiere crear una clase, deber adaptar el cdigo del ejemplo segn sea necesario. Cuando el usuario toca un anuncio, puede hacer que acceda a la pagina de destino del anuncio en la aplicacin o usar use navigateToURL() para visualizar la pgina de destino en un navegador web en el dispositivo. Este ejemplo utiliza navigateToURL(), funcional tanto con vnculos http: como con vnculos market:. En dispositivos mviles, la posicin iniciada por el cdigo de los controles web subyacentes cambia a los esquemas de URI conocidos sin distribuir ningn evento locationChanging. Dado que la API JavaScript de Admob cambia la posicin de la pgina, el ejemplo controla los eventos locationChanging y locationChange para que la aplicacin pueda reaccionar correctamente sin importar si cambia o no la posicin del objeto StageWebView.
1057
Un evento locationChanging se puede cancelar, por lo que el ejemplo llama al mtodo preventDefault() del evento e inicia el navegador web del dispositivo en la propiedad location del evento. Un evento locationChange no se puede cancelar. En este caso, el ejemplo inicia la nueva posicin con el mtodo navigateToURL() y vuelve a cargar la pgina de visualizacin del anuncio.
//Set up web view object var webView:StageWebView = new StageWebView(); webView.stage = this.stage; var adViewPort = new Rectangle( 0, 0, this.stage.stageWidth, 60 ); webView.viewPort = adViewPort; webView.addEventListener(ErrorEvent.ERROR, onWebViewError ); webView.addEventListener(LocationChangeEvent.LOCATION_CHANGING, onWebViewLocChanging ); webView.addEventListener(LocationChangeEvent.LOCATION_CHANGE, onWebViewLocChange ); //Copy the html file outside the app directory var templateFile:File = File.applicationDirectory.resolvePath( "adview.html" ); var workingFile:File = File.createTempFile(); templateFile.copyTo( workingFile, true ); try { webView.loadURL( workingFile.url ); } catch (e:Error) { trace( e ); } function onWebViewLocChange( event:LocationChangeEvent ):void { trace( "Change to" + event.location ); if( event.location != workingFile.url ) { //Reset location back to our ad display page navigateToURL( new URLRequest( event.location ) ); try {
1058
webView.loadURL( workingFile.url ); } catch (e:Error) { trace( e ); } } } function onWebViewLocChanging( event:LocationChangeEvent ):void { trace( "Changing " + event.location ); event.preventDefault(); navigateToURL( new URLRequest( event.location ) ); } function onWebViewError( error:ErrorEvent ):void { trace( error ); }
Nota: este ejemplo no funciona en aplicaciones de escritorio. Tampoco cuando se prueba en aplicaciones mviles en el escritorio, ya que existen restricciones de entorno limitado de seguridad remotas y locales. En el escritorio, el objeto StageWebView tiene restricciones de seguridad propias de un sistema operativo de escritorio. En dispositivos mviles, el objeto StageWebView utiliza las restricciones estndar de control web y de seguridad impuestas por el sistema operativo mvil. En este caso, un archivo cargado localmente (adview.html) puede acceder a recursos remotos el servicio de anuncios en un dispositivo mvil pero no en el escritorio.
1059
Los recursos del mismo entorno limitado de seguridad tienen acceso libre entre ellos. El cdigo ejecutable de los archivos de un entorno limitado remoto no tienen nunca acceso a archivos y datos
locales. Los motores de ejecucin de Flash Player y AIR consideran los siguientes componentes como dominios individuales y configuran entornos limitados de seguridad independientes para cada uno de ellos:
http://example.com
1060
Incluso si un dominio con nombre, como http://example.com, corresponde a una direccin IP especfica, como http://192.0.34.166, el motor de ejecucin configura entornos limitados de seguridad independientes para cada uno de ellos. Hay dos mtodos bsicos que puede utilizar un desarrollador para conceder a un archivo SWF el acceso a los activos de entornos limitados ajenos al del archivo SWF:
El mtodo Security.allowDomain() (consulte Controles de autor (desarrollador) en la pgina 1073) El archivo de poltica URL (consulte Controles de sitio web (archivos de poltica) en la pgina 1069)
En los modelos de seguridad del motor de ejecucin de AIR y Flash Player, existe una diferencia entre cargar contenido y extraer o acceder a datos. El contenido se define como medios, incluidos los medios visuales que los motores de ejecucin pueden mostrar, audio, vdeo o un archivo SWF que incluye medios mostrados. Se define como datos aquello que slo es accesible para el cdigo El contenido y los datos se cargan de modos diferentes.
Carga de contenido: el contenido se puede cargar utilizando clases como Loader, Sound y NetStream, mediante
etiquetas MXML al utilizar Flex o con etiquetas HTML en una aplicacin de AIR.
Extraccin de datos: los datos se pueden extraer de contenido de medios cargados a travs de objetos Bitmap, el
mtodo BitmapData.draw(), la propiedad Sound.id3 o el mtodo SoundMixer.computeSpectrum().
Acceso a datos: se puede acceder a datos directamente cargndolos desde un archivo externo (como un archivo
XML) a travs de clases como URLStream, URLLoader, FileReference, Socket y XMLSocket. AIR proporciona clases adicionales para cargar datos como, por ejemplo, FileStream, y XMLHttpRequest. El modelo de seguridad de Flash Player define reglas distintas para cargar contenido y acceder a los datos. En general, hay menos restricciones para cargar contenido que para acceder a los datos. En general, el contenido (archivos SWF, mapas de bits, archivos MP3 y vdeos) puede cargarse desde cualquier origen, pero si procede de un dominio ajeno al del contenido o al cdigo de carga, se ubicar en un entorno limitado de seguridad independiente. Hay algunos obstculos para cargar contenido:
De forma predeterminada, los archivos SWF locales (cargados desde una direccin fuera de la red como, por
ejemplo, el disco duro de un usuario) se clasifican en el entorno limitado local con sistema de archivos. Estos archivos no pueden cargar contenido de la red. Para obtener ms informacin, consulte Entornos limitados locales en la pgina 1061.
Los servidores RTMP (Real-Time Messaging Protocol) pueden limitar el acceso al contenido. Para obtener ms
informacin, consulte Contenido proporcionado a travs de servidores RTMP en la pgina 1080. Si el medio cargado es una imagen, audio o vdeo, sus datos (ya sean pxeles o sonidos) sern accesibles para un archivo SWF que no pertenezca a su entorno limitado de seguridad slo si el dominio de dicho archivo SWF se haya incluido en un archivo de poltica en el dominio de origen del medio. Para obtener informacin ms detallada, consulte Acceso a medios cargados como datos en la pgina 1084. Otros tipos de datos cargados contienen texto o archivos XML, que se cargan con un objeto URLLoader. De nuevo en este caso, para acceder a los datos de otro entorno limitado de seguridad, deben concederse permisos mediante un archivo de poltica URL en el dominio de origen. Para obtener informacin ms detallada, consulte Uso de URLLoader y URLStream en la pgina 1086.
1061
Nota: los archivos de poltica nunca se requieren para el cdigo que se ejecuta en el entorno limitado de la aplicacin de AIR para cargar datos o contenido remoto.
Entorno limitado local con sistema de archivos: por motivos de seguridad y de forma predeterminada, los motores
de ejecucin de Flash Player y AIR colocan todos los archivos locales en el entorno limitado local con sistema de archivos. Desde este entorno limitado, el cdigo ejecutable puede leer archivos locales (por ejemplo, mediante la clase URLLoader), pero no pueden comunicarse con la red de ningn modo. De este modo, el usuario tiene la seguridad de que no se filtran los datos locales a la red ni se comparten de forma indebida.
1062
El entorno limitado local con acceso a la red: al compilar un archivo SWF, se puede especificar que tenga acceso a
la red cuando se ejecute como un archivo local (consulte Configuracin del tipo de entorno limitado de los archivos SWF locales en la pgina 1064). Estos archivos se colocan en el entorno limitado local con acceso a la red. Los archivos SWF que se asignan al entorno limitado local con acceso a la red pierden el acceso al sistema de archivos local. A cambio, se les permite acceder a los datos de la red. Sin embargo, sigue sin permitirse que un archivo SWF local con acceso a la red lea los datos derivados de la red a menos que se disponga de permisos para ello, a travs de un archivo de poltica URL o una llamada al mtodo Security.allowDomain(). Para conceder dicho permiso, un archivo de poltica URL debe conceder permiso a todos los dominios a travs de <allowaccess-from domain="*"/> o Security.allowDomain("*"). Para obtener ms informacin, consulte Controles de sitio web (archivos de poltica) en la pgina 1069 y Controles de autor (desarrollador) en la pgina 1073.
El entorno limitado local de confianza: los archivos SWF locales que los usuarios o programas de instalacin
registran como archivos de confianza se colocan en el entorno limitado local de confianza. Los administradores del sistema y los usuarios tambin pueden reasignar un archivo SWF local al entorno limitado local de confianza, o quitarlo de l, en funcin de consideraciones de seguridad (consulte Controles de administrador en la pgina 1066 y Controles de usuario en la pgina 1068). Los archivos SWF asignados al entorno limitado local de confianza pueden interactuar con el resto de archivos SWF y cargar datos desde cualquier lugar (remoto o local).
El entorno limitado de la aplicacin AIR: este entorno limitado presenta contenido que se instal con la aplicacin
AIR en ejecucin. De forma predeterminada, el cdigo que se ejecuta en el entorno limitado de la aplicacin AIR puede reutilizar los scripts de los archivos de cualquier dominio. No obstante, a los archivos que se encuentran fuera del entorno limitado de la aplicacin AIR no se les permite reutilizar el cdigo de scripts en el entorno limitado de la aplicacin. De forma predeterminada,el cdigo y el contenido del entorno limitado de la aplicacin de AIR pueden cargar contenido y datos desde cualquier dominio. Se prohbe estrictamente la comunicacin entre entornos limitados locales con acceso a la red y entornos limitados locales con sistema de archivos, y entre entornos limitados locales con sistema de archivos y entornos limitados remotos. Una aplicacin que se ejecute en Flash Player o un usuario o administrador no pueden conceder permiso para permitir dicha comunicacin. La creacin de scripts en cualquier sentido entre archivos HTML locales y archivos SWF locales (por ejemplo, mediante la clase ExternalInterface) requiere que los archivos HTML y SWF implicados estn en el entorno limitado local de confianza. El motivo de ello es que los modelos de seguridad local de los navegadores difieren del modelo de seguridad local de Flash Player. Los archivos SWF incluidos en el entorno limitado local con acceso a la red no pueden cargar archivos SWF en el entorno limitado local con sistema de archivos. Los archivos SWF incluidos en el entorno limitado local con sistema de archivos no pueden cargar archivos SWF en el entorno limitado local con acceso a la red.
1063
Cuando se instala una aplicacin, todos los archivos incluidos en un paquete de AIR se instalan en el equipo del usuario en un directorio de la aplicacin. Los desarrolladores pueden hacer referencia a este directorio en cdigo a travs del esquema de URL app:/ (consulte Esquemas de URI en la pgina 821). Todos los archivos del rbol de directorios de la aplicacin se asignan al entorno limitado de la aplicacin cuando se ejecuta la aplicacin. El contenido en el entorno limitado de la aplicacin cuenta con todos los privilegios que tiene disponible una aplicacin de AIR, incluyendo la interaccin con el sistema de archivos local. Muchas aplicaciones de AIR solo usan estos archivos instalados localmente para ejecutar la aplicacin. Sin embargo, las aplicaciones de AIR no estn restringidas a solo los archivos dentro the directorio de la aplicacin; pueden cargar cualquier tipo de archivo de cualquier origen. Esto incluye archivos locales del equipo del usuario as como archivos de orgenes externos disponibles, como los de una red local o en Internet. El tipo de archivo no tiene ningn impacto en las restricciones de seguridad; los archivos HTML cargados tienen los mismos privilegios de seguridad que los archivos SWF cargados desde el mismo origen. El contenido en el entorno limitado de seguridad de la aplicacin tiene acceso a las API de AIR pero los contenidos en otros entornos limitados no pueden utilizarlas. Por ejemplo, la propiedad air.NativeApplication.nativeApplication.applicationDescriptor, que devuelve los contenidos del archivo descriptor de la aplicacin de la aplicacin, est restringido al contenido en el entorno limitado de seguridad de la aplicacin. Otro ejemplo de una API restringida es la clase FileStream, que contiene mtodos para leer y escribir en el sistema de archivos local. Las API de ActionScript que slo estn disponibles para el contenido en el entorno limitado de seguridad de la aplicacin se indican con el logotipo de AIR en Referencia de ActionScript 3.0 para la plataforma de Adobe Flash. El uso de estas API en otros entornos limitados hace que el motor de ejecucin emita una excepcin SecurityError. Para el contenido HTML (en un objeto HTMLLoader) todas las API JavaScript de AIR (las que estn disponibles mediante la propiedad window.runtime o mediante el objeto air cuando se usa el archivo AIRAliases.js) estn disponibles para el contenido en el entorno limitado de seguridad de la aplicacin. El contenido HTML en otro entorno limitado no tiene acceso a la propiedad window.runtime, por lo que este contenido no puede acceder a las API de AIR o Flash Player. El contenido que se ejecuta en el entorno limitado de la aplicacin de AIR cuenta con las siguientes restricciones adicionales:
Para el contenido HTML en el entorno limitado de seguridad de la aplicacin, hay limitaciones en el uso de API
que pueden transformar dinmicamente cadenas en cdigo ejecutable despus de que se carga el cdigo. Esta limitacin es para evitar que la aplicacin accidentalmente inserte (y ejecute) cdigo desde orgenes que no pertenecen a la aplicacin (como dominios de red potencialmente inseguros). Un ejemplo es el uso de la funcin eval(). Para ms informacin, consulte Restricciones de cdigo del contenido en entornos limitados diferentes en la pgina 1102
Para evitar posibles ataques de suplantacin de identidad (phishing), las etiquetas img en el contenido HTML en
objetos TextField de ActionScript se omiten en el contenido SWF en el entorno limitado de seguridad de la aplicacin.
El contenido en el entorno limitado de la aplicacin no puede usar el protocolo asfunction en el contenido HTML
en los campos de texto de ActionScript 2.0.
El contenido SWF en el entorno limitado de la aplicacin no puede usar la cach entre dominios, una funcin que
se aadi a la actualizacin 3 de Flash Player 9. Esta funcin permite que Flash Player utilice la cach persistentemente en el contenido del componente de la plataforma de Adobe y vuelva a utilizarlo en el contenido SWF cargado bajo demanda (eliminando la necesidad de volver a cargar el contenido varias veces).
1064
El cdigo JavaScript en un entorno limitado que no pertenece a la aplicacin no tiene acceso al objeto
window.runtime y como tal este cdigo no puede ejecutar las API de AIR.
Como valor predeterminado, el contenido en un entorno limitado de seguridad que no pertenece a la aplicacin no
puede usar llamadas XMLHttpRequest para cargar datos de otros dominios excepto del dominio que llama a la peticin. Sin embargo, el cdigo de aplicacin puede conceder permiso al contenido que no pertenece a la aplicacin configurando un atributo allowCrossdomainXHR en el fotograma o en el iframe. Para obtener ms informacin, consulte Restricciones de cdigo del contenido en entornos limitados diferentes en la pgina 1102.
Hay restricciones para llamar al mtodo window.open() JavaScript. Para ms informacin, consulte
Restricciones para llamar al mtodo window.open() JavaScript en la pgina 1105.
El contenido HTML en los entornos limitados de seguridad remotos (red) slo puede cargar contenido CSS, frame,
iframe e img de dominios remotos (de URL de red).
El contenido HTML en los entornos limitados local con sistema de archivos, local con acceso a la red o local de
confianza solo pueden cargar contenido CSS, frame, iframe e img de entornos limitados locales (no de URL de red o aplicaciones). Para obtener ms informacin, consulte Restricciones de cdigo del contenido en entornos limitados diferentes en la pgina 1102.
1065
Adobe Flex Puede configurar un archivo SWF para el entorno limitado local con sistema de archivos o el entorno limitado local con acceso a la red definiendo el indicador use-network en el compilador Adobe Flex. Para obtener ms informacin, consulte la seccin sobre las opciones del compilador de aplicaciones en Building and Deploying Adobe Flex 3 Applications (Creacin e implementacin de aplicaciones Adobe Flex 3).
La propiedad Security.sandboxType
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior El autor de un archivo SWF puede usar la propiedad Security.sandboxType esttica de slo lectura para determinar el tipo de entorno limitado al que el motor de ejecucin de AIR o Flash Player ha asignado el archivo SWF. La clase Security incluye constantes que representan los valores posibles de la propiedad Security.sandboxType, del siguiente modo:
Security.REMOTE: este archivo SWF procede de un URL de Internet y se rige por reglas de entorno limitado
basadas en dominios.
Security.LOCAL_WITH_FILE: el SWF es un archivo local y no es de confianza para el usuario. No se ha publicado
con una designacin de acceso a la red. El archivo SWF puede leer de orgenes de datos locales pero no puede comunicarse con Internet.
publicado con una designacin de acceso a la red. El archivo SWF se puede comunicar con Internet pero no puede leer en fuentes de datos locales.
Security.LOCAL_TRUSTED: el SWF es un archivo local y el usuario ha determinado que es de confianza, mediante el Administrador de configuracin o un archivo de configuracin de confianza de Flash Player. El archivo SWF puede leer de orgenes de datos locales y puede comunicarse con Internet. Security.APPLICATION: el archivo SWF se ejecuta en una aplicacin AIR, y se instal con el paquete (archivo AIR) de la aplicacin. De forma predeterminada, los archivos del entorno limitado de la aplicacin AIR pueden reutilizar los scripts de los archivos de cualquier dominio. No obstante, a los archivos que se encuentran fuera del entorno limitado de la aplicacin AIR no se les permite reutilizar los scripts del archivo AIR. De forma predeterminada, los archivos del entorno limitado de la aplicacin AIR pueden cargar contenido y datos desde cualquier dominio.
Controles de permiso
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior El modelo de seguridad de tiempo de ejecucin del cliente Flash Player se ha diseado en torno a los recursos, que son objetos como, por ejemplo, archivos SWF, datos locales y URL de Internet. Las personas con un inters directo son aquellas que poseen o utilizan esos recursos. Estas personas pueden ejercer controles (configuracin de seguridad) sobre sus propios recursos y cada recurso tiene cuatro personas con un inters directo. Flash Player aplica de forma estricta una jerarqua de autoridad para estos controles, como se muestra en la siguiente ilustracin:
1066
Esto significa, por ejemplo, que si un administrador restringe el acceso a un recurso, ninguna otra persona con un inters directo puede anular dicha restriccin. Para las aplicaciones de AIR, estos controles de permiso slo se aplican al contenido que se ejecuta fuera del entorno limitado de la aplicacin de AIR.
Controles de administrador
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior Un usuario administrador de un equipo, que haya iniciado sesin con derechos administrativos, puede aplicar una configuracin de seguridad de Flash Player que afecte a todos los usuarios del equipo. En un entorno no empresarial, como puede ser un equipo domstico, suele haber un usuario que tiene adems acceso administrativo. Incluso en un entorno empresarial, los usuarios individuales pueden tener derechos administrativos en el equipo. Hay dos tipos de controles de usuario administrador:
El archivo mms.cfg
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior El archivo mms.cfg es un archivo de texto que permite a los administradores conceder o restringir el acceso a numerosas capacidades. Cuando se inicia Flash Player, lee la configuracin de seguridad de este archivo y la utiliza para limitar la funcionalidad. El archivo mms.cfg incluye valores de configuracin que el administrador utiliza para gestionar capacidades como, por ejemplo, controles de privacidad, seguridad de archivos locales, conexiones de socket, etc. Un archivo SWF puede acceder a informacin sobre las capacidades desactivadas, mediante una llamada a las propiedades Capabilities.avHardwareDisable y Capabilities.localFileReadDisable. Sin embargo, la mayor parte de la configuracin del archivo mms.cfg no puede consultarse desde ActionScript. Para aplicar las polticas de privacidad y seguridad independientes de la aplicacin en un equipo, el archivo mms.cfg slo deben modificarlo los administradores del sistema. Los archivos de instalacin de aplicaciones no deben utilizar el archivo mms.cfg. Aunque un archivo de instalacin que se ejecutara con privilegios de administrador podra modificar el contenido del archivo mms.cfg, Adobe considera que dicho uso infringe la confianza del usuario e insta a los creadores de los archivos de instalacin que no modifiquen nunca el archivo mms.cfg.
1067
Windows: system\Macromed\Flash\mms.cfg
(por ejemplo, C:\WINDOWS\system32\Macromed\Flash\mms.cfg)
Windows: system\Macromed\Flash\FlashPlayerTrust
(por ejemplo, C:\WINDOWS\system32\Macromed\Flash\FlashPlayerTrust)
Las rutas incluidas en un archivo de configuracin de confianza deben ser siempre rutas locales o rutas de red SMB. Las rutas HTTP incluidas en un archivo de configuracin de confianza se omiten; slo los archivos locales pueden ser de confianza. Para evitar conflictos, debe asignarse a cada archivo de configuracin de confianza un nombre de archivo correspondiente a la aplicacin de instalacin y utilizar una extensin de archivo .cfg. Un desarrollador que distribuye un archivo SWF ejecutado localmente a travs de una aplicacin de instalacin puede hacer que la aplicacin aada un archivo de configuracin al directorio Global Flash Player Trust, concediendo as privilegios completos al archivo que distribuye. La aplicacin de instalacin debe ejecutarse como usuario con derechos administrativos. A diferencia del archivo mms.cfg, el directorio Global Flash Player Trust se incluye para que las aplicaciones de instalacin puedan conceder permisos de confianza. Tanto los usuarios administradores como las aplicaciones de instalacin pueden designar aplicaciones locales de confianza a travs del directorio Global Flash Player Trust. Hay tambin directorios Flash Player Trust para usuarios individuales (consulte Controles de usuario en la pgina 1068).
1068
Controles de usuario
Flash Player 9 y posterior Flash Player ofrece tres mecanismos de nivel de usuario diferentes para definir permisos: la interfaz de usuario de configuracin y el Administrador de configuracin, y el directorio User Flash Player Trust.
1069
Esta configuracin slo afecta al usuario actual, no a los dems usuarios que inician sesin en el equipo. Si un usuario sin derechos administrativos instala una aplicacin en su parte del sistema, el directorio User Flash Player Trust permite al archivo de instalacin registrar la aplicacin como "de confianza" para dicho usuario. Un desarrollador que distribuye un archivo SWF ejecutado localmente a travs de una aplicacin de instalacin puede hacer que se aada un archivo de configuracin al directorio User Flash Player Trust, concediendo as privilegios completos al archivo que distribuye. Incluso en esta situacin, el archivo del directorio User Flash Player Trust se considera un control de usuario, porque se inicia como consecuencia de una accin del usuario (la instalacin). Tambin hay un directorio Global Flash Player Trust que el usuario administrador o el archivo de instalacin utiliza para registrar una aplicacin para todos los usuarios de un equipo (consulte Controles de administrador en la pgina 1066).
Datos en mapas de bits, sonidos y vdeos Carga de archivos de texto y XML Importacin de archivos SWF desde otros dominios de seguridad en el dominio de seguridad del archivo SWF que
realiza la carga
Las conexiones basadas en documentos requieren archivos de poltica URL. Estos archivos permiten al servidor
indicar que sus datos y documentos estn disponibles para los archivos SWF de dominios determinados o de todos los dominios.
Las conexiones de socket requieren archivos de poltica de socket, que permiten establecer redes directamente en el
nivel inferior de socket TCP a travs de las clases Socket y XMLSocket. Flash Player requiere que los archivos de poltica se transmitan a travs del mismo protocolo que pretende utilizar la conexin que se desea establecer. Por ejemplo, cuando se incluye un archivo de poltica en el servidor HTTP, los archivos SWF de otros dominios pueden cargar datos de l como un servidor HTTP. Sin embargo, si no se proporciona un archivo de poltica de socket en el mismo servidor, se prohibir a los archivos SWF de otros dominios que se conecten con el servidor en el socket. Dicho de otro modo, la va por la cual se recupera un archivo de poltica debe coincidir con la va empleada en la conexin.
1070
En el resto de esta seccin se describen brevemente el uso y la sintaxis de los archivos de poltica, ya que se aplican a los archivos SWF publicados para Flash Player 10. (La implementacin de archivos de poltica es ligeramente diferente en las versiones anteriores de Flash Player, ya que las versiones posteriores han reforzado la seguridad del programa.) Para obtener informacin ms detallada sobre los archivos de poltica, consulte el tema sobre los cambios de los archivos de poltica en Flash Player 9 del Centro de desarrollo de Flash Player en la direccin www.adobe.com/go/devnet_security_es. El cdigo que se ejecuta en el entorno limitado de la aplicacin de AIR no requiere ningn archivo de directiva para acceder a los datos de una URL o socket. El cdigo de una aplicacin de AIR que se ejecutan en un entorno limitado ajeno a la aplicacin requiere un archivo de poltica.
1071
No puede recibir una notificacin del momento en el que se inicia o completa una solicitud de archivo de poltica, y no hay razn para ello. Flash Player realiza comprobaciones de poltica de forma asincrnica, y espera automticamente a iniciar las conexiones hasta que las comprobaciones de archivos de poltica se hayan realizado correctamente. Las secciones siguientes incluyen informacin que se aplica slo a los archivos de poltica URL. Para obtener ms informacin sobre los archivos de poltica de socket, consulte Conexin a sockets en la pgina 1087.
Mediante un solo asterisco (*), que coincide con todos los dominios y todas las direcciones IP Mediante un asterisco seguido de un sufijo, que coincide slo con los dominios que terminan con el sufijo
especificado Los sufijos deben empezar por un punto. Sin embargo, los dominios comodn con sufijos pueden incluir los dominios formados nicamente por el sufijo sin el punto inicial. Por ejemplo, xyz.com se considera parte de *.xyz.com. Los comodines no se pueden utilizar en las especificaciones de dominio IP. En el ejemplo siguiente se muestra un archivo de poltica URL que permite el acceso a archivos SWF procedentes de *.example.com, www.friendOfExample.com y 192.0.34.166:
<?xml version="1.0"?> <cross-domain-policy> <allow-access-from domain="*.example.com" /> <allow-access-from domain="www.friendOfExample.com" /> <allow-access-from domain="192.0.34.166" /> </cross-domain-policy>
Si especifica una direccin IP, slo se otorgar acceso a los archivos SWF cargados desde esa direccin IP mediante la sintaxis de IP (por ejemplo, http://65.57.83.12/flashmovie.swf). No se conceder acceso a los archivos SWF a travs de la sintaxis de nombre de dominio. Flash Player no lleva a cabo la resolucin DNS. Se puede permitir el acceso a documentos procedentes de cualquier dominio, tal y como se muestra en el siguiente ejemplo:
1072
<?xml version="1.0"?> <!-- http://www.foo.com/crossdomain.xml --> <cross-domain-policy> <allow-access-from domain="*" /> </cross-domain-policy>
Cada etiqueta <allow-access-from> tiene adems el atributo opcional secure, que tiene el valor predeterminado true. Si su archivo de poltica se encuentra en un servidor HTTPS y desea permitir que los archivos SWF de un servidor que no sea HTTPS puedan cargar datos del servidor HTTPS, puede establecer el atributo en false. Establecer el atributo secure en false puede poner en peligro la seguridad proporcionada por HTTPS. En concreto, establecer este atributo en false deja el contenido seguro expuesto a posibles ataques de fisgones y suplantadores. Adobe recomienda encarecidamente no establecer el atributo secure en false. Si los datos que se van a cargar se encuentran en un servidor HTTPS, pero el archivo SWF que los carga se encuentra en un servidor HTTP, Adobe recomienda mover el archivo SWF de carga a un servidor HTTPS. De este modo, se podrn mantener todas las copias de sus datos seguros bajo la proteccin de HTTPS. Sin embargo, si se decide mantener el archivo SWF que realiza la carga en un servidor HTTP, deber aadirse el atributo secure="false" a la etiqueta <allow-access-from>, como se muestra en el cdigo siguiente:
<allow-access-from domain="www.example.com" secure="false" />
Otro elemento que se puede utilizar para permitir el acceso es la etiqueta allow-http-request-headers-from. Este elemento permite a un cliente que aloja contenido de otro dominio de permisos enviar a su dominio encabezados definidos por el usuario. Mientras que la etiqueta <allow-access-from> concede permiso a otros dominios para extraer datos de su dominio, la etiqueta allow-http-request-headers-from concede permiso a otros dominios para introducir datos en el mismo, en la forma de encabezados. En el ejemplo siguiente, se permite a cualquier dominio enviar el encabezado SOAPAction al dominio actual:
<cross-domain-policy> <allow-http-request-headers-from domain="*" headers="SOAPAction"/> </cross-domain-policy>
Si la sentencia allow-http-request-headers-from se encuentra en el archivo maestro de poltica, se aplicar a todos los directorios del host. De lo contrario, slo se aplicar al directorio y los subdirectorios del archivo de poltica que contiene la sentencia.
Si utiliza el mtodo Loader.load(), establezca la propiedad checkPolicyFile del parmetro context, que es un
objeto LoaderContext.
Si incorpora una imagen en un campo de texto mediante la etiqueta <img>, establezca el atributo
checkPolicyFile de la etiqueta <img> en "true", como en el siguiente ejemplo: <img checkPolicyFile = "true" src = "example.jpg">
Si utiliza el mtodo Sound.load(), establezca la propiedad checkPolicyFile del parmetro context, que es un
objeto SoundLoaderContext.
1073
Reutilizacin de scripts entre archivos SWF (consulte Reutilizacin de scripts en la pgina 1080) Acceso a la lista de visualizacin (consulte Recorrido de la lista de visualizacin en la pgina 1083) Deteccin de eventos (consulte Seguridad de eventos en la pgina 1083) Acceso completo a las propiedades y mtodos del objeto Stage (consulte Seguridad del objeto Stage en la
pgina 1082) El principal objetivo de llamar al mtodo Security.allowDomain() es conceder permiso para que los archivos SWF de un dominio exterior puedan manipular mediante script el archivo SWF, a travs de una llamada al mtodo Security.allowDomain(). Para obtener ms informacin, consulte Reutilizacin de scripts en la pgina 1080. Cuando se especifica una direccin IP como parmetro en el mtodo Security.allowDomain(), no se permite el acceso de todas las partes que tienen su origen en la direccin IP especificada. Slo se permite el acceso de la parte que contiene la direccin IP especificada en su URL, y no un nombre de dominio que corresponda a la direccin IP. Por ejemplo, si el nombre de dominio www.example.com corresponde a la direccin IP 192.0.34.166, una llamada a Security.allowDomain("192.0.34.166") no concede el acceso a www.example.com. Se puede pasar el comodn "*" al mtodo Security.allowDomain() para permitir el acceso desde todos los dominios. Como se concede permiso a los archivos SWF de todos los dominios para que manipulen mediante script el archivo SWF que realiza la llamada, se debe utilizar el comodn "*" con precaucin. ActionScript incluye una segunda API de permiso, denominada Security.allowInsecureDomain(). Este mtodo realiza lo mismo que el mtodo Security.allowDomain() y adems, cuando se llama desde un archivo SWF que se encuentra disponible en una conexin HTTPS segura, permite el acceso al archivo SWF que realiza la llamada por parte de otros archivos SWF que se encuentran disponibles en un protocolo no seguro, como HTTP. Sin embargo, no es seguro permitir la reutilizacin de scripts entre archivos desde un protocolo seguro (HTTPS) y desde protocolos no seguros (como HTTP); si se permite, se deja el contenido seguro expuesto a posibles ataques de fisgones y suplantadores. Este es el modo en que pueden funcionar estos ataques: como el mtodo Security.allowInsecureDomain() permite que los archivos SWF proporcionados a travs de conexiones HTTP puedan acceder a los datos de HTTPS seguro, un atacante interpuesto entre el servidor HTTP y los usuarios podra sustituir el archivo SWF de HTTP por uno propio y acceder as a los datos HTTPS. Importante: no se permite que el cdigo que se ejecuta en el entorno limitado de la aplicacin de AIR llame a los mtodos allowDomain() o allowInsecureDomain() de la clase Security.
1074
Otro mtodo importante relacionado con la seguridad es el mtodo Security.loadPolicyFile(), que hace que Flash Player compruebe si hay un archivo de poltica en una ubicacin no estndar. Para obtener ms informacin, consulte Controles de sitio web (archivos de poltica) en la pgina 1069.
Puertos bloqueados
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior Flash Player y Adobe AIR, al igual que los navegadores, tienen restricciones para el acceso HTTP a determinados puertos. No se permiten las peticiones HTTP a determinados puertos estndar que se utilizan tradicionalmente para tipos de servidores que no son HTTP. Las API que acceden a una URL de red estn sujetas a estas restricciones de bloqueo de puertos. La nica excepcin son las API que llaman directamente a sockets, como Socket.connect() y XMLSocket.connect(), o las llamadas a Security.loadPolicyFile(), donde se carga un archivo de poltica de socket. Las conexiones de socket se permiten o deniegan a travs del uso de archivos de poltica de socket en el servidor de destino. La lista siguiente muestra las API de ActionScript 3.0 donde se aplica el bloqueo de puertos:
FileReference.download(),FileReference.upload(), Loader.load(), Loader.loadBytes(), navigateToURL(), NetConnection.call(), NetConnection.connect(), NetStream.play(), Security.loadPolicyFile(), sendToURL(), Sound.load(), URLLoader.load(), URLStream.load()
El bloqueo de puertos tambin se aplica a la importacin de biblioteca compartida, al uso de la etiqueta <img> en campos de texto y a la carga de archivos SWF en pginas HTML a travs de las etiquetas <object> y <embed>. El bloqueo de puertos tambin se aplica al uso de la etiqueta <img> en campos de texto y a la carga de archivos SWF en pginas HTML a travs de las etiquetas <object> y <embed>. Las listas siguientes muestran los puertos que estn bloqueados: HTTP: 20 (datos ftp), 21 (control ftp) HTTP y FTP: 1 (tcpmux), 7 (echo), 9 (discard), 11 (systat), 13 (daytime), 15 (netstat), 17 (qotd), 19 (chargen), 22 (ssh), 23 (telnet), 25 (smtp), 37 (time), 42 (name), 43 (nicname), 53 (domain), 77 (priv-rjs), 79 (finger), 87 (ttylink), 95 (supdup), 101 (hostriame), 102 (iso-tsap), 103 (gppitnp), 104 (acr-nema), 109 (pop2), 110 (pop3), 111 (sunrpc), 113 (auth), 115 (sftp), 117 (uucp-path), 119 (nntp), 123 (ntp), 135 (loc-srv / epmap), 139 (netbios), 143 (imap2), 179 (bgp), 389 (ldap), 465 (smtp+ssl), 512 (print / exec), 513 (login), 514 (shell), 515 (printer), 526 (tempo), 530 (courier), 531 (chat), 532 (netnews), 540 (uucp), 556 (remotefs), 563 (nntp+ssl), 587 (smtp), 601 (syslog), 636 (ldap+ssl), 993 (ldap+ssl), 995 (pop3+ssl), 2049 (nfs), 4045 (lockd), 6000 (x11)
1075
"all" (valor predeterminado): se admiten todas las API de red en el archivo SWF. "internal": el archivo SWF no puede llamar a las API de navegacin o de interaccin con el navegador que se
El parmetro allowNetworking se ha diseado principalmente para los casos en los que el archivo SWF y la pgina HTML que lo incluye pertenecen a dominios diferentes. No se recomienda el uso del valor de "internal" ni "none" cuando el archivo SWF que se carga pertenece al mismo dominio que las pginas HTML que lo incluyen, porque no se puede garantizar que un archivo SWF se cargue siempre con la pgina HTML deseada. Las partes que no son de confianza podran cargar un archivo SWF de su dominio sin ninguna pgina HTML que lo incluya, en cuyo caso la restriccin allowNetworking no funcionar del modo esperado. Al llamar a una API no permitida, se emite una excepcin SecurityError. Aada el parmetro allowNetworking y establezca su valor en las etiquetas <object> y <embed> de la pgina HTML que contiene una referencia al archivo SWF, como se muestra en el ejemplo siguiente:
<object classic="clsid:d27cdb6e-ae6d-11cf-96b8-444553540000" Code base="http://fpdownload.macromedia.com/pub/shockwave/cabs/flash/swflash.cab#version=9,0,124, 0" width="600" height="400" ID="test" align="middle"> <param name="allowNetworking" value="none" /> <param name="movie" value="test.swf" /> <param name="bgcolor" value="#333333" /> <embed src="test.swf" allowNetworking="none" bgcolor="#333333" width="600" height="400" name="test" align="middle" type="application/x-shockwave-flash" pluginspage="http://www.macromedia.com/go/getflashplayer" /> </object>
Una pgina HTML tambin puede utilizar un script para generar etiquetas que incorporan SWF. Necesita alterar el script para que inserte el valor allowNetworking adecuado. Las pginas HTML generadas por Adobe Flash Professional y Adobe Flash Builder utilizan la funcin AC_FL_RunContent() para incorporar referencias a archivos SWF. Aada la configuracin del parmetro allowNetworking al script, como en el siguiente ejemplo:
AC_FL_RunContent( ... "allowNetworking", "none", ...)
Adems de las API anteriores, no se admiten las siguientes API cuando allowNetworking se establece en "none":
1076
sendToURL(), FileReference.download(), FileReference.upload(), Loader.load(), LocalConnection.connect(), LocalConnection.send(), NetConnection.connect(), NetStream.play(), Security.loadPolicyFile(), SharedObject.getLocal(), SharedObject.getRemote(), Socket.connect(), Sound.load(), URLLoader.load(), URLStream.load(), XMLSocket.connect()
Aunque la configuracin de allowNetworking seleccionada permita a un archivo SWF usar una API de red, puede haber otras restricciones basadas en las limitaciones de un entorno limitado de seguridad (consulte Entornos limitados de seguridad en la pgina 1061). Cuando allowNetworking se establece en "none", no se puede hacer referencia a medios externos en una etiqueta <img> en la propiedad htmlText de un objeto TextField (se emite una excepcin SecurityError). Si se establece allowNetworking en "none", un smbolo de una biblioteca compartida importada aadido en la herramienta de edicin Flash (no mediante ActionScript) se bloquear en tiempo de ejecucin.
Una pgina HTML tambin puede utilizar un script para generar etiquetas que incorporan SWF. Es necesario modificar el script para insertar la configuracin adecuada de allowFullScreen. Las pginas HTML generadas por Flash Professional y Flex Builder utilizan la funcin AC_FL_RunContent() para incorporar referencias a archivos SWF y es necesario aadir la configuracin del parmetro allowFullScreen al script, como en el siguiente ejemplo:
AC_FL_RunContent( ... "allowFullScreen", "true", ...)
El cdigo ActionScript que inicia el modo de pantalla completa slo puede llamarse como respuesta a un evento de ratn o de teclado. Si se llama en otras situaciones, Flash Player emite una excepcin.
1077
Cuando se entra en el modo de pantalla completa, aparece un mensaje que indica al usuario cmo puede salir y volver al modo normal. El mensaje aparece durante unos segundos y luego desaparece progresivamente. Para el contenido que se est ejecutando en un navegador, el uso del teclado se limita al modo de pantalla completa. En Flash Player 9, slo se admiten los mtodos abreviados de teclado que devuelven la aplicacin a modo normal como, por ejemplo, presionar la tecla Esc. Los usuarios no pueden introducir texto en los campos de texto ni desplazarse por la pantalla. En Flash Player 10 y versiones posteriores, se admiten determinadas teclas que no afectan a la impresin (concretamente, las teclas de flecha, la barra espaciadora y el tabulador). Sin embargo, la entrada de texto an est prohibida. El modo de pantalla completa siempre se permite en el reproductor autnomo o en un archivo de proyector. Asimismo, el uso del teclado (incluyendo la entrada de texto) es totalmente compatible en estos entornos. Al llamar a la propiedad displayState de un objeto Stage, se emite una excepcin para cualquier origen de llamada que no est en el mismo entorno limitado de seguridad que el propietario del objeto Stage (el archivo SWF principal). Para obtener ms informacin, consulte Seguridad del objeto Stage en la pgina 1082. Los administradores pueden desactivar el modo de pantalla completa en los archivos SWF que se ejecutan en navegadores. Para ello, deben establecer FullScreenDisable = 1 en el archivo mms.cfg. Para obtener informacin ms detallada, consulte Controles de administrador en la pgina 1066. En un navegador, un archivo SWF debe estar contenido en una pgina HTML para poder verlo en el modo de pantalla completa.
Carga de contenido
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior El contenido de Flash Player y AIR puede cargar distintos tipos de contenido, incluyendo los siguientes:
Archivos SWF Imgenes Sonido Vdeo Archivos HTML (slo AIR) JavaScript (slo AIR)
1078
Al cargar un archivo SWF de un origen que no es de confianza (por ejemplo, un dominio distinto al del archivo SWF raz del objeto Loader), es aconsejable definir una mscara para el objeto Loader para evitar que el contenido cargado (que es un elemento secundario del objeto Loader) se dibuje en partes del escenario situadas fuera de la mscara, como se muestra en el siguiente cdigo:
import flash.display.*; import flash.net.URLRequest; var rect:Shape = new Shape(); rect.graphics.beginFill(0xFFFFFF); rect.graphics.drawRect(0, 0, 100, 100); addChild(rect); var ldr:Loader = new Loader(); ldr.mask = rect; var url:String = "http://www.unknown.example.com/content.swf"; var urlReq:URLRequest = new URLRequest(url); ldr.load(urlReq); addChild(ldr);
Cuando se llama al mtodo load() del objeto Loader, se puede especificar un parmetro context, que es un objeto LoaderContext. La clase LoaderContext incluye tres propiedades que permiten definir el contexto de uso del contenido cargado:
checkPolicyFile: utilice esta propiedad slo para cargar un archivo de imagen (no un archivo SWF). Esta
propiedad se especifica en un archivo de imagen de un dominio ajeno al del archivo que contiene el objeto Loader. Si establece esta propiedad en true, Loader comprueba el servidor de origen de un archivo de poltica URL (consulte Controles de sitio web (archivos de poltica) en la pgina 1069). Si el servidor concede permiso al dominio de Loader, el cdigo ActionScript de los archivos SWF del dominio de Loader puede acceder a los datos de la imagen cargada. Dicho de otro modo, se puede utilizar la propiedad Loader.content para obtener una referencia al objeto Bitmap que representa la imagen cargada o el mtodo BitmapData.draw() para acceder a los pxeles de la imagen cargada.
securityDomain: utilice esta propiedad slo si carga un archivo SWF (no una imagen). Esta propiedad se
especifica en un archivo SWF de un dominio ajeno al del archivo que contiene el objeto Loader. Actualmente, la propiedad securityDomain slo admite dos valores: null (el valor predeterminado) y SecurityDomain.currentDomain. Si se especifica SecurityDomain.currentDomain, el archivo SWF cargado debe importarse en el entorno limitado del objeto SWF que realiza la carga, lo que significa que funciona como si se hubiera cargado del servidor del archivo SWF que realiza la carga. Esto slo se permite si se encuentra un archivo de poltica URL en el servidor del archivo SWF cargado que permita el acceso por parte del dominio del archivo SWF que realiza la carga. Si se encuentra el archivo de poltica necesario, el cargador y el contenido cargado pueden manipularse mutuamente mediante script en cuanto se inicia la carga, ya que se encuentran en el mismo entorno limitado. El entorno limitado donde se importa el archivo puede sustituirse a travs de una carga normal, seguida de una llamada del archivo SWF cargado al mtodo Security.allowDomain(). Es posible que este ltimo mtodo sea ms sencillo, pues el archivo SWF cargado estar entonces en su entorno limitado natural y, por lo tanto, podr acceder a los recursos de su propio servidor real.
applicationDomain: utilice esta propiedad solamente si carga un archivo SWF escrito en ActionScript 3.0 (no una imagen ni un archivo SWF escritos en ActionScript 1.0 2.0). Al cargar el archivo, puede especificar que se incluya el archivo en un dominio de aplicacin concreto y no en un nuevo dominio de aplicacin que sea un elemento secundario del dominio de aplicacin del archivo SWF que realiza la carga, que es lo que sucede de forma predeterminada. Tenga en cuenta que los dominios de aplicacin son subunidades de los dominios de seguridad y, por lo tanto, puede especificar un dominio de aplicacin de destino nicamente si el archivo SWF que est cargando
1079
procede de su propio dominio de seguridad, ya sea porque corresponde a su servidor propio o porque lo ha importado en su dominio de seguridad a travs de la propiedad securityDomain. Si especifica un dominio de aplicacin pero el archivo SWF cargado forma parte de un dominio de seguridad distinto, el dominio especificado en applicationDomain se omite. Para obtener ms informacin, consulte Trabajo con dominios de aplicacin en la pgina 142. Para obtener ms detalles, consulte Especificacin del contexto de carga en la pgina 198. Una propiedad importante de un objeto Loader es contentLoaderInfo, que es un objeto LoaderInfo. A diferencia de lo que ocurre con la mayora de los objetos, un objeto LoaderInfo se comparte entre el archivo SWF que realiza la carga y el contenido cargado, y siempre es accesible para ambas partes. Cuando el contenido cargado es un archivo SWF, ste puede acceder al objeto LoaderInfo a travs de la propiedad DisplayObject.loaderInfo. Los objetos LoaderInfo contienen informacin como el progreso de carga, los URL del cargador y del contenido cargado, o la relacin de confianza entre ambos. Para obtener ms informacin, consulte Supervisin del progreso de carga en la pgina 196.
Para acceder al contenido cargado de este modo, puede utilizar el mtodo getImageReference() de la instancia de TextField, como se muestra en el cdigo siguiente:
var loadedObject:DisplayObject = myTextField.getImageReference('instanceName');
Sin embargo, tenga en cuenta que los archivos SWF e imgenes que se cargan de este modo se incluyen en el entorno limitado correspondiente a su origen. Si se carga un archivo de imagen mediante una etiqueta <img> en un campo de texto, puede ser que haya un archivo de poltica URL que permita el acceso a datos de la imagen. Para comprobar si hay un archivo de poltica, aada un atributo checkPolicyFile a la etiqueta <img>, como se muestra en el cdigo siguiente:
<img src = 'filename.jpg' checkPolicyFile = 'true' id = 'instanceName' >
1080
Si carga un archivo SWF mediante una etiqueta <img> en un campo de texto, puede permitir el acceso a los datos de dicho archivo SWF a travs de una llamada al mtodo Security.allowDomain(). Si utiliza una etiqueta <img> en un campo de texto para cargar un archivo externo (en lugar de usar una clase Bitmap incorporada en el archivo SWF), se crea automticamente un objeto Loader como elemento secundario del objeto TextField y el archivo externo se carga en dicho objeto Loader, tal y como sucedera si hubiera utilizado un objeto Loader en ActionScript para cargar el archivo. En este caso, el mtodo getImageReference() devuelve el objeto Loader que se cre automticamente. No es necesario realizar ninguna comprobacin de seguridad para acceder a este objeto Loader porque se encuentra en el mismo entorno limitado de seguridad que el cdigo que realiza la llamada. Sin embargo, si se hace referencia a la propiedad content del objeto Loader para acceder al medio cargado, s es preciso aplicar las reglas de seguridad. Si el contenido es una imagen, deber implementar un archivo de poltica URL y, si es un archivo SWF, deber hacer que el cdigo del archivo SWF llame al mtodo allowDomain(). Adobe AIR En el entorno limitado de la aplicacin, las etiquetas <img> de un campo de texto se omiten para evitar ataques de suplantacin de identidad. Asimismo, no se permite que el cdigo que se ejecuta en el entorno limitado de la aplicacin llame al mtodo allowDomain() de Security.
Reutilizacin de scripts
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior Si hay dos archivos escritos en ActionScript 3.0 o dos archivos HTML que se ejecutan en el mismo dominio (por ejemplo, el URL de un archivo SWF es http://www.example.com/swfA.swf y el URL del otro es http://www.example.com/swfB.swf), el cdigo definido en un archivo puede examinar y modificar las variables, objetos, propiedades, mtodos, etc. en el otro archivo y viceversa. Esto se denomina reutilizacin de scripts.
1081
Si dos archivos proceden de diferentes dominios como, por ejemplo, http://siteA.com/swfA.swf y http://siteB.com/swfB.swf, de forma predeterminada, Flash Player y AIR no permiten que swfA.swf determine swfB.swf, ni que swfB.swf determine swfA.swf. Un archivo SWF concede permiso a archivos SWF de otros dominios llamando a Security.allowDomain(). Si se llama a Security.allowDomain("siteA.com"), swfB.swf concede permiso a los archivos SWF de siteA.com para utilizarlo en scripts. La reutilizacin de scripts no se permite entre archivos SWF AVM1 y archivos SWF AVM2. Un archivo SWF AVM1 es aqul que se crea en ActionScript 1.0 o ActionScript 2.0. (AVM1 y AVM2 se refieren a la mquina virtual ActionScript.) Sin embargo, es posible utilizar la clase LocalConnection para enviar datos entre AVM1 y AVM2. En cualquier operacin entre dominios es importante tener claro qu dos partes estn involucradas. En esta seccin, llamaremos parte que accede a la que lleva a cabo la reutilizacin de scripts (normalmente el archivo SWF que accede a otro) y parte a la que se accede a la otra (por lo general, el archivo SWF al que se accede). Si siteA.swf usa scripts en siteB.swf, siteA.swf ser la parte que accede y siteB.swf ser la parte a la que se accede, tal y como se indica en la siguiente ilustracin:
Los permisos entre dominios establecidos con el mtodo Security.allowDomain() son asimtricos. En el ejemplo anterior, siteA.swf puede manipular mediante script a siteB.swf, pero siteB.swf no puede hacerlo con siteA.swf, ya que siteA.swf no ha llamado al mtodo Security.allowDomain() para dar permiso a los archivos SWF de siteB.com para manipularlo mediante script. Para configurar permisos simtricos, es necesario que ambos archivos SWF llamen al mtodo Security.allowDomain(). Flash Player protege los archivos SWF no slo de los scripts creados en varios dominios por otros archivos SWF, sino tambin de los originados por archivos HTML. El uso de scripts de HTML en SWF puede producirse mediante funciones callback establecidas a travs del mtodo ExternalInterface.addCallback(). Cuando el uso de scripts de HTML en SWF traspasa los dominios, el archivo SWF debe llamar al mtodo Security.allowDomain() para evitar que la operacin falle, tanto si es la parte que accede como si es la parte a la que se accede. Para obtener ms informacin, consulte Controles de autor (desarrollador) en la pgina 1073. Adems, Flash Player proporciona controles de seguridad para el uso de scripts de SWF en HTML. Para obtener ms informacin, consulte Control del acceso URL saliente en la pgina 1091.
1082
Mtodos
addChild() addChildAt() addEventListener() dispatchEvent() hasEventListener() setChildIndex() willTrigger()
displayState frameRate
height mouseChildren numChildren quality scaleMode showDefaultContextMenu stageFocusRect stageHeight stageWidth tabChildren textSnapshot width
Para que un archivo SWF de un entorno limitado ajeno al del propietario de Stage pueda acceder a estas propiedades y mtodos, el archivo SWF del propietario de Stage debe llamar al mtodo Security.allowDomain() para permitir el dominio del entorno limitado externo. Para obtener ms informacin, consulte Controles de autor (desarrollador) en la pgina 1073. La propiedad frameRate es especial, ya que cualquier archivo SWF puede leerla. Sin embargo, slo pueden cambiar la propiedad los archivos que se encuentran en el entorno limitado de seguridad del propietario de Stage (o los que han obtenido permiso a travs de una llamada al mtodo Security.allowDomain()). Tambin hay restricciones relativas a los mtodos removeChildAt() y swapChildrenAt() del objeto Stage, pero son distintas a las dems restricciones. En lugar de tener que estar en el mismo dominio que el propietario de Stage, para llamar a estos mtodos, el cdigo debe estar en el mismo dominio que el propietario de los objetos secundarios afectados, o bien los objetos secundarios pueden llamar al mtodo Security.allowDomain().
1083
Seguridad de eventos
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior Los eventos relacionados con la lista de visualizacin tienen limitaciones de acceso de seguridad que dependen del entorno limitado donde se encuentre el objeto de visualizacin que distribuye el evento. Un evento de la lista de visualizacin tiene fases de propagacin y captura (descritas en Gestin de eventos en la pgina 119). Durante las fases de propagacin y captura, un evento migra del objeto de visualizacin de origen a travs de los objetos de visualizacin principales en la lista de visualizacin. Si un objeto principal se encuentra en un entorno limitado de seguridad distinto al del objeto de visualizacin de origen, la fase de captura y propagacin se detiene debajo de dicho objeto principal, a menos que exista una confianza mutua entre el propietario del objeto principal y el propietario del objeto de origen. Esta confianza mutua se obtiene del siguiente modo:
1 El archivo SWF propietario del objeto principal debe llamar al mtodo Security.allowDomain() para confiar en
el dominio del archivo SWF propietario del objeto principal. El objeto LoaderInfo correspondiente a un archivo cargado (y al objeto Loader) contiene las dos propiedades siguientes, que definen la relacin entre el objeto cargado y el objeto Loader: childAllowsParent y parentAllowsChild. En los eventos distribuidos desde objetos que no sean objetos de visualizacin, no se realizan comprobaciones de seguridad.
1084
En el contenido que procesa o reproduce los datos a los que se va a acceder, llame al mtodo
Security.allowDomain() para permitir el acceso a los datos al contenido del resto de dominios.
En una imagen, sonido o vdeo cargado, aada un archivo de poltica URL en el servidor del archivo cargado. Este
archivo de poltica debe conceder acceso al dominio del archivo SWF que intenta llamar a los mtodos BitmapData.draw() o SoundMixer.computeSpectrum() para extraer datos del archivo. En las siguientes secciones se proporcionan detalles sobre el acceso a datos de mapa de bits, sonido y vdeo.
En el caso de un objeto de origen que no sea un mapa de bits cargado, el objeto de origen y (en el caso de un objeto
Sprite o MovieClip) todos sus objetos secundarios deben proceder del mismo dominio que el objeto que realiza la llamada al mtodo draw(), o bien deben incluirse en un archivo SWF que sea accesible para el llamador mediante una llamada al mtodo Security.allowDomain().
En el caso de un objeto de origen de mapa de bits cargado, el objeto de origen debe proceder del mismo dominio
que el objeto que realiza la llamada al mtodo draw() o su servidor de origen debe incluir un archivo de poltica URL que conceda permiso al dominio que realiza la llamada. Si no se cumplen estas condiciones, se emite una excepcin SecurityError. Cuando se carga una imagen mediante el mtodo load() de la clase Loader, se puede especificar un parmetro context, que es un objeto LoaderContext. Si se establece la propiedad checkPolicyFile del objeto LoaderContext en true, Flash Player comprueba si hay un archivo de poltica entre dominios en el servidor desde el cual se carga la imagen. Si hay un archivo de poltica y ste admite el dominio del archivo SWF que realiza la carga, el archivo podr acceder a los datos del objeto Bitmap; en caso contrario, se denegar el acceso. Tambin se puede especificar una propiedad checkPolicyFile en una imagen cargada a travs de una etiqueta <img> en un campo de texto. Para obtener informacin ms detallada, consulte Carga de archivos SWF e imgenes mediante la etiqueta <img> de un campo de texto en la pgina 1079.
1085
El mtodo SoundMixer.stopAll(): siempre se permite en el cdigo que se ejecuta en el mismo entorno limitado
de seguridad que el archivo de sonido. Para los archivos de otros entornos limitados existen comprobaciones de seguridad.
La propiedad id3 de la clase Sound: siempre se permite en archivos SWF que se encuentran en el mismo entorno
limitado de seguridad que el archivo de sonido. Para el cdigo de otros entornos limitados existen comprobaciones de seguridad. Cada sonido tiene dos tipos de entornos limitados asociados, que son un entorno limitado de contenido y un entorno limitado de propietario:
El dominio de origen del sonido determina el entorno limitado de contenido que, a su vez, determina si los datos
pueden extraerse del sonido a travs de la propiedad id3 del sonido y a travs del mtodo SoundMixer.computeSpectrum().
El objeto que inici el sonido que se reproduce determina el entorno limitado de propietario que, a su vez,
determina si el sonido puede detenerse a travs del mtodo SoundMixer.stopAll(). Cuando se carga el sonido mediante el mtodo load() de la clase Sound, se puede especificar un parmetro context, que es un objeto SoundLoaderContext. Si establece la propiedad checkPolicyFile del objeto SoundLoaderContext como true, el motor de ejecucin comprobar la existencia de un archivo de poltica URL en el servidor desde el que se carga el sonido. Si hay un archivo de poltica y ste admite el dominio del cdigo que realiza la carga, el cdigo podr acceder a la propiedad id del objeto Sound; en caso contrario, no ser posible. Adems, si se establece un valor de la propiedad checkPolicyFile, se puede activar el mtodo SoundMixer.computeSpectrum() para sonidos cargados. Se puede utilizar el mtodo SoundMixer.areSoundsInaccessible() para saber si una llamada al mtodo SoundMixer.stopAll() no va a detener todos los sonidos porque el que realiza la llamada no puede acceder al entorno limitado de uno o varios propietarios de sonidos. Llamar al mtodo SoundMixer.stopAll() permite detener estos sonidos cuyo entorno limitado de propietario es el mismo que el que realiza la llamada a stopAll(). Tambin detiene los sonidos que han empezado a reproducirse porque unos archivos SWF realizaron una llamada al mtodo Security.allowDomain() para permitir el acceso por parte del dominio del archivo SWF que realiza la llamada al mtodo stopAll(). Los dems sonidos no se detienen y su presencia puede revelarse mediante una llamada al mtodo SoundMixer.areSoundsInaccessible(). Para llamar al mtodo computeSpectrum(), es necesario que cada sonido que se est reproduciendo se encuentre en el mismo entorno limitado que el objeto que realiza la llamada al mtodo o que proceda de un origen que haya concedido permiso al entorno limitado del que realiza la llamada; en caso contrario, se emite una excepcin SecurityError. En el caso de los sonidos cargados desde sonidos incorporados en una biblioteca de un archivo SWF, el permiso se concede a travs de una llamada al mtodo Security.allowDomain() en el archivo SWF cargado. En el caso de los sonidos que no proceden de archivos SWF (procedentes de archivos MP3 cargados o archivos de vdeo) un archivo de poltica URL en el servidor de origen concede acceso a los datos de los medios cargados. Para obtener ms informacin, consulte Controles de autor (desarrollador) en la pgina 1073 y Controles de sitio web (archivos de poltica) en la pgina 1069.
1086
Para acceder a datos de sonido desde flujos RTMP, debe permitir el acceso en el servidor. Utilice la propiedad Client.audioSampleAccess de ActionScript de servidor para permitir acceso a directorios especficos de Flash Media Server. Para obtener ms informacin, consulte la referencia del lenguaje ActionScript de Flash Media Server.
Transmisin de vdeo en RTMP desde Flash Media Server Vdeo progresivo, que se carga desde un archivo FLV o F4V
Para utilizar el mtodo BitmapData.draw() y extraer grficos de flujos RTMP en tiempo de ejecucin, debe permitir el acceso en el servidor. Utilice la propiedad Client.videoSampleAccess de ActionScript de servidor para permitir el acceso a directorios especficos de Flash Media Server. Para obtener ms informacin, consulte la referencia del lenguaje ActionScript de Flash Media Server. Cuando se llama al mtodo BitmapData.draw() con vdeo progresivo como valor del parmetro source, el que realiza la llamada a BitmapData.draw() debe encontrarse en el mismo entorno limitado que el archivo FLV, o el servidor del archivo FLV debe tener un archivo de poltica que conceda permiso al dominio del archivo SWF que realiza la llamada. Para solicitar la descarga del archivo de poltica, debe establecerse la propiedad checkPolicyFile del objeto NetStream en true.
Carga de datos
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior El contenido de Flash Player y de AIR puede intercambiar datos con servidores. La carga de datos es una operacin distinta de la carga de medios, ya que la informacin cargada aparece directamente como objetos de programacin en lugar de mostrarse como medios. Generalmente, el contenido puede cargar datos desde el mismo dominio que el que los origin. No obstante, el contenido requerir archivos de poltica para cargar datos desde otros dominios (consulte Controles de sitio web (archivos de poltica) en la pgina 1069). Nota: el contenido que se ejecuta en el entorno limitado de la aplicacin de AIR nunca se sirve desde un dominio remoto (a no ser que el desarrollador importe intencionadamente contenido remoto en el entorno limitado de la aplicacin), por lo que no puede participar en este tipo de ataques que quedan protegidos por los archivos de poltica. El contenido de AIR en el entorno limitado de la aplicacin no est limitado a la carga de datos en sus archivos de poltica. Sin embargo, el contenido de AIR en otros entornos limitados est sujeto a las limitaciones aqu descritas.
1087
Si utiliza el mtodo load() para cargar contenido desde un dominio distinto al dominio desde el cual llama el mtodo, el motor de ejecucin busca un archivo de poltica en el servidor de los activos cargados. Si hay un archivo de poltica y concede acceso al dominio del contenido que realiza la carga, se pueden cargar los datos.
Conexin a sockets
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior De forma predeterminada, el motor de ejecucin busca un archivo de poltica de socket disponible en el puerto 843. Tal y como sucede con los archivos de poltica URL, este archivo se denominaarchivo maestro de poltica. Cuando se introdujeron por primera vez los archivos de poltica en Flash Player 6, no se admitan los archivos de poltica de socket. Las conexiones a servidores de socket se autorizaban a travs de un archivo de poltica desde la ubicacin predeterminada en un servidor HTTP del puerto 80 del mismo host que el servidor de socket. Flash Player 9 todava admite esta capacidad, pero Flash Player 10 no. En Flash Player 10, slo los archivos de poltica de socket pueden autorizar las conexiones de socket. Al igual que los archivos de poltica URL, los archivos de poltica de socket admiten una sentencia de metapoltica que especifica los puertos que pueden servir los archivos de poltica. Sin embargo, en lugar de master-only, la metapoltica predeterminada de los archivos de poltica de socket es all. Es decir, a no ser que el archivo maestro de poltica especifique una configuracin ms restrictiva, Flash Player asumir que cualquier socket del host puede servir un archivo de poltica de socket. De forma predeterminada, el acceso a conexiones de socket y socket XML est desactivado, incluso si el socket al que se conecta se encuentra en el dominio al que pertenece el archivo SWF. El acceso a nivel de socket es posible si se sirve un archivo de poltica de socket desde cualquiera de las ubicaciones siguientes:
Puerto 843 (la ubicacin del archivo maestro de poltica) El mismo puerto que la conexin de socket principal un puerto diferente a la conexin de socket principal
De forma predeterminada, Flash Player busca un archivo de poltica de socket en el puerto 843 y en el mismo puerto que utiliza la conexin de socket principal. Para servir un archivo de poltica de socket desde un puerto diferente, el archivo SWF debe llamar a Security.loadPolicyFile(). Los archivos de poltica de socket presentan la misma sintaxis que los archivos de poltica URL, salvo por el hecho de que tambin deben especificar los puertos a los que concede acceso. Cuando un archivo de poltica de socket procede de un nmero de puerto inferior a 1024, dicho archivo puede conceder acceso a cualquier puerto; cuando un archivo de poltica procede del puerto 1024 o superior, slo puede conceder acceso a otros puertos 1024 y superiores. Los puertos permitidos se especifican en el atributo to-ports de la etiqueta <allow-access-from>. Se aceptan como valor los nmeros de puerto nicos, los intervalos de puertos y los comodines. A continuacin se muestra un ejemplo de un archivo de poltica de socket:
<?xml version="1.0"?> <!DOCTYPE cross-domain-policy SYSTEM "http://www.adobe.com/xml/dtds/cross-domain-policy.dtd"> <!-- Policy file for xmlsocket://socks.mysite.com --> <cross-domain-policy> <allow-access-from domain="*" to-ports="507" /> <allow-access-from domain="*.example.com" to-ports="507,516" /> <allow-access-from domain="*.example.org" to-ports="516-523" /> <allow-access-from domain="adobe.com" to-ports="507,516-523" /> <allow-access-from domain="192.0.34.166" to-ports="*" /> </cross-domain-policy>
1088
Para recuperar un archivo de poltica de socket del puerto 843 o del mismo puerto que utiliza la conexin de socket principal, llame al mtodo Socket.connect() o XMLSocket.connect(). Flash Player comprueba en primer lugar la presencia del archivo maestro de poltica en el puerto 843. Si encuentra alguno, comprobar si ste contiene una sentencia de metapoltica que prohba los archivos de poltica de socket en el puerto de destino. Si el acceso no est prohibido, Flash Player buscar en primer lugar la sentencia allow-access-from en el archivo maestro de poltica. Si no encuentra ninguno, entonces buscar un archivo de poltica de socket en el mismo puerto que utiliza la conexin de socket principal. Para recuperar un archivo de poltica de socket de una ubicacin diferente, primero llame al mtodo
Security.loadPolicyFile() con la sintaxis especial "xmlsocket", como en el ejemplo siguiente: Security.loadPolicyFile("xmlsocket://server.com:2525");
Llame al mtodo Security.loadPolicyFile() antes de llamar al mtodo Socket.connect() o XMLSocket.connect(). Flash Player espera entonces hasta completar la solicitud del archivo de poltica antes de decidir si permite o no la conexin principal. Sin embargo, si el archivo maestro de poltica especifica que la ubicacin de de destino no puede servir archivos de poltica, la llamada a loadPolicyFile() no ser efectiva, incluso si hay un archivo de poltica en dicha ubicacin. Si se implementa un servidor de socket y se necesita proporcionar un archivo de poltica de socket, se debe decidir entre proporcionar el archivo de poltica a travs del mismo puerto que acepta conexiones principales o utilizar otro puerto. En cualquier caso, para poder enviar una respuesta, el servidor deber esperar a la primera transmisin de su cliente. Cuando Flash Player solicita un archivo de poltica, siempre transmite la siguiente cadena en cuanto se establece una conexin:
<policy-file-request/>
Cuando el servidor recibe esta cadena, puede transmitir el archivo de poltica. La peticin de Flash Player siempre termina con un byte null, y la respuesta del servidor debe terminar con otro byte del mismo tipo. No cabe esperar que se pueda reutilizar la misma conexin para una solicitud de archivo de poltica y una conexin principal; cierre la conexin despus de transmitir el archivo de poltica. De lo contrario, Flash Player cierra la conexin del archivo de poltica antes de volver a conectar para configurar la conexin principal.
Proteccin de datos
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior Para proteger los datos frente a prdidas y modificaciones mientras viajan por Internet, puede utilizar los protocolos TLS o SSL en el servidor desde el que se originan los datos. Seguidamente, puede conectarse al servidor mediante el protocolo HTTPS. En aplicaciones creadas para AIR 2 o posterior, tambin puede proteger las comunicaciones de socket TCP. La clase SecureSocket permite iniciar una conexin de socket con un servidor de sockets que use TLS (versin 1) o SSL (versin 4).
Envo de datos
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior El envo de datos se produce cuando el cdigo enva los datos a un servidor o recursos. En envo de datos se permite siempre para el contenido de un dominio de red. Un archivo SWF local puede enviar datos a direcciones de la red nicamente si se encuentra en el entorno limitado local de confianza, en el entorno limitado local con acceso a la red o en un entorno limitado de la aplicacin de AIR. Para obtener ms informacin, consulte Entornos limitados locales en la pgina 1061.
1089
Se puede utilizar la funcin flash.net.sendToURL() para enviar datos a un URL. Otros mtodos tambin envan peticiones a URL. Algunos de estos mtodos son los mtodos de carga como Loader.load() y Sound.load(), y los mtodos de carga de datos como URLLoader.load() y URLStream.load().
1090
propiedad contentLoaderInfo del objeto Loader. Cuando se distribuye este evento, el archivo SWF cargado ha llamado al mtodo Security.allowDomain() en el mtodo constructor y las clases del archivo SWF cargado estn disponibles para el archivo SWF que realiza la carga. El archivo SWF que realiza la carga puede recuperar las clases del archivo SWF cargado a travs de una llamada a Loader.contentLoaderInfo.applicationDomain.getDefinition().
1091
En cada comunicacin LocalConnection, hay un emisor y un detector. De forma predeterminada, Flash Player permite la comunicacin de LocalConnection entre cdigo ejecutndose en el mismo dominio. En el caso de cdigo ejecutndose en distintos entornos limitados, el detector debe dar permiso al emisor a travs del mtodo LocalConnection.allowDomain(). La cadena que pase como argumento al mtodo LocalConnection.allowDomain() puede contener cualquiera de los elementos siguientes: nombres de dominio exactos, direcciones IP y el operador comodn *. El mtodo allowDomain() ha cambiado de la forma que tena en ActionScript 1.0 y 2.0. En estas versiones anteriores allowDomain() era un mtodo callback implementado por el usuario. En ActionScript 3.0, allowDomain() es un mtodo incorporado de la clase LocalConnection que puede recibir llamadas. Con este cambio, el funcionamiento de allowDomain() es muy similar al de Security.allowDomain(). Un archivo SWF puede utilizar la propiedad domain de la clase LocalConnection para determinar su dominio.
Cuando AllowScriptAccess se establece como "always", el archivo SWF se puede comunicar con la pgina
HTML que lo incorpora, incluso cuando su dominio y el de la pgina son diferentes.
Cuando AllowScriptAccess se establece como "sameDomain", el archivo SWF se puede comunicar con la pgina
HTML que lo incorpora slo cuando su dominio y el de la pgina son iguales. Este es el valor predeterminado de
AllowScriptAccess. Utilice esta configuracin, o no defina un valor para AllowScriptAccess, para evitar que
un archivo SWF alojado en un dominio acceda a un script de una pgina HTML perteneciente a otro dominio.
1092
Cuando AllowScriptAccess se establece como "never", el archivo SWF no se puede comunicar con ninguna
pgina HTML. El uso de este valor se ha desfasado desde la versin de Adobe Flash CS4 Professional. No se recomienda y no debe ser necesario si no se proporcionan archivos SWF que no son de confianza desde su propio dominio. Si es preciso servir archivos SWF que no sean de confianza, Adobe recomienda crear un subdominio independiente y colocar en l todo ese contenido. Este es un ejemplo de configuracin de la etiqueta AllowScriptAccess en una pgina HTML para permitir el acceso URL saliente a un dominio diferente:
<object id='MyMovie.swf' classid='clsid:D27CDB6E-AE6D-11cf-96B8-444553540000' codebase='http://download.adobe.com/pub/shockwave/cabs/flash/swflash.cab#version=9,0,0,0' height='100%' width='100%'> <param name='AllowScriptAccess' value='always'/> <param name='src' value=''MyMovie.swf'/> <embed name='MyMovie.swf' pluginspage='http://www.adobe.com/go/getflashplayer' src='MyMovie.swf' height='100%' width='100%' AllowScriptAccess='never'/> </object>
Si el archivo SWF es un archivo de confianza local, la solicitud funcionar correctamente. Si el destino es la pgina HTML en la que se incorpora el archivo SWF, se aplicarn las reglas allowScriptAccess
descritas anteriormente.
Si el destino tiene contenido cargado del dominio al que pertenece el archivo SWF, la solicitud funcionar
correctamente.
Si el destino tiene contenido cargado de un dominio distinto al que pertenece el archivo SWF, y no se cumple
ninguna de las condiciones anteriores, la solicitud no funcionar correctamente. En el caso de las sentencias que crean scripts (como HTTP, HTTPS y mailto:), la solicitud no funcionar correctamente si se cumplen todas las condiciones siguientes:
El destino es una de las palabras clave especiales "_top" o "_parent", y el archivo SWF se encuentra en una pgina web alojada en un dominio diferente, y el archivo SWF est incorporado con un valor para allowScriptAccess que no es "always".
1093
Objetos compartidos
Flash Player 9 y posterior, Adobe AIR 1.0 y posterior Flash Player proporciona la capacidad de utilizar objetos compartidos, que son objetos de ActionScript que persisten fuera de un archivo SWF, ya sea localmente en el sistema de archivos de un usuario o remotamente en un servidor RTMP. Los objetos compartidos, al igual que otros medios de Flash Player, se dividen en entornos limitados de seguridad. Sin embargo, el modelo de entorno limitado de los objetos compartidos es algo distinto, ya que los objetos compartidos no son recursos a los que se puede tener acceso ms all de los lmites de los dominios. Por el contrario, los objetos compartidos siempre se recuperan de un almacn de objetos compartidos que es especfico del dominio de cada archivo SWF que llama a los mtodos de la clase SharedObject. Los almacenes de objetos compartidos suelen ser incluso ms especficos que los dominios de los archivos SWF: de forma predeterminada, cada archivo SWF utiliza un almacn de objetos compartidos especfico de su URL de origen completa. Para obtener ms informacin sobre los objetos compartidos, consulte Objetos compartidos en la pgina 706. Un archivo SWF puede utilizar el parmetro localPath de los mtodos SharedObject.getLocal() y SharedObject.getRemote() para usar un almacn de objetos compartidos asociado solamente a una parte de su URL. De este modo, el archivo SWF puede permitir el uso compartido con otros archivos SWF de otros URL. Incluso si se pasa el valor '/' para el parmetro localPath, se sigue designando un almacn de objetos compartidos especfico de su propio dominio. Los usuarios pueden restringir el acceso a objetos compartidos utilizando el cuadro de dilogo Configuracin de Flash Player o el Administrador de configuracin. De forma predeterminada, pueden crearse objetos compartidos de un mximo de 100 KB de datos por dominio. Los usuarios con derechos administrativos y los usuarios pueden tambin limitar la capacidad de escribir en el sistema de archivos. Para obtener ms informacin, consulte Controles de administrador en la pgina 1066 y Controles de usuario en la pgina 1068. Para especificar que un objeto compartido sea seguro, se debe establecer el valor true para el parmetro secure del mtodo SharedObject.getLocal() o del mtodo SharedObject.getRemote(). Tenga en cuenta las siguientes cuestiones relativas al parmetro secure:
Si el valor de este parmetro es true, Flash Player crea un nuevo objeto compartido seguro u obtiene una referencia
a un objeto compartido seguro existente. Slo pueden leer o escribir en este objeto compartido seguro archivos SWF enviados a travs de HTTPS que llamen a SharedObject.getLocal() con el parmetro secure definido como true.
Si el parmetro se establece en false, Flash Player crea un nuevo objeto compartido o bien obtiene una referencia
a un objeto compartido existente que pueda leerse y escribirse con archivos SWF enviados mediante conexiones que no son HTTPS.
1094
Si el archivo SWF que realiza la llamada no procede de un URL HTTPS, al especificar el valor true para el parmetro secure del mtodo SharedObject.getLocal() o del mtodo SharedObject.getRemote(), se emitir una excepcin SecurityError. La eleccin de un almacn de objetos compartidos se basa en el URL de origen de un archivo SWF. Esto es cierto incluso en las dos situaciones en las que un archivo SWF no se origina en un simple URL: carga de importacin y carga dinmica. La carga de importacin hace referencia a la situacin en la que se carga un archivo SWF con la propiedad LoaderContext.securityDomain establecida en SecurityDomain.currentDomain. En esta situacin, el archivo SWF cargado tendr un pseudoURL que empieza por el dominio del archivo SWF de carga, seguido del URL de origen real. La carga dinmica se refiere a la carga de un archivo SWF a travs del mtodo Loader.loadBytes(). En esta situacin, el archivo SWF cargado tendr un pseudoURL que empieza por el URL completo del archivo SWF que realiza la carga, seguido de un ID de entero. Tanto en la carga de importacin como en la carga dinmica, el pseudoURL de un archivo SWF puede examinarse con la propiedad LoaderInfo.url. El pseudoURL se trata del mismo modo que un URL real, en lo que se refiere a la eleccin de un almacn de objetos compartidos. Se puede especificar un parmetro localPath de objeto compartido que utilice el pseudoURL parcialmente o en su totalidad. Los usuarios y los administradores pueden optar por desactivar la utilizacin de objetos compartidos de terceros. Es la utilizacin de objetos compartidos por parte de cualquier archivo SWF que est ejecutndose en un navegador web, cuando el URL de origen de dicho archivo SWF procede de un dominio distinto al del URL que se muestra en la barra de direcciones del navegador. Los usuarios y administradores pueden optar por desactivar la utilizacin de objetos compartidos de terceros por motivos de privacidad, con el fin de evitar el seguimiento entre dominios. Para evitar esta restriccin, quiz desee asegurarse de que cualquier archivo SWF que utilice objetos compartidos slo se cargue en las estructuras de pgina HTML que garantizan que el archivo SWF procede del mismo dominio que se muestra en la barra de direcciones del navegador. Cuando se intentan utilizar objetos compartidos desde un archivo SWF de terceros y la utilizacin de objetos compartidos de terceros est desactivada, los mtodos SharedObject.getLocal() y SharedObject.getRemote() devuelven null. Para obtener ms informacin, consulte www.adobe.com/es/products/flashplayer/articles/thirdpartylso.
1095
Seguridad en AIR
Adobe AIR 1.0 y posterior
Instalacin y actualizaciones
Adobe AIR 1.0 y posterior Las aplicaciones de AIR se distribuyen mediante archivos de instalacin de AIR que utilizan la extensin air o a travs de los instaladores nativos, que usan la extensin y el formato de archivo de la plataforma nativa. Por ejemplo, el formato del archivo de instalacin nativo de Windows es un archivo EXE y para Android el formato nativo es un archivo APK. Cuando se instala Adobe AIR y se abre un archivo de instalacin de AIR, el motor de ejecucin de AIR administra el proceso de instalacin. Cuando se utiliza un instalador nativo, el sistema operativo administra el proceso de instalacin. Nota: los desarrolladores pueden especificar una versin y un nombre de aplicacin y un origen de editor, pero no se puede modificar el flujo de trabajo de instalacin de la aplicacin inicial. Esta restriccin es una ventaja para los usuarios porque todas las aplicaciones de AIR comparten un procedimiento de instalacin seguro, optimizado y coherente administrado por el motor de ejecucin. Si es necesario personalizar la aplicacin, se puede hacer cuando se ejecuta la aplicacin por primera vez.
1096
En Mac OS, para instalar una versin actualizada de una aplicacin, el usuario debe contar con adecuados privilegios del sistema para instalar en el directorio de la aplicacin. En Windows y Linux, el usuario debe disponer de privilegios de administrador. Nota: en iOS, el motor de ejecucin de AIR no se instala de forma independiente; cada aplicacin de AIR es una aplicacin de contenido propio. El motor de ejecucin se puede instalar de dos maneras: usando la funcin de instalacin integrada (instalando directamente desde un navegador web) o a travs de una instalacin manual.
Instalacin manual
Adobe AIR 1.0 y posterior Como alternativa, el usuario puede descargar e instalar manualmente el motor de ejecucin antes de abrir un archivo de AIR. Entonces el desarrollador puede distribuir un archivo de AIR mediante diferentes medios (por ejemplo, a travs de correo electrnico o un vnculo HTML en un sitio web). Cuando se abre el archivo de AIR, el motor de ejecucin comienza el proceso de instalacin de la aplicacin.
El motor de ejecucin proporciona una experiencia de instalacin coherente en todos los sistemas operativos, aun
cuando una aplicacin de AIR se instala desde un vnculo en un navegador web. La mayora de las experiencias de instalacin de las aplicaciones nativas dependen del navegador u otra aplicacin para proporcionar informacin de seguridad, si la hay.
La instalacin de la aplicacin de AIR identifica el origen de la aplicacin y la informacin sobre los privilegios
disponibles para la aplicacin (si el usuario permite continuar la instalacin).
El motor de ejecucin administra el proceso de instalacin de una aplicacin de AIR. Una aplicacin de AIR no
puede manipular el proceso de instalacin que utiliza el motor de ejecucin.
1097
En general, los usuarios no deberan instalar ninguna aplicacin de escritorio que proviene de un origen que no conocen o que no se puede verificar. La comprobacin de veracidad sobre la seguridad de las aplicaciones nativas es igual para las aplicaciones de AIR as como para otras aplicaciones que se instalan.
Destino de la aplicacin
Adobe AIR 1.0 y posterior El directorio de instalacin se puede establecer usando una de las siguientes dos opciones:
1 El usuario personaliza el destino durante la instalacin. La aplicacin se instala donde lo especifica el usuario. 2 Si el usuario no cambia el destino de la instalacin, la aplicacin se instala en la ruta predeterminada como lo
Mac OS: ~/Aplicaciones/ Windows XP y anterior: C:\Archivos Windows Vista: ~/Aplicaciones/ Linux: /opt/
Si el desarrollador especifica un parmetro installFolder en el archivo descriptor de la aplicacin, la aplicacin se instala en una ruta secundaria de este directorio.
de programa\
Windows: un directorio que contiene todos los archivos incluidos en el archivo de instalacin de AIR. Asimismo,
el motor de ejecucin crea un archivo exe durante la instalacin de la aplicacin de AIR.
Linux: un directorio que contiene todos los archivos incluidos en el archivo de instalacin de AIR. Asimismo, el
motor de ejecucin crea un archivo bin durante la instalacin de la aplicacin de AIR.
Mac OS: un archivo app que contiene todo el contenido del archivo de instalacin de AIR. Se puede examinar
usando la opcin "Show Package Contents" en Finder. El motor de ejecucin crea este archivo app como parte de la instalacin de la aplicacin de AIR. Una aplicacin de AIR se ejecuta del siguiente modo:
Windows: ejecutando el archivo .exe en la carpeta de instalacin, o un mtodo abreviado que corresponde a este
archivo (como un mtodo abreviado en el men Inicio o en el escritorio)
Linux: iniciando el archivo .bin en la carpeta de instalacin, seleccionando la aplicacin en el men de aplicaciones
o realizando la ejecucin a partir de un alias o acceso directo en el escritorio.
1098
Store/ donde
Store\ , donde
En Linux: <appData>/<appID>/Local
Puede acceder al directorio de almacenamiento de la aplicacin a travs de la propiedad air.File.applicationStorageDirectory. Puede acceder al contenido usando el mtodo resolvePath() de la clase File. Para ms informacin, consulte Trabajo con el sistema de archivos en la pgina 655.
1099
UntrustedAppInstallDisabled
UpdateDisabled
1100
La clase StageWebView es una clase de representacin HTML y cuenta con una integracin muy limitada con la aplicacin host de AIR. El contenido cargado mediante la clase StageWebView nunca se sita en el entorno limitado de seguridad de la aplicacin y no puede acceder a los datos ni llamar a las funciones en la aplicacin host de AIR. En las plataformas de escritorio, la clase StageWebView emplea el motor incorporado HTML de AIR, basado en Webkit, que tambin utiliza la clase HTMLLoader. En las plataformas mviles, la clase StageWebView utiliza el control HTML proporcionado por el sistema operativo. Por lo tanto, en las plataformas mviles la clase StageWebView presenta las mismas vulnerabilidades y factores de seguridad que el navegador web del sistema. La clase TextField puede mostrar cadenas de texto HTML. JavaScript no se puede ejecutar, pero el texto puede incluir vnculos e imgenes cargadas de forma externa. Para ms informacin, consulte Cmo evitar errores de JavaScript relacionados con la seguridad en la pgina 1001.
1101
Atributo sandboxRoot
Descripcin La URL que se debe utilizar para determinar el entorno limitado y dominio donde colocar el contenido del fotograma. Se deben utilizar los esquemas de URL file:, http: o https:. La URL desde donde cargar el contenido del fotograma. Se deben utilizar los esquemas URL file:, app: o app-storage:.
documentRoot
En el siguiente ejemplo se asigna el contenido instalado en el subdirectorio del entorno limitado de la aplicacin para que se ejecute en el entorno limitado remoto y en el dominio www.example.com:
<iframe src="ui.html" sandboxRoot="http://www.example.com/local/" documentRoot="app:/sandbox/"> </iframe>
Configuracin de un puente entre fotogramas principales y secundarios en diferentes entornos limitados o dominios Adobe AIR 1.0 y posterior AIR aade las propiedades childSandboxBridge y parentSandboxBridge al objeto window de cualquier fotograma secundario. Estas propiedades permiten definir puentes para que acten como interfaces entre un fotograma principal y uno secundario. Cada puente va en una direccin:
childSandboxBridge La propiedad childSandboxBridge permite que el fotograma secundario exponga una
interfaz al contenido en el fotograma principal. Para exponer una interfaz, se debe establecer la propiedad
childSandbox a una funcin u objeto en el fotograma secundario. Entonces puede acceder al objeto o funcin desde
el contenido en el fotograma principal. En el siguiente ejemplo se muestra el modo en que un script ejecutndose en un fotograma secundario puede exponer al fotograma principal un objeto que contiene una funcin y una propiedad:
var interface = {}; interface.calculatePrice = function(){ return .45 + 1.20; } interface.storeID = "abc" window.childSandboxBridge = interface;
Si este contenido secundario se encuentra en un iframe y se le asign un ID de "elemento secundario", se puede acceder a la interfaz desde el contenido principal leyendo la propiedad childSandboxBridge del fotograma:
var childInterface = document.getElementById("child").childSandboxBridge; air.trace(childInterface.calculatePrice()); //traces "1.65" air.trace(childInterface.storeID)); //traces "abc" parentSandboxBridge La propiedad parentSandboxBridge permite que el fotograma principal exponga una
interfaz al contenido en el fotograma secundario. Para exponer una interfaz, se debe establecer la propiedad parentSandbox del fotograma secundario a una funcin u objeto en el fotograma principal. Entonces puede acceder al objeto o funcin desde el contenido en el fotograma secundario. En el siguiente ejemplo se muestra el modo en que un script ejecutndose en un fotograma principal puede exponer al fotograma secundario un objeto que contiene una funcin de guardar:
1102
var interface = {}; interface.save = function(text){ var saveFile = air.File("app-storage:/save.txt"); //write text to file } document.getElementById("child").parentSandboxBridge = interface;
Usando esta interfaz, el contenido en el fotograma secundario podra guardar texto en un archivo denominado save.txt. Sin embargo, no tendra ningn otro acceso al sistema de archivos. En general, el contenido de aplicacin debe exponer una interfaz lo ms limitada posible a otros entornos limitados. El contenido secundario puede llamar a la funcin save de la siguiente manera:
var textToSave = "A string."; window.parentSandboxBridge.save(textToSave);
Si el contenido secundario intenta definir una propiedad del objeto parentSandboxBridge, el motor de ejecucin emite una excepcin SecurityError. Si el contenido principal intenta definir una propiedad del objeto childSandboxBridge, el motor de ejecucin emite una excepcin SecurityError.
1103
Se prohben las expresiones relacionadas con las lecturas de propiedades, como en el siguiente ejemplo:
a.b.c
La invocacin de funcin est prohibida. Las definiciones de funciones estn prohibidas. La configuracin de cualquier propiedad est prohibida. Los literales de funciones estn prohibidos.
Sin embargo, mientras se carga el cdigo, antes del evento onload y durante la ejecucin de la funcin del controlador de eventos onload, estas restricciones no se aplican al contenido en el entorno limitado de seguridad de la aplicacin. Por ejemplo, despus de cargar el cdigo, el cdigo siguiente hace que el motor de ejecucin emita una excepcin:
eval("alert(44)"); eval("myFunction(44)"); eval("NativeApplication.applicationID");
El cdigo generado dinmicamente, como el que se crea cuando se llama a la funcin eval(), presenta un riego de seguridad si se permite dentro del entorno limitado de la aplicacin. Por ejemplo, una aplicacin puede accidentalmente ejecutar una cadena cargada de un dominio de red y dicha cadena puede tener cdigo malintencionado. Por ejemplo, puede ser cdigo para eliminar o alterar archivos en el equipo del usuario. O puede ser cdigo que informa a un dominio de red que no es de confianza sobre el contenido de un archivo local. A continuacin se incluyen formas de generar cdigo dinmico:
Llamar a la funcin eval(). Usar las propiedades innerHTML o funciones DOM para insertar etiquetas de script que cargan un script fuera del
directorio de la aplicacin.
Usar las propiedades innerHTML o funciones DOM para insertar etiquetas de script que tienen cdigo insertado
(en lugar de cargar un script a travs del atributo src).
Configurar el atributo src para que las etiquetas script carguen un archivo JavaScript que se encuentra fuera del
directorio de la aplicacin.
Usar el esquema javascript de URL (como en href="javascript:alert('Test')"). Usar la funcin setInterval() o setTimout() donde el primer parmetro (definiendo la funcin para que se
ejecute de forma asncrona) es una cadena (para evaluar) en vez de un nombre de funcin (como en
setTimeout('x = 4', 1000)).
1104
Estas restricciones no impiden el uso de eval() con los literales de objetos JSON. Esto permite que el contenido de aplicacin trabaje con la biblioteca JSON JavaScript. Sin embargo, est restringido en el uso de cdigo JSON sobrecargado (con controladores de eventos). Para otros marcos de Ajax y bibliotecas de cdigo JavaScript, verifique si el cdigo en el marco o biblioteca funciona dentro de estas restricciones en cdigo generado dinmicamente. Si no funcionan, incluya cualquier contenido que usa el marco o la biblioteca en un entorno limitado de seguridad que no pertenece a la aplicacin. Para obtener ms informacin, consulte Restricciones para JavaScript dentro de AIR en la pgina 1064 y Uso de scripts entre contenido de la aplicacin y contenido que no pertenece a la aplicacin en la pgina 1111. Adobe mantiene una lista de marcos de Ajax que admiten el entorno limitado de seguridad de aplicacin, en http://www.adobe.com/es/products/air/develop/ajax/features/. A diferencia del contenido en el entorno limitado de seguridad de la aplicacin, el contenido JavaScript en un entorno limitado de seguridad que no pertenece a la aplicacin puede llamar a la funcin eval() para que ejecute dinmicamente el cdigo generado en cualquier momento. Restricciones para acceder a las API de AIR (para entornos limitados ajenos a la aplicacin) Adobe AIR 1.0 y posterior El cdigo JavaScript en un entorno limitado que no pertenece a la aplicacin no tiene acceso al objeto window.runtime y como tal este cdigo no puede ejecutar las API de AIR. Si el contenido en un entorno limitado de seguridad que no pertenece a la aplicacin llama al siguiente cdigo, la aplicacin emite una excepcin TypeError:
try { window.runtime.flash.system.NativeApplication.nativeApplication.exit(); } catch (e) { alert(e); }
El tipo de excepcin es TypeError (valor no definido), porque el contenido en el entorno limitado que no pertenece a la aplicacin no reconoce el objeto window.runtime, por lo tanto se lo considera un valor no definido. Se puede exponer la funcionalidad del motor de ejecucin al contenido en un entorno limitado que no pertenece a la aplicacin usando un puente de script. Para ms informacin, consulte Uso de scripts entre contenido de la aplicacin y contenido que no pertenece a la aplicacin en la pgina 1111. Restricciones para usar llamadas XMLHttpRequest Adobe AIR 1.0 y posterior El contenido HTML en el entorno limitado de seguridad de la aplicacin no puede utilizar mtodos XMLHttpRequest sincrnicos para cargar datos desde fuera del entorno limitado de la aplicacin mientras se est cargando el contenido HTML y durante el evento onLoad. De forma predeterminada, el contenido HTML en entornos limitados de seguridad que no pertenecen a la aplicacin no pueden usar el objeto JavaScript XMLHttpRequest para cargar datos de dominios que no sea el dominio que llama a la peticin. Una etiqueta frame o iframe puede incluir el atributo allowcrosscomainxhr. La configuracin de este atributo a cualquier valor que no sea null permite que el contenido en el fotograma o iframe use el objeto XMLHttpRequest JavaScript para cargar datos de dominios que no sea el dominio del cdigo que llama a la peticin:
1105
Para ms informacin, consulte Creacin de scripts entre contenido en diferentes dominios en la pgina 1106. Restricciones para cargar elementos CSS, frame, iframe e img (para el contenido en entornos limitados que no pertenecen a la aplicacin) Adobe AIR 1.0 y posterior El contenido HTML en los entornos limitados de seguridad remotos (red) solo puede cargar contenido CSS, frame, iframe e img de entornos limitados remotos (de URL de red). El contenido HTML en los entornos limitados local con sistema de archivos, local con acceso a la red o local de confianza solo pueden cargar contenido CSS, frame, iframe e img de entornos limitados locales (no de aplicaciones o entornos limitados remotos). Restricciones para llamar al mtodo window.open() JavaScript Adobe AIR 1.0 y posterior Si una ventana que se crea a travs de una llamada al mtodo window.open() JavaScript muestra contenido de un entorno limitado de seguridad que no pertenece a la aplicacin, el ttulo de la ventana comienza con el ttulo de la ventana principal (de inicio), seguido por dos puntos (:). No se puede utilizar el cdigo para trasladar esa porcin del ttulo de la ventana fuera de la pantalla. El contenido en entornos limitados de seguridad que no pertenecen a la aplicacin solo pueden llamar exitosamente al mtodo window.open() JavaScript en respuesta a un evento activado por el ratn o interaccin del teclado. Esto impide que el contenido que no pertenece a la aplicacin cree ventanas que se pueden utilizar maliciosamente (por ejemplo, para ataques de suplantacin de identidad (phishing). Asimismo, el controlador de eventos para el evento de ratn o teclado no puede definir el mtodo window.open() para ejecutarse despus de una demora (por ejemplo llamando a la funcin setTimeout()). El contenido en entornos limitados remotos (red) slo puede utilizar el mtodo window.open() para abrir el contenido en entornos limitados de red remotos. No puede utilizar el mtodo window.open() para abrir contenido de la aplicacin o entornos limitados locales. El contenido en los entornos limitados local con sistema de archivos, local con acceso a la red o local de confianza (consulte Entornos limitados de seguridad en la pgina 1061) slo puede usar el mtodo window.open() para abrir contenido en entornos limitados locales. No puede utilizar el mtodo window.open() para abrir contenido de la aplicacin o entornos limitados remotos. Errores al llamar a cdigo restringido Adobe AIR 1.0 y posterior Si se llama al cdigo que no se puede utilizar en un entorno limitado debido a estas restricciones de seguridad, el motor de ejecucin distribuye un error de JavaScript: Adobe AIR runtime security violation for JavaScript code in the application security sandbox (Infraccin de seguridad del motor de ejecucin de Adobe AIR para el cdigo JavaScript en el entorno limitado de seguridad de la aplicacin). Para ms informacin, consulte Cmo evitar errores de JavaScript relacionados con la seguridad en la pgina 1001.
1106
El cdigo en el entorno limitado de seguridad de la aplicacin no se permite en otros entornos limitados llamando
al mtodo Security.allowDomain(). Con la llamada a este mtodo desde el entorno limitado de seguridad de la aplicacin se emitir un error.
El objeto parentSandboxBridge permite que el contenido que se est cargando exponga las propiedades y
funciones a los scripts en el contenido cargado.
El objeto childSandboxBridge permite que el contenido cargado exponga las propiedades y funciones a los scripts
en el contenido que se est cargando. Los objetos expuestos a travs del puente de entorno limitado se pasan por valor y no por referencia. Todos los datos se serializan. Esto significa que los objetos expuestos por un lado del puente no pueden ser definidos por el otro lado del puente y que los objetos expuestos no tienen tipo. Asimismo, solo se pueden exponer funciones y objetos simples; no se pueden exponer objetos complejos.
1107
Si el contenido secundario intenta definir una propiedad del objeto parentSandboxBridge, el motor de ejecucin emite una excepcin SecurityError. De igual manera, si el contenido principal intenta definir una propiedad del objeto childSandboxBridge, el motor de ejecucin emite una excepcin SecurityError.
El objeto StoreAPI llama a la aplicacin principal para recuperar el precio normal del lbum, pero devuelve No disponible cuando se llama al mtodo getSaleAlbumPrice(). El siguiente cdigo define la clase StoreAPI:
1108
public class StoreAPI { private static var musicStore:Object; public function StoreAPI(musicStore:Object) { this.musicStore = musicStore; } public function getRegularAlbumPrice():String { return musicStore.getRegularAlbumPrice(); } public function getSaleAlbumPrice():String { return "Not available"; } public function getAlbumPrice():String { return musicStore.getRegularAlbumPrice(); } }
El siguiente cdigo representa un ejemplo del archivo SWF PriceQuoter que informa sobre el precio de venta pero no puede informar sobre el pecio de oferta:
package { import flash.display.Sprite; import flash.system.Security; import flash.text.*; public class PriceQuoter extends Sprite { private var storeRequester:Object; public function PriceQuoter() { trace("Initializing child SWF"); trace("Child sandbox: " + Security.sandboxType); storeRequester = loaderInfo.parentSandboxBridge; var tf:TextField = new TextField(); tf.autoSize = TextFieldAutoSize.LEFT; addChild(tf); tf.appendText("Store price of album is: " + storeRequester.getAlbumPrice()); tf.appendText("\n"); tf.appendText("Sale price of album is: " + storeRequester.getSaleAlbumPrice()); } } }
1109
Ms temas de ayuda
Uso de scripts entre contenidos en diferentes entornos limitados de seguridad en la pgina 1018 Entorno limitado de la aplicacin de AIR en la pgina 1062
Escritura en el disco
Adobe AIR 1.0 y posterior Las aplicaciones que se ejecutan en un navegador web solo tienen una interaccin limitada con el sistema de archivos local del usuario. Los navegadores web implementan polticas de seguridad que aseguran que el equipo de un usuario no corre riesgo como resultado de cargar contenido web. Por ejemplo, los archivos SWF que se ejecutan a travs de Flash Player en un navegador no pueden interactuar directamente con los archivos que ya se encuentran en el equipo del usuario. Los objetos y cookies compartidos se pueden escribir en el disco de un equipo de usuario para mantener las preferencias de usuario y otros datos, pero este es el lmite de la interaccin con el sistema de archivos. Dado que las aplicaciones de AIR se instalan de forma nativa, tienen un diferente contrato de seguridad, uno que incluye la capacidad de leer y escribir en todo el sistema de archivos local. Esta libertad conlleva gran responsabilidad para los desarrolladores. Las inseguridades de aplicacin accidentales ponen en peligro no slo la funcionalidad de la aplicacin, sino tambin la integridad del equipo del usuario. Por esta razn, los desarrolladores deben leer Prcticas recomendadas de seguridad para desarrolladores en la pgina 1112. Los desarrolladores de AIR puede acceder y escribir archivos en el sistema de archivos local usando varias convenciones de esquemas de URL:
1110
Descripcin Un alias al directorio de la aplicacin. Los archivos que se acceden desde esta ruta se les asignan un entorno limitado de la aplicacin y tienen privilegios completos concedidos por el motor de ejecucin. Un alias al directorio de almacenamiento local, estandarizado por el motor de ejecucin. Los archivos que se acceden desde esta ruta se les asigna un entorno limitado que no pertenece a la aplicacin. Un alias que representa la raz del disco duro del usuario. Un archivo que se accede desde esta ruta se le asigna un entorno limitado de la aplicacin si el archivo existe en el directorio de la aplicacin, de lo contrario se le asigna un entorno limitado que no pertenece a la aplicacin.
app-storage:/
file:///
Nota: las aplicaciones de AIR no pueden modificar el contenido usando el esquema de URL app:. Asimismo, el directorio de la aplicacin puede leer solo debido a la configuracin del administrador. A menos que haya restricciones de administrador en el equipo del usuario, las aplicaciones de AIR tienen el privilegio de escribir en cualquier ubicacin en el disco duro del usuario. Se recomienda que los desarrolladores usen la ruta appstorage:/ para el almacenamiento local relacionado con su aplicacin. Los archivos que se escriben en appstorage:/ desde una aplicacin se colocan en una ubicacin estndar:
Store/ donde
Store\ donde
En Linux: <appData>/<appID>/Local
Si una aplicacin est diseada para interactuar con archivos existentes en el sistema de archivos del usuario, asegrese de leer Prcticas recomendadas de seguridad para desarrolladores en la pgina 1112.
Security.allowDomain()
Adobe AIR 1.0 y posterior Las aplicaciones de AIR restringen el acceso al uso de scripts para el contenido que no pertenece a la aplicacin ms severamente que el plug-in de navegador de Flash Player restringe el acceso al uso de scripts para el contenido que no es de confianza. Por ejemplo, en Flash Player en el navegador, cuando un archivo SWF que se asigna al entorno limitado local-trusted llama al mtodo System.allowDomain(), el acceso a la secuencia de comandos se concede a cualquier archivo SWF cargado desde el dominio especificado. El mtodo equivalente no se permite por parte del contenido de aplicacin en las aplicaciones de AIR, ya que concedera acceso peligroso al archivo que no pertenece a la aplicacin en el sistema de archivos del usuario. Los archivos remotos no pueden acceder de forma directa al entorno limitado de la aplicacin, independientemente de las llamadas al mtodo Security.allowDomain().
1111
Si se llama a loadBytes() para cargar el contenido SWF y la propiedad allowLoadBytesCodeExecution del objeto LoaderContext est definida en false (el valor predeterminado), el objeto Loader emite una excepcin SecurityError.
1112
Nota: es posible que esta API cambie en una futura versin de Adobe AIR. Cuando ocurra, tal vez tenga que recompilar el contenido que usa la propiedad allowLoadBytesCodeExecution de la clase LoaderContext.
Incluir un archivo en un archivo de AIR (en la aplicacin instalada) slo si es necesario. Incluir un archivo de script en un archivo de AIR (en la aplicacin instalada) slo si el comportamiento se
comprende cabalmente y es de confianza.
No escribir ni modificar el contenido en el directorio de la aplicacin. El motor de ejecucin impide que las
aplicaciones escriban o modifiquen los archivos y directorios usando el esquema de URL app:/ emitiendo una a excepcin SecurityError.
No utilizar datos de un origen de red como parmetros para los mtodos de la API de AIR que pueden llevar a la
ejecucin de cdigo. Esto incluye el uso del mtodo Loader.loadBytes() y la funcin eval() JavaScript.
Usen datos de un origen de red para determinar un nombre de archivo. Utilicen datos de un origen de red para construir una URL que usa la aplicacin para enviar informacin privada.
1113
Si se deben almacenar las credenciales de forma local, se deben cifrar las credenciales cuando se escribe en el sistema
de archivos local. El motor de ejecucin proporciona un almacenamiento cifrado exclusivo para cada aplicacin instalada, a travs de la clase EncryptedLocalStore. Para obtener informacin, consulte Almacenamiento local cifrado en la pgina 715.
No se deben transmitir credenciales de usuario no cifradas a un origen de red a menos que el origen sea de
confianza.
Nunca se debe especificar una contrasea predeterminada en la creacin de una credencial, los usuarios deben crear
las propias. Los usuarios que dejan una contrasea predeterminada exponen sus credenciales a un atacante que ya conoce la contrasea predeterminada.
Firma de cdigo
Adobe AIR 1.0 y posterior Se requiere que todos los archivos de instalacin de AIR tengan el cdigo firmado. La firma de cdigo es un proceso criptogrfico de confirmar que el origen especificado del software es veraz. Las aplicaciones de AIR se pueden firmar utilizando un certificado emitido por una entidad de emisora de certificados externa (CA) o un certificado con firma automtica de creacin propia. Se recomienda un certificado comercial de una CA conocida ya que proporciona la garanta a los usuarios de que estn instalando la aplicacin real y no una falsificacin. Sin embargo, los certificados con firma automtica se pueden crear usando adt del SDK u usando Flash, Flash Builder u otra aplicacin que utilice adt para la generacin de certificados. Los certificados con firma automtica no garantizan que la aplicacin que se est instalando es original y se deben utilizar nicamente para probar una aplicacin antes de su lanzamiento pblico.
1114
clase Geolocation.
ACCESS_FINE_LOCATION Permite que la aplicacin acceda a datos GPS a travs de la clase Geolocation. ACCESS_NETWORK_STATE y ACCESS_WIFI_STATE Permite que la aplicacin acceda a la informacin de red a travs de
la clase NetworkInfo.
CAMERA Permite que la aplicacin acceda a la cmara. INTERNET Permite que la aplicacin realice solicitudes de red y permite la depuracin remota. READ_PHONE_STATE Permite que el motor de ejecucin de AIR silencie el audio cuando se produzca una llamada
entrante.
RECORD_AUDIO Permite que la aplicacin acceda al micrfono. WAKE_LOCK y DISABLE_KEYGUARD Permite que la aplicacin impida que el dispositivo entre en reposo con la
1115
Firmas de la aplicacin Todos los paquetes de la aplicacin creados para la plataforma Android se deben firmar. Debido a que las aplicaciones de AIR en Android se empaquetan en el formato APK de Android nativo, se firman de acuerdo con las convenciones de Android en lugar de conforme a las convenciones de AIR. Aunque Android y AIR utilizan la firma de cdigo de forma similar, existen diferencias importantes:
En Android, la firma verifica que la clave privada est en posesin del desarrollador, pero no se utiliza para
comprobar la identidad del mismo.
Para las aplicaciones enviadas al mercado de Android, el certificado debe ser vlido durante 25 aos como mnimo. Android no admite la migracin de la firma del paquete a otro certificado. Si una actualizacin se firma mediante
un certificado diferente, el usuario debe desintalar la aplicacin original antes de que pueda instalar la aplicacin actualizada.
Dos aplicaciones firmadas con el mismo certificado pueden especificar un ID compartido que les permita acceder
a los archivos de datos y a la cach entre s. (Este uso compartido no lo facilita AIR. ) IDs de usuario de la aplicacin Android utiliza un ncleo Linux. A todas las aplicaciones instaladas se les asigna un ID de usuario de tipo Linux que determina sus permisos para las operaciones como el acceso a archivos. Los archivos de los directorios temporales, de almacenamiento de la aplicacin y de la propia aplicacin se protegen frente al acceso mediante los permisos del sistema de archivos. Los archivos escritos en el almacenamiento externo (es decir, la tarjeta SD) se pueden leer, modificar y eliminar por otras aplicaciones, o por el usuario, cuando la tarjeta SD se instala como dispositivo de almacenamiento masivo en un equipo. Las cookies recibidas con solicitudes de Internet no se comparten entre aplicaciones de AIR.
Ms temas de ayuda
Android: Seguridad y permisos
1116
Firmas de la aplicacin Todos los paquetes de la aplicacin creados para la plataforma iOS se deben firmar. Dado que las aplicaciones de AIR en iOS son paquetes en formato IPA de iOS, se firman de acuerdo con los requisitos de iOS y no con los de AIR. Aunque Android y iOS utilizan la firma de cdigo de forma similar, existen diferencias importantes:
EN iOS, el certificado que se usa para firmar una aplicacin debe estar emitido por Apple; no se podrn usar
certificados de otras entidades emisoras.
En iOS, los certificados de distribucin emitidos por Apple suelen ser vlidos durante un ao.
Privacidad de la imagen de fondo Cuando un usuario cambia a una aplicacin en el fondo en el iOS, ste captura una captura de pantalla que utiliza para animar la transicin. Esta captura de pantalla se almacena en la memoria del dispositivo y a ella puede acceder un atacante con control fsico del dispositivo. Si la aplicacin muestra informacin confidencial, estos datos se deben proteger para que no se capturen mediante la captura de pantalla de fondo. El evento deactivate distribuido mediante el objeto NativeApplication seala que una aplicacin est a punto de cambiar a segundo plano. Utilice este evento para borrar u ocultar la informacin confidencial.
1117
Ejemplos de fragmento de cdigo en la pgina 1117 Ejemplos basados en clases en la pgina 1118 Ejemplos prcticos que contienen varios archivos de origen en la pgina 1118
Para ejecutar los ejemplos de cdigo de ActionScript 3.0 en el escritorio, consulte:
Ejecucin de ejemplos de ActionScript 3.0 en Flash Professional en la pgina 1118 Ejecucin de ejemplos de ActionScript 3.0 en Flash Builder en la pgina 1120
El uso de las sentencias trace y otras herramientas de depuracin en Adobe Flash Professional o Adobe Flash Builder puede aumentar su conocimiento de un ejemplo de cdigo. Los ejemplos de cdigo de ActionScript 3.0 tambin se puede ejecutar en dispositivos mviles que admitan Flash Player 10.1 y versiones posteriores. Para obtener ms informacin, consulte Ejecucin de ejemplos de ActionScript 3.0 en dispositivos mviles en la pgina 1121. Si se estn desarrollando aplicaciones para dispositivos de TV, tambin se pueden aprovechar los ejemplos de ActionScript 3.0. Utilice su escritorio para estudiar los ejemplos. Para obtener ms informacin sobre el desarrollo para dispositivos de TV, consulte Flash Platform for TV (en ingls) en el sitio web del Centro de desarrollo de Adobe.
Tipos de ejemplos
Existen tres tipos de ejemplos de cdigo utilizados en la gua para desarrolladores de ActionScript 3.0 y en otros libros, artculos y referencias de lenguaje relacionados:
Fragmentos de cdigo Ejemplos basados en clases Ejemplos prcticos que contienen varios archivos de origen
Los fragmentos de cdigo slo contienen cdigo suficiente para mostrar una sola idea. Normalmente no incluyen un paquete ni sentencias de clase.
1118
El cdigo para un ejemplo basado en clase incluye una sentencia package, una declaracin de clase y una funcin constructora.
Uno o varios archivos de origen de ActionScript. Un archivo .FLA para su uso con Flash Professional. Uno o varios archivos MXML para su uso con Flash Builder. Archivos de datos, archivos de imagen, archivos de sonido u otros recursos utilizados por la aplicacin de ejemplo
(opcional). Los ejemplos prcticos tambin se encuentran en muchos de los artculos de inicio rpido de los centros para desarrolladores de Flash y Flex. Los ejemplos prcticos se suelen distribuir como archivos ZIP.
1119
5 Seleccione Archivo > Guardar. Asigne un nombre al archivo y haga clic en Aceptar. 6 Para probar el ejemplo, seleccione Control > Probar pelcula.
Si la clase es la clase del documento principal para el programa, debe ampliar la clase MovieClip:
import flash.display.MovieClip; public class Example1 extends MovieClip{ //... }
Tambin se debe asegurar que todas las clases con referencia en el ejemplo se declaran utilizando sentencias import.
4 Seleccione Archivo > Guardar. Asigne al archivo el mismo nombre que la clase en el ejemplo (p. ej.
ContextMenuExample.as). Nota: algunos de los ejemplos basados en clases, como el ejemplo de la clase flashx.textLayout.container.ContainerController, incluyen varios niveles en la declaracin del paquete (paquete flashx.textLayout.container.examples {). En estos ejemplos, guarde el archivo en una subcarpeta que coincida con la declaracin del paquete (flashx/textLayout/container/examples), o elimine el nombre del paquete (para que ActionScript comience con package { solamente) y podr probar el archivo desde cualquier ubicacin.
5 Seleccione Archivo > Nuevo. 6 En el cuadro de dilogo Nuevo documento, seleccione Documento de Flash (ActionScript 3.0) y haga clic en
coincidir con el nombre del archivo de origen de ActionScript que acaba de guardar (p. ej. ContextMenuExample).
8 Seleccione Archivo > Guardar. Asigne al archivo FLA el mismo nombre que la clase en el ejemplo (p. ej.
ContextMenuExample.as).
9 Para probar el ejemplo, seleccione Control > Probar pelcula.
1120
existente, cree una nueva aplicacin MXML (elija Archivo > Nuevo > Aplicacin de MXML). Asigne al proyecto o a la aplicacin un nombre descriptivo (p. ej. ContextMenuExample).
2 Dentro del archivo MXML generado, aada una etiqueta <mx:Script>. 3 Pegue el contenido del ejemplo de fragmento de cdigo entre las etiquetas <mx:Script> y </mx:Script>. Guarde
el archivo MXML.
4 Para ejecutar el ejemplo, seleccione la opcin de men Ejecutar > Ejecutar para el archivo MXML principal (por
proyecto). Utilice los valores predeterminados para otros campos (o cmbielos segn su entorno especfico). Haga clic en Finish (Finalizar) para crear el proyecto y el archivo principal de ActionScript.
3 Borre todo el contenido generado del archivo de ActionScript. Pegue cdigo de ejemplo, incluyendo las sentencias
de importacin y empaquetado, en el archivo ActionScript y guarde el archivo. Nota: algunos de los ejemplos basados en clases, como el ejemplo de la clase flashx.textLayout.container.ContainerController, incluyen varios niveles en la declaracin del paquete (paquete flashx.textLayout.container.examples {). En estos ejemplos, guarde el archivo en una subcarpeta que coincida con la declaracin del paquete (flashx/textLayout/container/examples), o elimine el nombre del paquete (para que ActionScript comience con package { solamente) y podr probar el archivo desde cualquier ubicacin.
4 Para ejecutar el ejemplo, seleccione la opcin del men Run (Ejecutar) > Run (Ejecutar) para el nombre de la clase
de ActionScript principal (p. ej. Run (Ejecutar) > Run ContextMenuExample (Ejecutar ContextMenuExample).
1121
2 En Flash Builder, seleccione File (Archivo) > New (Nuevo)> Flex Project (Proyecto de Flex).. En la seccin Project
Location (Ubicacin del proyecto), haga clic en Browse (Examinar) y seleccione la carpeta que contiene los archivos de ejemplo. En el campo Project Name (Nombre de proyecto), indique el nombre de la carpeta (p. ej. ContextMenuExample). Utilice los valores predeterminados para otros campos (o cmbielos segn su entorno especfico). Haga clic en Next (Siguiente) para continuar.
3 En el panel Output (Salida), haga clic en Next (Siguiente) para aceptar el valor predeterminado. 4 En el panel Source Paths (Rutas de origen), haga clic en el botn Browse (Examinar) situado junto al campo Main
Application File (Archivo de aplicacin principal). Seleccione el archivo de ejemplo MXML principal en la carpeta de ejemplo. Haga clic en Finish (Finalizar) para crear los archivos del proyecto.
5 Para ejecutar el ejemplo, seleccione la opcin de men Ejecutar > Ejecutar para el archivo MXML principal (por
Professional en la pgina 1118 o en Ejecucin de ejemplos de ActionScript 3.0 en Flash Builder en la pgina 1120. En Flash Professional, el archivo SWF se crea cuando se selecciona Control > Probar pelcula. En Flash Builder, el archivo SWF se crea cuando se ejecuta, se depura o se crea el proyecto de Flash Builder.
2 Copie el archivo SWF en un directorio en el dispositivo mvil. Utilice el software que acompaa al dispositivo para
copiar el archivo.
3 En la barra de direcciones del navegador del dispositivo mvil, indique la URL file:// para el archivo SWF. Por
ejemplo, indique file:://applications/myExample.swf. Para copiar archivos en un servidor web y ejecutar el ejemplo en el navegador del dispositivo, realice lo siguiente:
1 Cree un archivo SWF y otro HTML. En primer lugar, siga las instrucciones incluidas en Ejecucin de ejemplos de
ActionScript 3.0 en Flash Professional en la pgina 1118 o en Ejecucin de ejemplos de ActionScript 3.0 en Flash Builder en la pgina 1120. En Flash Professional, al seleccionar Control (Control) > Test Movie (Probar pelcula) se crea nicamente el archivo SWF. Para crear ambos archivos, en primer lugar seleccione tanto Flash como HTML en la ficha Formats (Formatos) del cuadro de dilogo Publish Settings (Configuracin de publicacin). A continuacin, seleccione Archivo > Publicar para crear los archivos HTML y SWF. En Flash Builder, los archivos SWF y HTML se crean cuando se ejecuta, depura o se crea el proyecto de Flash Builder.
2 Copie los archivos SWF y HTML en un directorio del servidor web. 3 En la barra de direcciones del navegador del dispositivo mvil, introduzca la direccin HTTP del archivo HTML.
Por ejemplo, indique http://www.myWebServer/examples/myExample.html. Antes de ejecutar un ejemplo en un dispositivo mvil, tenga en cuenta los siguientes puntos.
1122
Por ejemplo, aada esta funcin a la clase de documento como funcin privada. Despus, en otros mtodos de la clase de documento, realice un seguimiento de los datos con cdigo tal y como se muestra a continuacin:
var traceField:TextField = createTracingTextField(10, 10, 150, 150); // Use the newline character "\n" to force the text to the next line. traceField.appendText("data to trace\n"); traceField.appendText("more data to trace\n"); // Use the following line to clear the text field. traceField.appendText("");
1123
El mtodo appendText() slo acepta un valor como parmetro. Dicho valor es una cadena (una instancia de String o un literal de cadena). Para imprimir el valor de una variable que no sea de tipo cadena, primero debe convertir el valor en una cadena. La forma ms sencilla de hacer esto es llamar al mtodo toString() del objeto:
var albumYear:int = 1999; traceField.appendText("albumYear = "); traceField.appendText(albumYear.toString());
Administracin de la seleccin
Algunos ejemplos requieren que se proporcione la seleccin a un campo. Con esta operacin se puede, por ejemplo, introducir texto o seleccionar un botn. Para seleccionar un campo, utilice el dispositivo de sealizacin del dispositivo mvil como, por ejemplo, una pluma o el dedo. O bien, utilice las teclas de navegacin del dispositivo mvil para seleccionar un campo. Para elegir un botn que tenga la seleccin, utilice la tecla para seleccionar del dispositivo mvil tal y como se usa Intro en un ordenador. En algunos dispositivos, al puntear dos veces en un botn, ste se selecciona. Para obtener ms informacin sobre la seleccin, consulte Administracin de la seleccin en la pgina 558.
1124
Rendimiento
Los dispositivos mviles cuentan con menos capacidad de procesamiento que los de escritorio. Posiblemente algunos ejemplos que consumen ms CPU funcionan ms lentamente en dispositivos mviles. En el ejemplo de la seccin Ejemplo de API de dibujo: Generador visual algortmico en la pgina 230 se realizan dibujos y procesamientos extensos al entrar en cada fotograma. Al ejecutar este ejemplo en un equipo se muestran distintas APIs de dibujo. Sin embargo, el ejemplo no resulta adecuado en algunos dispositivos mviles debido a sus limitaciones de rendimiento. Para obtener ms informacin sobre el rendimiento en los dispositivos mviles, consulte Optimizacin del rendimiento para la plataforma Flash.
Prcticas recomendadas
En los ejemplos no se consideran las mejores prcticas en el desarrollo de aplicaciones para dispositivos mviles. Las limitaciones de memoria y capacidad de procesamiento de los dispositivos mviles requieren una atencin especial. Del mismo modo, la interfaz de usuario para la pequea pantalla presenta distintas necesidades que una pantalla de escritorio. Para obtener ms informacin sobre el desarrollo de aplicaciones para dispositivos mviles, consulte Optimizacin del rendimiento para la plataforma Flash.
1125
Maysculas/Minsculas UPPER CASE: las palabras clave SQL de literal se escriben todas en maysculas. lower case: los marcadores de posicin o los nombres de las clusulas se escriben todos en minsculas. Caracteres de definicin ::= Indica una definicin de clusula o de declaracin. Caracteres de agrupacin y alternancia | El carcter de barra se utiliza entre opciones alternativas y se puede leer como or. [] Los elementos entre corchetes son opcionales; los corchetes pueden contener un solo elemento o varios
elementos.
() Los parntesis que encierran un conjunto de alternativas (conjunto de elementos separados por el carcter
barra) designan un grupo requerido de elementos, es decir, un conjunto de elementos que son los valores posibles de un solo elemento requerido.
Cuantificadores
+ Un signo "ms" despus de un elemento entre parntesis indica que el elemento precedente puede existir una o varias veces. puede existir 0 o ms veces.
* Un asterisco despus de un elemento entre corchetes indica que el elemento precedente (entre corchetes) Caracteres literales * Un asterisco en un nombre de columna o entre parntesis despus de un nombre de funcin indica equivale
al carcter de asterisco literal ms que al cuantificador "0 oo ms".
. Un punto representa un punto literal. , Una coma representa una coma literal
1126
() Un par de parntesis encerrando una sola clusula o elemento indica que es necesario el uso de parntesis
literales.
Otros caracteres: a no ser que se indique lo contrario, el resto de caracteres representan sus equivalentes literales.
Sintaxis SQL general Declaraciones de manipulacin de datos (SELECT, INSERT, UPDATE y DELETE) Declaraciones de definicin de datos (declaraciones CREATE, ALTER y DROP para tablas, ndices, vistas y
activadores)
Declaraciones y clusulas especiales Funciones incorporadas (funciones de agregacin, escalares y de formato de fecha/hora) Operadores Parmetros Funciones SQL no admitidas Funciones SQL adicionales
lnea, etc.) para separar palabras independientes en una declaracin SQL. Sin embargo, el espacio en blanco es optativo entre palabras y smbolos El tipo y la cantidad de caracteres de espacio en blanco en una declaracin SQL no es relevante. Puede utilizar espacios en blanco (como la sangra o saltos de lnea) para dar un formato ms claro a las declaraciones SQL sin que afecte a su funcionalidad.
1127
La declaracin SELECT se utiliza para consultar la base de datos. El resultado de una declaracin SELECT es cero o ms filas de datos, donde cada fila tiene un nmero fijo de columnas. El nmero de columnas del resultado se especifica mediante el nombre de la columna result o la lista de expresiones entre las palabras clave SELECT y FROM (opcional).
sql-statement ::= SELECT [ALL | DISTINCT] result [FROM table-list] [WHERE expr] [GROUP BY expr-list] [HAVING expr] [compound-op select-statement]* [ORDER BY sort-expr-list] [LIMIT integer [( OFFSET | , ) integer]] result-column [, result-column]* * | table-name . * | expr [[AS] string] table [ join-op table join-args ]* table-name [AS alias] | ( select ) [AS alias] , | [NATURAL] [LEFT | RIGHT | FULL] [OUTER | INNER | CROSS] JOIN [ON expr] [USING ( id-list )] UNION | UNION ALL | INTERSECT | EXCEPT expr [sort-order] [, expr [sort-order]]* [COLLATE collation-name] [ASC | DESC] BINARY | NOCASE
result result-column table-list table join-op join-args compound-op sort-expr-list sort-order collation-name
::= ::= ::= ::= ::= ::= ::= ::= ::= ::=
Cualquier expresin arbitraria se puede utilizar como resultado. Si una expresin del resultado es *, todas las columnas de todas las tablas se reemplazan por dicha expresin. Si la expresin es el nombre de una tabla seguido de .*, el resultado es todas las columnas de dicha tabla. La palabra clave DISTINCT provoca la devolucin de un subconjunto de filas de resultados (donde cada fila es distinta). Se asume que todos los valores de NULL son iguales. El comportamiento predeterminado es la devolucin de todas las filas de resultados, que se pueden explicitar con la palabra clave ALL. La consulta se ejecuta en una o varias tablas especificadas con la palabra clave FROM. Si los distintos nombres de las tablas estn separados por comas, la consulta utiliza la unin cruzada de las distintas tablas. La sintaxis JOIN tambin se puede utilizar para especificar el modo de unin de las tablas. El nico tipo de unin externa admitida es LEFT OUTER JOIN. Las expresiones de la clusula ON deben producir como resultado un valor booleano. Se puede utilizar una subconsulta entre parntesis como una tabla de la clusula FROM. Se puede omitir toda la clusula FROM, en cuyo caso, el resultado ser una nica fila con los valores de la lista de expresiones del resultado. La clusula WHERE se utiliza para limitar el nmero de filas recuperadas por la consulta. Las expresiones de la clusula WHERE deben producir como resultado un valor booleano. El filtrado de la clusula WHERE se lleva a cabo antes de cualquier agrupacin, por lo que las expresiones de la clusula WHERE no pueden incluir funciones de agregacin. La clusula GROUP BY combina una o varias filas del resultado en una sola fila de resultados. La clusula GROUP BY es especialmente til cuando el resultado contiene funciones de agregacin. Las expresiones de la clusula GROUP BY no tienen por qu ser expresiones que aparezcan en la lista de expresiones SELECT. La clusula HAVING se parece a WHERE, en el sentido que limita las filas devueltas por la declaracin. Sin embargo, la clusula HAVING se aplica tras producirse cualquier agrupacin especificada por una clusula GROUP BY. En consecuencia, la expresin HAVING puede hacer referencia a valores que incluyan funciones de agregacin. No es necesario que aparezca ninguna expresin de la clusula HAVING en la lista SELECT. Al igual que ocurre con la expresin WHERE, la expresin HAVING debe producir como resultado un valor booleano.
1128
La clusula ORDER BY provoca la ordenacin de las filas de resultados. El argumento sort-expr-list de la clusula ORDER BY es una lista de expresiones utilizadas como clave para la ordenacin. LasexpresionesnotienenporquformarpartedelresultadodeunadeclaracinSELECT,peroenunadeclaracinS ELECTcompuesta(unadeclaracinSELECTqueutiliceunodelosoperadorescompound-op), cada expresin de ordenacin debe coincidir exactamente con una de las columnas de resultados. Cada expresin de ordenacin puede ir acompaada, de forma opcional, de una clusula sort-order formada por la palabra clave COLLATE y el nombre de la funcin de intercalacin utilizada para ordenar el texto, o bien la palabra clave ASC o DESC para especificar el tipo de ordenacin (ascendente o descendente). sort-order se puede omitir y utilizar el valor predeterminado (orden ascendente). Para obtener una definicin de la clusula COLLATE y de las funciones de intercalacin, consulte COLLATE. La clusula LIMIT pone un lmite superior al nmero de filas devueltas en el resultado. Un valor negativo de LIMIT indica la ausencia de lmite superior. El OFFSET opcional que sigue a LIMIT especifica el nmero de filas que se deben saltar al principio del conjunto de resultados. En una consulta SELECT compuesta, la clusula LIMIT tal vez aparezca slo tras la declaracin SELECT final. El lmite se aplica a toda la consulta. Tenga en cuenta que si utiliza la palabra clave OFFSET en la clusula LIMIT, el lmite es el primer entero y el desfase es el segundo entero. Si se utiliza una coma en vez de la palabra clave OFFSET, el desfase es primer nmero y el lmite es el segundo. Esta aparente contradiccin es intencionada: maximiza la compatibilidad con sistemas de bases de datos SQL heredados. Un SELECT compuesto est formado por do o ms declaraciones SELECT simples conectadas por uno de los operadores UNION, UNION ALL, INTERSECT o EXCEPT. En un SELECT, compuesto, todas las declaraciones SELECT que lo forman deben especificar el mismo nmero de columnas de resultados. Slo puede haber una clusula ORDER BY nica tras la declaracin SELECT final (y antes de la clusula LIMIT nica, si se ha especificado). Los operadores UNION y UNION ALL combinan los resultados de las declaraciones SELECT siguiente y anterior en una sola tabla. La diferencia reside en que en UNION, todas las filas de resultados son distintas, mientras que en UNION ALL puede haber duplicados. El operador INTERSECT toma la interseccin de los resultados de las declaraciones SELECT anterior y siguiente. EXCEPT toma el resultado del SELECT anterior tras eliminar los resultados del SELECT siguiente. Si se conectan tres o ms declaraciones SELECT en una compuesta, se agrupan de la primera a la ltima. Para obtener una definicin de las expresiones permitidas, consulte Expresiones. Desde AIR 2.5, el operador CAST de SQL es compatible al leer para convertir los datos BLOB a objetos ByteArray de ActionScript. Por ejemplo, el siguiente cdigo lee los datos sin procesar que no se almacenen en formato AMF y los almacena en un objeto ByteArray:
stmt.text = "SELECT CAST(data AS ByteArray) AS data FROM pictures;"; stmt.execute(); var result:SQLResult = stmt.getResult(); var bytes:ByteArray = result.data[0].data;
INSERT La declaracin INSERT se expresa de dos formas bsicas y se utiliza para llenar tablas con datos.
sql-statement ::= INSERT [OR conflict-algorithm] INTO [database-name.] table-name [(columnlist)] VALUES (value-list) | INSERT [OR conflict-algorithm] INTO [database-name.] table-name [(columnlist)] select-statement REPLACE INTO [database-name.] table-name [(column-list)] VALUES (value-list) | REPLACE INTO [database-name.] table-name [(column-list)] select-statement
1129
La primera expresin (con la palabra clave VALUES) crea una nica nueva fila en una tabla existente. Si no se especifica un column-list, el nmero de valores debe coincidir con el nmero de columnas de la tabla. Si se especifica un column-list, el nmero de valores debe coincidir con el nmero de columnas especificadas. Las columnas de la tabla que no aparecen en la lista de columnas se llenan con valores predeterminados en el momento de creacin de la tabla, o con NULL si no hay ningn valore predeterminado definido. La segunda expresin de la declaracin INSERT toma los datos de una declaracin SELECT. El nmero de columnas del resultado de SELECT debe coincidir exactamente con el nmero de columnas de la tabla si no se especifica columnlist, o debe coincidir con el nmero de columnas especificadas en el column-list. Se realiza una nueva entrada en la tabla por cada fila del resultado de SELECT. El SELECT puede ser simple o compuesto. Para obtener una definicin de las declaraciones SELECT admitidas, consulte SELECT. El conflict-algorithm opcional permite especificar un algoritmo de resolucin de conflictos de restricciones alternativo y utilizarlo durante este comando. Para ver una explicacin y definicin de algoritmos de conflicto, consulte Declaraciones y clusulas especiales en la pgina 1136. Las dos formas de REPLACE INTO de la declaracin equivalen a utilizar la expresin INSERT [OR conflict-algorithm] estndar con el algoritmo de conflictos REPLACE (p.ej. la forma INSERT OR REPLACE...). Las dos formas de REPLACE INTO de la declaracin equivalen a utilizar la expresin INSERT [OR conflict-algorithm] estndar con el algoritmo de conflictos REPLACE (p.ej. la forma INSERT OR REPLACE...). UPDATE El comando de actualizacin cambia los registros existentes en una tabla.
sql-statement [WHERE expr] ::= UPDATE [database-name.] table-name SET column1=value1, column2=value2,...
El comando consta de una palabra clave UPDATE seguida del nombre de la tabla en la que se desean actualizar los registros. Tras la palabra clave SET, indique el nombre de la columna y el valor con el que la columna cambiar como lista separada por comas. La expresin de la clusula WHERE proporciona la fila o filas en las que se actualizan los registros. DELETE El comando DELETE se utiliza para eliminar registros de una tabla.
sql-statement ::= DELETE FROM [database-name.] table-name [WHERE expr]
El comando est formado por las palabras clave DELETE FROM seguidas del nombre de la tabla de la que se eliminarn los registros. Sin una clusula WHERE, se eliminan todas las filas de la tabla. Si se facilita una clusula WHERE, slo se eliminan las filas que coincidan con la expresin. La expresin de la clusula WHERE debe producir como resultado un valor booleano. Para obtener una definicin de las expresiones permitidas, consulte Expresiones.
1130
ndices: CREATE INDEX DROP INDEX Vistas: CREATE VIEWS DROP VIEWS Activadores: CREATE TRIGGERS DROP TRIGGERS
CREATE TABLE Una declaracin CREATE TABLE est formada por las palabras clave CREATE TABLE, seguidas del nombre de la nueva tabla y (entre parntesis) una lista de definiciones y restricciones de columnas. El nombre de la tabla puede ser un identificador o una cadena.
sql-statement name sql-statement statement column-def type column-constraint ::= CREATE [TEMP | TEMPORARY] TABLE [IF NOT EXISTS] [database-name.] table( column-def [, column-def]* [, constraint]* ) CREATE [TEMP | TEMPORARY] TABLE [database-name.] table-name AS select-
name [type] [[CONSTRAINT name] column-constraint]* typename | typename ( number ) | typename ( number , number ) NOT NULL [ conflict-clause ] | PRIMARY KEY [sort-order] [ conflict-clause ] [AUTOINCREMENT] | UNIQUE [conflict-clause] | CHECK ( expr ) | DEFAULT default-value | COLLATE collation-name constraint ::= PRIMARY KEY ( column-list ) [conflict-clause] | UNIQUE ( column-list ) [conflict-clause] | CHECK ( expr ) conflict-clause ::= ON CONFLICT conflict-algorithm conflict-algorithm ::= ROLLBACK | ABORT | FAIL | IGNORE | REPLACE default-value ::= NULL | string | number | CURRENT_TIME | CURRENT_DATE | CURRENT_TIMESTAMP sort-order ::= ASC | DESC collation-name ::= BINARY | NOCASE column-list ::= column-name [, column-name]*
Cada definicin de columna es el nombre de la columna seguido de su tipo de datos correspondiente y, por ltimo, una o varias restricciones de columna opcionales. El tipo de datos de la columna limita los datos que pueden guardarse en dicha columna. Si se intenta guardar un valor en una columna con tipos de datos distintos, el motor de ejecucin convertir el valor en el tipo adecuado si es posible, o lanzar un error. Consulte la seccin Compatibilidad de tipos de datos para obtener ms informacin. La restriccin de la columna NOT NULL indica que la columna no puede contener valores NULL. Una restriccin UNIQUE provoca la creacin de un ndice en la columna o columnas especificadas. Este ndice puede contener claves nicas: dos filas no pueden contener valores duplicados o combinaciones de valores para la columna o columnas especificadas. Una declaracin CREATE TABLE puede tener varias restricciones UNIQUE, incluidas varias columnas con una restriccin UNIQUE en la definicin de la columna o mltiples restricciones UNIQUE en el nivel de las tablas.
1131
Una restriccin CHECK define una expresin que se calcula y debe ser true para poder insertar o actualizar los datos de una fila. La expresin CHECK debe producir como resultado un valor booleano. Una clusula COLLATE en una definicin de columna especifica qu funcin de intercalacin de texto debe usarse al comparar entradas de texto en la columna. La funcin de intercalacin BINARY se utiliza de forma predeterminada. Para obtener ms informacin sobre la clusula COLLATE y sus funciones de intercalacin, consulte COLLATE. La restriccin DEFAULT especifica un valor predeterminado para utilizarlo con un INSERT. El valor puede ser NULL, una constante de cadena o un nmero. El valor predeterminado tambin puede ser una de las palabras clave especiales (no distinguen entre maysculas y minsculas) CURRENT_TIME, CURRENT_DATE o CURRENT_TIMESTAMP. Si el valor es NULL, se inserta (literalmente) una constante de cadena o un nmero en la columna cada vez que una declaracin INSERT no especifique un valor para la columna. Si el valor es CURRENT_TIME, CURRENT_DATE o CURRENT_TIMESTAMP, se inserta en la columna la fecha/hora UTC actual. Para CURRENT_TIME, el formato es HH:MM:SS. Para CURRENT_DATE, el formato es YYYY-MM-DD. El formato para CURRENT_TIMESTAMP es YYYY-MM-DD HH:MM:SS. Al especificar un PRIMARY KEY, normalmente slo se crea un ndice de UNIQUE en la columna o columnas correspondientes. Sin embargo, si la restriccin PRIMARY KEY se encuentra en una sola columna con el tipo de datos INTEGER (o a uno de sus equivalentes como int), entonces la base de datos utiliza dicha columna como clave principal actual para la tabla. Esto significa que la columna slo puede contener valores enteros nicos. (Tenga en cuenta que en muchas implementaciones de SQLite slo el tipo de columna INTEGER hace que la columna sirva de clave principal interna, pero en Adobe AIR, los equivalentes de INTEGER como int tambin proporcionan este comportamiento.) Si una tabla no contiene una columna INTEGER PRIMARY KEY, se generar automticamente una clave de enteros al insertar una fila. Siempre se puede acceder a la clave principal de una fila mediante uno de los nombres especiales ROWID, OID o _ROWID_. Puede utilizar estos nombres tanto si son un INTEGER PRIMARY KEY declarado explcitamente o un valor interno generado. No obstante, si la tabla tiene un INTEGER PRIMARY KEY explcito, el nombre de la columna de los datos del resultado es el nombre real de la columna, no el nombre especial. Una cINTEGER PRIMARY KEY tambin puede contener la palabra clave AUTOINCREMENT. Cuando se utiliza la palabra clave AUTOINCREMENT , la base de datos genera automticamente una clave entera incrementada y la inserta en la columna INTEGER PRIMARY KEY cuando ejecuta una declaracin INSERT que no especifica ningn valor explcito para la columna. Slo puede haber una restriccin PRIMARY KEY en una declaracin CREATE TABLE. Puede ser parte de una definicin de columna o tratarse de una restriccin PRIMARY KEY nica en el nivel de tablas. Una columna de clave principal es NOT NULL implcitamente. La clusula conflict-clause opcional con restricciones permite especificar un algoritmo de resolucin de conflictos de restricciones alternativo predeterminado para dicha restriccin. El valor predeterminado es ABORT. Las restricciones distintas de la misma tabla pueden tener distintos algoritmos de resolucin de conflictos predeterminados. Si una declaracin INSERT o UPDATE especifica un algoritmo de resolucin de conflictos de restricciones distinto, dicho algoritmo se utilizar en vez del especificado en la declaracin CREATE TABLE. Consulte la seccin ON CONFLICT de Declaraciones y clusulas especiales en la pgina 1136 para obtener ms informacin. Las restricciones adicionales, como las FOREIGN KEY, no producen errores porque el motor de ejecucin las omite. Si las palabras clave TEMP o TEMPORARY se encuentran entre CREATE y TABLE, la tabla creada slo ser visible dentro de la misma conexin de base de datos (instancia de SQLConnection). Se elimina automticamente cuando se cierra la conexin de base de datos. Todos los ndices creados en una tabla temporal tambin son temporales. Las tablas y los ndices temporales se guardan en un archivo independiente distinto del archivo principal de la base de datos.
1132
Si se especifica el prefijo opcional database-name, la tabla se crea en una base de datos especificada (base de datos conectada a la instancia de SQLConnection mediante la llamada al mtodo attach() con el nombre de base de datos especificado). Es un error especificar un prefijo database-name y la palabra clave TEMP, a no ser que el prefijo database-name sea temp. Si no se especifica ningn nombre de base de datos y la palabra clave TEMP no est presente, la tabla se crea en la base de datos principal (la base de datos conectada a la instancia de SQLConnection mediante el mtodo open() o openAsync()). No hay lmites arbitrarios en el nmero de columnas o en el nmero de restricciones de una tabla. Tampoco hay lmites arbitrarios en la cantidad de datos de una fila. La expresin CREATE TABLE AS define la tabla como el conjunto de resultados de una consulta. Los nombres de las columnas de la tabla son los nombres de las columnas del resultado. Si la clusula IF NOT EXISTS opcional est presente y ya existe otra tabla con el mismo nombre, la base de datos ignora el comando CREATE TABLE. Se puede eliminar una tabla con la declaracin DROP TABLE, y se pueden realizar cambios limitados con la declaracin ALTER TABLE. ALTER TABLE El comando ALTER TABLE permite al usuario renombrar o agregar una nueva columna a una tabla existente. No es posible eliminar una columna de una tabla.
sql-statement ::= ALTER TABLE [database-name.] table-name alteration alteration ::= RENAME TO new-table-name alteration ::= ADD [COLUMN] column-def
Se utiliza la sintaxis RENAME TO para renombrar la tabla identificada por [database-name.] como new-table-name. Este comando no se puede utilizar para mover una tabla entre bases de datos asociadas; slo sirve para renombrar una tabla dentro de la misma base de datos. Si la tabla que se va a renombrar contiene activadores o ndices, stos permanecen asociados a la tabla una vez renombrada. No obstante, si hay definiciones o declaraciones de vistas ejecutadas por activadores que hacen referencia a la tabla que se est renombrando, no se actualizan automticamente con el nuevo nombre de la tabla. Si la tabla renombrada tiene vistas o activadores asociados, debe descartarlos manualmente y recrear las definiciones de los activadores o las vistas con el nuevo nombre de la tabla. Se utiliza la sintaxis ADD [COLUMN] para agregar una nueva columna a una tabla existente. La nueva columna siempre se aade al final de la lista de las columnas existentes. La clusula column-def puede expresarse de todas las formas permitidas en una declaracin CREATE TABLE, aunque con las siguientes restricciones:
La columna no puede tener una restriccin PRIMARY KEY o UNIQUE. La columna no puede tener un valor predeterminado CURRENT_TIME, CURRENT_DATE o
CURRENT_TIMESTAMP.
Si se especifica una restriccin NOT NULL, la columna debe tener un valor predeterminado distinto de NULL.
El tiempo de ejecucin de la declaracin ALTER TABLE no se ve afectado por la cantidad de datos de la tabla. DROP TABLE La declaracin DROP TABLE elimina una tabla agregada con una declaracin CREATE TABLE. La tabla con el tablename especificado es la que se descarta. Se elimina completamente de la base de datos y del archivo del disco. No es posible recuperar la tabla. Todos los ndices asociados a la tabla se eliminan tambin.
sql-statement ::= DROP TABLE [IF EXISTS] [database-name.] table-name
1133
De forma predeterminada, la declaracin DROP TABLE no reduce el tamao del archivo de base de datos. El espacio libre de la base de datos se conserva y se utiliza en operaciones INSERT posteriores. Para eliminar espacio libre de la base de datos, utilice el mtodo SQLConnection.clean(). Si el parmetro autoClean se establece en true al crear la base de datos por primera vez, el espacio se libera automticamente. La clusula IF EXISTS opcional desactiva el error que se producira si la tabla no existiese. CREATE INDEX El comando CREATE INDEX est formado por las palabras clave CREATE INDEX seguidas del nombre del nuevo ndice, la palabra clave ON, el nombre de una tabla creada previamente para indexar y una lista entre parntesis de los nombres de las columnas cuyos valores se utilizan para la clave del ndice.
sql-statement column-name ::= ::= CREATE [UNIQUE] INDEX [IF NOT EXISTS] [database-name.] index-name ON table-name ( column-name [, column-name]* ) name [COLLATE collation-name] [ASC | DESC]
Cada columna puede ir seguida de las palabras clave ASC o DESC para indicar la ordenacin, pero la designacin del orden se omite en tiempo de ejecucin. La ordenacin siempre se establece en orden ascendente. La clusula COLLATE que sigue a cada nombre de columna define una secuencia de intercalacin utilizada para los valores de texto de dicha columna. La secuencia de intercalacin predeterminada es la definida para dicha columna en la declaracin CREATE TABLE. Si no se especifica ninguna secuencia de intercalacin, se utiliza BINARY. Para obtener una definicin de la clusula COLLATE y de las funciones de intercalacin, consulte COLLATE. No hay lmites arbitrarios en el nmero de ndices que se pueden asociar a una sola tabla. Tampoco hay lmites en el nmero de columnas de cada ndice. DROP INDEX La declaracin DROP INDEX elimina un ndice agregado con la declaracin CREATE INDEX. El ndice especificado se elimina completamente del archivo de base de datos. La nica forma de poder recuperar el ndice es volver a escribir el comando CREATE INDEX correspondiente.
sql-statement ::= DROP INDEX [IF EXISTS] [database-name.] index-name
De forma predeterminada, la declaracin DROP INDEX no reduce el tamao del archivo de base de datos. El espacio libre de la base de datos se conserva y se utiliza en operaciones INSERT posteriores. Para eliminar espacio libre de la base de datos, utilice el mtodo SQLConnection.clean(). Si el parmetro autoClean se establece en true al crear la base de datos por primera vez, el espacio se libera automticamente. CREATE VIEW El comando CREATE VIEW asigna un nombre a una declaracin SELECT predefinida. Este nuevo nombre se puede utilizar posteriormente en una clusula FROM de otra declaracin SELECT en vez de un nombre de tabla. Las vistas se suelen utilizar para simplificar las consultas combinando un complejo conjunto de datos (de uso frecuente) en una estructura que se puede utilizar en otras operaciones.
sql-statement ::= CREATE [TEMP | TEMPORARY] VIEW [IF NOT EXISTS] [database-name.] view-name AS select-statement
Si la palabra clave TEMP o TEMPORARY se encuentra entre CREATE y VIEW, la vista creada slo es visible para la instancia de SQLConnection que abri la base de datos y se elimina automticamente al cerrarla.
1134
Si se especifica un [database-name], la vista se crea en la base de datos especificada (una base de datos conectada a la instancia de SQLConnection mediante el mtodo attach(), con el argumento name especificado. Es un error especificar un [database-name] y la palabra clave TEMP a no ser que [database-name] sea temp. Si no se especifica ningn nombre de base de datos y la palabra clave TEMP no est presente, la vistase crea en la base de datos principal (la base de datos conectada a la instancia de SQLConnection mediante el mtodo open() o openAsync()). Las vistas son de slo lectura. Una declaracin DELETE, INSERT o UPDATE no se puede utilizar en una vista, a no ser que se haya definido al menos un activador del tipo asociado (INSTEAD OF DELETE, INSTEAD OF INSERT, INSTEAD OF UPDATE). Para obtener ms informacin sobre la creacin de un activador para una vista, consulte CREATE TRIGGER. La declaracin DROP VIEW elimina una vista de la base de datos. DROP VIEW La declaracin DROP VIEW elimina una vista creada con la declaracin CREATE VIEW.
sql-statement ::= DROP VIEW [IF EXISTS] view-name
El view-name especificado es el nombre de la vista que se va a descartar. Se elimina de la base de datos, pero no se modifica ningn dato de las tablas subyacentes. CREATE TRIGGER La declaracin CREATE TRIGGER se utiliza para agregar activadores al esquema de base de datos. Un activador es una operacin de base de datos (trigger-action) que se lleva a cabo automticamente cuando se produce un evento concreto de base de datos (database-event).
sql-statement name ::= CREATE [TEMP | TEMPORARY] TRIGGER [IF NOT EXISTS] [database-name.] trigger[BEFORE | AFTER] database-event ON table-name trigger-action ::= CREATE [TEMP | TEMPORARY] TRIGGER [IF NOT EXISTS] [database-name.] triggerINSTEAD OF database-event ON view-name trigger-action DELETE | INSERT | UPDATE | UPDATE OF column-list [FOR EACH ROW] [WHEN expr] BEGIN trigger-step ; [ trigger-step ; ]* END update-statement | insert-statement | delete-statement | select-statement column-name [, column-name]*
sql-statement name
database-event
::=
trigger-action
::=
trigger-step
::=
column-list
::=
1135
Un activador se activa cada vez que se produce un DELETE, INSERT o UPDATE en una tabla de base de datos particular, o cuando se actualiza el UPDATE de una o varias columnas de una tabla. Los activadores son permanente, a no ser que se utilice la palabra clave TEMP o TEMPORARY. En ese caso, el activador se elimina cuando se cierra la conexin de base de datos principal de la instancia de SQLConnection. Si no se especifica ningn tiempo, (BEFORE o AFTER) el valor predeterminado del activador es BEFORE. Slo se admiten activadores FOR EACH ROW, por lo que el texto FOR EACH ROW es opcional. Con un activador FOR EACH ROW, se ejecutan las declaraciones trigger-step en cada fila de la base de datos que se inserte, actualice o elimine. Para ello, la declaracin activa el activador si la expresin de clusula WHEN produce true como resultado. Si se facilita una clusula WHEN, las declaraciones SQL especificadas como pasos de activacin slo se ejecutan en las filas en las que la clusula WHEN es true. Si no se facilita ninguna clusula WHEN, las declaraciones SQL se ejecutan en todas las filas. Dentro del cuerpo de un activador (la clusula trigger-action), los valores previos y siguientes de cambios de la tabla afectada estn disponibles con los nombres especiales de tabla OLD y NEW. La estructura de las tablas OLD y NEW coincide con la estructura de la tabla en la que se crea el activador. La tabla OLD contiene todas las filas modificadas o eliminadas con la declaracin del activador en el estado que tenan antes de iniciarse las operaciones de la declaracin. La tabla NEW contiene todas las filas modificadas o creadas con la declaracin del activador en el estado que tenan despus de iniciarse las operaciones de la declaracin. Tanto la clusula WHEN como las declaraciones trigger-step pueden acceder a valores de la fila insertada, eliminada o actualizada mediante referencias expresadas como NEW.column-name y OLD.column-name, donde column-name es el nombre de la columna de la tabla con la que se asocia el activador. La disponibilidad de las referencias a la tabla OLD y NEW depende del tipo de database-event gestionado por el activador:
INSERT las referencias NEW son vlidas UPDATE las referencias NEW y OLD son vlidas DELETE las referencias OLD son vlidas
El tiempo especificado (BEFORE, AFTER o INSTEAD OF) determina cundo se ejecutan las declaraciones triggerstep en relacin a la insercin, modificacin o eliminacin de la fila asociada. Una clusula ON CONFLICT puede especificarse como parte de una declaracin UPDATE o INSERT en un trigger-step. Sin embargo, si se especifica una clusula ON CONFLICT como parte de la declaracin que activa el activador, se utilizar la poltica de gestin de conflictos. Adems de activadores de tablas, se puede crear un activador INSTEAD OF en una vista. Si se definen uno o varios INSTEAD OF INSERT, INSTEAD OF DELETE o INSTEAD OF UPDATE en una vista, no se considerar un error ejecutar el tipo asociado de la instancia (INSERT, DELETE o UPDATE) en la vista. En ese caso, al ejecutar un INSERT, DELETE o UPDATE en la vista, activa los activadores asociados. Como el activador es un activador INSTEAD OF, las tablas subyacentes de la vista no se modifican con la declaracin que activa el activador. Sin embargo, los activadores se pueden utilizar para realizar operaciones de modificacin en las tablas subyacentes. Debe tener algo importante en cuenta cuando cree un activador en una tabla con una columna INTEGER PRIMARY KEY. Si un activador BEFORE modifica la columna INTEGER PRIMARY KEY de una fila que se deba actualizar con la declaracin que activa el activador, no se realiza ninguna actualizacin. Una alternativa es crear la tabla con una columna PRIMARY KEY en vez de con una columna INTEGER PRIMARY KEY. Un activador se puede eliminar con la declaracin DROP TRIGGER. Cuando se visualiza o se descarta una tabla, todos los activadores asociados a la tabla o a la vista tambin se descartan automticamente. Funcin RAISE () Se puede utilizar una funcin SQL RAISE() especial en la declaracin trigger-step de un activador. Esta funcin tiene la sintaxis siguiente:
1136
raise-function
::=
( ( ( (
Cuando se llama a una de las primeras tres expresiones durante la ejecucin del activador, la accin de procesamiento ON CONFLICT especificada (ABORT, FAIL o ROLLBACK) se lleva a cabo y finaliza la ejecucin de la declaracin actual. ROLLBACK se considera un error de ejecucin de declaracin y la instancia de SQLStatement cuyo mtodo execute() se estaba ejecutando distribuye un evento (SQLErrorEvent.ERROR). El objeto SQLError de la propiedad error del objeto de evento distribuido tiene su propiedad details establecida como el error-message especificado en la funcin RAISE(). Cuando se llama a RAISE(IGNORE), se abandona el resto del activador actual, la declaracin que provoc la ejecucin del activador y los activadores posteriores que podran ejecutarse. No se invierte ningn cambio en la base de datos. Si la declaracin que provoc la ejecucin del activador es en s misma un activador, su programa reanuda la ejecucin al principio del siguiente paso. Para obtener ms informacin sobre los algoritmos de resolucin de conflictos, consulte la seccin ON CONFLICT (algoritmos de conflictos). DROP TRIGGER La declaracin DROP TRIGGER elimina un activador creado por la declaracin CREATE TRIGGER.
sql-statement ::= DROP TRIGGER [IF EXISTS] [database-name.] trigger-name
El activador se elimina de la base de datos. Tenga en cuenta que los activadores se descartan automticamente cuando se descarta su tabla asociada.
El tipo de intercalacin predeterminada de las columnas es BINARY. Cuando se utiliza la intercalacin BINARY con valores de la clase de almacenamiento TEXT, se lleva a cabo una intercalacin binaria comparando los bytes de la memoria que representan el valor, independientemente de la codificacin del texto. La secuencia de intercalacin NOCASE slo se aplica a valores de la clase de almacenamiento TEXT. Cuando se utiliza, la intercalacin NOCASE lleva a cabo una comparacin sin distinguir entre maysculas y minsculas. No se utiliza ninguna secuencia de intercalacin en las clases de almacenamiento de tipo NULL, BLOB, INTEGER o REAL.
1137
Para utilizar un tipo de intercalacin que no sea BINARY con una columna, debe especificar una clusula COLLATE como parte de la definicin de la columna en la declaracin CREATE TABLE. Cada vez que se comparan dos valores TEXT, se utiliza una secuencia de intercalacin para determinar los resultados de la comparacin a partir de las siguientes reglas:
En los operadores de comparacin binarios, si uno de los operandos es una columna, el tipo de intercalacin
predeterminada de la columna determina la secuencia de intercalacin que se utiliza para la comparacin. Si ambos operandos son columnas, el tipo de intercalacin del operando izquierdo determina la secuencia de intercalacin utilizada. Si ninguno de los operandos es una columna, se utiliza la secuencia de intercalacin BINARY.
El operador BETWEEN...AND equivale a utilizar dos expresiones con los operadores >= y <=. Por ejemplo, la
expresin x BETWEEN y AND z es equivalente a x >= y AND x <= z. En consecuencia, el operador BETWEEN...AND sigue la regla anterior para determinar la secuencia de intercalacin.
Una clusula ORDER BY que forme parte de una declaracin SELECT puede asignarse explcitamente a una
secuencia de intercalacin para utilizarla en la operacin de ordenacin. En este caso, siempre se utiliza la secuencia de intercalacin explcita. En cualquier otro caso, si la expresin ordenada por una clusula ORDER BY es una columna, el tipo de intercalacin predeterminado de la columna se utilizar para determinar la ordenacin. Si la expresin no es una columna, se utiliza la secuencia de intercalacin BINARY. EXPLAIN El modificador de comandos EXPLAIN es una ampliacin no estndar de SQL.
sql-statement ::= EXPLAIN sql-statement
Si la palabra clave EXPLAIN aparece antes de cualquier otra declaracin SQL, en vez de ejecutar el comando, en realidad el resultado informa sobre la secuencia de instrucciones de la mquina virtual que se habra utilizado para ejecutar el comando, de no haber estado presente la palabra clave EXPLAIN. La funcin EXPLAIN es una funcin avanzada y permite a los desarrolladores cambiar el texto de declaraciones SQL para intentar mejorar el rendimiento o depurar una declaracin que parezca no funcionar correctamente. ON CONFLICT (algoritmos de conflictos) La clusula ON CONFLICT no es un comando SQL independiente. Se trata de una clusula no estndar que puede aparecer en muchos otros comandos SQL.
conflict-clause conflict-clause conflict-algorithm ::= ::= ::= ON CONFLICT conflict-algorithm OR conflict-algorithm ROLLBACK | ABORT | FAIL | IGNORE | REPLACE
La primera expresin de la clusula ON CONFLICT utiliza las palabras clave ON CONFLICT y se utiliza en una declaracin CREATE TABLE. En el caso de una declaracin INSERT o UPDATE, se utiliza la segunda expresin ON CONFLICT sustituida por OR para que la sintaxis sea ms natural. Por ejemplo, en vez de INSERT ON CONFLICT IGNORE, la declaracin se convierte en INSERT OR IGNORE. Aunque las palabras clave son distintas, el significado de la clusula es el mismo en ambas expresiones.
1138
La clusula ON CONFLICT especifica el algoritmo empleado para resolver conflictos de restricciones. Los cinco algoritmos son ROLLBACK, ABORT, FAIL, IGNORE y REPLACE. El algoritmo predeterminado es ABORT. A continuacin se explican los cinco algoritmos de conflictos:
ROLLBACK Cuando se produce una violacin de restriccin, se activa un ROLLBACK inmediatamente y finaliza la
transaccin actual. El comando se cancela y la instancia de SQLStatement distribuye un evento error. Si no hay ninguna transaccin activa (que no sea la transaccin implcita creada en cada comando), este algoritmo funciona igual que ABORT.
ABORT Cuando se produce una violacin de restriccin, el comando descarta todos los cambios anteriores realizados
y la instancia de SQLStatement distribuye un evento error. No se ejecuta ROLLBACK, por lo que se conservan los comandos anteriores de una transaccin. ABORT es el comportamiento predeterminado.
FAIL Cuando se produce una violacin de restriccin, el comando se cancela y la instancia de SQLStatement distribuye
un evento error. No obstante, todos los cambios realizados por la declaracin en la base de datos antes de producirse la violacin se conservan y no se descartan. Por ejemplo, si una declaracin UPDATE encuentra una violacin de restriccin en la fila 100 que intenta actualizar, los cambios realizados en las 99 filas anteriores se conservan, pero no as los de la fila 100 y sucesivas.
IGNORE Cuando se produce una violacin de restriccin, la fila que contiene la violacin no se inserta ni se cambia.
Salvo el caso omiso que se hace a esta fila, el comando contina ejecutndose con normalidad. Las filas anteriores y posteriores a la que contiene la violacin de restriccin se insertan y se actualizan tambin con normalidad. No se devuelve ningn error.
REPLACE Cuando se produce una violacin de restriccin UNIQUE, las filas previas existentes que generan la violacin se eliminan antes de insertar o actualizar la fila actual. En consecuencia, siempre se produce la insercin y la actualizacin de filas y el comando sigue ejecutndose con normalidad. No se devuelve ningn error. Si se produce una violacin de restriccin NOT NULL, el valor NULL se reemplaza por el valor predeterminado de dicha columna. Si la columna no tiene ningn valor predeterminado, se utiliza el algoritmo ABORT. Si se produce una violacin de restriccin CHECK, se utiliza el algoritmo IGNORE. Cuando esta estrategia de resolucin de conflictos elimina filas para poder satisfacer una restriccin, no se invocan activadores de eliminacin en otras filas.
El algoritmo especificado en la clusula OR de una declaracin INSERT o UPDATE anula cualquier algoritmo especificado en una declaracin CREATE TABLE. Si no se especifica ningn algoritmo en la declaracin CREATE TABLE o en la declaracin INSERT o UPDATE en ejecucin, se utiliza el algoritmo ABORT. REINDEX El comando REINDEX se utiliza para eliminar y recrear uno o varios ndices. El comando resulta til si ha cambiado la definicin de una secuencia de intercalacin.
sql-statement sql-statement ::= ::= REINDEX collation-name REINDEX [database-name .] ( table-name | index-name )
En la primera expresin, se recrean todos los ndices de las bases de datos asociadas que utilicen la secuencia de intercalacin especificada. En la segunda expresin, cuando se especifica un table-name, se reconstruyen todos los ndices asociados a la tabla. Si se especifica un index-name, slo se elimina y se recrea el ndice especificado. COMENTARIOS Los comentarios no son comandos SQL, pero pueden estar presentes en las consultas SQL. El motor de ejecucin los trata como espacios en blanco. Pueden empezar en cualquier ubicacin de un espacio en blanco, incluidas expresiones al margen que abarquen varias lneas.
1139
comment
::=
Un comentario de una sola lnea se indica con dos guiones. Un comentario de una sola lnea slo llega hasta el final de la lnea actual. Los comentarios en bloque pueden abarcar varias lneas o incorporarse en una sola lnea. Si no hay ningn delimitador, un comentario en bloque llega hasta el final de la entrada. Esta situacin no se trata como un error. Una nueva declaracin SQL puede empezar en una nueva lnea detrs del final del comentario en bloque. Los comentarios en bloque pueden incluirse en cualquier espacio en blanco, incluidas expresiones al margen, y en medio de otras declaraciones SQL. Los comentarios en bloque no se pueden anidar. Los comentarios de una sola lnea dentro de un comentario en bloque no se tienen en cuenta. EXPRESIONES Las expresiones son subcomandos dentro de otros bloques SQL. A continuacin se describe la sintaxis vlida para una expresin dentro de una declaracin SQL:
expr ::= expr binary-op expr | expr [NOT] like-op expr [ESCAPE expr] | unary-op expr | ( expr ) | column-name | table-name.column-name | database-name.table-name.column-name | literal-value | parameter | function-name( expr-list | * ) | expr ISNULL | expr NOTNULL | expr [NOT] BETWEEN expr AND expr | expr [NOT] IN ( value-list ) | expr [NOT] IN ( select-statement ) | expr [NOT] IN [database-name.] table-name | [EXISTS] ( select-statement ) | CASE [expr] ( WHEN expr THEN expr )+ [ELSE expr] END | CAST ( expr AS type ) | expr COLLATE collation-name LIKE | GLOB see Operators see Operators :param-name | @param-name | ? literal-value [, literal-value]* literal-string | literal-number | literal-boolean | literal-blob |
like-op ::= binary-op ::= unary-op ::= parameter ::= value-list ::= literal-value ::= literal-null literal-string ::= 'string value' literal-number ::= integer | number literal-boolean ::= true | false literal-blob ::= X'string of hexadecimal data' literal-null ::= NULL
Una expresin es una combinacin de valores y operadores que pueden producir como resultado un valor. Las expresiones se pueden dividir en dos tipos generales, en funcin de si producen un valor booleano (true o false) o un valor no booleano.
1140
En mltiples situaciones habituales, incluidas las clusulas WHERE y HAVING, la expresin ON en una clusula JOIN, y una expresin CHECK, la expresin debe producir como resultado un valor booleano. Los siguientes tipos de expresiones cumplen esta condicin:
ISNULL NOTNULL IN () EXISTS () LIKE GLOB Ciertas funciones Ciertos operadores (concretamente, operadores de comparacin)
Valores literales Un valor numrico literal se escribe como un nmero entero o un nmero de coma flotante. Se admite notacin cientfica. El carcter . (punto) siempre se utiliza como punto decimal. Un literal de cadena se indica encerrando la cadena en comillas simples '. Para incluir una comilla dentro de una cadena, ponga dos comillas sencillas seguidas como en el siguiente ejemplo: ''. Un literal booleano se indica con el valor true o false. Los valores de literal booleano se utilizan con el tipo de datos de columna Boolean. Un literal BLOB es un literal de cadena que contiene datos hexadecimales y est precedido de un solo carcter x o X, como X'53514697465'. Un valor de literal tambin puede ser el token NULL. Nombre de columna Un nombre de columna puede ser cualquiera de los nombres definidos en la declaracin CREATE TABLE o uno de los siguientes identificadores especiales: ROWID, OID o _ROWID_. Todos estos identificadores especiales describen la nica clave de enteros aleatorios (la "clave de fila") asociada a cada fila de la tabla. Los identificadores especiales slo hacen referencia a la clave de la fila si la declaracin CREATE TABLE no define una columna real con el mismo nombre. Las claves de fila se comportan como columnas de slo lectura. Una clave de fila se puede utilizar en cualquier situacin en que utilizara una columna normal, salgo para cambiar el valor de una clave de fila en una declaracin UPDATE o INSERT. La declaracin SELECT * FROM no incluye la clave de fila en su conjunto de resultados. Declaracin SELECT Una declaracin SELECT puede aparecer en una expresin bien como el operando a la derecha del operador IN, como una cantidad escalar (un valor de resultado nico) o como el operando de un operador EXISTS. Cuando se utiliza como una cantidad escalar o como el operando de un operador IN, el SELECT slo puede tener una columna en su resultado. Se permite una declaracin SELECT compuesta (conectada con palabras clave como UNION o EXCEPT). Con el operador EXISTS, las columnas del conjunto de resultados de SELECT se ignoran y la expresin devuelve TRUE si existen una o varias filas y devuelve FALSE si el conjunto de resultados est vaco. Si ningn trmino de la expresin SELECT hace referencia al valor de la consulta que lo contiene, la expresin se calcula una vez antes de cualquier otro procesamiento y, si es necesario, se reutiliza el resultado. Si la expresin SELECT contiene variables de la consulta exterior (denominada subconsulta correlacionada), SELECT se vuelve a calcular cada vez que sea necesario.
1141
Cuando SELECT es el operando a la derecha del operador IN, el operador IN devuielve TRUE si el resultado del operando a la izquierda es igual que cualquiera de los valores del conjunto de resultados de la declaracin SELECT. El operador IN puede estar precedido de la palabra clave NOT para invertir el sentido de la prueba. Cuando aparece un SELECT en una expresin, pero no es un operando a la derecha del operador IN, la primera fila del resultado de SELCT pasa a ser el valor utilizado en la expresin. Si SELECT arroja ms de una fila de resultados, se ignoran todas las filas siguientes. Si SELECT no arroja ninguna fila, el valor de SELECT es NULL. Expresin CAST Una expresin CAST cambia el tipo de datos del valor especificado al proporcionado. El tipo especificado puede ser cualquier nombre de tipo no vaco vlido para el tipo en una definicin de columna de la declaracin CREATE TABLE. Consulte la seccin Compatibilidad de tipos de datos para obtener ms informacin. Elementos de expresiones adicionales Los siguientes elementos SQL tambin se pueden utilizar en expresiones:
Funciones incorporadas: Funciones de agregacin, funciones escalares y funciones de formato de fecha y hora Operadores Parmetros
Funciones incorporadas
Las funciones incorporadas se pueden dividir en tres categoras principales:
SUM(X) TOTAL(X)
1142
En cualquiera de las funciones de agregacin anteriores que toman un solo argumento, dicho argumento puede ir precedido de la palabra clave DISTINCT. En este caso, los elementos duplicados se filtran antes de transferirse a la funcin de agregacin. Por ejemplo, la llamada a la funcin COUNT(DISTINCT x) devuelve el nmero de valores distintos de la columna X y no el nmero total de valores no NULL de la columna x. Funciones escalares Las funciones escalares operan con valores, de fila en fila.
ABS(X) COALESCE(X, Y, ...) GLOB(X, Y) IFNULL(X, Y) HEX(X) LAST_INSERT_ROWID( ) LENGTH(X) LIKE(X, Y [, Z]) Devuelve el valor absoluto del argumento X. Devuelve una copia del primer argumento no NULL. Si todos los argumentos son NULL se devuelve NULL. Debe haber al menos dos argumentos. Esta funcin se utiliza para implementar la sintaxis de X GLOB Y. Devuelve una copia del primer argumento no NULL. Si ambos argumentos son NULL se devuelve NULL. Esta funcin se comporta como COALESCE(). El argumento se interpreta como un valor de tipo de almacenamiento BLOB. El resultado es una representacin hexadecimal del contenido de dicho valor. Devuelve el identificador de fila (clave principal generada) de la ltima fila insertada en la base de datos mediante la instancia de SQLConnection actual. Este valor es el mismo que el valor devuelto por la propiedad SQLConnection.lastInsertRowID. Devuelve la longitud de cadena de X en caracteres. Esta funcin se utiliza para implementar la sintaxis de X LIKE Y [ESCAPE Z] de SQL. Si la clusula ESCAPE opcional est presente, se invoca la funcin con tres argumentos. En caso contrario, se invoca slo con dos argumentos. Devuelve una copia de la cadena X con todos los caracteres convertidos a minscula. Devuelve una cadena formada al eliminar espacios desde la izquierda de X. Si se especifica un argumento Y, la funcin elimina todos los caracteres de Y desde la izquierda de X. Devuelve el argumento con el valor mximo. Los argumentos pueden ser cadenas, adems de nmeros. El valor mximo se determina con la ordenacin definida. Tenga en cuenta que MAX() es una funcin simple cuando tiene 2 o ms argumentos, pero es una funcin de agregacin cuando tiene un solo argumento. Devuelve el argumento con el valor mnimo. Los argumentos pueden ser cadenas, adems de nmeros. El valor mnimo se determina con la ordenacin definida. Tenga en cuenta que MIN() es una funcin simple cuando tiene 2 o ms argumentos, pero es una funcin de agregacin cuando tiene un solo argumento. Devuelve el primer argumento si los argumentos son distintos; en caso contrario, devuelve NULL. Esta rutina devuelve una cadena que es el valor de su argumento indicado para su inclusin en otra declaracin SQL. Las cadenas se encierran con comillas simples y tantos saltos en las comillas interiores como sea necesario. Las clases de almacenamiento BLOB se codifican como literales hexadecimales. Esta funcin resulta til cuando se escriben activadores que implementan funciones de deshacer y rehacer. Devuelve un entero seudoaleatorio entre -9223372036854775808 y 9223372036854775807. Este valor aleatorio no tiene proteccin cifrada. Devuelve un BLOB de N bytes con bytes seudoaleatorios. N debe ser un entero positivo. Este valor aleatorio no tiene proteccin cifrada. Si el valor de N es negativo, se devuelve un solo byte. Redondea el nmero X a Y dgitos a la derecha del punto decimal. Si se omite el argumento Y, se utiliza 0. Devuelve una cadena formada al eliminar espacios desde la derecha de X. Si se especifica un argumento Y, la funcin elimina todos los caracteres de Y desde la derecha de X. Devuelve una subcadena de la cadena de entrada X que comienza con el carcter nmero Y de Z caracteres de longitud. El carcter situado ms a la izquierda de X es la posicin 1 del ndice. Si Y es negativo, el primer carcter de la subcadena se busca contando desde la derecha y no desde la izquierda. Devuelve una cadena formada al eliminar espacios desde la derecha de X. Si se especifica un argumento Y, la funcin elimina todos los caracteres de Y desde la derecha de X. Devuelve el tipo de expresin X. Los posibles valores devueltos son 'null', 'integer', 'real', 'text' y 'blob'. Para obtener ms informacin sobre los tipos de datos, consulte la seccin Compatibilidad de tipos de datos. Devuelve una copia de la cadena de entrada X convertida a mayscula.
MIN(X, Y, ...)
NULLIF(X, Y) QUOTE(X)
RANDOM(*) RANDOMBLOB(N)
UPPER(X)
1143
ZEROBLOB(N)
Funciones de formato de fecha y hora Las funciones de formato de fecha y hora son un grupo de funciones escalares que se utilizan para crear datos de fecha y hora con formato. Tenga en cuenta que estas funciones operan con cadenas y valores numricos y devuelven este tipo de valores. Estas funciones no estn pensadas para utilizarse con el tipo de datos DATE. Si utiliza estas funciones en datos de una columna cuyo tipo de datos declarado sea DATE, no tendrn el comportamiento predeterminado.
DATE(T, ...) La funcin DATE() devuelve una cadena con la fecha en este formato: YYYY-MM-DD. El primer parmetro (T) especifica una cadena de tiempo con el formato encontrado en formato Time. Se puede especificar cualquier nmero de modificadores despus de la cadena de tiempo. Puede encontrar los modificadores disponibles en Modificadores. La funcin TIME() devuelve una cadena que contiene la hora en formato HH:MM:SS. El primer parmetro (T) especifica una cadena de tiempo con el formato encontrado en formato Time. Se puede especificar cualquier nmero de modificadores despus de la cadena de tiempo. Puede encontrar los modificadores disponibles en Modificadores. La funcin DATETIME() devuelve una cadena que contiene la fecha y la hora en formato AAAAMM-DD HH:MM:SS. El primer parmetro (T) especifica una cadena de tiempo con el formato encontrado en formato Time. Se puede especificar cualquier nmero de modificadores despus de la cadena de tiempo. Puede encontrar los modificadores disponibles en Modificadores. La funcin JULIANDAY() devuelve un nmero que indica el nmero de das transcurridos entre el medioda (Greenwich) del 24 de noviembre de 4714 a.C. y la fecha suministrada. El primer parmetro (T) especifica una cadena de tiempo con el formato encontrado en formato Time. Se puede especificar cualquier nmero de modificadores despus de la cadena de tiempo. Puede encontrar los modificadores disponibles en Modificadores. La rutina STRFTIME() devuelve la fecha segn la cadena de formato especificada como el primer argumento F. La cadena de formato admite las siguientes sustituciones: %d: da del mes %f: fracciones de segundo SS.SSS %H: hora 00-24 %j: da del ao 001-366 %J: nmero de da de calendario juliano %m: mes 01-12 %M: minuto 00-59 %s: segundos desde 1970-01-01 %S: segundos 00-59 %w: da de la semana 0-6 (domingo = 0) %W: semana del ao 00-53 %Y: ao 0000-9999 %% - % El segundo parmetro (T) especifica una cadena de tiempo con el formato encontrado en formato Time. Se puede especificar cualquier nmero de modificadores despus de la cadena de tiempo. Puede encontrar los modificadores disponibles en Modificadores.
TIME(T, ...)
DATETIME(T, ...)
JULIANDAY(T, ...)
STRFTIME(F, T, ...)
Formatos de tiempo Una cadena de tiempo puede estar en cualquiera de los siguientes formatos:
YYYY-MM-DD YYYY-MM-DD HH:MM YYYY-MM-DD HH:MM:SS YYYY-MM-DD HH:MM:SS.SSS 2007-06-15 2007-06-15 07:30 2007-06-15 07:30:59 2007-06-15 07:30:59.152
1144
2007-06-15T07:30 2007-06-15T07:30:59 2007-06-15T07:30:59.152 07:30 (la fecha es 2000-01-01) 07:30:59 (la fecha es 2000-01-01) 07:30:59:152 (la fecha es 2000-01-01) Fecha y hora actual en sistema de coordenadas universal (UCT). Nmero de da de calendario juliano como nmero de coma flotante.
El carcter T en estos formatos es un carcter literal "T" que separa la fecha y la hora. Los formatos que slo incluyen una hora asumen que la fecha es 2001-01-01. Modificadores La cadena de tiempo puede no ir seguida de ningn modificador o de varios modificadores que alteran la fecha o su interpretacin. Los modificadores disponibles son:
NNN days NNN hours NNN minutes NNN.NNNN seconds NNN months NNN years start of month start of year start of day weekday N localtime utc Nmero de das que se agregan a la hora. Nmero de horas que se agregan a la hora. Nmero de minutos que se agregan a la hora. Nmero de segundos y milisegundos que se agregan a la hora. Nmero de meses que se agregan a la hora. Nmero de aos que se agregan a la hora. Retrocede al principio del mes. Retrocede al principio del ao. Retrocede al principio del da. Avanza la hora al da de la semana especificado. (0 = domingo, 1 = lunes, etc.). Convierte la fecha en hora local. Convierte la fecha en hora del sistema de coordenadas universal (UTC).
Operadores
SQL admite una amplia seleccin de operadores, incluidos los operadores habituales que existen en la mayora de los lenguajes de programacin, adems de otros operadores exclusivos de SQL. Operadores habituales Los siguientes operadores binarios se permiten en un bloque SQL y se muestran ordenados de mayor a menor precedencia:
* / % + << >> & | < >= > >= = == != AND OR
<> IN
El operador COLLATE se puede entender como un operador de postfijo unario. El operador COLLATE tiene la precedencia mayor. Siempre se vincula con mayor fuerza que cualquier operador de prefijo unario u operador binario.
1145
Tenga en cuenta que existen dos variaciones de los operadores de igualdad y de desigualdad. El operador de igualdad puede ser = o ==. El operador de desigualdad puede ser != o <>. El operador || es el operador de concatenacin de cadenas: une las dos cadenas y sus operandos. El operador % genera el resto de su mdulo de entre el operando izquierdo y el derecho. El resultado de cualquier operador binario es un valor numrico, excepto el operador de concatenacin ||, que produce un resultado de cadena. Operadores SQL LIKE El operador LIKE lleva a cabo una comparacin de coincidencia de patrones.
expr pattern ::= ::= (column-name | expr) LIKE pattern '[ string | % | _ ]'
El operando a la derecha del operador LIKE contiene el patrn y el operando de la izquierda contiene la cadena que debe comparar con el patrn. Un smbolo de porcentaje (%) en el patrn es un carcter comodn: busca cada secuencia de cero o ms caracteres de la cadena y la compara. Un guin bajo (_) en el patrn busca coincidencias de cualquier carcter de la cadena. Cualquier otro carcter se compara consigo mismo o con su equivalente en minsculas/maysculas, es decir, se comparan las bsquedas sin distincin entre maysculas y minsculas. (Nota: el motor de base de datos slo puede leer caracteres en mayscula/minscula Latin de 7 bits. En consecuencia, el operador LIKE distingue entre maysculas y minsculas en caracteres iso8859 de 8 bits o en caracteres UTF-8. Por ejemplo, la expresin 'a' LIKE 'A' es TRUE pero '' LIKE '' es FALSE). La distincin entre maysculas y minsculas en caracteres Latin se puede cambiar con la propiedad SQLConnection.caseSensitiveLike. Si la clusula ESCAPE opcional est presente, la expresin que sigue a la palabra clave ESCAPE debe producir como resultado una cadena con un solo carcter. Este carcter se puede utilizar en el patrn LIKE para coincidir con el porcentaje literal o con los caracteres de guin bajo. El carcter de escape seguido de un smbolo de porcentaje, un guin bajo o el mismo carcter coincide con un smbolo de porcentaje literal, con un guin bajo o con un carcter de escape de la cadena, respectivamente. GLOB El operador GLOB es parecido a LIKE pero utiliza la sintaxis de glob de archivos Unix para los comodines. Al contrario que LIKE, GLOB s distingue entre maysculas y minsculas. IN El operador IN calcula si su operando izquierdo es igual a los valores de su operando derecho (un conjunto de valores entre parntesis).
in-expr ::= expr [NOT] IN expr [NOT] IN expr [NOT] IN literal-value ( value-list ) | ( select-statement ) | [database-name.] table-name [, literal-value]*
value-list
::=
El operando derecho puede ser un conjunto de valores literales separados por comas, o el resultado de una declaracin SELECT. Consulte las declaraciones SELECT de las expresiones para ver una explicacin y las limitaciones de una declaracin SELECT como operando derecho del operador IN. BETWEEN...AND El operador BETWEEN...AND equivale a utilizar dos expresiones con los operadores >= y <=. Por ejemplo, la expresin x BETWEEN y AND z es equivalente a x >= y AND x <= z. NOT
1146
El operador NOT es un operador de negacin. Los operadores GLOB, LIKEe IN pueden ir precedidos de la palabra clave NOT para invertir el sentido de la prueba (dicho de otro modo, para comprobar que un valor no coincide con el patrn indicado).
Parmetros
Un parmetro especifica un marcador de posicin en la expresin para un valor literal que se llena en tiempo de ejecucin asignndole un valor para el conjunto asociativo SQLStatement.parameters. Los parmetros pueden expresarse de tres formas:
? :AAAA Un signo de interrogacin indica un parmetro indexado. A los parmetros se les asignan valores de ndice numricos (basados en cero) segn su orden en la declaracin. Dos puntos seguidos de un nombre de identificador indica un parmetro con el nombre AAAA. Los parmetros especificados tambin se numeran segn su orden en la declaracin SQL. Para evitar confusiones, lo mejor es evitar mezclar parmetros con nombre y con nmero. Un "smbolo de arroba" equivale a dos puntos.
@AAAA
ROW). Los activadores INSTEAD OF no se admiten en tablas (los activadores INSTEAD OF slo se permiten en vistas). Activadores recurrentes: los activadores que se autoactivan no se admiten.
ALTER TABLE Slo se admiten las variantes RENAME TABLE y ADD COLUMN del comando ALTER TABLE. Otros tipos de operaciones ALTER TABLE como DROP COLUMN, ALTER COLUMN, ADD CONSTRAINT, etc., se omiten. Transacciones anidadas Slo se permite una sola transaccin activa. RIGHT y FULL OUTER JOIN RIGHT OUTER JOIN o FULL OUTER JOIN no se admiten. VIEW actualizable Una vista es de slo lectura. No se puede ejecutar una declaracin DELETE, INSERT o UPDATE
en una vista. Un activador INSTEAD OF que se activa para intentar aplicar un DELETE, INSERT o UPDATE en una vista s se admite y se puede utilizar para actualizar las tablas admitidas en el cuerpo del activador.
GRANT y REVOKE Una base de datos es un archivo de disco normal; los nicos permisos de acceso que se pueden aplicar son los habituales de acceso de archivos del sistema operativo instalado. Los comandos GRANT y REVOKE que suelen estar en RDBMS de cliente/servidor no se implementan.
Los siguientes elementos SQL y funciones SQLite se admiten en algunas implementaciones de SQLite, pero no en Adobe AIR. La mayor parte de su funcionalidad est disponible mediante mtodos de la clase SQLConnection:
Elementos SQL relativos a la transaccin (BEGIN, END, COMMIT, ROLLBACK) Esta funcionalidad est disponible mediante mtodos de la clase SQLConnection, relativos a la transaccin: SQLConnection.begin(), SQLConnection.commit() y SQLConnection.rollback(). ANALYZE Esta funcionalidad est disponible mediante el mtodo SQLConnection.analyze(). ATTACH Esta funcionalidad est disponible mediante el mtodo SQLConnection.attach(). COPY Esta declaracin no se admite. CREATE VIRTUAL TABLE Esta declaracin no se admite. DETACH Esta funcionalidad est disponible mediante el mtodo SQLConnection.detach().
1147
PRAGMA Esta declaracin no se admite. VACUUM Esta funcionalidad est disponible mediante el mtodo SQLConnection.compact(). El acceso a la tabla del sistema no est disponible Las tablas del sistema, incluida sqlite_master y otras tablas con el
prefijo "sqlite_" no estn disponibles en las declaraciones SQL. El motor de ejecucin contiene una API de esquema que proporciona un mtodo orientado a objetos para acceder a los datos del esquema. Para obtener ms informacin, consulte el mtodo SQLConnection.loadSchema().
Funciones de expresiones regulares (MATCH() y REGEX()) Estas funciones no estn disponibles en declaraciones SQL.
Sin embargo, en Adobe AIR, los parmetros de declaracin indexados estn basados en cero (es decir, el primer parmetro tiene el ndice 0, el segundo parmetro tiene el ndice 1, etc.
Definiciones de columnas INTEGER PRIMARY KEY En muchas implementaciones, slo las columnas definidas
exactamente como INTEGER PRIMARY KEY se utilizan como columna de clave principal real para una tabla. En dichas implementaciones, si se utiliza otro tipo de datos (normalmente un equivalente para INTEGER (como int), la columna no se utiliza como clave principal interna. Sin embargo, en Adobe AIR, el tipo de datos int (y otros sinnimos de INTEGER) se consideran exactamente equivalentes a INTEGER. En consecuencia, se utiliza una columna definida como int PRIMARY KEY como clave interna para la tabla. Para obtener ms informacin, consulte las secciones CREATE TABLE y Afinidad de columnas.
incluye la mayora de las clases con clases personalizadas, pero excluye algunas clases con objetos de visualizacin que contengan propiedades como objetos de visualizacin.)
String correspondiente a la clase String (equivalente a la afinidad de columna TEXT). XML correspondiente ala clase XML de ActionScript (E4X). XMLList correspondiente a la clase XMLList de ActionScript (E4X).
Los siguientes valores literales no se admiten de forma predeterminada en SQLite, pero s en Adobe AIR:
true se utiliza para representar el valor booleano literal true, para trabajar con columnas BOOLEAN. false se utiliza para representar el valor booleano literal false, para trabajar con columnas BOOLEAN.
1148
Clases de almacenamiento en la pgina 1148 Afinidad de columnas en la pgina 1149 Tipos de datos y operadores de comparacin en la pgina 1151 Tipos de datos y operadores matemticos en la pgina 1152 Tipos de datos y ordenacin en la pgina 1152 Tipos de datos y agrupacin en la pgina 1152 Tipos de datos y declaraciones SELECT compuestas en la pgina 1152
Clases de almacenamiento
Las clases de almacenamiento representan los tipos de datos reales que se utilizan para guardar valores en una base de datos. Se utilizan las siguientes clases de almacenamiento en la base de datos:
NULL El valor es un valor NULL. INTEGER El valor es un entero con signo. REAL El valor es un valor numrico de coma flotante. TEXT El valor es una cadena de texto (limitada a 256 MB). BLOB El valor es un objeto grande binario (BLOB); dicho de otro modo, datos binarios sin procesar (limitados a 256 MB).
Todos los valores suministrados a la base de datos como literales incorporados en una declaracin SQL o valores ligados al uso de parmetros en una declaracin SQL preparada se asignan a una clase de almacenamiento antes de que se ejecute la declaracin SQL. A los literales que forman parte de una declaracin SQL se les asigna una clase de almacenamiento TEXT si estn encerrados con comillas simples o dobles, una clase INTEGER si el literal est especificado como un nmero sin comillas, sin punto decimal ni exponente, una clase REAL si el literal es un nmero sin comillas, con punto decimal o exponente y una clase de almacenamiento NULL si el valor es NULL. Los literales con clase de almacenamiento BLOB se especifican con la notacin X'ABCD'. Para obtener ms informacin, consulte Valores literales en expresiones. Los valores suministrados como parmetros con el conjunto asociativo SQLStatement.parameters se asignan a la clase de almacenamiento que mejor coincidencia tenga con el tipo de datos. Por ejemplo, los valores int se vinculan a una clase de almacenamiento INTEGER, los valores Number a la clase REAL, los valores String a la clase de almacenamiento TEXT y los objetos ByteArray a la clase de almacenamiento BLOB.
1149
Afinidad de columnas
La afinidad de una columna es el tipo recomendado para los datos guardados en dicha columna. Cuando se guarda un valor en una columna (mediante una declaracin INSERT o UPDATE), el motor de ejecucin intenta convertir el valor de su tipo de datos en la afinidad especificada. Por ejemplo, si se inserta un valor Date (instancia de Date en ActionScript o JavaScript) en una columna cuya afinidad es TEXT, el valor Date se convertir a la representacin de String (equivale a llamar al mtodo toString() del objeto) antes de guardarlo en la base de datos. Si el valor no se puede convertir a la afinidad especificada, se produce un error y la operacin no se lleva a cabo. Cuando se recupera un valor de la base de datos mediante una declaracin SELECT, se devuelve como una instancia de la clase correspondiente a la afinidad, independientemente de si se convirti a un tipo de datos distinto al guardarse. Si una columna acepta valores NULL, el valor null de ActionScript o JavaScript se puede utilizar como valor de parmetros para almacenar NULL en la columna. Cuando se recupera una clase de almacenamiento NULL de una declaracin SELECT, siempre se devuelve como el valor null de ActionScript o JavaScript, independientemente de la afinidad de la columna. Si una columna acepta valores NULL, siempre comprueba los valores recuperados de dicha columna para determinar si son null antes de intentar convertir los valores a un tipo que no pueda ser NULL (como Number o Boolean). A cada columna de la base de datos se le asigna uno de los siguientes tipos de afinidad:
TEXT (o String) NUMERIC INTEGER (o int) REAL (o Number) Boolean Date XML XMLLIST Objeto NONE
TEXT (o String) Una columna con afinidad TEXT o String almacena todas las clases de almacenamiento NULL, TEXT o BLOB. Si se insertan datos numricos en una columna con afinidad TEXT, se convierten a texto antes de guardarlos. NUMERIC Una columna con afinidad NUMERIC contiene valores que utilizan clases de almacenamiento NULL, REAL o INTEGER. Cuando se insertan datos de texto en una columna NUMERIC, se intenta convertir en un nmero entero o real antes de guardarlo. Si la conversin se realiza correctamente, el valor se guarda con la clase de almacenamiento INTEGER o REAL (por ejemplo, un valor de '10.05' se convierte a una clase de almacenamiento REAL antes de ordenarlo). Si no se puede realizar la conversin, se produce un error. No se intenta convertir a un valor NULL. Se devuelve un valor recuperado de una columna NUMERIC como una instancia del tipo numrico ms especfico con el que encaje el valor. Dicho de otro modo, si el valor es un entero positivo o 0, se devuelve como una instancia de uint. Si es un entero negativo, se devuelve como instancia de int. Finalmente, si tiene un componente de coma flotante (no es un entero), se devuelve como instancia de Number. INTEGER (o int)
1150
Una columna que utiliza afinidad INTEGER se comporta del mismo modo que una columna con afinidad NUMERIC, con una excepcin. Si el valor se va a guardar como un valor real (instancia de Number) sin componente de coma flotante o si el valor es un valor de texto que se puede convertir a un valor real sin componente de coma flotante, se convierte a un entero y se guarda utilizando la clase de almacenamiento INTEGER. Si se intenta guardar un valor real con un componente de coma flotante se produce un error. REAL (o Number) Una columna con afinidad REAL o NUMBER se comporta como una columna con afinidad NUMERIC con la diferencia de que fuerza los valores enteros a una representacin de coma flotante. Siempre se devuelve un valor de una columna REAL de la base de datos como una instancia de Number. Boolean Una columna con afinidad Boolean almacena valores true o false. Una columna Boolean acepta un valor que es una instancia de Boolean en ActionScript o JavaScript. Si el cdigo intenta guardar un valor String, un elemento String con longitud mayor que cero se considerar true y un elemento vaco String se considerar false. Si el cdigo intenta guardar datos numricos, se guardar cualquier valor distinto de cero como true y 0 se guardar como false. Cuando se recupera un valor Boolean con una declaracin SELECT, se devuelve como instancia de Boolean. Los valores no NULL se guardan con la clase de almacenamiento INTEGER (0 para false; 1 para true) y se convierten en objetos Boolean cuando se recuperan los datos. Date Una columna con afinidad Date almacena valores de fecha y hora. Una columna Date est diseada para aceptar valores que sean instancias de Date de ActionScript o JavaScript. Si se intenta guardar un valor String en una columna Date, el motor de ejecucin intentar convertirlo en una fecha de calendario juliano. Si falla la conversin, se produce un error. Si el cdigo intenta guardar un valor Number, int o uint, no se realiza ningn intento para validar los datos y se asume que se trata de un valor de fecha de calendario juliano correcto. Un valor Date recuperado con una declaracin SELECT se convierte automticamente en una instancia de Date. Los valores de DATE se guardan como valores de fecha de calendario juliano con la clase de almacenamiento REAL. Por ello, las operaciones de ordenacin y comparacin funcionan del modo esperado. XML o XMLList Una columna que utiliza afinidad XML o XMLList almacena estructuras XML. Cuando el cdigo intenta guardar datos en una columna XML con un parmetro SQLStatement, el motor de ejecucin intenta convertir y validar el valor con la funcin XML() o XMLList() de ActionScript. Si el valor no se puede convertir a XML vlido, se produce un error. Si se intenta guardar los datos con un valor de texto SQL literal (por ejemplo, INSERT INTO (col1) VALUES ('Invalid XML (no closing tag)'), el valor no se analiza ni se valida: se asume que est bien expresado. Si se guarda un valor no vlido, se devuelve un objeto vaco XML al recuperarlo. Los datos XML y XMLList se almacenan con la clase de almacenamiento TEXT o NULL. Object Una columna con afinidad Object almacena objetos complejos de ActionScript o JavaScript, incluidas instancias de la clase Object, as como instancias de subclases de Object como instancias de Array e incluso instancias de clases personalizadas. Los datos de la columna OBJECT estn serializados en formato AMF3 y se guardan con la clase de almacenamiento BLOB. Cuando se recupera una valor, se deserializa de AMF3 y se devuelve como una instancia de la clase tal como se guard. Tenga en cuenta que algunas clases de ActionScript, especialmente los objetos de visualizacin, no se pueden deserializar como instancias de su tipo de datos original. Antes de guardar una instancia de clase personalizada, debe registrar un apodo para la clase con el mtodo flash.net.registerClassAlias() (o, en Flex,
1151
agregando metadatos [RemoteObject] a la declaracin de la clase). Asimismo, antes de recuperar los datos debe registrar el mismo apodo para la clase. Cualquier dato que no pueda deserializarse correctamente, bien porque la clase no se puede deserializar inherentemente o porque falta o no coincide un apodo de la clase, se devuelve como un objeto annimo (una instancia de la clase Object con propiedades y valores que se corresponden con la instancia original tal como se guard. NONE Una columna con afinidad NONE no tiene preferencia sobre una clase de almacenamiento frente a otra. No intenta convertir los datos antes de insertarlos. Determinacin de la afinidad El tipo de afinidad de una columna se determina mediante el tipo declarado de la columna de la declaracin CREATE TABLE. Al determinar el tipo, se aplican las siguientes reglas (no distinguen entre maysculas y minsculas):
Si el tipo de datos de la columna contiene alguna de las cadenas "CHAR", "CLOB", "STRI" o "TEXT", dicha columna
tiene afinidad TEXT/String. Tenga en cuenta que el tipo VARCHAR contiene la cadena "CHAR" y, por lo tanto, se le asigna afinidad TEXT.
Si el tipo de datos de la columna contiene la cadena "BLOB" o si no hay ningn tipo de datos especificado, la
columna tiene afinidad NONE.
Si el tipo de datos de la columna contiene la cadena "XMLL" la columna tiene afinidad XMLList. Si el tipo de datos es la cadena "XML", la columna tiene afinidad XML. Si el tipo de datos contiene la cadena "OBJE", la columna tiene afinidad Object. Si el tipo de datos contiene la cadena "BOOL", la columna tiene afinidad Boolean. Si el tipo de datos contiene la cadena "DATE", la columna tiene afinidad de datos Date. Si el tipo de datos contiene la cadena "INT" (incluida "UINT"), se le asigna afinidad INTEGER/int. Si el tipo de datos contiene cualquiera de las cadenas "REAL", "NUMB", "FLOA" o "DOUB", la columna tiene
afinidad REAL/Number.
En caso contrario, la afinidad es NUMERIC. Si se crea una tabla con una declaracin CREATE TABLE t AS SELECT... ninguna columna tendr un tipo de datos
especificado y se le dar la afinidad NONE.
Un valor con clase de almacenamiento NULL sed considera menor que cualquier otro valor (incluidos valores con
clase de almacenamiento NULL).
Un valor INTEGER o REAL es menor que cualquier otro valor TEXT o BLOB. Cuando se compara un INTEGER
o un REAL con otro INTEGER o REAL, se lleva a cabo una comparacin numrica.
Un valor TEXT es menor que un valor BLOB. Cuando se comparan dos valores TEXT, se lleva a cabo una
comparacin binaria.
Cuando se comparan dos valores BLOB, el resultado siempre se determina mediante una comparacin binaria. ltima modificacin 20/6/2011
1152
El operador ternario BETWEEN siempre se recrea como la expresin binaria equivalente. Por ejemplo, BETWEEN b AND c se recrea como >= b AND a <= c, incluso si esto significa que se deben aplicar distintas afinidades a IN en cada una de las comparaciones necesarias para producir la expresin. Las expresiones de tipo a IN (SELECT b ....) se gestionan mediante tres reglas enumeradas previamente para comparaciones binarias, es decir, de un modo similar a a = b. Por ejemplo, si b es un valor de columna y a es una expresin, la afinidad de b se aplica a a antes de realizar ninguna comparacin. La expresin a IN (x, y, z) se recrea como a = +x OR a = +y OR a = +z. Los valores a la derecha del operador IN (los valores x, y y z en este ejemplo) se consideran expresiones incluso si se encuentran en los valores de columna. Si el valor a la izquierda del operador IN es una columna, se utiliza la afinidad de dicha columna. Si el valor es una expresin, no se produce ninguna conversin. El modo en que se realizan las comparaciones tambin se puede ver afectado al utilizar una clusula COLLATE. Para obtener ms informacin, consulte COLLATE.
1153
1004
1005 1006 1007 1008 1009 1010 2001 2002 2003 2004 2005 2006 2007 2008 2009
1154
2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022
2023 2024 2025 2026 2027 2028 2030 2032 2033 2034 2035 2036 2037 2043 2044 2046 2047 2048 2049 2050 2051 2052 2053
Cannot have both ON and USING clauses in the same join. (No se pueden tener las clusulas ON y USING en la misma unin.) Cannot join using column '%s' - column not present in both tables. (No se puede unir con la columna '%s'; la columna no est presente en ambas tablas.) OnlyasingleresultallowedforaSELECTthatispartofanexpression.(Slo un nico resultado permitido para un SELECT que forme parte de una expresin.) No such table: '[%s.]%s'. (No existe dicha tabla: '[%s.]%s'.) No tables specified. (No se ha especificado ninguna tabla.) Too many columns in result set|too many columns on '%s'. (Demasiadas columnas en el conjunto de resultados|demasiadas columnas en '%s'.) %s ORDER|GROUP BY term out of range - should be between 1 and %d. (Trmino %s ORDER|GROUP BY fuera de rango; debe estar entre 1 y %d.) Too many terms in ORDER BY clause. (Demasiados trminos en la clusula ORDER BY.) %s ORDER BY term out of range - should be between 1 and %d. (Trmino %s ORDER BY fuera de rango; debe estar entre 1 y %d.) %r ORDER BY term does not match any column in the result set. (Trmino %r ORDER BY no coincide con ninguna columna del conjunto de resultados.) ORDER BY clause should come after '%s' not before. (La clusula ORDER BY debe ir detrs de '%s', no delante.) LIMIT clause should come after '%s' not before. (La clusula LIMIT debe ir detrs de '%s', no delante.) SELECTs to the left and right of '%s' do not have the same number of result columns. (Los SELECT a la izquierda y a la derecha de '%s' do no tienen el mismo nmero de columnas de resultados.) A GROUP BY clause is required before HAVING. (Se requiere una clusula GROUP BY antes de HAVING.) Aggregate functions are not allowed in the GROUP BY clause. (La clusula GROUP BY no admite funciones de agregacin.) DISTINCT in aggregate must be followed by an expression. (El DISTINCT de la agregacin debe ir seguido de una expresin.) Too many terms in compound SELECT. (Demasiados trminos en el SELECT compuesto.) Too many terms in ORDER|GROUP BY clause. (Demasiados trminos en la clusula ORDER|GROUP BY.) Temporary trigger may not have qualified name. (El activador temporal podra no tener un nombre cualificado.) Trigger '%s' already exists. (El activador '%s' ya existe.) Cannot create BEFORE|AFTER trigger on view: '%s'. (No se puede crear activador BEFORE|AFTER en la vista: '%s'.) Cannot create INSTEAD OF trigger on table: '%s'. (No se puede crear activador INSTEAD OF en la tabla: '%s'.) No such trigger: '%s'. (No existe dicho activador: '%s'.) Recursive triggers not supported ('%s'). (No se admiten activadores recurrentes ('%s').) No such column: %s[. (No existe dicha columna: %s[..)%s[.%s]] VACUUM is not allowed from SQL. (No se permite VACUUM desde SQL.) Table '%s': indexing function returned an invalid plan. (Tabla '%s': la funcin de indexado devolvi un plan no vlido.) At most %d tables in a join. (En la mayora de las tablas %d de una unin.) Cannot add a PRIMARY KEY column. (No se puede aadir una columna PRIMARY KEY.) Cannot add a UNIQUE column. (No se puede aadir una columna UNIQUE.) Cannot add a NOT NULL column with default value NULL. (No se puede aadir una columna NOT NULL con valore predeterminado NULL.) Cannot add a column with non-constant default. (No se puede aadir una columna con valor predeterminado no constante.) Cannot add a column to a view. (No se puede aadir una columna a una vista.) ANALYZE is not allowed in SQL. (No se permite ANALYZE en SQL.) Invalid name: '%s'. (Nombre no vlido: '%s'.) ATTACH is not allowed from SQL. (No se permite ATTACH desde SQL.)
1155
2054 2055 2056 2058 2060 2061 2062 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074
2075 2076 2077 2080 2081 2082 2083 2084 2085 2086
2087 2088 2089 2090 2092 2093 2094 2095 2096 2097
%s '%s' cannot reference objects in database '%s'. (%s '%s' no puede hacer referencia a objetos de la base de datos '%s'.) Access to '[%s.]%s.%s' is prohibited. (El acceso a '[%s.]%s.%s' est prohibido.) Not authorized. (No autorizado.) No such view: '[%s.]%s'. (No existe dicha vista: '[%s.]%s'.) Temporary table name must be unqualified. (El nombre de la tabla temporal debe ser incompleto.) Table '%s' already exists. (La tabla '%s' ya existe.) There is already an index named: '%s'. (Ya hay un ndice llamado: '%s'.) Duplicate column name: '%s'. (Nombre duplicado de columna: '%s'.) Table '%s' has more than one primary key. (La tabla '%s' tiene ms de una clave principal.) AUTOINCREMENT is only allowed on an INTEGER PRIMARY KEY. (AUTOINCREMENT slo se permite en un INTEGER PRIMARY KEY.) No such collation sequence: '%s'. (No existe dicha secuencia de intercalacin: '%s'.) Parameters are not allowed in views. (No se permiten parmetros en las vistas.) View '%s' is circularly defined. (La vista '%s' est definida circularmente.) Table '%s' may not be dropped. (La tabla '%s' no se puede descartar.) Use DROP VIEW to delete view '%s'. (Utilice DROP VIEW para eliminar la vista '%s'.) Use DROP TABLE to delete table '%s'. (Utilice DROP TABLE para eliminar la tabla '%s'.) Foreign key on '%s' should reference only one column of table '%s'. (La clave externa de '%s' debera hacer referencia a una sola columna de la tabla '%s'.) Number of columns in foreign key does not match the number of columns in the referenced table. (El nmero de columnas de la clave externa no coincide con el nmero de columnas de la tabla de referencia.) Unknown column '%s' in foreign key definition. (Columna desconocida '%s' en definicin de clave externa.) Table '%s' may not be indexed. (La tabla '%s' no se puede indexar.) Views may not be indexed. (Las vistas no se pueden indexar.) Conflicting ON CONFLICT clauses specified. (Clusulas ON CONFLICT conflictivas especificadas.) No such index: '%s'. (No existe dicho ndice: '%s'.) Index associated with UNIQUE or PRIMARY KEY constraint cannot be dropped. (El ndice asociado a la restriccin UNIQUE o PRIMARY KEY no se puede descartar.) BEGIN is not allowed in SQL. (No se permite BEGIN en SQL.) COMMIT is not allowed in SQL. (No se permite COMMIT en SQL.) ROLLBACK is not allowed in SQL. (No se permite ROLLBACK en SQL.) Unabletoopenatemporarydatabasefileforstoringtemporarytables.(No se puede abrir un archivo de base de datos temporal para guardar las tablas temporales.) Unable to identify the object to be reindexed. (No se puede identificar el objeto que se va a reindexar.) Table '%s' may not be modified. (La tabla '%s' no se puede modificar.) Cannot modify '%s' because it is a view. (No se puede modificar '%s' porque es una vista.) Variable number must be between ?0 and ?%d<. (El nmero de variables debe estar entre ?0 y ?%d<.) Misuse of aliased aggregate '%s'. (Uso incorrecto de agregacin dentada '%s'.) Ambiguous column name: '[%s.[%s.]]%s'. (Nombre de columna ambiguo: '[%s.[%s.]]%s'.) No such function: '%s'. (No existe dicha funcin: '%s'.) Wrong number of arguments to function '%s'. (Nmero incorrecto de argumentos para la funcin '%s'.) Subqueries prohibited in CHECK constraints. (Subconsultas prohibidas en restricciones de CHECK.) Parameters prohibited in CHECK constraints. (Parmetros prohibidos en restricciones de CHECK.)
1156
2098 2099 2100 2101 2102 2103 2104 2105 2106 2108
2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2300 2301 2302 2303 2304 2305 2306 2307 2309 2400 2401 2402 2403 2404 2405 2406 2407 2408
Expression tree is too large (maximum depth %d). (El rbol de expresiones es demasiado grande (profundidad mxima: %d).) RAISE() may only be used within a trigger-program. (RAISE() slo se puede utilizar en un programa de activador.) Table '%s' has %d columns but %d values were supplied. (La tabla '%s' tiene %d columnas, pero se han facilitado %d valores.) Database schema is locked: '%s'. (El esquema de base de datos est bloqueado: '%s'.) Statement too long. (Declaracin demasiado larga.) Unable to delete/modify collation sequence due to active statements. (No se puede eliminar/modificar secuencia de intercalacin porque hay declaraciones activas.) Too many attached databases - max %d. (Demasiadas bases de datos asociadas; mx.: %d.) Cannot ATTACH database within transaction. (No se puede realizar una operacin ATTACH con la base de datos durante la transaccin.) Database '%s' is already in use. (La base de datos '%s' ya se est utilizando.) Attached databases must use the same text encoding as main database. (Las bases de datos asociadas deben utilizar la misma codificacin de texto que la base de datos principal.) Out of memory. (Memoria insuficiente.) Unable to open database. (No se puede abrir la base de datos.) Cannot DETACH database within transaction. (No se puede realizar una operacin DETACH con la base de datos durante la transaccin.) Cannot detach database: '%s'. (No se puede desasociar la base de datos: '%s'.) Database '%s' is locked. (La base de datos '%s' est bloqueada.) Unable to acquire a read lock on the database. (No se puede adquirir un bloqueo de lectura en la base de datos.) [column|columns] '%s'[,'%s'] are not [unique|is] not unique. (La(s) [columna|columnas] '%s'[,'%s'] no son [exclusivas|no] es exclusiva.) Malformed database schema. (Esquema de base de datos formado incorrectamente.) Unsupported file format. (Formato de archivo no admitido.) Unrecognized token: '%s'. (Smbolo no reconocido: '%s'.) Could not convert text value to numeric value. (No se pudo convertir el valor de texto en valor numrico.) Could not convert string value to date. (No se pudo convertir el valor de cadena en una fecha.) Could not convert floating point value to integer without loss of data. (No se pudo convertir el valor de coma flotante en entero sin prdida de datos.) Cannot rollback transaction - SQL statements in progress. (No se puede invertir la transaccin: declaraciones SQL en curso.) Cannot commit transaction - SQL statements in progress. (No se puede confirmar la transaccin: declaraciones SQL en curso.) Database table is locked: '%s'. (La base de datos est bloqueada: '%s'.) Read-only table. (Tabla de slo lectura.) String or blob too big. (Cadena o blob demasiado grande.) Cannot open indexed column for writing. (No se puede abrir la columna indexada para su escritura.) Cannot open value of type %s. (No se puede abrir un valor de tipo %s.) No such rowid: %s<. (No existe dicho identificador de fila: %s<.) Object name reserved for internal use: '%s'. (Nombre de objeto reservado para uso interno: '%s'.) View '%s' may not be altered. (La vista '%s' no se puede alterar.) Default value of column '%s' is not constant. (El valor predeterminado de la columna '%s' no es constante.) Not authorized to use function '%s'. (No dispone de autorizacin para utilizar la funcin '%s'.) Misuse of aggregate function '%s'. (Uso incorrecto de funcin de agregacin '%s'.) Misuse of aggregate: '%s'. (Uso incorrecto de agregacin: '%s'.) No such database: '%s'. (No existe dicha base de datos: '%s'.)
1157
Table '%s' has no column named '%s'. (La tabla '%s' no contiene ninguna columna llamada '%s'.) No such module: '%s'. (No existe dicho mdulo: '%s'.) No such savepoint: '%s'. (No existe dicho punto guardado: '%s'.) Cannot rollback - no transaction is active. (No se puede restaurar: no hay ninguna transaccin activa.) Cannot commit - no transaction is active. (No se puede confirmar: no hay ninguna transaccin activa.)