Packagespark.accessibility
Classpublic class PanelAccImpl
InheritancePanelAccImpl Inheritance AccImpl Inheritance flash.accessibility.AccessibilityImplementation
Subclasses TitleWindowAccImpl

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

PanelAccImpl is the accessibility implementation class for spark.components.Panel.

When a Spark Panel is created, the accessibilityImplementation property of a special child Sprite 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 Panel. See the mx.accessibility.AccImpl and flash.accessibility.AccessibilityImplementation classes for background information about accessibility implementation classes and MSAA.

Children

A Panel has no MSAA children. All children of the actual Panel are siblings of the Panel in the FlashPlayer's MSAA tree, because Flash Player does not support objects with accessibility implementations having children with their own accessibility implementations.

The PanelAccImpl is set as the accessibilityImplementation of the titleDisplay object because setting it on the Panel itself would not allow the Panel's children to be exposed in MSAA. Because of this an invisible rectangle is drawn in the titleDisplay making it the same size as the Panel as a whole so that the MSAA Location is the bounding rectangle of the entire Panel. Screen readers like JAWS rely on the MSAA Location to announce whether some component is in the grouping since the MSAA structure is flat.

Role

The MSAA Role of a Panel is ROLE_SYSTEM_GROUPING.

Name

The MSAA Name of a Panel is, by default, the title that it displays. To override this behavior, set the Panel's accessibilityName property.

When the Name changes, a Panel dispatches the MSAA event EVENT_OBJECT_NAMECHANGE.

Description

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

State

The MSAA State of a Panel is always STATE_SYSTEM_NORMAL, indicating that no state flags are set.

Since the state does not change, a Panel does not dispatch the MSAA event EVENT_OBJECT_STATECHANGE.

Value

The MSAA Value of a Panel is always the empty string.

Location

The MSAA Location of a Panel is its bounding rectangle.

Default Action

A Panel does not have an MSAA DefaultAction .

Focus

A Panel does not accept focus.

Selection

A Panel does not support selection in the MSAA sense.



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.
PanelAccImpl
  
[static] Enables accessibility in the Panel class.
PanelAccImpl
 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
PanelAccImpl()Constructor
public function PanelAccImpl(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 Panel class.

This method is called by application startup code that is autogenerated by the MXML compiler. Afterwards, when instances of Panel are initialized, the accessibilityImplementation property of a special first child Sprite will be set to an instance of this class. If the PanelAccImpl were attached to the Panel itself the accessibility implementations of the Panel's children would be ignored.