ActionScript® 3.0 Referenzhandbuch für die Adobe® Flash®-Plattform
Home  |  Liste der Pakete und Klassen ausblenden |  Pakete  |  Klassen  |  Neue Funktionen  |  Stichwortverzeichnis  |  Anhänge  |  Warum auf Englisch?
Filter: Daten werden vom Server abgerufen...
Daten werden vom Server abgerufen...
flash.desktop 

DockIcon  - AS3

Paketflash.desktop
Klassepublic class DockIcon
VererbungDockIcon Inheritance InteractiveIcon Inheritance Icon Inheritance EventDispatcher Inheritance Object

Sprachversion: ActionScript 3.0
Laufzeitversionen: AIR 1.0

Die DockIcon-Klasse stellt das Dock-Symbol im Mac OS X®-Stil dar.

Unterstützung von AIR-Profilen: Diese Funktion wird auf allen Desktopbetriebssystemen unterstützt, jedoch nicht auf mobilen Geräten oder Geräten mit AIR für TV. Mit der NativeApplication.isSupported-Eigenschaft können Sie testen, ob zur Laufzeit Unterstützung gegeben ist. Weitere Informationen zum AIR-Support über mehrere Profile finden Sie unter Unterstützung von AIR-Profilen.

Mit der DockIcon-Klasse können Sie das Erscheinungsbild des Standardsymbols ändern. Sie können das Symbol zum Beispiel animieren oder Informationsgrafiken hinzufügen. Sie können dem Dock-Symbolmenü auch Elemente hinzufügen. Die hinzugefügten Menüelemente werden über den Standardmenüelementen angezeigt.

Es kann keine Instanz der DockIcon-Klasse erstellt werden. Rufen Sie das Objekt, welches das Docksymbol des Betriebssystems darstellt, aus NativeApplication.icon ab.

Nicht alle Betriebssysteme verfügen über Docksymbole. Überprüfen Sie NativeApplication.supportsDockIcon, um festzustellen, ob Dock-Symbole vom aktuellen System unterstützt werden. Wenn Dock-Symbole unterstützt werden, hat die NativeApplication.icon-Eigenschaft den Typ DockIcon. Andernfalls weist NativeApplication.icon eine andere Unterklasse von InteractiveIcon auf, normalerweise SystemTrayIcon.

Wichtig: Beim Versuch, eine Methode der DockIcon-Klasse für das NativeApplication.icon-Objekt aufzurufen, wird eine Laufzeitausnahme ausgelöst, wenn AIR keine Dock-Symbole unterstützt.

Beispiele anzeigen

Verwandte API-Elemente



Öffentliche Eigenschaften
 EigenschaftDefiniert von
      bitmaps : Array
[override] Das Symbolbild als ein Array von BitmapData-Objekten in verschiedenen Größen.
DockIcon
 Inheritedconstructor : Object
Ein Verweis auf das Klassenobjekt oder die Konstruktorfunktion für eine angegebene Objektinstanz.
Object
      height : int
[override] [schreibgeschützt] Die aktuelle Anzeigehöhe des Symbols in Pixel.
DockIcon
      menu : NativeMenu
Das vom System bereitgestellte Menü dieses Docksymbols.
DockIcon
      width : int
[override] [schreibgeschützt] Die aktuelle Anzeigebreite des Symbols in Pixel.
DockIcon
Öffentliche Methoden
 MethodeDefiniert von
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registriert ein Ereignis-Listener-Objekt bei einem EventDispatcher-Objekt, sodass der Listener über ein Ereignis benachrichtigt wird.
EventDispatcher
  
    bounce(priority:String = "informational"):void
Benachrichtigt den Benutzer, dass ein Ereignis aufgetreten ist, das möglicherweise sein Eingreifen erfordert.
DockIcon
 Inherited
Sendet ein Ereignis in den Ereignisablauf.
EventDispatcher
 Inherited
Überprüft, ob das EventDispatcher-Objekt Listener für einen bestimmten Ereignistyp registriert hat.
EventDispatcher
 Inherited
Gibt an, ob für ein Objekt eine bestimmte Eigenschaft definiert wurde.
Object
 Inherited
Gibt an, ob eine Instanz der Object-Klasse in der Prototypkette des Objekts vorhanden ist, das als Parameter angegeben wurde.
Object
 Inherited
Gibt an, ob die angegebene Eigenschaft vorhanden ist und durchlaufen werden kann.
Object
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Entfernt einen Listener aus dem EventDispatcher-Objekt.
EventDispatcher
 Inherited
Legt die Verfügbarkeit einer dynamischen Eigenschaft für Schleifenoperationen fest.
Object
 Inherited
Gibt die Stringdarstellung dieses Objekts zurück, formatiert entsprechend den Konventionen des Gebietsschemas.
Object
 Inherited
Gibt das angegebene Objekt als String zurück.
Object
 Inherited
Gibt den Grundwert des angegebenen Objekts zurück.
Object
 Inherited
Überprüft, ob bei diesem EventDispatcher-Objekt oder bei einem seiner Vorgänger ein Ereignis-Listener für einen bestimmten Ereignistyp registriert ist.
EventDispatcher
Ereignisse
 Ereignis Übersicht Definiert von
 Inherited[broadcast event] Wird ausgelöst, wenn Flash Player oder eine AIR-Anwendung den Betriebssystemfokus erhält und aktiv wird.EventDispatcher
 Inherited[broadcast event] Wird ausgelöst, wenn Flash Player- oder die AIR-Anwendung den Fokus verliert und inaktiv wird.EventDispatcher
Eigenschaftendetails
    

bitmaps

Eigenschaft
bitmaps:Array[override]

Laufzeitversionen: AIR 1.0

Das Symbolbild als ein Array von BitmapData-Objekten in verschiedenen Größen.

Wenn ein Symbol in einem bestimmten Betriebssystemkontext angezeigt wird, wird die Bitmap aus dem Array verwendet, die der angezeigten Größe am nächsten kommt. Falls erforderlich, wird die Bitmap skaliert. Gebräuchliche Größen sind 16x16, 32x32, 48x48 und 128x128. (Mit einigen Betriebssystemen können in naher Zukunft Symbole in der Größe 512x512 Pixel verwendet werden.)

In bestimmten Kontexten verwendet das Betriebssystem möglicherweise ein Standardsymbol, wenn der bitmaps-Eigenschaft keine Eingabe zugewiesen wurde. In anderen Kontexten wird kein Symbol angezeigt.

Um das Erscheinungsbild des Symbols festzulegen oder zu ändern, weisen Sie der bitmaps-Eigenschaft ein Array mit bitmapData-Objekten zu:

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

Das direkte Ändern des bitmaps-Array hat keine Auswirkungen.

Um das Symbolbild zu löschen, weisen Sie der bitmaps-Eigenschaft ein leeres Array zu.

Hinweis: Beim Laden von Bilddateien für ein Symbol erzielen Sie die beste Alphamischung im Allgemeinen mit dem PNG-Dateiformat. Das GIF-Format unterstützt nur Transparenz oder keine Transparenz (keine Mischmodi). Das JPG-Format unterstützt keine Transparenz.



Implementierung
    override public function get bitmaps():Array
    override public function set bitmaps(value:Array):void
    

height

Eigenschaft 
height:int  [schreibgeschützt] [override]

Laufzeitversionen: AIR 1.0

Die aktuelle Anzeigehöhe des Symbols in Pixel.

Einige Symbolkontexte unterstützen dynamische Größen. Die height-Eigenschaft gibt die Höhe des Symbols an, das für den aktuellen Kontext aus dem bitmaps-Array ausgewählt wurde. Die tatsächliche Anzeigehöhe kann davon abweichen, falls das Betriebssystem das Symbol skaliert hat.



Implementierung
    override public function get height():int
    

menu

Eigenschaft 
menu:NativeMenu

Sprachversion: ActionScript 3.0
Laufzeitversionen: AIR 1.0

Das vom System bereitgestellte Menü dieses Docksymbols.

Alle Elemente im Menü werden über den Standardelementen angezeigt. Die Standardelemente können nicht geändert oder entfernt werden.



Implementierung
    public function get menu():NativeMenu
    public function set menu(value:NativeMenu):void

Beispiel  ( Verwendung dieses Beispiels )
Im folgenden Beispiel wird dem Dockmenü ein Element hinzugefügt:
 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

Eigenschaft 
width:int  [schreibgeschützt] [override]

Laufzeitversionen: AIR 1.0

Die aktuelle Anzeigebreite des Symbols in Pixel.

Einige Symbolkontexte unterstützen dynamische Größen. Die width-Eigenschaft gibt die Breite des Symbols an, das für den aktuellen Kontext aus dem bitmaps-Array ausgewählt wurde. Die tatsächliche Anzeigebreite kann davon abweichen, falls das Betriebssystem das Symbol skaliert hat.



Implementierung
    override public function get width():int
Methodendetails

    bounce

()Methode
public function bounce(priority:String = "informational"):void

Sprachversion: ActionScript 3.0
Laufzeitversionen: AIR 1.0

Benachrichtigt den Benutzer, dass ein Ereignis aufgetreten ist, das möglicherweise sein Eingreifen erfordert.

Beim Aufrufen dieser Methode beginnt das Dock-Symbol zu „springen“, jedoch nur, wenn sich die Anwendung im Hintergrund befindet. Wenn priority den Wert NotificationType.Informational aufweist, springt das Symbol einmal. Wenn priority den Wert NotificationType.Critical aufweist, springt das Symbol so lange, bis die Anwendung in den Vordergrund geholt wird.

Parameter

priority:String (default = "informational") — Die Dringlichkeit, mit der das Docksymbol springt.

Verwandte API-Elemente


Beispiel  ( Verwendung dieses Beispiels )

Im folgenden Beispiel springt das Dock-Symbol so lange, bis der Benutzer die Anwendung aktiviert.
 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);
 }
 
DockIconExample.as

Im folgenden Beispiel wird eine Bildfolge geladen und das Symbolbild animiert, wenn der Timer mit dem Dock-Symbolmenü gestartet wird. (Damit das Beispiel funktioniert, müssen Sie einen Satz an Symbolbildern bereitstellen und die URLs im ImageURLs-Array ändern.)
 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);
            }
        }
    }
}




[ X ]Warum auf Englisch?
Inhalt des ActionScript 3.0-Referenzhandbuchs wird in englischer Sprache angezeigt

Nicht alle Teile des ActionScript 3.0-Referenzhandbuchs wurden in alle Sprachen übersetzt. Wenn der Text zu einem Sprachelement nicht übersetzt wurde, wird er auf Englisch angezeigt. Zum Beispiel wurden die Informationen zur ga.controls.HelpBox-Klasse nicht in andere Sprachen übersetzt. In der deutschen Version des Referenzhandbuchs erscheint der Abschnitt zur ga.controls.HelpBox-Klasse deshalb auf Englisch.