SystemTrayIcon - Referencia de la API de Adobe ActionScript® 3 (AS3 )

Paquete	flash.desktop
Clase	public class SystemTrayIcon
Herencia	SystemTrayIcon InteractiveIcon Icon EventDispatcher Object

Versión del lenguaje:

ActionScript 3.0

Versiones de motor de ejecución:

AIR 1.0

La clase SystemTrayIcon representa el icono (al estilo bandeja del sistema) del área de notificación de la barra de tareas de Windows^®.

Compatibilidad con perfil de AIR: esta característica se admite en los sistemas operativos de escritorio, pero no en dispositivos móviles ni dispositivos de AIR para TV. Consulte Compatibilidad con perfil de AIR para obtener información sobre la compatibilidad de la API con varios perfiles.

No todos los sistemas operativos de escritorio tienen iconos de bandeja del sistema. Verifique NativeApplication.supportsSystemTrayIcon para determinar si el sistema actual admite iconos de bandeja del sistema.

No se puede crear una instancia de la clase SystemTrayIcon. Obtiene el objeto que representa el icono de la bandeja del sistema de la propiedad icon del objeto "global" NativeApplication.

Si se admiten iconos de bandeja del sistema, el icono es de tipo SystemTrayIcon. En caso contrario, el tipo de icono es otra subclase de InteractiveIcon, normalmente DockIcon.

Importante: si intenta llamar a un método de la clase SystemTrayIcon en el objeto NativeApplication.icon de un sistema operativo donde AIR no es compatible con iconos de bandeja del sistema, se genera un error de tiempo de ejecución.

Elementos de API relacionados

flash.desktop.NativeApplication.icon
flash.desktop.NativeApplication.supportsSystemTrayIcon
flash.desktop.DockIcon

Propiedades públicas

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.	SystemTrayIcon
		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.	SystemTrayIcon
		menu : NativeMenu Menú de iconos de bandeja del sistema.	SystemTrayIcon
		tooltip : String Información del texto de sugerencia se muestra para el icono de bandeja del sistema.	SystemTrayIcon
		width : int [override] [solo lectura] Anchura de visualización actual del icono, en píxeles.	SystemTrayIcon

Métodos públicos

Ocultar métodos públicos heredados

Mostrar métodos públicos heredados

	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
		dispatchEvent(event:Event):Boolean Distribuye un evento en el flujo del evento.	EventDispatcher
		hasEventListener(type:String):Boolean Comprueba si el objeto EventDispatcher tiene detectores registrados para un tipo concreto de evento.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indica si un objeto tiene definida una propiedad especificada.	Object
		isPrototypeOf(theClass:Object):Boolean Indica si hay una instancia de la clase Object en la cadena de prototipo del objeto especificado como parámetro.	Object
		propertyIsEnumerable(name:String):Boolean Indica si existe la propiedad especificada y si es enumerable.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Elimina un detector del objeto EventDispatcher.	EventDispatcher
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Establece la disponibilidad de una propiedad dinámica para operaciones de bucle.	Object
		toLocaleString():String Devuelve la representación de cadena de este objeto, con formato según las convenciones específicas de configuración regional.	Object
		toString():String Devuelve la representación de cadena del objeto especificado.	Object
		valueOf():Object Devuelve el valor simple del objeto especificado.	Object
		willTrigger(type:String):Boolean 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

Eventos

Haga clic para obtener más información sobre los eventos

Ocultar eventos heredados

Mostrar eventos heredados

	Resumen	Definido por
activate	[evento broadcast] Se distribuye cuando Flash Player o AIR pasan a estar activos.	EventDispatcher
click	Distribuido por este objeto SystemTrayIcon al hacer clic con el botón del ratón.	SystemTrayIcon
deactivate	[evento broadcast] Se distribuye cuando Flash Player o de AIR pasan a estar inactivos.	EventDispatcher
mouseDown	Distribuido por este objeto SystemTrayIcon al hacer clic con el botón del ratón.	SystemTrayIcon
mouseUp	Distribuido por este objeto SystemTrayIcon al soltar el botón del ratón.	SystemTrayIcon
rightClick	Distribuido por este objeto SystemTrayIcon al hacer clic con el botón derecho del ratón.	SystemTrayIcon
rightMouseDown	Distribuido por este objeto SystemTrayIcon al hacer clic con el botón derecho del ratón.	SystemTrayIcon
rightMouseUp	Distribuido por este objeto SystemTrayIcon al soltar el botón derecho del ratón.	SystemTrayIcon

Constantes públicas

	Constante		Definido por
		MAX_TIP_LENGTH : Number = 63 [estática] Longitud permitida por el sistema para la información de herramienta del icono de bandeja del sistema.	SystemTrayIcon

Información sobre propiedades

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

tooltip

propiedad

tooltip:String

Versión del lenguaje:

ActionScript 3.0

Versiones de motor de ejecución:

AIR 1.0

Información del texto de sugerencia se muestra para el icono de bandeja del sistema. Si la longitud de la cadena es mayor que SystemTrayIcon.MAX_TIP_LENGTH, la sugerencia se muestra truncada.

Implementación
public function get tooltip():String
public function set tooltip(value:String):void

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():int

Información sobre eventos

click

Evento

Tipo de objeto de evento: flash.events.ScreenMouseEvent
propiedad ScreenMouseEvent.type = flash.events.ScreenMouseEvent.CLICK

Versiones de motor de ejecución:

AIR 1.0

Distribuido por este objeto SystemTrayIcon al hacer clic con el botón del ratón.

La constante ScreenMouseEvent.CLICK define el valor de la propiedad type de un objeto de evento click.

Este evento tiene las propiedades destacables siguientes:

Propiedad	Valor
`buttonDown`	`true` si se pulsa el botón principal del ratón; en caso contrario; `false`.
`ctrlKey`	`true` en Windows o Linux, si la tecla Ctrl está activa. `true` en Mac, si la tecla Ctrl o Comando está activa. En caso contrario, `false`.
`currentTarget`	Objeto que procesa de forma activa el objeto de evento con un detector de eventos.
`shiftKey`	`true` si la tecla Mayús está activa; `false` si está inactiva.
`commandKey`	`true` en Mac, si la tecla Comando está activa; `false` si está inactiva. Siempre es `false` en Windows.
`controlKey`	`true` si la tecla Control o Ctrl está activa; `false` si está inactiva.
`screenX`	La coordenada horizontal en la que se produce el evento en las coordenadas de la pantalla.
`screenY`	La coordenada vertical en la que se produce el evento en las coordenadas de la pantalla.
`target`	Objeto SystemTrayIcon bajo el dispositivo señalador.

mouseDown

Evento

Tipo de objeto de evento: flash.events.ScreenMouseEvent
propiedad ScreenMouseEvent.type = flash.events.ScreenMouseEvent.MOUSE_DOWN

Versiones de motor de ejecución:

AIR 1.0

Distribuido por este objeto SystemTrayIcon al hacer clic con el botón del ratón.

La constante ScreenMouseEvent.MOUSE_DOWN define el valor de la propiedad type de un objeto de evento mouseDown.

Este evento tiene las propiedades destacables siguientes:

Propiedad	Valor
`buttonDown`	`true` si se pulsa el botón principal del ratón; en caso contrario; `false`.
`ctrlKey`	`true` en Windows o Linux, si la tecla Ctrl está activa. `true` en Mac, si la tecla Ctrl o Comando está activa. En caso contrario, `false`.
`currentTarget`	Objeto que procesa de forma activa el objeto de evento con un detector de eventos.
`shiftKey`	`true` si la tecla Mayús está activa; `false` si está inactiva.
`commandKey`	`true` en Mac, si la tecla Comando está activa; `false` si está inactiva. Siempre es `false` en Windows.
`controlKey`	`true` si la tecla Control o Ctrl está activa; `false` si está inactiva.
`screenX`	La coordenada horizontal en la que se produce el evento en las coordenadas de la pantalla.
`screenY`	La coordenada vertical en la que se produce el evento en las coordenadas de la pantalla.
`target`	Objeto SystemTrayIcon bajo el dispositivo señalador.

mouseUp

Evento

Tipo de objeto de evento: flash.events.ScreenMouseEvent
propiedad ScreenMouseEvent.type = flash.events.ScreenMouseEvent.MOUSE_UP

Versiones de motor de ejecución:

AIR 1.0

Distribuido por este objeto SystemTrayIcon al soltar el botón del ratón.

La constante ScreenMouseEvent.MOUSE_UP define el valor de la propiedad type de un objeto de evento mouseUp.

Este evento tiene las propiedades destacables siguientes:

Propiedad	Valor
`buttonDown`	`true` si se pulsa el botón principal del ratón; en caso contrario; `false`.
`ctrlKey`	`true` en Windows o Linux, si la tecla Ctrl está activa. `true` en Mac, si la tecla Ctrl o Comando está activa. En caso contrario, `false`.
`currentTarget`	Objeto que procesa de forma activa el objeto de evento con un detector de eventos.
`shiftKey`	`true` si la tecla Mayús está activa; `false` si está inactiva.
`commandKey`	`true` en Mac, si la tecla Comando está activa; `false` si está inactiva. Siempre es `false` en Windows.
`controlKey`	`true` si la tecla Control o Ctrl está activa; `false` si está inactiva.
`screenX`	La coordenada horizontal en la que se produce el evento en las coordenadas de la pantalla.
`screenY`	La coordenada vertical en la que se produce el evento en las coordenadas de la pantalla.
`target`	Objeto SystemTrayIcon bajo el dispositivo señalador.

rightClick

Evento

Tipo de objeto de evento: flash.events.ScreenMouseEvent
propiedad ScreenMouseEvent.type = flash.events.ScreenMouseEvent.RIGHT_CLICK

Versiones de motor de ejecución:

AIR 1.0

Distribuido por este objeto SystemTrayIcon al hacer clic con el botón derecho del ratón.

La constante ScreenMouseEvent.RIGHT_CLICK define el valor de la propiedad type de un objeto de evento rightClick.

Este evento tiene las propiedades destacables siguientes:

Propiedad	Valor
`buttonDown`	`true` si se pulsa el botón principal del ratón; en caso contrario; `false`.
`ctrlKey`	`true` en Windows o Linux, si la tecla Ctrl está activa. `true` en Mac, si la tecla Ctrl o Comando está activa. En caso contrario, `false`.
`currentTarget`	Objeto que procesa de forma activa el objeto de evento con un detector de eventos.
`shiftKey`	`true` si la tecla Mayús está activa; `false` si está inactiva.
`commandKey`	`true` en Mac, si la tecla Comando está activa; `false` si está inactiva. Siempre es `false` en Windows.
`controlKey`	`true` si la tecla Control o Ctrl está activa; `false` si está inactiva.
`screenX`	La coordenada horizontal en la que se produce el evento en las coordenadas de la pantalla.
`screenY`	La coordenada vertical en la que se produce el evento en las coordenadas de la pantalla.
`target`	Objeto SystemTrayIcon bajo el dispositivo señalador.

rightMouseDown

Evento

Tipo de objeto de evento: flash.events.ScreenMouseEvent
propiedad ScreenMouseEvent.type = flash.events.ScreenMouseEvent.RIGHT_MOUSE_DOWN

Versiones de motor de ejecución:

AIR 1.0

Distribuido por este objeto SystemTrayIcon al hacer clic con el botón derecho del ratón.

La constante ScreenMouseEvent.RIGHT_MOUSE_DOWN define el valor de la propiedad type de un objeto de evento rightMouseDown.

Este evento tiene las propiedades destacables siguientes:

Propiedad	Valor
`buttonDown`	`true` si se pulsa el botón principal del ratón; en caso contrario; `false`.
`ctrlKey`	`true` en Windows o Linux, si la tecla Ctrl está activa. `true` en Mac, si la tecla Ctrl o Comando está activa. En caso contrario, `false`.
`currentTarget`	Objeto que procesa de forma activa el objeto de evento con un detector de eventos.
`shiftKey`	`true` si la tecla Mayús está activa; `false` si está inactiva.
`commandKey`	`true` en Mac, si la tecla Comando está activa; `false` si está inactiva. Siempre es `false` en Windows.
`controlKey`	`true` si la tecla Control o Ctrl está activa; `false` si está inactiva.
`screenX`	La coordenada horizontal en la que se produce el evento en las coordenadas de la pantalla.
`screenY`	La coordenada vertical en la que se produce el evento en las coordenadas de la pantalla.
`target`	Objeto SystemTrayIcon bajo el dispositivo señalador.

rightMouseUp

Evento

Tipo de objeto de evento: flash.events.ScreenMouseEvent
propiedad ScreenMouseEvent.type = flash.events.ScreenMouseEvent.RIGHT_MOUSE_UP

Versiones de motor de ejecución:

AIR 1.0

Distribuido por este objeto SystemTrayIcon al soltar el botón derecho del ratón.

La constante ScreenMouseEvent.RIGHT_MOUSE_UP define el valor de la propiedad type de un objeto de evento rightMouseUp.

Este evento tiene las propiedades destacables siguientes:

Propiedad	Valor
`buttonDown`	`true` si se pulsa el botón principal del ratón; en caso contrario; `false`.
`ctrlKey`	`true` en Windows o Linux, si la tecla Ctrl está activa. `true` en Mac, si la tecla Ctrl o Comando está activa. En caso contrario, `false`.
`currentTarget`	Objeto que procesa de forma activa el objeto de evento con un detector de eventos.
`shiftKey`	`true` si la tecla Mayús está activa; `false` si está inactiva.
`commandKey`	`true` en Mac, si la tecla Comando está activa; `false` si está inactiva. Siempre es `false` en Windows.
`controlKey`	`true` si la tecla Control o Ctrl está activa; `false` si está inactiva.
`screenX`	La coordenada horizontal en la que se produce el evento en las coordenadas de la pantalla.
`screenY`	La coordenada vertical en la que se produce el evento en las coordenadas de la pantalla.
`target`	Objeto SystemTrayIcon bajo el dispositivo señalador.

Información sobre constantes

MAX_TIP_LENGTH

Constante

public static const MAX_TIP_LENGTH:Number = 63

Versión del lenguaje:

ActionScript 3.0

Versiones de motor de ejecución:

AIR 1.0

Longitud permitida por el sistema para la información de herramienta del icono de bandeja del sistema.

Avisos legales | Política de privacidad en línea

SystemTrayIcon - AS3

Paquetesx

Elementos del lenguaje

Apéndices

Paquete flash.desktop

bitmaps

height

menu

tooltip

width

click

mouseDown

mouseUp

rightClick

rightMouseDown

rightMouseUp

MAX_TIP_LENGTH