Adobe® Flex® 4 Language Reference
Show Packages and Classes List |  Packages  |  Classes  |  Index  |  Appendixes
spark.accessibility 
TitleWindowAccImpl 
Packagespark.accessibility
Classpublic class TitleWindowAccImpl
InheritanceTitleWindowAccImpl Inheritance PanelAccImpl Inheritance AccImpl Inheritance AccessibilityImplementation Inheritance Object

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



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
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
 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.
TitleWindowAccImpl
 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 TitleWindow class.
TitleWindowAccImpl
 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
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] Method for supporting state Accessibility.
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

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.