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

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

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

SliderBaseAccImpl is the accessibility implementation class for spark.components.supportClasses.SliderBase.

The Spark HSlider and VSlider components extend SliderBase and use SlideBaseAccImpl as their accessibility implementation class. For convenience, the rest of this description uses the word Slider to mean either HSlider or VSlider, even though there is no Spark class named Slider.

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

Children

A Slider has 3 MSAA children:

1. Clickable area to the left (or bottom) of thumb
2. Thumb
3. Clickable area to the right (or top) of thumb

Role

The MSAA Role of a Slider is ROLE_SYSTEM_SLIDER.

The Role of each child is:

1. ROLE_SYSTEM_PUSHBUTTON
2. ROLE_SYSTEM_INDICATOR
3. ROLE_SYSTEM_PUSHBUTTON

Name

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

The Name of each child comes from a locale-dependent resource. In the en_US locale, the names are:

1. "Page left" for HSlider; "Page up" for VSlider
2. "Position"
3. "Page right" for HSlider; "Page down" for VSlider

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

Description

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

The Description of each child part is the empty string.

State

The MSAA state of a Slider 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 Slider has focus)

The State of each child part is:

- STATE_SYSTEM_UNAVAILABLE (when enabled is false)

When the State of the Slider or one of its child parts changes, a Slider dispatches the MSAA event EVENT_OBJECT_STATECHANGE with the proper childID for the part or 0 for itself.

Value

The MSAA Value of a Slider is a number between 0 and 100.

The child parts do not have MSAA values.

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

Location

The MSAA Location of a Slider or its thumb is its bounding rectangle. For the two children representing the trackbar regions adjacent to the thumb, the slider's bounding rectangle is returned.

Default Action

A Slider and its child parts have no default action.

Focus

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

Selection

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

SliderBaseAccImpl | () | Constructor

`public function SliderBaseAccImpl(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 SliderBase class.

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

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