Pacoteflash.desktop
Classepublic class DockIcon
HerançaDockIcon Inheritance InteractiveIcon Inheritance Icon Inheritance EventDispatcher Inheritance Object

The DockIcon class represents the OS X-style dock icon.

Not all operating systems have dock icons. Check Shell.supportsDockIcon to determine if dock icons are supported on the current system. When dock icons are supported, Shell.icon property will be of type DockIcon. Otherwise, the type of Shell.icon will be another subclass of InteractiveIcon, typically SystemTrayIcon.

An instance of the DockIcon class cannot be created. Get the object representing the operating system dock icon from Shell.icon.

Important: Attempting to call DockIcon class methods on the Shell.icon object on operating systems without dock icons, will generate run-time exceptions.

Veja também

flash.system.Shell.icon
flash.system.Shell.supportsDockIcon
flash.desktop.SystemTrayIcon


Propriedades Públicas
 PropriedadeDefinido por
  bitmaps : Array
The icon bitmaps as an array of BitmapData objects. An array of BitmapData objects pertaining to system icons for a file.
DockIcon
 Inheritedconstructor : 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.
DockIcon
  menu : NativeMenu
The menu of this dock icon.
DockIcon
 Inheritedprototype : 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.
DockIcon
Métodos Públicos
 MétodoDefinido por
 Inherited
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
  
bounce(priority:String = "informational"):void
Notifies the user that an event has occured that may require attention.
DockIcon
 Inherited
Dispatches an event into the event flow.
EventDispatcher
 Inherited
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
EventDispatcher
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
EventDispatcher
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Returns the primitive value of the specified object.
Object
 Inherited
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
EventDispatcher
Eventos
 Evento Descrição Definido por
 Inherited Dispatched when Flash Player or the and AIR application gains operating system focus and becomes active.EventDispatcher
 Inherited Dispatched when Flash Player loses operating system focus and is becoming inactive.EventDispatcher
Detalhes da propriedade
bitmapspropriedade
bitmaps:Array  [read-write]

The icon bitmaps as an array of BitmapData objects.

When an icon is displayed in a given operating system context, the bitmap in the array closest to the displayed size will be 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 when nothing has been assigned to the bitmaps property. In others, no icon will appear.

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

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

Modifying bitmaps directly has no effect.

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

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

An array of BitmapData objects pertaining to system icons for a file.

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


Implementação
    public function get bitmaps():Array
    public function set bitmaps(value:Array):void
heightpropriedade 
height:int  [read-only]

The current display height of the icon in pixels.

Some icon contexts support dynamic sizes. height indicates the current size.


Implementação
    public function get height():int
menupropriedade 
menu:NativeMenu  [read-write]

The menu of this dock icon.

If no menu is set, the operating system-provided menu, if any, will be used.


Implementação
    public function get menu():NativeMenu
    public function set menu(value:NativeMenu):void
widthpropriedade 
width:int  [read-only]

The current display width of the icon in pixels.

Some icon contexts support dynamic sizes. width indicates the current size.


Implementação
    public function get width():int
Detalhes do método
bounce()método
public function bounce(priority:String = "informational"):void

Notifies the user that an event has occured that may require attention.

Calling this method will "bounce" the dock icon if, and only if the application is in the background. If the priority is NotificationType.Informational then there will be a single bounce. If the priority is NotificationType.Critical then the dock icon will bounce until the application is brought to the foreground.

Parâmetros

priority:String (default = "informational") — The urgency with which to bounce the dock.

Veja também