Apache Flex 4.16.1 API Reference | All Packages | All Classes | Index | Frames No Frames |
TitleWindowAccImpl

Package | spark.accessibility
Class | public class TitleWindowAccImpl
Inheritance | TitleWindowAccImpl PanelAccImpl AccImpl flash.accessibility.AccessibilityImplementation

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

TitleWindowAccImpl is the accessibility implementation class for spark.components.TitleWindow.

When a Spark TitleWindow is created, the `accessibilityImplementation` property of a special child Sprite 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 this component. See the mx.accessibility.AccImpl and flash.accessibility.AccessibilityImplementation classes for background information about accessibility implementation classes and MSAA.

Children

A TitleWindow has no MSAA children. All children of the actual TitleWindow are siblings of the TitleWindow in the FlashPlayer's MSAA tree, because Flash Player does not support objects with accessibility implementations having children with their own accessibility implementations.

The TitleWindowAcImpl is set as the `accessibilityImplementation` of the `titleDisplay` because setting it on the TitleWindow itself would not allow the TitleWindows's children to be exposed in MSAA. Because of this an invisible rectangle is drawn in the `titleDisplay` making it the same size as the TitleWindow as a whole so that the MSAA Location is the bounding rectangle of the entire TitleWindow. Screen readers like JAWS rely on the MSAA Location to announce whether some component is in the TitleWindow since the MSAA structure is flat.

Role

The MSAA Role of a TitleWindow is ROLE_SYSTEM_PANE.

Name

The MSAA Name of a TitleWindow is, by default, the title that it displays. To override this behavior, set the TitleWindow's `accessibilityName` property.

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

Description

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

State

The MSAA State of a TitleWindow is always STATE_SYSTEM_MOVEABLE.

Since the State does not change, a TitleWindow does not dispatch the MSAA event EVENT_OBJECT_STATECHANGE.

Value

The MSAA Value of a TitleWindow is always the empty string.

Location

The MSAA Location of a TitleWindow is its bounding rectangle.

Default Action

A TitleWindow does not have an MSAA DefaultAction.

Focus

A TitleWindow does not accept focus.

Selection

A TitleWindow does not support selection in the MSAA sense.

Other

A TitleWindow also dispatches the following MSAA events:

- EVENT_OBJECT_CREATE, when it is created
- EVENT_OBJECT_DESTROY, when it is closed
- EVENT_OBJECT_LOCATIONCHANGE, when it is moved

Protected Properties
Hide Inherited Protected Properties
Show Inherited 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
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | TitleWindowAccImpl(master:UIComponent) Constructor. | TitleWindowAccImpl
|  | enableAccessibility():void [static] Enables accessibility in the TitleWindow class. | TitleWindowAccImpl
|  | 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

Protected Methods
Show Inherited Protected Methods
Show Inherited 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

TitleWindowAccImpl | () | Constructor

`public function TitleWindowAccImpl(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 TitleWindow class.

This method is called by application startup code that is autogenerated by the MXML compiler. Afterwards, when instances of TitleWindow are initialized, the `accessibilityImplementation` property of a special first child Sprite will be set to an instance of this class. If the TitleWindowAccImpl were attached to the TitleWindow itself the accessibility implementations of the TitleWindow's children would be ignored.

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