mx.accessibility.PanelAccImpl

Package	mx.accessibility
Class	public class PanelAccImpl
Inheritance	PanelAccImpl AccImpl AccessibilityImplementation
Subclasses	TitleWindowAccImpl

Review Needed

The PanelAccImpl class, also called the Panel Accessibility Implementation class, enables communication between a Panel component and a screen reader. Screen readers are used to translate screen content into synthesized speech or braille for visually impaired users.

The PanelAccImpl class supports system roles, object-based events, and states.

A Panel reports the role ROLE_SYSTEM_WINDOW (0x09) to a screen reader. A Panel's titleBar returns the role ROLE_SYSTEM_TITLEBAR (0x01), and a Panel's contentPane returns the role ROLE_SYSTEM_DIALOG (0x12).

A Panel reports the following states to a screen reader:

STATE_SYSTEM_NORMAL (0x00000000)
STATE_SYSTEM_UNAVAILABLE (0x00000001)
STATE_SYSTEM_FOCUSED (0x00000004)
STATE_SYSTEM_FOCUSABLE (0x00100000)

A Panel dispatches the following event to a screen reader:

EVENT_OBJECT_NAMECHANGE (0x800C)

	Property	Defined by
		errno : uint Errors are indicated out-of-band, rather than in return values.	AccessibilityImplementation
		stub : Boolean If a component is released without an ActionScript accessibility implementation, it is strongly suggested that a component accessibility stub be included.	AccessibilityImplementation

	Property	Defined by
		eventsToHandle : Array All AccImpl subclasses must override this function by returning an array of strings of the events for which the class should listen from its master component.	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
		PanelAccImpl(master:UIComponent) Creates a new PanelAccImpl instance for the specified Panel component.	PanelAccImpl
		accDoDefaultAction(childID:uint):void 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):* IAccessible method for returning the bounding box of the Panel or of one of its child elements.	PanelAccImpl
		accSelect(selFlag:uint, childID:uint):void IAccessible method for altering the selection in the component that this AccessibilityImplementation represents.	AccessibilityImplementation
		enableAccessibility():void [static] Method call for enabling accessibility for a component.	PanelAccImpl
		get_accDefaultAction(childID:uint):String IAccessible method for returning the default action of the component that this AccessibilityImplementation represents or of one of its child elements.	AccessibilityImplementation
		get_accFocus():uint IAccessible 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 IAccessible method for returning the name for the component that this AccessibilityImplementation represents or for one of its child elements.	AccImpl
		get_accRole(childID:uint):uint IAccessible method for returning system role for the component.	PanelAccImpl
		get_accSelection():Array IAccessible 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 state of the Panel.	PanelAccImpl
		get_accValue(childID:uint):String IAccessible method for returning the runtime value of the component that this AccessibilityImplementation represents or of one of its child elements.	AccessibilityImplementation
		getChildIDArray():Array Method to return an array of childIDs.	PanelAccImpl

	Method	Defined by
		eventHandler(event:Event):void Handles events from the master component.	AccImpl
		getName(childID:uint):String Method for returning the name of the Panel which is spoken out by the screen reader.	PanelAccImpl
		getState(childID:uint):uint Returns the state of the accessible component.	AccImpl

Constructor detail

PanelAccImpl

()

constructor

public function PanelAccImpl(master:UIComponent)

Creates a new PanelAccImpl instance for the specified Panel component.

Direct calls to the AccImpl subclass constructors are unneccessary. When a Flex project is compiled with Generate accessible SWF file set to true, the compiler instantiates the accessibility implementations for the components used in the project that have them by calling the the static enableAccessibility() method.

Parameters

master:UIComponent — The UIComponent instance that this PanelAccImpl instance is making accessible.

Method detail

accLocation

()

method

public override function accLocation(childID:uint):*

IAccessible method for returning the bounding box of the Panel or of one of its child elements.

Returns the Panel instance or the child element which correspond to the childID that was passed.

Parameters

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

Returns

* — The Panel component, the Panel's titleBar or the Panel's contentPane.

enableAccessibility

()

method

public static function enableAccessibility():void

Method call for enabling accessibility for a component. This method is required for the compiler to activate the accessibility classes for a component.

When a Flex project is compiled with the Generate accessible SWF file set to true, the Flex compiler automatically enables accessibility implementations for the components used in the project that have them.

Accessible component classes should include the [AccessibilityClass] meta tag to specify the appropriate AccImpl subclass or accessibility implementation and let the compiler know to call enableAccessibility().

Example
Following is an example showing how the [AccessibilityClass] meta tag specifies the appropriate AccImpl subclass or accessibility implementation for the mx.containers.Panel component.

[AccessibilityClass(implementation="mx.accessibility.PanelAccImpl")]

get_accRole

()

method

public override function get_accRole(childID:uint):uint

IAccessible method for returning system role for the component. System roles are predefined for all the components in MSAA.

A Panel component, ( childID == 0 ), reports the role ROLE_SYSTEM_WINDOW/code> (0x09). the Panel's titleBar ( childID == 1 ) reports the role ROLE_SYSTEM_TITLEBAR (0x01), the Panel's contentPane ( childID == 2 ) reports the role ROLE_SYSTEM_DIALOG (0x12).


    Parameters


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



Returns


uint — Role associated with the component or one of its child elements. 
   
  



See also


AccessibilityImplementation Constants: Object Roles


Microsoft Accessibility Developer Center: IAccessible::get_accRole


Microsoft Accessibility Developer Center User Interface Element Reference: Window





get_accState () method  



public override function get_accState(childID:uint):uint
   IAccessible method for returning the state of the Panel.
   States are predefined for all the components in MSAA.
   Values are assigned to each state.
   Depending upon the Panel being Focusable, Focused and Moveable, a value is returned.
     
Parameters


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



Returns


uint — State depending upon the Panel being Focusable, Focused and Moveable
  
   



See also


getChildIDArray()


flash.accessibility.AccessibilityImplementation.get_accState()


AccessibilityImplementation Constants: Object State Constants


Microsoft Accessibility Developer Center: IAccessible::get_accState





getChildIDArray () method  



public override function getChildIDArray():Array
   Method to return an array of childIDs.
     

Returns


Array — An array of unsigned integer IDs, one for each the Panel's titleBar, and the Panel's contentPane. 
  






getName () method  



protected override function getName(childID:uint):String
   Method for returning the name of the Panel which is spoken out by the screen reader.
   The Panel should return its Title as the name.
     
Parameters


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



Returns


String — Name string corresponding to the Panel control.

Adobe® Flex™ 3 Language Reference	All Packages \| All Classes \| Index \| Frames No Frames
Class PanelAccImpl	Properties \| Methods