Packageflash.accessibility
Classpublic class AccessibilityImplementation
InheritanceAccessibilityImplementation Inheritance Object

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 9, AIR 2.0

The AccessibilityImplementation class is the base class in Flash Player that allows for the implementation of accessibility in components. This class enables communication between a component and a screen reader. Screen readers are used to translate screen content into synthesized speech or braille for visually impaired users.

The AccessibilityImplementation class provides a set of methods that allow a component developer to make information about system roles, object based events, and states available to assistive technology.

Adobe Flash Player uses Microsoft Active Accessibility (MSAA), which provides a descriptive and standardized way for applications and screen readers to communicate. For more information on how the Flash Player works with MSAA, see the accessibility chapter in Using Flex SDK.

The methods of the AccessibilityImplementation class are a subset of the IAccessible interface for a component instance.

The way that an AccessibilityImplementation implements the IAccessible interface, and the events that it sends, depend on the kind of component being implemented.

Do not directly instantiate AccessibilityImplementation by calling its constructor. Instead, create new accessibility implementations by extending the AccImpl class for each new component. In Flash, see the fl.accessibility package. In Flex, see the mx.accessibility package and the accessibility chapter in Using Flex SDK.

Note: The AccessibilityImplementation class is not supported in AIR runtime versions before AIR 2. The class is available for compilation in AIR versions before AIR 2, but is not supported in the runtime until AIR 2.

See also

IAccessible


Public Properties
 PropertyDefined By
  errno : uint
Indicates an error code.
AccessibilityImplementation
  stub : Boolean
Used to create a component accessibility stub.
AccessibilityImplementation
Public Methods
 MethodDefined By
  
Static constructor.
AccessibilityImplementation
 Inherited
_init():*
[static]
_init
  
accDoDefaultAction(childID:uint):void
AccessibilityImplementation
  
accLocation(childID:uint):*
AccessibilityImplementation
  
accSelect(operation:uint, childID:uint):void
AccessibilityImplementation
  
AccessibilityImplementation
  
AccessibilityImplementation
  
AccessibilityImplementation
  
MSAA method for returning the system role for the component that this AccessibilityImplementation represents or for one of its child elements.
AccessibilityImplementation
  
AccessibilityImplementation
  
AccessibilityImplementation
  
AccessibilityImplementation
  
AccessibilityImplementation
  
AccessibilityImplementation
  
AccessibilityImplementation
 Inherited
AS3
 Inherited
init():*
[static]
init
  
AccessibilityImplementation
 Inherited
AS3
 Inherited
AS3
Protected Methods
 MethodDefined By
 Inherited
[static]
protected
 Inherited
_setPropertyIsEnumerable(o:*, V:String, enumerable:Boolean):void
[static]
protected
Public Constants
 ConstantDefined By
 Inheritedlength : int = 1
[static]
length
Property Detail
errnoproperty
public var errno:uint

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 9, AIR 2.0

Indicates an error code. Errors are indicated out-of-band, rather than in return values. To indicate an error, set the errno property to one of the error codes documented in the AccessibilityImplementation Constants appendix. This causes your return value to be ignored. The errno property of your AccessibilityImplementation is always cleared (set to zero) by the player before any AccessibilityImplementation method is called.

See also

stubproperty 
public var stub:Boolean

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 9, AIR 2.0

Used to create a component accessibility stub. If a component is released without an ActionScript accessibility implementation, Adobe recommends that you add a component accessibility stub. This stub causes Flash Player, for accessibility purposes, to treat the component as a simple graphic rather than exposing the internal structure of buttons, textfields, and so on, within the component.

To create a component accessibility stub, subclass the relevant AccImpl class, overriding the property stub with a value of true.

See also

mx.accessibility.AccImpl class in Flex (\sdks\4.0.0\frameworks\projects\framework\src\mx\accessibility\AccImpl.as)
fl.accessibility.AccImpl class in Flash (\Local Settings\Application Data\Adobe\Flash CS5\en_US\Configuration\Classes\mx\accessibility\AccImpl.as)
Constructor Detail
AccessibilityImplementation()Constructor
public function AccessibilityImplementation()

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 9, AIR 2.0

Static constructor. Do not directly instantiate AccessibilityImplementation by calling its constructor. Instead, create new accessibility implementations by extending the mx.accessibility.AccImpl class for each new component.

See also

mx.accessibility.AccImpl
Method Detail
accDoDefaultAction()method
public function accDoDefaultAction(childID:uint):void

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 9, AIR 2.0

Parameters

childID:uint

See also

accLocation()method 
public function accLocation(childID:uint):*

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 9, AIR 2.0

Parameters

childID:uint

Returns
*

See also

accSelect()method 
public function accSelect(operation:uint, childID:uint):void

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 9, AIR 2.0

Parameters

operation:uint
 
childID:uint

See also

get_accDefaultAction()method 
public function get_accDefaultAction(childID:uint):String

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 9, AIR 2.0

Parameters

childID:uint

Returns
String

See also

get_accFocus()method 
public function get_accFocus():uint

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 9, AIR 2.0

Returns
uint

See also

get_accName()method 
public function get_accName(childID:uint):String

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 9, AIR 2.0

Parameters

childID:uint

Returns
String

See also

get_accRole()method 
public function get_accRole(childID:uint):uint

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 9, AIR 2.0

MSAA method for returning the system role for the component that this AccessibilityImplementation represents or for one of its child elements. System roles are predefined for all the components in MSAA.

Parameters

childID:uint — An unsigned integer corresponding to one of the component's child elements as defined by getChildIDArray().

Returns
uint — System role associated with the component.

See also

get_accSelection()method 
public function get_accSelection():Array

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 9, AIR 2.0

Returns
Array

See also

get_accState()method 
public function get_accState(childID:uint):uint

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 9, AIR 2.0

Parameters

childID:uint

Returns
uint

See also

get_accValue()method 
public function get_accValue(childID:uint):String

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 9, AIR 2.0

Parameters

childID:uint

Returns
String

See also

get_selectionActiveIndex()method 
public function get_selectionActiveIndex():*

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 9, AIR 2.0

Returns
*

See also

get_selectionAnchorIndex()method 
public function get_selectionAnchorIndex():*

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 9, AIR 2.0

Returns
*

See also

getChildIDArray()method 
public function getChildIDArray():Array

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 9, AIR 2.0

Returns
Array

See also

isLabeledBy()method 
public function isLabeledBy(labelBounds:Rectangle):Boolean

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 9, AIR 2.0

Parameters

labelBounds:Rectangle

Returns
Boolean

See also