Referenshandbok för ActionScript® 3.0 i Adobe® Flash®-plattformen
Hem  |  Dölj paket och klasslista |  Paket  |  Klasser  |  Nyheter  |  Index  |  Bilagor  |  Varför på engelska?
Filter: Hämtar data från servern ...
Hämtar data från servern ...
flash.accessibility 

AccessibilityProperties  - AS3

Paketflash.accessibility
Klasspublic class AccessibilityProperties
ArvAccessibilityProperties Inheritance Object
Underklasser UIComponentAccImpl, UIComponentAccProps

Språkversion: ActionScript 3.0
Körningsmiljöversioner: AIR 1.0, Flash Player 9

Klassen AccessibilityProperties gör att du kan styra hur Flash-objekt visas i hjälpmedel, till exempel i skärmläsare.

Det går att bifoga ett AccessibilityProperties-objekt till vilket visningsobjekt som helst men Flash Player kommer bara att läsa AccessibilityProperties-objekt för vissa typer av objekt: fullständiga SWF-filer (som de representeras av DisplayObject.root), behållarobjekt (DisplayObjectContainer och underklasser), knappar (SimpleButton och underklasser) samt text (TextField och underklasser).

Egenskapen name för de här objekten är den viktigaste egenskapen att ange, eftersom hjälpmedelskomponenter ger namnet på objekten till användarna som grundläggande navigeringshjälp. Blanda inte ihop AccessibilityProperties.name och DisplayObject.name; de är helt skilda och har inget med varann att göra. Egenskapen AccessibilityProperties.name är ett namn som läses upp högt av hjälpmedelskomponenten medan DisplayObject.name är ett variabelnamn som bara är synligt för ActionScript-kod.

I Flash Professional åsidosätter egenskaper för AccessibilityProperties-objekt motsvarande inställningar på hjälpmedelspanelen under utvecklingen.

Om du vill ta reda på om Flash Player körs i en miljö som kan hantera hjälpmedelsfunktioner använder du egenskapen Capabilities.hasAccessibility. Om du ändrar AccessibilityProperties-objekt måste du anropa Accessibility.updateProperties()-metoden för att ändringarna ska börja gälla.

Visa exemplen

Relaterade API-element



Publika egenskaper
 EgenskapDefinieras med
 Inheritedconstructor : Object
En referens till klassobjektet eller konstruktorfunktionen för en given objektinstans.
Object
  description : String
Anger en beskrivning för visningsobjektet i den hjälpmedelsanpassade presentationen.
AccessibilityProperties
  forceSimple : Boolean
Om det är true utesluter Flash Player underordnade objekt i det här visningsobjektet från den hjälpmedelsanpassade presentationen.
AccessibilityProperties
  name : String
Anger ett namn för visningsobjektet i den hjälpmedelsanpassade presentationen.
AccessibilityProperties
  noAutoLabeling : Boolean
Om det är true inaktiverar Flash Player standardsystemet för automatiska etiketter.
AccessibilityProperties
  shortcut : String
Visar ett kortkommando som är associerat med visningsobjektet.
AccessibilityProperties
  silent : Boolean
Om det är true utesluts visningsobjektet från den hjälpmedelsanpassade presentationen.
AccessibilityProperties
Publika metoder
 MetodDefinieras med
  
Skapar ett nytt AccessibilityProperties-objekt.
AccessibilityProperties
 Inherited
Anger om det finns en egenskap angiven för ett objekt.
Object
 Inherited
Anger om en instans av klassen Object finns i prototypkedjan för objektet som anges som parameter.
Object
 Inherited
Anger om den angivna egenskapen finns och är uppräkningsbar.
Object
 Inherited
Anger tillgänglighet för en dynamisk egenskap för slingåtgärder.
Object
 Inherited
Returnerar det här objektets strängrepresentation, formaterad i enlighet med språkspecifika konventioner.
Object
 Inherited
Returnerar det angivna objektets strängbeteckning.
Object
 Inherited
Returnerar det angivna objektets primitiva värde.
Object
Egenskapsdetaljer

description

egenskap
public var description:String

Språkversion: ActionScript 3.0
Körningsmiljöversioner: AIR 1.0, Flash Player 9

Anger en beskrivning för visningsobjektet i den hjälpmedelsanpassade presentationen. Om du har mycket information om objektet är det bäst att välja ett koncist namn och ange det mesta av innehållet i egenskapen description. Gäller fullständiga SWF-filer, behållare, knappar och text. Standardvärdet är en tom sträng.

I Flash Professional motsvarar den här egenskapen fältet Beskrivning på hjälpmedelspanelen.

forceSimple

egenskap 
public var forceSimple:Boolean

Körningsmiljöversioner: AIR 1.0, Flash Player 9

Om det är true utesluter Flash Player underordnade objekt i det här visningsobjektet från den hjälpmedelsanpassade presentationen. Standardvärdet är false. Gäller fullständiga SWF-filer och behållare.

name

egenskap 
public var name:String

Språkversion: ActionScript 3.0
Körningsmiljöversioner: AIR 1.0, Flash Player 9

Anger ett namn för visningsobjektet i den hjälpmedelsanpassade presentationen. Gäller fullständiga SWF-filer, behållare, knappar och text. Blanda inte ihop med DisplayObject.name som inte alls har med det att göra. Standardvärdet är en tom sträng.

I Flash Professional motsvarar den här egenskapen fältet Namn på hjälpmedelspanelen.

noAutoLabeling

egenskap 
public var noAutoLabeling:Boolean

Körningsmiljöversioner: AIR 1.0, Flash Player 9

Om det är true inaktiverar Flash Player standardsystemet för automatiska etiketter. Automatisk etikettering gör att textobjekt inuti knappar behandlas som knappnamn och textobjekt nära textfält behandlas som textfältnamn. Standardvärdet är false. Gäller endast fullständiga SWF-filer.

Värdet för egenskapen noAutoLabeling ignoreras om du inte anger det innan en hjälpmedelsfunktion analyserar SWF-filen för första gången. Om du vill ställa in noAutoLabelingtrue ska du göra det så tidigt som möjligt i koden.

shortcut

egenskap 
public var shortcut:String

Språkversion: ActionScript 3.0
Körningsmiljöversioner: AIR 1.0, Flash Player 9

Visar ett kortkommando som är associerat med visningsobjektet. Ange bara den här strängen för gränssnittskontroller som har ett kortkommando. Gäller behållare, knappar och text. Standardvärdet är en tom sträng.

Obs: Om du tilldelar den här egenskapen innebär det inte automatiskt att den angivna tangentkombinationen tilldelas det här objektet. Du måste göra det själv, t.ex. genom att lyssna efter ett KeyboardEvent.

Syntaxen för den här strängen är långa namn för modifieringstangenter och plustecknet (+) för att ange tangentkombination. Exempel på giltiga strängar är "Ctrl+F", "Ctrl+Shift+Z" etc.

silent

egenskap 
public var silent:Boolean

Språkversion: ActionScript 3.0
Körningsmiljöversioner: AIR 1.0, Flash Player 9

Om det är true utesluts visningsobjektet från den hjälpmedelsanpassade presentationen. Standardvärdet är false. Gäller fullständiga SWF-filer, behållare, knappar och text.

Konstruktordetaljer

AccessibilityProperties

()Konstruktor
public function AccessibilityProperties()

Språkversion: ActionScript 3.0
Körningsmiljöversioner: AIR 1.0, Flash Player 9

Skapar ett nytt AccessibilityProperties-objekt.

AccessibilityPropertiesExample.as

I följande exempel används exempelklasserna AccessibilityExample, CustomAccessibleButton, CustomSimpleButton och ButtonDisplayState för att skapa en hjälpmedelskompatibel meny som fungerar med vanliga skärmläsare. Standardfunktionen för klassen AccessibilityProperties är följande:
  1. Anropa configureAssets, det skapar en anpassad knapp och ställer in etikett och beskrivning. Dessa värden förmedlas till slutanvändaren av skärmläsaren.
  2. Anropa setTimeOut() för att se till att Flash Player har tillräckligt med tid att upptäcka skärmläsaren innan egenskaperna uppdateras.

Obs: Anropa setTimeout() före kontroll av Accessibility.active. så att Flash Player får de 2 sekunder som behövs för att ansluta till en skärmläsare om en sådan finns tillgänglig. Utan tillräcklig fördröjning kan setTimeout-anropet returnera false trots att en skärmläsare finns tillgänglig.

I följande exempel bearbetas Accessibility.updateProperties()-metod bara om anropet till Accessibility.active returnerar true, vilket bara sker om Flash Player är ansluten till en aktiv skärmläsare. Om updateProperties anropas utan aktiv skärmläsare orsakar den ett IllegalOperationError-undantag.

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 ]Varför på engelska?
Innehåll i Referenshandbok för ActionScript 3.0 i Adobe Flash-plattformen är på engelska

Det är inte alla delar av Referenshandbok för ActionScript 3.0 i Adobe Flash-plattformen som översätts till alla språk. Om ett språkelement inte översätts visas det på engelska. Klassen ga.controls.HelpBox översätts till exempel inte till något språk. I den svenska versionen av referenshandboken visas därför klassen ga.controls.HelpBox på engelska.