| Package | spark.accessibility |
| Class | public class TextBaseAccImpl |
| Inheritance | TextBaseAccImpl  AccImpl AccessibilityImplementation Object |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
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.
Hide Inherited Public Properties
Show Inherited Public Properties| Method | Defined By | ||
|---|---|---|---|
TextBaseAccImpl(master:UIComponent)
Constructor. | TextBaseAccImpl | ||
 |
An IAccessible method that performs the default action associated with the component
that this AccessibilityImplementation represents or of one of its child elements. | AccessibilityImplementation | |
|
MSAA method for returning a DisplayObject or Rectangle
specifying the bounding box of a child element in the AccessibilityImplementation. | AccessibilityImplementation | |
|
IAccessible method for altering the selection in the component
that this AccessibilityImplementation represents. | AccessibilityImplementation | |
[static]
Enables accessibility in the TextBase class. | TextBaseAccImpl | ||
|
MSAA method for returning the default action of the component
that this AccessibilityImplementation represents or of one of its child elements. | AccessibilityImplementation | |
|
MSAA method for returning the unsigned integer ID of the child element, if any,
that has child focus within the component. | AccessibilityImplementation | |
|
MSAA method for returning the name for the component
that this AccessibilityImplementation represents or for one of its child elements. | AccessibilityImplementation | |
|
MSAA method for returning the system role for the component
that this AccessibilityImplementation represents or for one of its child elements. | AccessibilityImplementation | |
|
MSAA method for returning an array containing the IDs of all child elements that are selected. | AccessibilityImplementation | |
|
IAccessible method for returning the current runtime state of the component that this
AccessibilityImplementation represents or of one of its child elements. | AccessibilityImplementation | |
|
MSAA method for returning the runtime value of the component that this
AccessibilityImplementation represents or of one of its child elements. | AccessibilityImplementation | |
| AccessibilityImplementation | ||
| AccessibilityImplementation | ||
|
Returns an array containing the unsigned integer IDs of all child elements
in the AccessibilityImplementation. | AccessibilityImplementation | |
| [static]
Method for supporting Form Accessibility. | AccImpl | |
|
Indicates whether an object has a specified property defined. | Object | |
| [static]
Returns true if an ancestor of the component has enabled set to false. | AccImpl | |
|
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 | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns the string representation of the specified object. | Object | |
|
Returns the primitive value of the specified object. | Object | |
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.
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 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.
Mon Apr 10 2017, 12:28 PM -07:00