spark.accessibility

# VideoPlayerAccImpl - AS3 Flex

Package | spark.accessibility
Class | public class VideoPlayerAccImpl
Inheritance | VideoPlayerAccImpl AccImpl AccessibilityImplementation Object

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 2.0

VideoPlayerAccImpl is the accessibility implementation class for spark.components.VideoPlayer.

When a Spark VideoPlayer 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 VideoPlayer. See the mx.accessibility.AccImpl and flash.accessibility.AccessibilityImplementation classes for background information about accessibility implementation classes and MSAA.

Children

The VideoPlayer has six MSAA children:

1. Play/Pause control
2. Scrub control
3. Play time indicator
4. Mute control
5. Volume control
6. Full Screen control

The controls will always appear in the same order for accessibility regardless of the order of controls in the skin.

Role

The MSAA Role of a VideoPlayer is ROLE_SYSTEM_PANE.

The Role of each child control is:

1. Play/Pause control: ROLE_SYSTEM_BUTTON
2. Scrub control: ROLE_SYSTEM_SLIDER
3. Play time indicator: ROLE_SYSTEM_STATICTEXT
4. Mute control: ROLE_SYSTEM_BUTTON
5. Volume control: ROLE_SYSTEM_SLIDER
6. Full Screen control: ROLE_SYSTEM_BUTTON

Name

The MSAA Name of a VideoPlayer is, by default, specified by a locale-dependent resource. For the en_US locale, the name is "VideoPlayer". When wrapped in a FormItem element, this name is combined with the FormItem's label. To override this behavior, set the VideoPlayer's's `accessibilityName` property.

The Name of each child control is similarly specified by a resource. The en_US names are:

1. Play/Pause control: "Play" or "Pause"
2. Scrub control: "Scrub Bar"
3. Play time indicator: the displayed text
4. Mute control: "Muted" or "Not muted"
5. Volume control: "Volume Bar"
6. Full Screen control: "Full Screen"

To override the names of these child controls, reskin the VideoPlayer and set the `accessibilityName` of the controls.

Note that the Play/Pause control and the Mute control have MSAA Names which change as you interact with them. To specify them, set `accessibilityName` to a comma-separated list of MSAA Names, such as "Play,Pause" or "Not Muted,Muted".

When the Name of the VideoPlayer or one of its child controls changes, a VideoPlayer dispatches the MSAA event EVENT_OBJECT_NAMECHANGE with the proper childID for the control or 0 for itself.

Description

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

The Description of each child control is the empty string.

State

The MSAA State of a VideoPlayer is STATE_SYSTEM_NORMAL.

The State of each child control is:

1. Play/Pause control:
   - STATE_SYSTEM_UNAVAILABLE
   - STATE_SYSTEM_FOCUSABLE
   - STATE_SYSTEM_FOCUSED
2. Scrub control:
   - STATE_SYSTEM_UNAVAILABLE
   - STATE_SYSTEM_FOCUSABLE
   - STATE_SYSTEM_FOCUSED
3. Play time indicator:
   - STATE_SYSTEM_UNAVAILABLE
   - STATE_SYSTEM_READONLY
4. Mute control:
   - STATE_SYSTEM_UNAVAILABLE
   - STATE_SYSTEM_FOCUSABLE
   - STATE_SYSTEM_FOCUSED
5. Volume control:
   - STATE_SYSTEM_UNAVAILABLE
   - STATE_SYSTEM_FOCUSABLE
   - STATE_SYSTEM_FOCUSED
6. Full Screen control:
   - STATE_SYSTEM_UNAVAILABLE
   - STATE_SYSTEM_FOCUSABLE
   - STATE_SYSTEM_FOCUSED

When the State of the VideoPlayer or one of its child controls changes, a VideoPlayer dispatches the MSAA event EVENT_OBJECT_STATECHANGE with the proper childID for the control or 0 for itself.

Value

A VideoPlayer does not have an MSAA Value.

THe Value of each child control is:

1. Play/Pause control: no Value
2. Scrub control: Value of slider as an amount of time
3. Play time indicator: no Value
4. Mute control: no Value
5. Volume control: Value of slider
6. Full Screen control: no Value

When the Value of a child control changes, a VideoPlayer dispatches the MSAA event EVENT_OBJECT_VALUECHANGE with the proper childID for the control.

Location

The MSAA Location of a VideoPlayer, or one of its child controls, is its bounding rectangle.

Default Action

A VideoPlayer does not have an MSAA DefaultAction.

The DefaultAction of each child control is:

1. Play/Pause control: "Press"
2. Scrub control: none
3. Play time indicator: none
4. Mute control: "Press"
5. Volume control: none
6. Full Screen control: "Press"

Performing the default action of one of the child controls will have the following effect:

1. Play/Pause control: toggle between Play and Pause
2. Scrub control: none
3. Play time indicator: none
4. Mute control: toggle between Mute and Not Muted
5. Volume control: none
6. Full Screen control: toogle Full Screen on and off

Focus

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

Some of its child controls also accept focus:

1. Play/Pause control: accepts focus
2. Scrub control: accepts focus
3. Play time indicator: does not accept focus
4. Mute control: transfers focus to Volume Bar
5. Volume control: accepts focus
6. Full Screen control: accepts focus

When reporting focus, the VideoPlayer reports itself if it is focused and none of its child controls is focused. Otherwise, the focus may be reported as being on the Play/Pause control, the Scrub control, the Volume control, or the Full Screen control.

Selection

A VideoPlayer does not support selection in the MSAA sense.

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | constructor : Object A reference to the class object or constructor function for a given object instance. | Object
|  | errno : uint Indicates an error code. | AccessibilityImplementation
|  | stub : Boolean Used to create a component accessibility stub. | AccessibilityImplementation

Protected Properties
Hide Inherited Protected Properties
Show Inherited Protected Properties

| Property | Defined By
--- | --- | ---
|  | eventsToHandle : Array [read-only] All subclasses must override this function by returning an array of strings of the events to listen for. | AccImpl
|  | master : UIComponent A reference to the UIComponent instance that this AccImpl instance is making accessible. | AccImpl
|  | role : uint Accessibility role of the component being made accessible. | AccImpl

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | VideoPlayerAccImpl(master:UIComponent) Constructor. | VideoPlayerAccImpl
|  | accDoDefaultAction(childID:uint):void An IAccessible method that performs the default action associated with the component that this AccessibilityImplementation represents or of one of its child elements. | AccessibilityImplementation
|  | accLocation(childID:uint):* MSAA method for returning a DisplayObject or Rectangle specifying the bounding box of a child element in the AccessibilityImplementation. | AccessibilityImplementation
|  | accSelect(operation:uint, childID:uint):void IAccessible method for altering the selection in the component that this AccessibilityImplementation represents. | AccessibilityImplementation
|  | enableAccessibility():void [static] Enables accessibility in the VideoPlayer class. | VideoPlayerAccImpl
|  | get_accDefaultAction(childID:uint):String MSAA method for returning the default action of the component that this AccessibilityImplementation represents or of one of its child elements. | AccessibilityImplementation
|  | get_accFocus():uint MSAA method for returning the unsigned integer ID of the child element, if any, that has child focus within the component. | AccessibilityImplementation
|  | get_accName(childID:uint):String MSAA method for returning the name for the component that this AccessibilityImplementation represents or for one of its child elements. | AccessibilityImplementation
|  | get_accRole(childID:uint):uint MSAA method for returning the system role for the component that this AccessibilityImplementation represents or for one of its child elements. | AccessibilityImplementation
|  | get_accSelection():Array MSAA method for returning an array containing the IDs of all child elements that are selected. | AccessibilityImplementation
|  | get_accState(childID:uint):uint IAccessible method for returning the current runtime state of the component that this AccessibilityImplementation represents or of one of its child elements. | AccessibilityImplementation
|  | get_accValue(childID:uint):String MSAA method for returning the runtime value of the component that this AccessibilityImplementation represents or of one of its child elements. | AccessibilityImplementation
|  | get_selectionActiveIndex():* | AccessibilityImplementation
|  | get_selectionAnchorIndex():* | AccessibilityImplementation
|  | getChildIDArray():Array Returns an array containing the unsigned integer IDs of all child elements in the AccessibilityImplementation. | AccessibilityImplementation
|  | getFormName(component:UIComponent):String [static] Method for supporting Form Accessibility. | AccImpl
|  | hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined. | Object
|  | isAncestorDisabled(component:UIComponent):Boolean [static] Returns true if an ancestor of the component has enabled set to false. | AccImpl
|  | isLabeledBy(labelBounds:Rectangle):Boolean Returns true or false to indicate whether a text object having a bounding box specified by a x, y, width, and height should be considered a label for the component that this AccessibilityImplementation represents. | AccessibilityImplementation
|  | isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter. | Object
|  | propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable. | Object
|  | setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations. | Object
|  | toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions. | Object
|  | toString():String Returns the string representation of the specified object. | Object
|  | valueOf():Object Returns the primitive value of the specified object. | Object

Protected Methods
Hide Inherited Protected Methods
Show Inherited Protected Methods

| Method | Defined By
--- | --- | ---
|  | eventHandler(event:Event):void Generic event handler. | AccImpl
|  | getName(childID:uint):String Returns the name of the accessible component. | AccImpl
|  | getState(childID:uint):uint Utility method to determine state of the accessible component. | AccImpl

Constructor Detail

### VideoPlayerAccImpl

()
Constructor

`public function VideoPlayerAccImpl(master:UIComponent)`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 2.0

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 2.0

Enables accessibility in the VideoPlayer class.

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

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00