flash.desktop.InteractiveIcon (ActionScript 3.0)

Package	flash.desktop
Class	public class InteractiveIcon
Inheritance	InteractiveIcon Icon EventDispatcher Object
Subclasses	DockIcon, SystemTrayIcon

Language version:

ActionScript 3.0

Runtime version:

AIR 1.0

The InteractiveIcon class is the base class for the operating system icons associated with applications.

Use the icon property of the NativeApplication object to get an instance of the application icon. The icon type will be one of the subclasses of InteractiveIcon, either DockIcon on Mac OS X^® or SystemTrayIcon on Windows^® and Linux.

You cannot instantiate the InteractiveIcon class directly. Calls to the new InteractiveIcon() constructor will throw an ArgumentError exception.

	Property	Defined by
		bitmaps : Array The icon image as an array of BitmapData objects of different sizes.	InteractiveIcon
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		height : int [read-only] The current display height of the icon in pixels.	InteractiveIcon
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		width : int [read-only] The current display width of the icon in pixels.	InteractiveIcon

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined by
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.	EventDispatcher
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	EventDispatcher
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	EventDispatcher
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		valueOf():Object Returns the primitive value of the specified object.	Object
		willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	EventDispatcher

	Event	Summary	Defined by
		activate	[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.	EventDispatcher
		deactivate	[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.	EventDispatcher

Property detail

bitmaps

property

bitmaps:Array [read-write]

Runtime version:

AIR 1.0

The icon image as an array of BitmapData objects of different sizes.

When an icon is displayed in a given operating system context, the bitmap in the array closest to the displayed size is used (and scaled if necessary). Common sizes include 16x16, 32x32, 48x48, and 128x128. (512x512 pixel icons may be used for some operating system icons in the near future.)

In some contexts, the operating system may use a default system icon if nothing has been assigned to the bitmaps property. In other contexts, no icon appears.

To set or change the icon appearance, assign an array of BitmapData objects to the bitmaps property:

	 icon.bitmaps = new Array(icon16x16.bitmapData, icon128x128.bitmapData);

Modifying the bitmaps array directly has no effect.

To clear the icon image, assign an empty array to the bitmaps property.

Note: When loading image files for an icon, the PNG file format generally provides the best alpha blending. The GIF format supports only on or off transparency (no blending). The JPG format does not support transparency at all.

Implementation
public function get bitmaps():Array
public function set bitmaps(value:Array):void

height

property

height:int [read-only]

Language version:

ActionScript 3.0

Runtime version:

AIR 1.0

The current display height of the icon in pixels.

Some icon contexts support dynamic sizes. The height property indicates the height of the icon chosen from the bitmaps array for the current context. The actual display height may be different if the operating system has scaled the icon.

Implementation
public function get height():int

width

property

width:int [read-only]

Language version:

ActionScript 3.0

Runtime version:

AIR 1.0

The current display width of the icon in pixels.

Some icon contexts support dynamic sizes. The width property indicates the width of the icon chosen from the bitmaps array for the current context. The actual display width may be different if the operating system has scaled the icon.

Implementation
public function get width():int

Submit Feedback

ActionScript 3.0 Language Reference	All Packages \| All Classes \| Language Elements \| Index \| Appendices \| Conventions \| Frames No Frames
Class InteractiveIcon	Properties \| Methods \| Events