Package | flash.accessibility |
Classe | public class AccessibilityProperties |
Héritage | AccessibilityProperties Object |
Sous-classes | UIComponentAccImpl, UIComponentAccProps |
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | AIR 1.0, Flash Player 9 |
Vous pouvez joindre un objet AccessibilityProperties à tout objet à afficher. Cependant, Flash Player ne lira votre objet AccessibilityProperties que pour certains types d’objet : les fichiers SWF complets (représentés par DisplayObject.root
), les objets conteneur (DisplayObjectContainer
et les sous-classes), les boutons (SimpleButton
et les sous-classes) et le texte (TextField
et les sous-classes).
La propriété name
de ces objets est la plus importante à indiquer car les outils d’aide à l’accessibilité fournissent le nom des objets aux utilisateurs comme principal moyen de navigation. Ne confondez pas AccessibilityProperties.name
et DisplayObject.name
; il s’agit de deux propriétés distinctes et sans rapport entre elles. La propriété AccessibilityProperties.name
est le nom qui est lu à haute voix par l’outil d’aide à l’accessibilité, alors que DisplayObject.name
est un nom de variable visible uniquement dans le code ActionScript.
Dans Flash Professional, les propriétés des objets AccessibilityProperties
remplacent les paramètres correspondants du panneau Accessibilité pendant la création.
Pour savoir si Flash Player s’exécute dans un environnement qui prend en charge les fonctions d’accessibilité, utilisez la propriété Capabilities.hasAccessibility
. Si vous modifiez des objets AccessibilityProperties, vous devez appeler la méthode Accessibility.updateProperties()
pour que les modifications deviennent effectives.
Eléments de l’API associés
flash.display.DisplayObject.accessibilityProperties
flash.display.InteractiveObject.tabIndex
flash.system.Capabilities.hasAccessibility
Propriété | Défini par | ||
---|---|---|---|
constructor : Object
Référence à l’objet de classe ou à la fonction constructeur d’une occurrence donnée d’un objet. | Object | ||
description : String
Fournit une description de cet objet d’affichage dans la présentation accessible. | AccessibilityProperties | ||
forceSimple : Boolean
Si la valeur est true, Flash Player exclut les objets enfant contenus dans cet objet d’affichage de la présentation accessible. | AccessibilityProperties | ||
name : String
Affecte un nom à cet objet d’affichage dans la présentation accessible. | AccessibilityProperties | ||
noAutoLabeling : Boolean
Si la valeur est true, le système d’étiquetage automatique par défaut de Flash Player est désactivé. | AccessibilityProperties | ||
shortcut : String
Indique un raccourci clavier associé à l’objet d’affichage. | AccessibilityProperties | ||
silent : Boolean
Si la valeur est true, l’objet d’affichage est exclu de la présentation accessible. | AccessibilityProperties |
Méthode | Défini par | ||
---|---|---|---|
Crée un nouvel objet AccessibilityProperties. | AccessibilityProperties | ||
Indique si la propriété spécifiée d’un objet est définie. | Object | ||
Indique si une occurrence de la classe Object figure dans la chaîne de prototype de l’objet spécifié en tant que paramètre. | Object | ||
Indique si la propriété spécifiée existe et est énumérable. | Object | ||
Définit la disponibilité d’une propriété dynamique pour les opérations en boucle. | Object | ||
Renvoie la représentation de chaîne de cet objet, formatée selon les paramètres régionaux en vigueur. | Object | ||
Renvoie la représentation sous forme de chaîne de l’objet spécifié. | Object | ||
Renvoie la valeur primitive de l’objet spécifié. | Object |
description | propriété |
public var description:String
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | AIR 1.0, Flash Player 9 |
Fournit une description de cet objet d’affichage dans la présentation accessible. Si vous avez beaucoup d’informations à mentionner à propos de l’objet, choisissez un nom concis et gardez le reste pour la propriété description
. S'applique aux fichiers SWF entiers, aux conteneurs, aux boutons et au texte. La valeur par défaut est une chaîne vide.
Dans Flash Professional, cette propriété correspond au champ Description du panneau Accessibilité.
forceSimple | propriété |
public var forceSimple:Boolean
Versions du moteur d’exécution: | AIR 1.0, Flash Player 9 |
Si la valeur est true
, Flash Player exclut les objets enfant contenus dans cet objet d’affichage de la présentation accessible. La valeur par défaut est false
. S’applique aux fichiers SWF entiers et aux conteneurs.
name | propriété |
public var name:String
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | AIR 1.0, Flash Player 9 |
Affecte un nom à cet objet d’affichage dans la présentation accessible. S'applique aux fichiers SWF entiers, aux conteneurs, aux boutons et au texte. Ne confondez pas avec la propriété DisplayObject.name
, qui n’a aucun rapport. La valeur par défaut est une chaîne vide.
Dans Flash Professional, cette propriété correspond au champ Nom du panneau Accessibilité.
noAutoLabeling | propriété |
public var noAutoLabeling:Boolean
Versions du moteur d’exécution: | AIR 1.0, Flash Player 9 |
Si la valeur est true
, le système d’étiquetage automatique par défaut de Flash Player est désactivé. Avec l’étiquetage automatique, les objets texte placés dans les boutons sont traités comme des noms de bouton, et ceux qui sont placés à côté des champs de texte sont traités comme des noms de champ de texte. La valeur par défaut est false
. S’applique aux fichiers SWF entiers uniquement.
La valeur de la propriété noAutoLabeling
est ignorée, sauf si vous la spécifiez avant la première lecture de votre fichier SWF par une aide d’accessibilité. Si vous envisagez de définir noAutoLabeling
sur true
, faites-le aussi tôt que possible dans votre code.
shortcut | propriété |
public var shortcut:String
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | AIR 1.0, Flash Player 9 |
Indique un raccourci clavier associé à l’objet d’affichage. Ne spécifiez cette chaîne que pour les contrôles de l’interface utilisateur que vous avez associés à une touche de raccourci. S’applique aux conteneurs, aux boutons et au texte. La valeur par défaut est une chaîne vide.
Remarque : l’affectation de cette propriété n’affecte pas automatiquement la combinaison de touches spécifiée à cet objet ; pour ce faire, vous devez utiliser vous-même un écouteur d’événements KeyboardEvent
.
La syntaxe de cette chaîne utilise des noms longs pour les touches de modification et le signe plus(+) pour signaler une combinaison de touches. Ctrl+F, Ctrl+Maj+Z sont des exemples de chaînes valides.
silent | propriété |
public var silent:Boolean
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | AIR 1.0, Flash Player 9 |
Si la valeur est true
, l’objet d’affichage est exclu de la présentation accessible. La valeur par défaut est false
. S'applique aux fichiers SWF entiers, aux conteneurs, aux boutons et au texte.
AccessibilityProperties | () | Constructeur |
public function AccessibilityProperties()
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | AIR 1.0, Flash Player 9 |
Crée un nouvel objet AccessibilityProperties.
AccessibilityExample
, CustomAccessibleButton
, CustomSimpleButton
et ButtonDisplayState
pour créer un menu d’accessibilité qui fonctionne avec les lecteurs d’écran les plus courants. Voici les principales fonctionnalités de la classe AccessibilityProperties
:
- Appelez
configureAssets
, qui crée un bouton personnalisé et définit son intitulé et sa description. Voici les valeurs que le lecteur d’écran envoie à l’utilisateur final. - Appelez
setTimeOut()
pour vous assurer que Flash Player dispose de suffisamment de temps pour détecter le lecteur d’écran avant de mettre les propriétés à jour.
Remarque : appelez setTimeout()
avant de vérifier Accessibility.active
. pour accorder à Flash Player les 2 secondes dont il a besoin pour se connecter à un lecteur d’écran, le cas échéant. Si vous ne laissez pas suffisamment de temps au lecteur, l’appel de setTimeout
risque de renvoyer la valeur false
même lorsqu’un lecteur d’écran est disponible.
L’exemple suivant ne traite la méthode Accessibility.updateProperties()
que si l’appel à Accessibility.active
renvoie la valeur true
. Cette situation ne se produit que lorsque Flash Player est déjà connecté à un lecteur d’écran actif. Si la méthode updateProperties
est appelée sans lecteur d’écran actif, elle émet une exception IllegalOperationError
.
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(); } } }
Tue Jun 12 2018, 09:30 AM Z