Apache Flex 4.16.1 API Reference | All Packages | All Classes | Index | Frames No Frames |
TabBarAccImpl

Package | spark.accessibility
Class | public class TabBarAccImpl
Inheritance | TabBarAccImpl ButtonBarBaseAccImpl ListBaseAccImpl AccImpl flash.accessibility.AccessibilityImplementation

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.

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
--- | --- | ---
|  | TabBarAccImpl(master:UIComponent) Constructor. | TabBarAccImpl
|  | enableAccessibility():void [static] Enables accessibility in the TabBar class. | TabBarAccImpl
|  | getFormName(component:UIComponent):String [static] Method for supporting Form Accessibility. | AccImpl
|  | isAncestorDisabled(component:UIComponent):Boolean [static] Returns true if an ancestor of the component has enabled set to false. | AccImpl

Protected Methods
Show 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

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.

Wed Nov 15 2017, 09:50 AM +01:00