ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
spark.accessibility 

TextBaseAccImpl  - AS3 Flex

Packagespark.accessibility
Classpublic class TextBaseAccImpl
InheritanceTextBaseAccImpl Inheritance AccImpl Inheritance AccessibilityImplementation Inheritance Object

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

TextBaseAccImpl is the accessibility implementation class for spark.components.TextBase.

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

Children

A TextBase has no MSAA children.

Role

The MSAA Role of a TextBase is ROLE_SYSTEM_STATICTEXT.

Name

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

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

Description

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

State

The MSAA State of a TextBase is a combination of:

  • STATE_SYSTEM_UNAVAILABLE (when enabled is false)
  • STATE_SYSTEM_READONLY

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

Value

A TextBase does not have an MSAA Value.

Location

The MSAA Location of a TextBase is its bounding rectangle.

Default Action

A TextBase does not have an MSAA DefaultAction.

Focus

A TextBase does not accept focus.

Selection

A TextBase does not support selection in the MSAA sense.

Other

MSAA documentation suggests that the accessibilityShortcut should be set to the shortcut keystroke for any associated input component. Since the shortcut is an accessibility property and not implementable by an AccessibilityImplementation it is not addressed in TextBaseAccImpl.



Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 Inheritederrno : uint
Indicates an error code.
AccessibilityImplementation
 Inheritedstub : Boolean
Used to create a component accessibility stub.
AccessibilityImplementation
Protected Properties
 PropertyDefined By
 InheritedeventsToHandle : Array
[read-only] All subclasses must override this function by returning an array of strings of the events to listen for.
AccImpl
 Inheritedmaster : UIComponent
A reference to the UIComponent instance that this AccImpl instance is making accessible.
AccImpl
 Inheritedrole : uint
Accessibility role of the component being made accessible.
AccImpl
Public Methods
 MethodDefined By
  
Constructor.
TextBaseAccImpl
 Inherited
An IAccessible method that performs the default action associated with the component that this AccessibilityImplementation represents or of one of its child elements.
AccessibilityImplementation
 Inherited
accLocation(childID:uint):*
MSAA method for returning a DisplayObject or Rectangle specifying the bounding box of a child element in the AccessibilityImplementation.
AccessibilityImplementation
 Inherited
accSelect(operation:uint, childID:uint):void
IAccessible method for altering the selection in the component that this AccessibilityImplementation represents.
AccessibilityImplementation
  
[static] Enables accessibility in the TextBase class.
TextBaseAccImpl
 Inherited
MSAA method for returning the default action of the component that this AccessibilityImplementation represents or of one of its child elements.
AccessibilityImplementation
 Inherited
MSAA method for returning the unsigned integer ID of the child element, if any, that has child focus within the component.
AccessibilityImplementation
 Inherited
MSAA method for returning the name for the component that this AccessibilityImplementation represents or for one of its child elements.
AccessibilityImplementation
 Inherited
MSAA method for returning the system role for the component that this AccessibilityImplementation represents or for one of its child elements.
AccessibilityImplementation
 Inherited
MSAA method for returning an array containing the IDs of all child elements that are selected.
AccessibilityImplementation
 Inherited
IAccessible method for returning the current runtime state of the component that this AccessibilityImplementation represents or of one of its child elements.
AccessibilityImplementation
 Inherited
MSAA method for returning the runtime value of the component that this AccessibilityImplementation represents or of one of its child elements.
AccessibilityImplementation
 Inherited
AccessibilityImplementation
 Inherited
AccessibilityImplementation
 Inherited
Returns an array containing the unsigned integer IDs of all child elements in the AccessibilityImplementation.
AccessibilityImplementation
 Inherited
[static] Method for supporting Form Accessibility.
AccImpl
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
[static] Returns true if an ancestor of the component has enabled set to false.
AccImpl
 Inherited
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
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Returns the primitive value of the specified object.
Object
Protected Methods
 MethodDefined By
 Inherited
Generic event handler.
AccImpl
 Inherited
Returns the name of the accessible component.
AccImpl
 Inherited
getState(childID:uint):uint
Utility method to determine state of the accessible component.
AccImpl
Constructor Detail

TextBaseAccImpl

()Constructor
public function TextBaseAccImpl(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 TextBase class.

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