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

Package | spark.accessibility
Class | public class CheckBoxAccImpl
Inheritance | CheckBoxAccImpl ButtonBaseAccImpl AccImpl flash.accessibility.AccessibilityImplementation
Subclasses | RadioButtonAccImpl

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

CheckBoxAccImpl is the accessibility implementation class for spark.components.CheckBox.

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

Children

A CheckBox has no MSAA children.

Role

The MSAA Role of a CheckBox is ROLE_SYSTEM_CHECKBOX.

Name

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

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

Description

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

State

The MSAA State of a CheckBox 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_CHECKED (when selected is true)

When the Name changes, a CheckBox dispatches the MSAA event EVENT_OBJECT_STATECHANGE.

Value

A CheckBox does not have an MSAA Value.

Location

The MSAA Location of a CheckBox is its bounding rectangle.

Default Action

The MSAA DefaultAction of a CheckBox is "Check" or "UnCheck", depending on whether it is currently checked or not.

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

Focus

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

Selection

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

CheckBoxAccImpl | () | Constructor

`public function CheckBoxAccImpl(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 CheckBox class.

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

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