ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
mx.automation 

AutomationClass  - AS3 Flex
Packagemx.automation
Classpublic class AutomationClass
InheritanceAutomationClass Inheritance Object
Implements IAutomationClass2

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Provides serializable class information for external automation tools. Some classes are represented as the same AutomationClass (HSlider and VSlider, forinstance).

Learn more

Understanding the automation framework

Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  implementationVersion : int
Version of the implementation classes.
AutomationClass
  name : String
[read-only] the class name
AutomationClass
  previousVersionClassNames : Array
An array of names of the classes that are compatible with current class.
AutomationClass
  propertyNameMap : Object
[read-only] private
AutomationClass
  superClassName : String
[read-only] The name of the class's superclass.
AutomationClass
Public Methods
 MethodDefined By
  
AutomationClass(name:String, superClassName:String = null)
AutomationClass
  
addImplementationClassName(className:String):void
Add Flex class names which match this class description.
AutomationClass
  
fillInASTypesFromMethods(dtForClass:XML, methodName:String, argDescriptors:Array):void
[static] Fills in the AS types for the provided propertyDescriptors based on the information provided in the describeType XML.
AutomationClass
  
fillInASTypesFromProperties(dtForClass:XML, propertyDescriptors:Array):void
[static] Fills in the AS types for the provided propertyDescriptors based on the information provided in the describeType XML.
AutomationClass
  
getClassName(obj:Object):String
[static] Returns the fully qualified name of the class to which the object belongs.
AutomationClass
  
getDefinitionFromObjectDomain(obj:Object, className:String):Class
[static] Utility function that returns the class definition from the domain of a object instance
AutomationClass
  
getDescriptorForEvent(event:Event):IAutomationEventDescriptor
Translates between component event and Automation method descriptor
AutomationClass
  
getDescriptorForEventByName(eventName:String):IAutomationEventDescriptor
AutomationClass
  
getDescriptorForMethodByName(methodName:String):IAutomationMethodDescriptor
Returns a full methodDescriptor from its name
AutomationClass
  
getMajorVersion():String
[static] Returns the major from current version number
AutomationClass
  
getPropertyDescriptors(objForInitialization:Object = null, forVerification:Boolean = true, forDescription:Boolean = true):Array
Returns the list of properties this class supports.
AutomationClass
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
isPrototypeOf(theClass:Object):Boolean
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
  
toString():String
AutomationClass
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
Property Detail

implementationVersion

property
implementationVersion:int

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 9, AIR 1.1

Version of the implementation classes. This version is supposed to be unique for all implementation classes of a single ClassInfo tag in XML



Implementation
    public function get implementationVersion():int
    public function set implementationVersion(value:int):void

name

property 
name:String  [read-only]

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

the class name



Implementation
    public function get name():String

previousVersionClassNames

property 
previousVersionClassNames:Array

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 9, AIR 1.1

An array of names of the classes that are compatible with current class.



Implementation
    public function get previousVersionClassNames():Array
    public function set previousVersionClassNames(value:Array):void

propertyNameMap

property 
propertyNameMap:Object  [read-only]

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

private



Implementation
    public function get propertyNameMap():Object

superClassName

property 
superClassName:String  [read-only]

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The name of the class's superclass.



Implementation
    public function get superClassName():String
Constructor Detail

AutomationClass

()Constructor
public function AutomationClass(name:String, superClassName:String = null)



Parameters
name:String
 
superClassName:String (default = null)
Method Detail

addImplementationClassName

()method
public function addImplementationClassName(className:String):void

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Add Flex class names which match this class description.

Parameters

className:String — the name of the Flex class

fillInASTypesFromMethods

()method 
public static function fillInASTypesFromMethods(dtForClass:XML, methodName:String, argDescriptors:Array):void

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Fills in the AS types for the provided propertyDescriptors based on the information provided in the describeType XML.

Parameters

dtForClass:XML
 
methodName:String
 
argDescriptors:Array

fillInASTypesFromProperties

()method 
public static function fillInASTypesFromProperties(dtForClass:XML, propertyDescriptors:Array):void

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Fills in the AS types for the provided propertyDescriptors based on the information provided in the describeType XML.

Parameters

dtForClass:XML
 
propertyDescriptors:Array

getClassName

()method 
public static function getClassName(obj:Object):String

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

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

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

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

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

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):IAutomationEventDescriptor

Parameters

eventName:String

Returns
IAutomationEventDescriptor

getDescriptorForMethodByName

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

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

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.

getMajorVersion

()method 
public static function getMajorVersion():String

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 9, AIR 1.1

Returns the major from current version number

Returns
String

getPropertyDescriptors

()method 
public function getPropertyDescriptors(objForInitialization:Object = null, forVerification:Boolean = true, forDescription:Boolean = true):Array

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Returns the list of properties this class supports.

Parameters

objForInitialization:Object (default = null) — Object which can be used to find the ActionScript type of the properties.
 
forVerification:Boolean (default = true) — If true, indicates that properties used for verification should be included in the return value.
 
forDescription:Boolean (default = true) — If true, indicates that properties used for object identitication should be included in the return value.

Returns
Array — Array containing property descriptions.

toString

()method 
public function toString():String

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

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



© 2014 Adobe Systems Incorporated. All rights reserved.
Thu Dec 4 2014, 05:50 PM -08:00
 

 

Legal Notices | Online Privacy Policy