| Package | spark.accessibility |
| Class | public class RichEditableTextAccImpl |
| Inheritance | RichEditableTextAccImpl  AccImpl flash.accessibility.AccessibilityImplementation |
| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
When a Spark RichEditableText 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 RichEditableText.
See the mx.accessibility.AccImpl and
flash.accessibility.AccessibilityImplementation classes
for background information about accessibility implementation
classes and MSAA.
Children
A RichEditableText has no MSAA children.
Role
The MSAA Role of a RichEditableText is ROLE_SYSTEM_TEXT.
Name
The MSAA Name of a RichEditableText is, by default, the empty string.
When wrapped in a FormItem element, the Name is the FormItem's label.
To override this behavior,
set the RichEditableText's accessibilityName property.
When the Name changes, a RichEditableText dispatches the MSAA event EVENT_OBJECT_NAMECHANGE.
Description
The MSAA Description of a RichEditableText is, by default,
the empty string, but you can set the RichEditableText's
accessibilityDescription property.
State
The MSAA State of a RichEditableText is a combination of:
When the State changes, a RichEditableText dispatches the MSAA event EVENT_OBJECT_STATECHANGE.
Value
The MSAA Value of a RichEditableText is equal to
its text property.
When the Value changes, a RichEditableText dispatches the MSAA event EVENT_OBJECT_VALUECHANGE.
Location
The MSAA Location of a RichEditableText is its bounding rectangle.
Default Action
A RichEditableText does not have an MSAA DefaultAction.
Focus
A RichEditableText accepts focus. When it does so it dispatches the MSAA event EVENT_OBJECT_FOCUS.
Selection
A RichEditableText does not support selection in the MSAA sense,
and text selection is not part of Microsoft's IAccessibility COM interface.
But, in Player 10.1 and later, screen readers can determine
the currently selected text range via the GetSelection() method
in Adobe's ISimpleTextSelection COM interface, which calls the
selectionAnchorIndex and selectionActiveIndex
getters in this class.
| Property | Defined By | ||
|---|---|---|---|
| selectionActiveIndex : int [read-only]
A character position, relative to the beginning of the
text String of the RichEditableText,
specifying the end of the selection
that moves when the selection is extended with the arrow keys. | RichEditableTextAccImpl | ||
| selectionAnchorIndex : int [read-only]
A character position, relative to the beginning of the
text String of the RichEditableText,
specifying the end of the selection
that stays fixed when the selection is extended with the arrow keys. | RichEditableTextAccImpl | ||
| Method | Defined By | ||
|---|---|---|---|
RichEditableTextAccImpl(master:UIComponent)
Constructor. | RichEditableTextAccImpl | ||
enableAccessibility():void [static]
Enables accessibility in the RichEditableText class. | RichEditableTextAccImpl | ||
 | 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 | |
| selectionActiveIndex | property |
Hide Inherited Protected Properties
Show Inherited Protected PropertiesselectionActiveIndex:int [read-only] | Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | Flash Player 10.1, AIR 2.0 |
A character position, relative to the beginning of the
text String of the RichEditableText,
specifying the end of the selection
that moves when the selection is extended with the arrow keys.
The active position may be either the start or the end of the selection.
For example, if you drag-select from position 12 to position 8,
then selectionAnchorPosition will be 12
and selectionActivePosition will be 8,
and when you press Left-Arrow selectionActivePosition
will become 7.
A value of -1 indicates "not set".
In Player 10.1 and later, and AIR 2.0 and later,
an AccessibilityImplementation can implement
selectionAnchorIndex and selectionAnchorIndex
in order to make an accessibility client aware of the text selection
in TLF text via Adobe's ISimpleTextSelection COM interface.
The default value is -1.
public function get selectionActiveIndex():intSee also
| selectionAnchorIndex | property |
selectionAnchorIndex:int [read-only] | Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | Flash Player 10.1, AIR 2.0 |
A character position, relative to the beginning of the
text String of the RichEditableText,
specifying the end of the selection
that stays fixed when the selection is extended with the arrow keys.
The anchor position may be either the start or the end of the selection.
For example, if you drag-select from position 12 to position 8,
then selectionAnchorPosition will be 12
and selectionActivePosition will be 8,
and when you press Left-Arrow selectionActivePosition
will become 7.
A value of -1 indicates "not set".
In Player 10.1 and later, and AIR 2.0 and later,
an AccessibilityImplementation can implement
selectionAnchorIndex and selectionAnchorIndex
in order to make an accessibility client aware of the text selection
in TLF text via Adobe's ISimpleTextSelection COM interface.
The default value is -1.
public function get selectionAnchorIndex():intSee also
| RichEditableTextAccImpl | () | Constructor |
public function RichEditableTextAccImpl(master:UIComponent)| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
Constructor.
Parametersmaster:UIComponent — The UIComponent instance that this AccImpl instance
is making accessible.
|
| 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 RichEditableText class.
This method is called by application startup code
that is autogenerated by the MXML compiler.
Afterwards, when instances of RichEditableText are initialized,
their accessibilityImplementation property
will be set to an instance of this class.