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

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:

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.


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
  
TextBaseAccImpl(master:UIComponent)
Constructor.
TextBaseAccImpl
  
enableAccessibility():void
[static] Enables accessibility in the TextBase class.
TextBaseAccImpl
 Inherited
getFormName(component:UIComponent):String
[static] Method for supporting Form Accessibility.
AccImpl
 Inherited
isAncestorDisabled(component:UIComponent):Boolean
[static] Returns true if an ancestor of the component has enabled set to false.
AccImpl
Protected Methods
 MethodDefined By
 Inherited
eventHandler(event:Event):void
Generic event handler.
AccImpl
 Inherited
getName(childID:uint):String
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.




The Apache Software Foundation

Wed Nov 15 2017, 09:50 AM +01:00