| Paquete | flash.desktop |
| Clase | public class DockIcon |
| Herencia | DockIcon  InteractiveIcon Icon EventDispatcher Object |
| Versión del lenguaje: | ActionScript 3.0 |
| Versiones de motor de ejecución: | AIR 1.0 |
Compatibilidad con perfil de AIR: esta característica se admite en todos los sistemas operativos de escritorio, pero no en dispositivos móviles ni dispositivos de AIR para TV. Puede probar la compatibilidad en tiempo de ejecución con la propiedad NativeApplication.supportsDockIcon. Consulte Compatibilidad con perfil de AIR para obtener información sobre la compatibilidad de la API con varios perfiles.
Puede utilizar la clase DockIcon para cambiar el aspecto del icono estándar, por ejemplo, animándolo o añadiendo información gráfica adicional. También puede añadir elementos al menú de iconos del Dock. Los elementos de menú añadidos se muestran sobre los elementos estándar.
No se puede crear una instancia de la clase DockIcon. Obtiene el objeto que representa el icono acoplado del sistema operativo desde NativeApplication.icon.
No todos los sistemas operativos tienen iconos acoplados. Verifique NativeApplication.supportsDockIcon para determinar si el sistema actual admite acoplar iconos. Si se admiten iconos de Dock, la propiedad NativeApplication.icon es de tipo DockIcon. En caso contrario, el tipo de NativeApplication.icon es otra subclase de InteractiveIcon, normalmente SystemTrayIcon.
Importante: si intenta llamar a un método de la clase DockIcon en el objeto NativeApplication.icon de un sistema operativo donde AIR no es compatible con iconos del Dock, se genera un error de tiempo de ejecución.
Elementos de API relacionados
flash.desktop.NativeApplication.supportsDockIcon
flash.desktop.SystemTrayIcon
Ocultar propiedades públicas heredadas
Mostrar propiedades públicas heredadas| Propiedad | Definido por | ||
|---|---|---|---|
| bitmaps : Array [override]
La imagen del icono es un conjunto de objetos BitmapData de distinto tamaño. | DockIcon | ||
 | constructor : Object
Una referencia a la clase de objeto o función constructora para una instancia de objeto determinada. | Object | |
| height : int [override] [solo lectura]
Altura de visualización actual del icono, en píxeles. | DockIcon | ||
| menu : NativeMenu
Menú proporcionado por el sistema para este icono acoplado. | DockIcon | ||
| width : int [override] [solo lectura]
Anchura de visualización actual del icono, en píxeles. | DockIcon | ||
| Método | Definido por | ||
|---|---|---|---|
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registra un objeto de detector de eventos con un objeto EventDispatcher, de modo que el detector reciba la notificación de un evento. | EventDispatcher | |
Notifica al usuario la aparición de un evento que tal vez requiera atención. | DockIcon | ||
|
Distribuye un evento en el flujo del evento. | EventDispatcher | |
|
Comprueba si el objeto EventDispatcher tiene detectores registrados para un tipo concreto de evento. | EventDispatcher | |
|
Indica si un objeto tiene definida una propiedad especificada. | Object | |
|
Indica si hay una instancia de la clase Object en la cadena de prototipo del objeto especificado como parámetro. | Object | |
|
Indica si existe la propiedad especificada y si es enumerable. | Object | |
|
Elimina un detector del objeto EventDispatcher. | EventDispatcher | |
|
Establece la disponibilidad de una propiedad dinámica para operaciones de bucle. | Object | |
|
Devuelve la representación de cadena de este objeto, con formato según las convenciones específicas de configuración regional. | Object | |
|
Devuelve la representación de cadena del objeto especificado. | Object | |
|
Devuelve el valor simple del objeto especificado. | Object | |
|
Comprueba si hay registrado un detector de eventos con este objeto EventDispatcher o con cualquiera de sus ascendientes para el tipo de evento concreto. | EventDispatcher | |
bitmaps | propiedad |
bitmaps:Array[override] | Versiones de motor de ejecución: | AIR 1.0 |
La imagen del icono es un conjunto de objetos BitmapData de distinto tamaño.
Cuando un icono se visualiza en el contexto de un sistema operativo concreto, los objetos de mapa de bits del conjunto con tamaño más parecido al que se visualiza serán los que se utilicen (si es necesario, se cambian de tamaño). Los tamaños más habituales son 16x16, 32x32, 48x48 y 128x128. (En un futuro cercano, se podrán utilizar iconos de 512x512 píxeles en el sistema operativo.)
En algunos contextos, el sistema operativo puede utilizar el icono predeterminado del sistema si no se ha asignado nada a la propiedad bitmaps. En otros contextos no aparece ningún icono.
Para definir o modificar el aspecto del icono, asigne un conjunto de objetos BitmapData a la propiedad bitmaps:
icon.bitmaps = new Array(icon16x16.bitmapData, icon128x128.bitmapData);
Modificar el conjunto de bitmaps directamente no produce ningún efecto.
Para borrar la imagen del icono, asigne un conjunto vacío a la propiedad bitmaps.
Nota: al cargar archivos de imagen para un icono, el formato de archivo PNG suele proporcionar la mejor mezcla alfa. El formato GIF sólo admite la activación o la desactivación de la transparencia (no la mezcla). El formato JPG no admite ningún tipo de transparencia.
Implementación
override public function get bitmaps():Array override public function set bitmaps(value:Array):void height | propiedad |
height:int [solo lectura] [override] | Versiones de motor de ejecución: | AIR 1.0 |
Altura de visualización actual del icono, en píxeles.
Algunos contextos de iconos admiten tamaños dinámicos. La propiedad height indica la altura de icono elegida en el conjunto bitmaps para el contexto actual. La altura de visualización actual puede no ser la misma si el sistema operativo cambia el icono de tamaño.
Implementación
override public function get height():int menu | propiedad |
menu:NativeMenu| Versión del lenguaje: | ActionScript 3.0 |
| Versiones de motor de ejecución: | AIR 1.0 |
Menú proporcionado por el sistema para este icono acoplado.
Todos los elementos del menú se muestran por encima de los elementos estándar. Las opciones estándar no se pueden modificar ni eliminar.
Implementación
public function get menu():NativeMenu public function set menu(value:NativeMenu):voidEjemplo ( Cómo utilizar este ejemplo )
import flash.desktop.NativeApplication;
import flash.events.Event;
private function createDockIconMenu():void{
if(NativeApplication.supportsDockIcon){
var dockIcon:DockIcon = NativeApplication.nativeApplication.icon as DockIcon;
var dockMenu:NativeMenu = new NativeMenu();
var command:NativeMenuItem = dockMenu.addItem(new NativeMenuItem("Command"));
command.addEventListener(Event.SELECT, onCommand);
dockIcon.menu = dockMenu;
}
}
private function onCommand(event:Event):void{
//do command...
}
width | propiedad |
width:int [solo lectura] [override] | Versiones de motor de ejecución: | AIR 1.0 |
Anchura de visualización actual del icono, en píxeles.
Algunos contextos de iconos admiten tamaños dinámicos. La propiedad width indica la anchura de icono elegida en el conjunto bitmaps para el contexto actual. La anchura de visualización actual puede no ser la misma si el sistema operativo cambia el icono de tamaño.
Implementación
override public function get width():intbounce | () | método |
public function bounce(priority:String = "informational"):void| Versión del lenguaje: | ActionScript 3.0 |
| Versiones de motor de ejecución: | AIR 1.0 |
Notifica al usuario la aparición de un evento que tal vez requiera atención.
Al llamar a este método, el icono del Dock "rebota" si, y sólo si, la aplicación se está ejecutando en segundo plano. Si la prioridad es NotificationType.Informational, el icono rebota una vez. Si la prioridad es NotificationType.Critical, el icono rebota de forma continua hasta que la aplicación pasa a primer plano.
Parámetros
priority:String (default = "informational") |
Elementos de API relacionados
Ejemplo ( Cómo utilizar este ejemplo )
import flash.display.DockIcon;
import flash.display.NotificationType;
import flash.desktop.NativeApplication;
if(NativeApplication.supportsDockIcon){
var dockIcon:DockIcon = NativeApplication.nativeApplication.icon As DockIcon;
dockIcon.bounce(NotificationType.CRITICAL);
}
package {
import flash.desktop.DockIcon;
import flash.desktop.NativeApplication;
import flash.display.Loader;
import flash.display.NativeMenu;
import flash.display.NativeMenuItem;
import flash.display.Sprite;
import flash.events.Event;
import flash.events.TimerEvent;
import flash.net.URLRequest;
import flash.utils.Timer;
public class AnimatedDockIcon extends Sprite
{
private var imageURLs:Array = ['gfx/frame01.png',
'gfx/frame02.png',
'gfx/frame03.png',
'gfx/frame04.png'];
private var images:Array = new Array();
private var animTimer:Timer = new Timer(100);
public function AnimatedDockIcon()
{
NativeApplication.nativeApplication.autoExit = false;
addEventListener(Event.COMPLETE, loadImages);
loadImages();
animTimer.addEventListener(TimerEvent.TIMER,advanceFrame);
addMenu();
stage.nativeWindow.close();
}
private function addMenu():void{
var menu:NativeMenu = new NativeMenu();
var start:NativeMenuItem = menu.addItem(new NativeMenuItem("Start animation"));
var stop:NativeMenuItem = menu.addItem(new NativeMenuItem("Stop animation"));
start.addEventListener(Event.SELECT, startTimer);
stop.addEventListener(Event.SELECT, stopTimer);
var dockIcon:DockIcon = NativeApplication.nativeApplication.icon as DockIcon;
dockIcon.menu = menu;
}
private function startTimer(event:Event):void{
animTimer.start();
}
private function stopTimer(event:Event):void{
animTimer.stop();
}
private var currentFrame:int = 0;
private function advanceFrame(event:Event):void{
if(currentFrame < images.length){
currentFrame++;
} else {
currentFrame = 0;
}
NativeApplication.nativeApplication.icon.bitmaps = [images[currentFrame]];
}
private function loadImages(event:Event = null):void{
if(event != null){
images.push(event.target.content.bitmapData);
}
if(imageURLs.length > 0){
var urlString:String = imageURLs.pop();
var loader:Loader = new Loader();
loader.contentLoaderInfo.addEventListener(Event.COMPLETE, loadImages, false, 0, true);
loader.load(new URLRequest(urlString));
} else {
var complete:Event = new Event(Event.COMPLETE,false,false);
dispatchEvent(complete);
}
}
}
}
Tue Jun 12 2018, 02:12 PM Z