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

Package | spark.accessibility
Class | public class ToggleButtonAccImpl
Inheritance | ToggleButtonAccImpl ButtonBaseAccImpl AccImpl flash.accessibility.AccessibilityImplementation

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

ToggleButtonAccImpl is the accessibility implementation class for spark.components.ToggleButton.

When a Spark ToggleButton 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 ToggleButton. See the mx.accessibility.AccImpl and flash.accessibility.AccessibilityImplementation classes for background information about accessibility implementation classes and MSAA.

Children

A ToggleButton has no MSAA children.

Role

The MSAA Role of a ToggleButton is ROLE_SYSTEM_PUSHBUTTON.

Name

The MSAA Name of a ToggleButton is, by default, the label that it displays. When wrapped in a FormItem element, this label will be combined with the FormItem's label. To override this behavior, set the ToggleButton's `accessibilityName` property.

To provide two separate names for the different states of an icon-based ToggleButton (such as "Mute" and "Unmute", or "Play" and "Pause"), both names can be separated by a comma in the `accessibilityName` property, as in `accessibilityProperty="Mute,Unmute"`. When using state specific names like this the button will not exposed the "pressed" state when pressed.

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

Description

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

State

The MSAA State of a ToggleButton 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 CheckBox has focus)
- STATE_SYSTEM_PRESSED (when selected is true; not used when state specific names are provided)

When the State changes, a ToggleButton dispatches the MSAA event EVENT_OBJECT_STATECHANGE.

Value

A ToggleButton does not have an MSAA Value.

Location

The MSAA Location of a ToggleButton is its bounding rectangle.

Default Action

The MSAA DefaultAction of a ToggleButton is "Toggle".

When an MSAA client tells the Button to perform this action, KEY_DOWN and KEY_UP MouseEvents for the SPACE key are generated, to simulate pressing the ToggleButton via the keyboard, if the ToggleButton is enabled.

Focus

A ToggleButton accepts focus. When it does so, it dispatches the MSAA event EVENT_OBJECT_FOCUS.

Selection

A ToggleButton does not support selection in the MSAA sense.

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
--- | --- | ---
|  | ToggleButtonAccImpl(master:UIComponent) Constructor. | ToggleButtonAccImpl
|  | enableAccessibility():void [static] Enables accessibility in the ToggleButton class. | ToggleButtonAccImpl
|  | 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

ToggleButtonAccImpl | () | Constructor

`public function ToggleButtonAccImpl(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 ToggleButton class.

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

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