Packagespark.accessibility
Classpublic class ListAccImpl
InheritanceListAccImpl Inheritance ListBaseAccImpl Inheritance AccImpl Inheritance flash.accessibility.AccessibilityImplementation

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

ListAccImpl is the accessibility implementation class for spark.components.List.

When a Spark ListBase is created, its accessibilityImplementation property is set to an instance of this class. The Flash Player then uses this class to allow MSAA clients such as screen readers to see and manipulate the List. See the mx.accessibility.AccImpl and flash.accessibility.AccessibilityImplementation classes for background information about accessibility implementation classes and MSAA.

Children

The MSAA children of a list are its list items. The number of children is the number of items in the dataProvider, not just the number of visible renderers.

As described above, the accessibility of the list items is managed by the List; the accessibilityImplementation and accessibilityProperties of the item renderers are ignored by the Flash Player.

Role

The MSAA Role of a List is ROLE_SYSTEM_LIST.

The Role of each list item in the List is ROLE_SYSTEM_LISTITEM.

Name

The MSAA Name of a List is, by default, an empty string. When wrapped in a FormItem element, the Name is the FormItem's label. To override this behavior, set the List's accessibilityName property.

The Name of each list item is determined by the List's itemToLabel() method.

When the Name of the List or one of its items changes, a List dispatches the MSAA event EVENT_OBJECT_NAMECHANGE with the proper childID for a list item or 0 for itself.

Description

The MSAA Description of a List is, by default, an empty string, but you can set the List's accessibilityDescription property.

The Description of each list item is the empty string.

State

The MSAA State of a List is a combination of:

The State of a list item is a combination of:

When the State of the List or one of its items changes, a List dispatches the MSAA event EVENT_OBJECT_STATECHANGE with the proper childID for the list item or 0 for itself.

Value

A List or list item does not have an MSAA Value.

Location

The MSAA Location of a List or a list item is its bounding rectangle.

Default Action

A List does not have an MSAA DefaultAction.

The MSAA DefaultAction of a list item is "Double Click".

Performing the default action on a list item will cause it to be selected.

Focus

A List accepts focus. When it does so, it dispatches the MSAA event EVENT_OBJECT_FOCUS.

Selection

A List allows either a single or multiple list items to be selected, depending on the allowMultipleSelection property. When an item is selected, it dispatches MSAA event EVENT_OBJECT_SELECTION.



Protected Properties
 PropertyDefined By
 InheritedeventsToHandle : Array
[read-only] All subclasses must override this function by returning an array of strings of the events to listen for.
AccImpl
 Inheritedmaster : UIComponent
A reference to the UIComponent instance that this AccImpl instance is making accessible.
AccImpl
 Inheritedrole : uint
Accessibility role of the component being made accessible.
AccImpl
Public Methods
 MethodDefined By
  
Constructor.
ListAccImpl
  
[static] Enables accessibility in the List class.
ListAccImpl
 Inherited
getFormName(component:UIComponent):String
[static] Method for supporting Form Accessibility.
AccImpl
 Inherited
isAncestorDisabled(component:UIComponent):Boolean
[static] Returns true if an ancestor of the component has enabled set to false.
AccImpl
Protected Methods
 MethodDefined By
 Inherited
eventHandler(event:Event):void
Generic event handler.
AccImpl
 Inherited
getName(childID:uint):String
Returns the name of the accessible component.
AccImpl
 Inherited
getState(childID:uint):uint
Utility method to determine state of the accessible component.
AccImpl
Constructor Detail
ListAccImpl()Constructor
public function ListAccImpl(master:UIComponent)

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

Constructor.

Parameters
master:UIComponent — The UIComponent instance that this AccImpl instance is making accessible.
Method Detail
enableAccessibility()method
public static function enableAccessibility():void

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

Enables accessibility in the List class.

This method is called by application startup code that is autogenerated by the MXML compiler. Afterwards, when instances of List are initialized, their accessibilityImplementation property will be set to an instance of this class.