Packagesrc.main
Classpublic class CustomAutomationClass
Implementsmx.automation.IAutomationClass

Custom Automation class (Used with Adobe's approval).



Public Properties
 PropertyDefined by
  name : String
[read-only] The class name
CustomAutomationClass
  propertyNameMap : Object
[read-only] private
CustomAutomationClass
  superClassName : String
[read-only] The name of the class's superclass.
CustomAutomationClass
Public Methods
 MethodDefined by
  
CustomAutomationClass(name:String, superClassName:String = null)
CustomAutomationClass
  
addImplementationClassName(className:String):void
The list of the Flex classes that implement this automation class
CustomAutomationClass
  
addPropertyDescriptor(p:IAutomationPropertyDescriptor):void
Indicates that this class has the specified property
CustomAutomationClass
  
getClassName(obj:Object):String
[static] Returns the fully qualified name of the class to which the object belongs.
CustomAutomationClass
  
getDefinitionFromObjectDomain(obj:Object, className:String):Class
[static] Utility function that returns the class definition from the domain of a object instance
CustomAutomationClass
  
getDescriptorForEvent(event:Event):IAutomationEventDescriptor
Translates between component event and Automation method descriptor
CustomAutomationClass
  
getDescriptorForEventByName(eventName:String):IAutomationEventDescriptor
CustomAutomationClass
  
getDescriptorForMethodByName(methodName:String):IAutomationMethodDescriptor
Returns a full methodDescriptor from its name
CustomAutomationClass
  
getPropertyDescriptors(objForInitialization:Object = null, forVerification:Boolean = true, forDescription:Boolean = true):Array
Returns the list of properties this class supports
CustomAutomationClass
  
toString():String
CustomAutomationClass
Property detail
nameproperty
name:String  [read-only]

The class name

Implementation
    public function get name():String
propertyNameMapproperty 
propertyNameMap:Object  [read-only]

private

Implementation
    public function get propertyNameMap():Object
superClassNameproperty 
superClassName:String  [read-only]

The name of the class's superclass.

Implementation
    public function get superClassName():String
Constructor detail
CustomAutomationClass()constructor
public function CustomAutomationClass(name:String, superClassName:String = null)Parameters
name:String
 
superClassName:String (default = null)
Method detail
addImplementationClassName()method
public function addImplementationClassName(className:String):void

The list of the Flex classes that implement this automation class

Parameters
className:String — the name of the Flex class
addPropertyDescriptor()method 
public function addPropertyDescriptor(p:IAutomationPropertyDescriptor):void

Indicates that this class has the specified property

Parameters
p:IAutomationPropertyDescriptor
getClassName()method 
public static function getClassName(obj:Object):String

Returns the fully qualified name of the class to which the object belongs.

Parameters
obj:Object — The object whose class name is desired

Returns
String — Fully qualified name of the class
getDefinitionFromObjectDomain()method 
public static function getDefinitionFromObjectDomain(obj:Object, className:String):Class

Utility function that returns the class definition from the domain of a object instance

Parameters
obj:Object
 
className:String

Returns
Class
getDescriptorForEvent()method 
public function getDescriptorForEvent(event:Event):IAutomationEventDescriptor

Translates between component event and Automation method descriptor

Parameters
event:Event — The event object for which a method descrptor is required.

Returns
IAutomationEventDescriptor — The method descriptor for the event passed if one is available. Otherwise null.
getDescriptorForEventByName()method 
public function getDescriptorForEventByName(eventName:String):IAutomationEventDescriptorParameters
eventName:String

Returns
IAutomationEventDescriptor
getDescriptorForMethodByName()method 
public function getDescriptorForMethodByName(methodName:String):IAutomationMethodDescriptor

Returns a full methodDescriptor from its name

Parameters
methodName:String — The method name for which the descriptor is required.

Returns
IAutomationMethodDescriptor — The method descriptor for the name passed if one is available. Otherwise null.
getPropertyDescriptors()method 
public function getPropertyDescriptors(objForInitialization:Object = null, forVerification:Boolean = true, forDescription:Boolean = true):Array

Returns the list of properties this class supports

Parameters
objForInitialization:Object (default = null) — Object which can be used to find ActionScript type of the properties.
 
forVerification:Boolean (default = true) — Indicates whether properties used for verfication should be included or not. Default value is true
 
forDescription:Boolean (default = true) — Indicates whether properties used for object identitication should be included or not. Default value is true

Returns
Array — Array containing property descriptions.
toString()method 
public function toString():String

Returns
String — name, superClassName, and event/method mappings.