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

Package | spark.accessibility
Class | public class SpinnerAccImpl
Inheritance | SpinnerAccImpl AccImpl flash.accessibility.AccessibilityImplementation
Subclasses | NumericStepperAccImpl

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

SpinnerAccImpl is the accessibility implementation class for spark.components.Spinner.

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

Children

A Spinner has 2 MSAA children, which are its increment and decrement buttons.

Role

The MSAA Role of a Spinner is ROLE_SYSTEM_SPINBUTTON.

The Role of each child button is ROLE_SYSTEM_PUSHBUTTON.

Name

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

The Name of each child button comes from a locale-dependent resource. For the en_US locale, the names are "More" and "Less".

When the Name of the Spinner or one of its child button changes, a Spinner dispatches the MSAA event EVENT_OBJECT_NAMECHANGE with the proper childID for the button or 0 for itself.

Description

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

The Description of each child button is the empty string.

State

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

When the State of the Spinner or one of its child buttons changes, a Spinner dispatches the MSAA event EVENT_OBJECT_STATECHANGE with the proper childID for the button or 0 for itself.

Value

The MSAA Value of a Spinner is the value currently held by the Spinner.

The child buttons do not have MSAA values.

When the Value of the Spinner changes, a Spinner dispatches the MSAA event EVENT_OBJECT_VALUECHANGE.

Location

The MSAA Location of a Spinner, or one of its child buttons, is its bounding rectangle.

Default Action

A Spinner does not have an MSAA DefaultAction.

The DefaultAction of each child button is "Press".

Performing the default action of one of the child buttons will increment or decrement the value.

Focus

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

Selection

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

SpinnerAccImpl | () | Constructor

`public function SpinnerAccImpl(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 Spinner class.

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

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