ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
com.adobe.icc.editors.events 

AssetValidationEvent  - AS3 Asset Composer

Packagecom.adobe.icc.editors.events
Classpublic class AssetValidationEvent
InheritanceAssetValidationEvent Inheritance Event Inheritance Object

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 9.5
Runtime Versions: AIR (unsupported), Flash Player 10.2

The AssetValidationEvent class represents the event object passed to the event listener for domain api invokers.

This event is dispatched by various asset domain classes when the validate() method has been invoked on them. This event encapsulates the result of the client side validations performed on the domain object the validate() api was called for.

Related API Elements

com.adobe.icc.editors.model.ModuleModel.validate()


Public Properties
 PropertyDefined By
 Inheritedbubbles : Boolean
[read-only] Indicates whether an event is a bubbling event.
Event
 Inheritedcancelable : Boolean
[read-only] Indicates whether the behavior associated with the event can be prevented.
Event
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedcurrentTarget : Object
[read-only] The object that is actively processing the Event object with an event listener.
Event
  data : *
The data is an arbitrary value associated with the type of fault and varies from case to case.
AssetValidationEvent
 InheritedeventPhase : uint
[read-only] The current phase in the event flow.
Event
  faultType : int
The faultType corresponds to one of the constants defined in the class AssetValidationFaultType.
AssetValidationEvent
 Inheritedtarget : Object
[read-only] The event target.
Event
 Inheritedtype : String
[read-only] The type of event.
Event
Public Methods
 MethodDefined By
  
AssetValidationEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false)
Constructor.
AssetValidationEvent
 Inherited
Duplicates an instance of an Event subclass.
Event
 Inherited
formatToString(className:String, ... arguments):String
A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.
Event
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Checks whether the preventDefault() method has been called on the event.
Event
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Cancels an event's default behavior if that behavior can be canceled.
Event
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
Event
 Inherited
Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
Event
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns a string containing all the properties of the Event object.
Event
 Inherited
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
  INVALID : String = "invalid"
[static] The AssetValidationEvent.INVALID constant defines the value of the type property of the event object for a invalid event.
AssetValidationEvent
  VALID : String = "valid"
[static] The AssetValidationEvent.VALID constant defines the value of the type property of the event object for a valid event.
AssetValidationEvent
Property Detail

data

property
public var data:*

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 9.5
Runtime Versions: AIR (unsupported), Flash Player 10.2

The data is an arbitrary value associated with the type of fault and varies from case to case. The following table illustrates the association between fault codes and the related data:

Fault CodeData
AssetValidationFaultType.INCOMPATIBLE_DATADICTIONARYArray of assets dependent upon the target asset
This property is applicable for the invalid event type. For the case of valid event type, this property must be ignored.

Related API Elements

faultType

property 
public var faultType:int

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 9.5
Runtime Versions: AIR (unsupported), Flash Player 10.2

The faultType corresponds to one of the constants defined in the class AssetValidationFaultType.

This property is applicable for the invalid event type. For the case of valid event type, this property must be ignored.

Related API Elements

Constructor Detail

AssetValidationEvent

()Constructor
public function AssetValidationEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false)

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 9.5
Runtime Versions: AIR (unsupported), Flash Player 10.2

Constructor.

Parameters
type:String — The event type; indicates the action that caused the event.
 
bubbles:Boolean (default = false) — Specifies whether the event can bubble up the display list hierarchy.
 
cancelable:Boolean (default = false) — Specifies whether the behavior associated with the event can be prevented.
Constant Detail

INVALID

Constant
public static const INVALID:String = "invalid"

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 9.5
Runtime Versions: AIR (unsupported), Flash Player 10.2

The AssetValidationEvent.INVALID constant defines the value of the type property of the event object for a invalid event.

The invalid event is dispatched when the validations executed on the domain object fail for some reason. The validations are run implicitly when the domain object is saved or explicitly when the validate() method is invoked on a domain object like TextModel, ListModel etc.

When this event is dispatched, the properties faultType and data contain meaningful values and can be read to find out the reason for failure and any data associated.

VALID

Constant 
public static const VALID:String = "valid"

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 9.5
Runtime Versions: AIR (unsupported), Flash Player 10.2

The AssetValidationEvent.VALID constant defines the value of the type property of the event object for a valid event.

The valid event is dispatched when the validations executed on the domain object are successful. The validations are run implicitly when the domain object is saved or explicitly when the validate() method is invoked on a domain object like TextModel, ListModel etc.