SliderBaseAccImpl

Package	spark.accessibility
Class	public class SliderBaseAccImpl
Inheritance	SliderBaseAccImpl AccImpl AccessibilityImplementation Object

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:

Clickable area to the left (or bottom) of thumb
Thumb
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:

ROLE_SYSTEM_PUSHBUTTON
ROLE_SYSTEM_INDICATOR
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:

"Page left" for HSlider; "Page up" for VSlider
"Position"
"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.

Public Properties

	Property		Defined By
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		errno : uint Indicates an error code.	AccessibilityImplementation
		stub : Boolean Used to create a component accessibility stub.	AccessibilityImplementation

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

	Method		Defined By
		SliderBaseAccImpl(master:UIComponent) Constructor.	SliderBaseAccImpl
		accDoDefaultAction(childID:uint):void An IAccessible method that performs the default action associated with the component that this AccessibilityImplementation represents or of one of its child elements.	AccessibilityImplementation
		accLocation(childID:uint):* MSAA method for returning a DisplayObject or Rectangle specifying the bounding box of a child element in the AccessibilityImplementation.	AccessibilityImplementation
		accSelect(operation:uint, childID:uint):void IAccessible method for altering the selection in the component that this AccessibilityImplementation represents.	AccessibilityImplementation
		enableAccessibility():void [static] Enables accessibility in the SliderBase class.	SliderBaseAccImpl
		get_accDefaultAction(childID:uint):String MSAA method for returning the default action of the component that this AccessibilityImplementation represents or of one of its child elements.	AccessibilityImplementation
		get_accFocus():uint MSAA method for returning the unsigned integer ID of the child element, if any, that has child focus within the component.	AccessibilityImplementation
		get_accName(childID:uint):String MSAA method for returning the name for the component that this AccessibilityImplementation represents or for one of its child elements.	AccessibilityImplementation
		get_accRole(childID:uint):uint MSAA method for returning the system role for the component that this AccessibilityImplementation represents or for one of its child elements.	AccessibilityImplementation
		get_accSelection():Array MSAA method for returning an array containing the IDs of all child elements that are selected.	AccessibilityImplementation
		get_accState(childID:uint):uint IAccessible method for returning the current runtime state of the component that this AccessibilityImplementation represents or of one of its child elements.	AccessibilityImplementation
		get_accValue(childID:uint):String MSAA method for returning the runtime value of the component that this AccessibilityImplementation represents or of one of its child elements.	AccessibilityImplementation
		get_selectionActiveIndex():*	AccessibilityImplementation
		get_selectionAnchorIndex():*	AccessibilityImplementation
		getChildIDArray():Array Returns an array containing the unsigned integer IDs of all child elements in the AccessibilityImplementation.	AccessibilityImplementation
		getFormName(component:UIComponent):String [static] Method for supporting Form Accessibility.	AccImpl
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isAncestorDisabled(component:UIComponent):Boolean [static] Returns true if an ancestor of the component has enabled set to false.	AccImpl
		isLabeledBy(labelBounds:Rectangle):Boolean Returns true or false to indicate whether a text object having a bounding box specified by a x, y, width, and height should be considered a label for the component that this AccessibilityImplementation represents.	AccessibilityImplementation
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		valueOf():Object Returns the primitive value of the specified object.	Object

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