Adobe® Flex® 4 Language Reference
Hide Packages and Classes List |  Packages  |  Classes  |  Index  |  Appendixes
spark.accessibility 
TabBarAccImpl 
Packagespark.accessibility
Classpublic class TabBarAccImpl
InheritanceTabBarAccImpl Inheritance ButtonBarBaseAccImpl Inheritance ListBaseAccImpl Inheritance AccImpl Inheritance AccessibilityImplementation Inheritance Object

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

TabBarAccImpl is the accessibility implementation class for spark.components.TabBar.

When a Spark TabBar 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 TabBar. 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 TabBar are its tabs. As described above, the accessibility of these tabs is managed by the TabBar; their own accessibilityImplementation and accessibilityProperties are ignored by the Flash Player.

Role

The MSAA Role of a TabBar is ROLE_SYSTEM_PAGETABLIST.

The Role of each tab is ROLE_SYSTEM_PAGETAB.

Name

The MSAA Name of a TabBar 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 TabBar's accessibilityName property.

The Name of each tab is determined by the TabBar's itemToLabel() method.

When the Name of the TabBar or one of its tabs changes, a TabBar dispatches the MSAA event EVENT_OBJECT_NAMECHANGE with the proper childID for the tab or 0 for itself.

Description

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

The Description of each tab is the empty string.

State

The MSAA State of a TabBar is a combination of:

  • STATE_SYSTEM_UNAVAILABLE (when enabled is false)
  • STATE_SYSTEM_FOCUSABLE (when enabled is true)
  • STATE_SYSTEM_FOCUSED (when enabled is true and the TabBar has focus)

The State of a tab in a TabBar is a combination of:

  • STATE_SYSTEM_FOCUSED
  • STATE_SYSTEM_PRESSED

When the State of the TabBar or one of its tabs changes, a TabBar dispatches the MSAA event EVENT_OBJECT_STATECHANGE with the proper childID for the tab or 0 for itself.

Value

A TabBar, or a tab in a TabBar, does not have an MSAA Value.

Location

The MSAA Location of a TabBar, or a tab in a TabBar, is its bounding rectangle.

Default Action

A TabBar does not have an MSAA DefaultAction.

The DefaultAction of a tab in a TabBar is "Switch". When it is performed, the given tab is pressed.

Focus

Both the TabBar and its individual tabs accept focus. When they do so it dispatches the MSAA event EVENT_OBJECT_FOCUS. A tab is not automatically pressed when focused through arrow key navigation. To press a focused tab, the user must press the spacebar.

Selection

MSAA Selection will press the tab corresponding to the specified childID. Only one tab can be pressed at a time.



Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 Inheritederrno : uint
Errors are indicated out-of-band, rather than in return values.
AccessibilityImplementation
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
 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
 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.
TabBarAccImpl
 Inherited
An IAccessible method that performs the default action associated with the component that this AccessibilityImplementation represents or of one of its child elements.
AccessibilityImplementation
 Inherited
accLocation(childID:uint):*
MSAA method for returning a DisplayObject or Rectangle specifying the bounding box of a child element in the AccessibilityImplementation.
AccessibilityImplementation
 Inherited
accSelect(selFlag:uint, childID:uint):void
IAccessible method for altering the selection in the component that this AccessibilityImplementation represents.
AccessibilityImplementation
  
[static] Enables accessibility in the TabBar class.
TabBarAccImpl
 Inherited
MSAA method for returning the default action of the component that this AccessibilityImplementation represents or of one of its child elements.
AccessibilityImplementation
 Inherited
MSAA method for returning the unsigned integer ID of the child element, if any, that has child focus within the component.
AccessibilityImplementation
 Inherited
MSAA method for returning the name for the component that this AccessibilityImplementation represents or for one of its child elements.
AccessibilityImplementation
 Inherited
MSAA method for returning the system role for the component that this AccessibilityImplementation represents or for one of its child elements.
AccessibilityImplementation
 Inherited
MSAA method for returning an array containing the IDs of all child elements that are selected.
AccessibilityImplementation
 Inherited
IAccessible method for returning the current runtime state of the component that this AccessibilityImplementation represents or of one of its child elements.
AccessibilityImplementation
 Inherited
MSAA method for returning the runtime value of the component that this AccessibilityImplementation represents or of one of its child elements.
AccessibilityImplementation
 Inherited
Returns an array containing the unsigned integer IDs of all child elements in the AccessibilityImplementation.
AccessibilityImplementation
 Inherited
[static] Method for supporting Form Accessibility.
AccImpl
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
[static] Method for supporting state Accessibility.
AccImpl
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Returns the primitive value of the specified object.
Object
Protected Methods
 MethodDefined By
 Inherited
Generic event handler.
AccImpl
 Inherited
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

TabBarAccImpl

()Constructor
public function TabBarAccImpl(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 TabBar class.

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