Apache Flex 4.16.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
ButtonBarBaseAccImpl

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

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

ButtonBarBaseAccImpl is the accessibility implementation class for spark.components.supportClasses.ButtonBarBase.

Although TabBar has its own accessibility implementation subclass, ButtonBar simply uses the one for ButtonBarBase. Therefore, the rest of this description refers to the commonly-used ButtonBar component rather than the ButtonBarBase base class.

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

Role

The MSAA Role of a ButtonBar is ROLE_SYSTEM_TOOLBAR.

The Role of each Button in the ButtonBar is ROLE_SYSTEM_PUSHBUTTON.

Name

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

The Name of each Button is determined by the ButtonBar's `itemToLabel()` method.

When the Name of the ButtonBar or one of its Buttons changes, a ButtonBar dispatches the MSAA event EVENT_OBJECT_NAMECHANGE with the proper childID for the Button or 0 for itself.

Description

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

The Description of each Button is the empty string.

State

The MSAA State of a ButtonBar 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 ButtonBar has focus)

The State of a Button in a ButtonBar is a combination of:

- STATE_SYSTEM_FOCUSED (when it has focus)
- STATE_SYSTEM_PRESSED (when it is selected)

When the State of the ButtonBar or one of its Buttons changes, a ButtonBar dispatches the MSAA event EVENT_OBJECT_STATECHANGE with the proper childID for the Button or 0 for itself.

Value

A ButtonBar, or a Button in a ButtonBar, does not have an MSAA Value.

Location

The MSAA Location of a ButtonBar, or a Button in a ButtonBar, is its bounding rectangle.

Default Action

A ButtonBar does not have an MSAA DefaultAction.

The DefaultAction for a Button in a ButtonBar is "Press".

Focus

Both the ButtonBar and its individual buttons accept focus. When they do so it dispatches the MSAA event EVENT_OBJECT_FOCUS. A button is not automatically selected when focused through arrow key navigation. To select a focused button, the user must press the spacebar.

Selection

MSAA Selection will press the button corresponding to the specified childID. Only one button 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
--- | --- | ---
|  | ButtonBarBaseAccImpl(master:UIComponent) Constructor. | ButtonBarBaseAccImpl
|  | enableAccessibility():void [static] Enables accessibility in the ButtonBarBase class. | ButtonBarBaseAccImpl
|  | 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

ButtonBarBaseAccImpl | () | Constructor

`public function ButtonBarBaseAccImpl(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 ButtonBarBase class.

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

Sun Mar 5 2017, 03:42 PM +11:00