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

FlexVersion  - AS3 Flex

Packagemx.core
Classpublic class FlexVersion
InheritanceFlexVersion Inheritance Object

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

This class controls the backward-compatibility of the framework. With every new release, some aspects of the framework such as behaviors, styles, and default settings, are changed which can affect your application. By setting the compatibilityVersion property, the behavior can be changed to match previous releases. This is a 'global' flag; you cannot apply one version to one component or group of components and a different version to another component or group of components.

Learn more



Public Properties
 PropertyDefined By
  compatibilityErrorFunction : Function
[static] A function that gets called when the compatibility version is set more than once, or set after it has been read.
FlexVersion
  compatibilityVersion : uint
[static] The current version that the framework maintains compatibility for.
FlexVersion
  compatibilityVersionString : String
[static] The compatibility version, as a string of the form "X.X.X".
FlexVersion
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
Public Methods
 MethodDefined By
 Inherited
Indicates whether an object has a specified property defined.
Object
 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
Public Constants
 ConstantDefined By
  CURRENT_VERSION : uint = 0x04060000
[static] The current released version of the Flex SDK, encoded as a uint.
FlexVersion
  VERSION_2_0 : uint = 0x02000000
[static] The compatibilityVersion value of Flex 2.0, encoded numerically as a uint.
FlexVersion
  VERSION_2_0_1 : uint = 0x02000001
[static] The compatibilityVersion value of Flex 2.0.1, encoded numerically as a uint.
FlexVersion
  VERSION_3_0 : uint = 0x03000000
[static] The compatibilityVersion value of Flex 3.0, encoded numerically as a uint.
FlexVersion
  VERSION_4_0 : uint = 0x04000000
[static] The compatibilityVersion value of Flex 4.0, encoded numerically as a uint.
FlexVersion
  VERSION_4_5 : uint = 0x04050000
[static] The compatibilityVersion value of Flex 4.5, encoded numerically as a uint.
FlexVersion
  VERSION_4_6 : uint = 0x04060000
[static] The compatibilityVersion value of Flex 4.6, encoded numerically as a uint.
FlexVersion
  VERSION_ALREADY_READ : String = "versionAlreadyRead"
[static] A String passed as a parameter to the compatibilityErrorFunction() method if the compatibility version has already been read.
FlexVersion
  VERSION_ALREADY_SET : String = "versionAlreadySet"
[static] A String passed as a parameter to the compatibilityErrorFunction() method if the compatibility version has already been set.
FlexVersion
Property Detail

compatibilityErrorFunction

property
compatibilityErrorFunction:Function

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

A function that gets called when the compatibility version is set more than once, or set after it has been read. If this function is not set, the SDK throws an error. If set, File calls this function, but it is up to the developer to decide how to handle the call. This function will also be called if the function is set more than once. The function takes two parameters: the first is a uint which is the version that was attempted to be set; the second is a string that is the reason it failed, either VERSION_ALREADY_SET or VERSION_ALREADY_READ.



Implementation
    public static function get compatibilityErrorFunction():Function
    public static function set compatibilityErrorFunction(value:Function):void

compatibilityVersion

property 
compatibilityVersion:uint

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

The current version that the framework maintains compatibility for. This defaults to CURRENT_VERSION. It can be changed only once; changing it a second time results in a call to the compatibilityErrorFunction() method if it exists, or results in a runtime error. Changing it after the compatibilityVersion property has been read results in an error because code that is dependent on the version has already run. There are no notifications; the assumption is that this is set only once, and this it is set early enough that no code that depends on it has run yet.

The default value is FlexVersion.CURRENT_VERSION.



Implementation
    public static function get compatibilityVersion():uint
    public static function set compatibilityVersion(value:uint):void

compatibilityVersionString

property 
compatibilityVersionString:String

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

The compatibility version, as a string of the form "X.X.X". This is a pass-through to the compatibilityVersion property, which converts the number to and from a more human-readable String version.



Implementation
    public static function get compatibilityVersionString():String
    public static function set compatibilityVersionString(value:String):void
Constant Detail

CURRENT_VERSION

Constant
public static const CURRENT_VERSION:uint = 0x04060000

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

The current released version of the Flex SDK, encoded as a uint.

VERSION_2_0

Constant 
public static const VERSION_2_0:uint = 0x02000000

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

The compatibilityVersion value of Flex 2.0, encoded numerically as a uint. Code can compare this constant against the compatibilityVersion to implement version-specific behavior.

VERSION_2_0_1

Constant 
public static const VERSION_2_0_1:uint = 0x02000001

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

The compatibilityVersion value of Flex 2.0.1, encoded numerically as a uint. Code can compare this constant against the compatibilityVersion to implement version-specific behavior.

VERSION_3_0

Constant 
public static const VERSION_3_0:uint = 0x03000000

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

The compatibilityVersion value of Flex 3.0, encoded numerically as a uint. Code can compare this constant against the compatibilityVersion to implement version-specific behavior.

VERSION_4_0

Constant 
public static const VERSION_4_0:uint = 0x04000000

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

The compatibilityVersion value of Flex 4.0, encoded numerically as a uint. Code can compare this constant against the compatibilityVersion to implement version-specific behavior.

VERSION_4_5

Constant 
public static const VERSION_4_5:uint = 0x04050000

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

The compatibilityVersion value of Flex 4.5, encoded numerically as a uint. Code can compare this constant against the compatibilityVersion to implement version-specific behavior.

VERSION_4_6

Constant 
public static const VERSION_4_6:uint = 0x04060000

Language Version: ActionScript 3.0
Product Version: Flex 4.6
Runtime Versions: Flash Player 11, AIR 3

The compatibilityVersion value of Flex 4.6, encoded numerically as a uint. Code can compare this constant against the compatibilityVersion to implement version-specific behavior.

VERSION_ALREADY_READ

Constant 
public static const VERSION_ALREADY_READ:String = "versionAlreadyRead"

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

A String passed as a parameter to the compatibilityErrorFunction() method if the compatibility version has already been read.

VERSION_ALREADY_SET

Constant 
public static const VERSION_ALREADY_SET:String = "versionAlreadySet"

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

A String passed as a parameter to the compatibilityErrorFunction() method if the compatibility version has already been set.