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.accessibility 

AccessibilityProperties  - AS3

Paketflash.accessibility
Klassepublic class AccessibilityProperties
VererbungAccessibilityProperties Inheritance Object
Unterklassen UIComponentAccImpl, UIComponentAccProps

Sprachversion: ActionScript 3.0
Laufzeitversionen: AIR 1.0, Flash Player 9

Mit der AccessibilityProperties-Klasse können Sie die Darstellung von Flash-Objekten in Hilfen zur Unterstützung der Barrierefreiheit, z. B. Bildschirmleseprogrammen, beeinflussen.

Sie können allen Anzeigeobjekten ein AccessibilityProperties-Objekt zuordnen. Dieses wird von Flash Player jedoch nur für bestimmte Objektarten gelesen: ganze SWF-Dateien (dargestellt durch DisplayObject.root), Containerobjekte (DisplayObjectContainer und Unterklassen), Schaltflächen (SimpleButton und Unterklassen) sowie Text (TextField und Unterklassen).

Die name-Eigenschaft dieser Objekte ist die wichtigste festzulegende Eigenschaft, da Hilfen zur Barrierefreiheit die Objektnamen als Grundlage für die Benutzernavigation verwendet werden. Verwechseln Sie nicht AccessibilityProperties.name mit DisplayObject.name. Dies sind unterschiedliche und voneinander unabhängige Eigenschaften. Die AccessibilityProperties.name-Eigenschaft ist ein Name, der von Hilfen zur Barrierefreiheit vorgelesen wird. Bei DisplayObject.name hingegen handelt es sich im Wesentlichen um einen Variablennamen, der nur im ActionScript-Code verfügbar ist.

In Flash Professional setzen diese Eigenschaften von AccessibilityProperties-Objekten die Eigenschaften außer Kraft, die beim Authoring im Bedienfeld „Eingabehilfen“ verfügbar sind.

Um zu ermitteln, ob Flash Player in einer Umgebung ausgeführt wird, die Hilfen zur Barrierefreiheit unterstützt, verwenden Sie die Capabilities.hasAccessibility-Eigenschaft. Wenn Sie AccessibilityProperties-Objekte ändern, müssen Sie die Accessibility.updateProperties()-Methode aufrufen, damit die Änderungen wirksam werden.

Beispiele anzeigen

Verwandte API-Elemente



Öffentliche Eigenschaften
 EigenschaftDefiniert von
 Inheritedconstructor : Object
Ein Verweis auf das Klassenobjekt oder die Konstruktorfunktion für eine angegebene Objektinstanz.
Object
  description : String
Gibt eine Beschreibung dieses Anzeigeobjekts in der barrierefreien Darstellung.
AccessibilityProperties
  forceSimple : Boolean
Der Wert true bewirkt, dass Flash Player untergeordnete Objekte dieses Anzeigeobjekts von der barrierefreien Darstellung ausschließt.
AccessibilityProperties
  name : String
Gibt einen Namen für dieses Anzeigeobjekt in der barrierefreien Darstellung an.
AccessibilityProperties
  noAutoLabeling : Boolean
Wenn dieser Wert „true“ ist, wird das standardmäßig aktivierte System der automatischen Bezeichnerzuweisung von Flash Player deaktiviert.
AccessibilityProperties
  shortcut : String
Gibt eine Tastenkombination an, die diesem Anzeigeobjekt zugeordnet ist.
AccessibilityProperties
  silent : Boolean
Wenn dieser Wert „true“ ist, wird dieses Anzeigeobjekt von der barrierefreien Darstellung ausgenommen.
AccessibilityProperties
Öffentliche Methoden
 MethodeDefiniert von
  
Erstellt ein neues AccessibilityProperties-Objekt.
AccessibilityProperties
 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
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
Eigenschaftendetails

description

Eigenschaft
public var description:String

Sprachversion: ActionScript 3.0
Laufzeitversionen: AIR 1.0, Flash Player 9

Gibt eine Beschreibung dieses Anzeigeobjekts in der barrierefreien Darstellung. Wenn zu einem Objekt eine große Menge an Informationen angeboten werden soll, wählen Sie am besten einem kurzen Namen und weisen die übrigen Angaben der description-Eigenschaft zu. Gilt für ganze SWF-Dateien, Container, Schaltflächen und Text. Der Standardwert lautet "" (ein leerer String).

In Flash Professional entspricht diese Eigenschaft dem Feld „Beschreibung“ im Bedienfeld „Eingabehilfen“.

forceSimple

Eigenschaft 
public var forceSimple:Boolean

Laufzeitversionen: AIR 1.0, Flash Player 9

Der Wert true bewirkt, dass Flash Player untergeordnete Objekte dieses Anzeigeobjekts von der barrierefreien Darstellung ausschließt. Der Standardwert lautet false. Gilt für ganze SWF-Dateien und Container.

name

Eigenschaft 
public var name:String

Sprachversion: ActionScript 3.0
Laufzeitversionen: AIR 1.0, Flash Player 9

Gibt einen Namen für dieses Anzeigeobjekt in der barrierefreien Darstellung an. Gilt für ganze SWF-Dateien, Container, Schaltflächen und Text. Nicht zu verwechseln mit der davon unabhängigen Eigenschaft DisplayObject.name. Der Standardwert lautet "" (ein leerer String).

In Flash Professional entspricht diese Eigenschaft dem Feld „Name“ im Bedienfeld „Eingabehilfen“.

noAutoLabeling

Eigenschaft 
public var noAutoLabeling:Boolean

Laufzeitversionen: AIR 1.0, Flash Player 9

Wenn dieser Wert true lautet, wird das standardmäßig aktivierte System der automatischen Bezeichnerzuweisung von Flash Player deaktiviert. Bei der automatischen Bezeichnerzuweisung werden Textobjekte innerhalb von Schaltflächen als Schaltflächennamen und Textobjekte in der Nähe von Textfeldern als Textfeldnamen behandelt. Der Standardwert lautet false. Gilt nur für ganze SWF-Dateien.

Der Wert der Eigenschaft noAutoLabeling wird ignoriert, sofern Sie ihn nicht angeben, bevor die SWF-Datei zum ersten Mal auf Barrierefreiheit geprüft wird. Wenn Sie beabsichtigen, noAutoLabeling auf den Wert true einzustellen, sollten Sie dies im Programmcode so früh wie möglich tun.

shortcut

Eigenschaft 
public var shortcut:String

Sprachversion: ActionScript 3.0
Laufzeitversionen: AIR 1.0, Flash Player 9

Gibt eine Tastenkombination an, die diesem Anzeigeobjekt zugeordnet ist. Geben Sie diesen String nur für Steuerelemente der Benutzeroberfläche an, denen Sie eine Tastenkombination zugewiesen haben. Gilt für Container, Schaltflächen und Text. Der Standardwert lautet "" (ein leerer String).

Hinweis: Durch das Zuweisen dieser Eigenschaft wird dem Objekt nicht automatisch die entsprechende Tastenkombination zugewiesen. Dafür müssen Sie selbst sorgen, indem Sie beispielsweise auf entsprechende KeyboardEvent-Ereignisse warten.

Die Syntax dieses Strings verwendet lange Namen für die Zusatztasten und das Pluszeichen (+) zur Angabe von Tastenkombinationen. Beispiele für gültige Strings sind „Strg+F“, „Strg+Umschalt+Z“ usw.

silent

Eigenschaft 
public var silent:Boolean

Sprachversion: ActionScript 3.0
Laufzeitversionen: AIR 1.0, Flash Player 9

Wenn dieser Wert true ist, wird dieses Anzeigeobjekt von der barrierefreien Darstellung ausgenommen. Der Standardwert lautet false. Gilt für ganze SWF-Dateien, Container, Schaltflächen und Text.

Konstruktordetails

AccessibilityProperties

()Konstruktor
public function AccessibilityProperties()

Sprachversion: ActionScript 3.0
Laufzeitversionen: AIR 1.0, Flash Player 9

Erstellt ein neues AccessibilityProperties-Objekt.

AccessibilityPropertiesExample.as

Im folgenden Beispiel wird mit den Klassen AccessibilityExample, CustomAccessibleButton, CustomSimpleButton und ButtonDisplayState ein Menü erstellt, das mit den Hilfen zur Barrierefreiheit kompatibel ist und mit den gängigen Bildschirmleseprogrammen funktioniert. Die Hauptfunktionalität der Klasse AccessibilityProperties lautet wie folgt:
  1. Rufen Sie die configureAssets-Methode auf, die eine benutzerdefinierte Schaltfläche erstellt und ihre Werte für Bezeichnung und Beschreibung festlegt. Dies sind die Werte, die das Bildschirmleseprogramm an Endbenutzer weitergibt.
  2. Rufen Sie setTimeOut() auf, um sicherzustellen, dass Flash Player genügend Zeit hat, das Bildschirmleseprogramm zu erkennen, bevor die Eigenschaften aktualisiert werden.

Hinweis: Rufen Sie setTimeout() auf, bevor Sie Accessibility.active aktivieren, um Flash Player die zwei Sekunden zu geben, die die Anwendung zum Herstellen der Verbindung zu einem Bildschirmleseprogramm benötigt (falls vorhanden). Wenn Sie keine ausreichende Zeitverzögerung angeben, wird beim Aufrufen von setTimeout ggf. auch false zurückgegeben, wenn ein Bildschirmleseprogramm verfügbar ist.

Das folgende Beispiel verarbeitet die Accessibility.updateProperties()-Methode nur, wenn beim Aufrufen von Accessibility.active der Wert true zurückgegeben wird. Dies ist nur der Fall, wenn Flash Player gerade über eine Verbindung zu einem aktiven Bildschirmleseprogramm verfügt. Wenn Sie updateProperties aufrufen, ohne dass ein Bildschirmleseprogramm aktiv ist, wird eine IllegalOperationError-Ausnahme ausgelöst.

package {
    import flash.display.Sprite;
    import flash.accessibility.Accessibility;
    import flash.utils.setTimeout;
    
    public class AccessibilityPropertiesExample extends Sprite {
        public static const BUTTON_WIDTH:uint = 90;
        public static const BUTTON_HEIGHT:uint = 20;
        
        private var gutter:uint = 5;
        private var menuLabels:Array = new Array("PROJECTS", "PORTFOLIO", "CONTACT");
        private var menuDescriptions:Array = new Array("Learn more about our projects"
                                                     , "See our portfolio"
                                                     , "Get in touch with our team");
        
        public function AccessibilityPropertiesExample() {
            configureAssets();
            setTimeout(updateAccessibility, 2000); 
        }
        
        private function updateAccessibility():void {
            trace("Accessibility.active: " + Accessibility.active);
            if(Accessibility.active) {
                Accessibility.updateProperties();
            }
        }
        
        private function configureAssets():void {
            var child:CustomAccessibleButton;
            for(var i:uint; i < menuLabels.length; i++) {
                child = new CustomAccessibleButton();
                child.y = (numChildren * (BUTTON_HEIGHT + gutter));
                child.setLabel(menuLabels[i]);
                child.setDescription(menuDescriptions[i]);
                addChild(child);
            }
        }
    }


import flash.accessibility.AccessibilityProperties;
import flash.display.Shape;
import flash.display.SimpleButton;
import flash.display.Sprite;
import flash.events.Event;
import flash.text.TextFormat;
import flash.text.TextField;
    
class CustomAccessibleButton extends Sprite {
    private var button:SimpleButton;
    private var label1:TextField;
    private var description:String;
    private var _name:String;
        
    public function CustomAccessibleButton(_width:uint = 0, _height:uint = 0) {
        _width = (_width == 0) ? AccessibilityPropertiesExample.BUTTON_WIDTH : _width;
        _height = (_height == 0) ? AccessibilityPropertiesExample.BUTTON_HEIGHT : _height;
            
        button = buildButton(_width, _height);
        label1 = buildLabel(_width, _height);
            
        addEventListener(Event.ADDED, addedHandler);
    }
        
    private function addedHandler(event:Event):void {
        trace("addedHandler: " + name);
        var accessProps:AccessibilityProperties = new AccessibilityProperties();
        accessProps.name = this._name;
        accessProps.description = description;
        accessibilityProperties = accessProps;
        removeEventListener(Event.ADDED, addedHandler);
    }
        
    private function buildButton(_width:uint, _height:uint):SimpleButton {
        var child:SimpleButton = new CustomSimpleButton(_width, _height);
        addChild(child);
        return child;
    }

    private function buildLabel(_width:uint, _height:uint):TextField {
        var format:TextFormat = new TextFormat();
        format.font = "Verdana";
        format.size = 11;
        format.color = 0xFFFFFF;
        format.align = TextFormatAlign.CENTER;
        format.bold = true;
            
        var child:TextField = new TextField();
        child.y = 1;
        child.width = _width;
        child.height = _height;
        child.selectable = false;
        child.defaultTextFormat = format;
        child.mouseEnabled = false;
            
        addChild(child);
        return child;
    }
        
    public function setLabel(text:String):void {
        label1.text = text;
        this._name = text;
    }
        
    public function setDescription(text:String):void {
        description = text;
    }
}
    
class CustomSimpleButton extends SimpleButton {
    private var upColor:uint = 0xFFCC00;
    private var overColor:uint = 0xCCFF00;
    private var downColor:uint = 0x00CCFF;

    public function CustomSimpleButton(_width:uint, _height:uint) {
        downState = new ButtonDisplayState(downColor, _width, _height);
        overState = new ButtonDisplayState(overColor, _width, _height);
        upState = new ButtonDisplayState(upColor, _width, _height);
        hitTestState = new ButtonDisplayState(upColor, _width, _height);
        useHandCursor = true;
    }        
}

class ButtonDisplayState extends Shape {
    private var bgColor:uint;
    private var _width:uint;
    private var _height:uint;

    public function ButtonDisplayState(bgColor:uint, _width:uint, _height:uint) {
        this.bgColor = bgColor;
        this._width = _width;
        this._height = _height;
        draw();
    }

    private function draw():void {
        graphics.beginFill(bgColor);
        graphics.drawRect(0, 0, _width, _height);
        graphics.endFill();
    }
}
}




[ 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.