Packagemx.accessibility
Classpublic class MenuBarAccImpl
InheritanceMenuBarAccImpl Inheritance AccImpl Inheritance AccessibilityImplementation

Review Needed

The MenuBarAccImpl class, also called the MenuBar Accessiblity Implementation class, is used to make a MenuBar component accessible.

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

A MenuBar reports the role ROLE_SYSTEM_MENUBAR (0x02) to a screen reader. Items of a MenuBar report the role ROLE_SYSTEM_MENUITEM (0x0c).

A MenuBar reports the following states to a screen reader:

Additionally, items of a MenuBar report the following states:

A MenuBar dispatches the following events to a screen reader:

See also

MenuBar
Microsoft Accessibility Developer Center User Interface Element Reference: Menu Bar

Public Properties
 PropertyDefined by
 Inheritederrno : uint
Errors are indicated out-of-band, rather than in return values.
AccessibilityImplementation
 Inheritedstub : Boolean
If a component is released without an ActionScript accessibility implementation, it is strongly suggested that a component accessibility stub be included.
AccessibilityImplementation
Protected Properties
 PropertyDefined by
  eventsToHandle : Array
[read-only] 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.
MenuBarAccImpl
 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
  
MenuBarAccImpl(master:UIComponent)
Creates a new MenuBarAccImpl instance for the specified MenuBar component.
MenuBarAccImpl
  
accDoDefaultAction(childID:uint):void
IAccessible method for performing the default action associated with a MenuItem.
MenuBarAccImpl
  
accLocation(childID:uint):*
IAccessible method for returning the bounding box of a MenuItem.
MenuBarAccImpl
 Inherited
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.
MenuBarAccImpl
  
get_accDefaultAction(childID:uint):String
IAccessible method for returning the default action.
MenuBarAccImpl
  
get_accFocus():uint
IAccessible method for returning the childFocus of the List.
MenuBarAccImpl
 Inherited
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.
MenuBarAccImpl
 Inherited
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 MenuItem.
MenuBarAccImpl
 Inherited
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.
MenuBarAccImpl
Protected Methods
 MethodDefined by
  
eventHandler(event:Event):void
Override the generic event handler.
MenuBarAccImpl
 Inherited
getName(childID:uint):String
Returns the name of the accessible component or the name of one of its child elements.
AccImpl
 Inherited
getState(childID:uint):uint
Returns the state of the accessible component.
AccImpl
Property detail
eventsToHandleproperty
eventsToHandle:Array  [read-only]

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.

Implementation
    protected function get eventsToHandle():Array
Constructor detail
MenuBarAccImpl()constructor
public function MenuBarAccImpl(master:UIComponent)

Creates a new MenuBarAccImpl instance for the specified MenuBar 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 MenuBarAccImpl instance is making accessible.

See also

Configuring Flex applications for accessibility
Method detail
accDoDefaultAction()method
public override function accDoDefaultAction(childID:uint):void

IAccessible method for performing the default action associated with a MenuItem.

The MenuBar component in Flex performs the default action by responding to keyboard and mouse events.

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

See also

Microsoft Accessibility Developer Center: IAccessible::accDoDefaultAction
accLocation()method 
public override function accLocation(childID:uint):*

IAccessible method for returning the bounding box of a MenuItem.

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

Returns
* — A MenuItem.

See also

Microsoft Accessibility Developer Center: IAccessible::accLocation
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().

See also

Configuring Flex applications for accessibility

Example
Following is an example showing how the [AccessibilityClass] meta tag specifies the appropriate AccImpl subclass or accessibility implementation for the mx.controls.MenuBar component. 
[AccessibilityClass(implementation="mx.accessibility.MenuBarAccImpl")]

eventHandler()method 
protected override function eventHandler(event:Event):void

Override the generic event handler. Each AccImpl subclass must implement this method to listen for events from its master component.

Parameters
event:Event — The event object.
get_accDefaultAction()method 
public override function get_accDefaultAction(childID:uint):String

IAccessible method for returning the default action. For child menuItems, the default action is either Open or Close depending on whether or not the menuItem is the selected, but for the Menu component itself, null is returned.

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

Returns
String — DefaultAction String

See also

Microsoft Accessibility Developer Center: IAccessible::get_accDefaultAction
Microsoft Accessibility Developer Center User Interface Element Reference: Menu Bar
get_accFocus()method 
public override function get_accFocus():uint

IAccessible method for returning the childFocus of the List.

Returns
uint — The childID of the selected menuItem.
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 MenuBar component, ( childID == 0 ), reports the role ROLE_SYSTEM_MENU (0x02). Items of a Menu component ( childID >= 1 ) report the role ROLE_SYSTEM_MENUITEM (0x0C).

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.

See also

AccessibilityImplementation Constants: Object Roles
Microsoft Accessibility Developer Center: IAccessible::get_accRole
Microsoft Accessibility Developer Center User Interface Element Reference: Menu Bar
get_accState()method 
public override function get_accState(childID:uint):uint

IAccessible method for returning the state of the MenuItem. States are predefined for all the components in MSAA. Values are assigned to each state. Depending upon the menuItem being Selected, Selectable, Invisible, Offscreen, 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 menuItem being Selected, Selectable, Invisible, Offscreen

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 listItem defined in the MenuBar component's menuBarItems array.