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.managers 

ErrorManager  - AS3 Asset Composer
Packagecom.adobe.icc.editors.managers
Classpublic class ErrorManager
InheritanceErrorManager Inheritance Object

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

The ErrorManager helps you handle errors occurring on the client.

It is a central place for handling all the validation/service errors and displaying the correct error message in the current user locale.


Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  errorManagerImpl : IErrorManager
[static] [write-only] Method to override the error manager implementation
ErrorManager
Public Methods
 MethodDefined By
  
handleError(fault:Fault, flags:uint = 0x0004, closeHandler:Function = null):void
[static] Helper method for handling Document Composer faults.
ErrorManager
  
handleFault(fault:Fault, asset:*):void
[static] Helper method for handling server faults.
ErrorManager
  
handleValidationFault(evt:AssetValidationEvent):void
[static] Helper method for handling client domain validation errors.
ErrorManager
 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
  
showMessage(msgTitle:String, msgText:String, closeHandler:Function = null, messageType:String = null, flags:uint = 0x0004):void
[static] Helper method for handling Document Composer user messages.
ErrorManager
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
toString():String
Returns the string representation of the specified object.
Object
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
  Error_Icon : * = Error
[static] The constant specifying the Error Icon.
ErrorManager
  Info_Icon : * = Info
[static] The constant specifying the Info Icon.
ErrorManager
  Ok_Icon : * = Ok
[static] The constant specifying the OK Icon.
ErrorManager
  Warning_Icon : * = Warning
[static] The constant specifying the Warning Icon.
ErrorManager
Property Detail

errorManagerImpl

property
errorManagerImpl:IErrorManager  [write-only]

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

Method to override the error manager implementation



Implementation
    public static function set errorManagerImpl(value:IErrorManager):void
Method Detail

handleError

()method
public static function handleError(fault:Fault, flags:uint = 0x0004, closeHandler:Function = null):void

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

Helper method for handling Document Composer faults.

This method reads the fault code from the passed fault object, pulls the relevant error message from the resource bundle, fills it with details if required and shows it to the user in form of an Alert box.

Parameters

fault:Fault — The fault object encapsulating server fault.
 
flags:uint (default = 0x0004) — The buttons to be present on the Alert dialog.
 
closeHandler:Function (default = null) — The function to be called when the user clicks the button on the alert

handleFault

()method 
public static function handleFault(fault:Fault, asset:*):void

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

Helper method for handling server faults.

This method reads the fault code from the passed fault object, pulls the relevant error message from the resource bundle, fills it with details if required and shows it to the user in form of an Alert box.

Parameters

fault:Fault — The fault object encapsulating server fault.
 
asset:* — The related asset for which the fault occured.

handleValidationFault

()method 
public static function handleValidationFault(evt:AssetValidationEvent):void

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

Helper method for handling client domain validation errors.

This method identifies the validation failure cause and displays suitable error message to the user in form of an Alert box.

Parameters

evt:AssetValidationEvent — The AssetValidationEvent event raised by the domain object during validation.

showMessage

()method 
public static function showMessage(msgTitle:String, msgText:String, closeHandler:Function = null, messageType:String = null, flags:uint = 0x0004):void

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

Helper method for handling Document Composer user messages.

This method pulls the relevant user message from the resource bundle, fills it with details if required and shows it to the user in form of an Alert box.

Parameters

msgTitle:String — The Message Title to be displayed in the Alert Window.
 
msgText:String — The Message text to be shown in the Alert dialog.
 
closeHandler:Function (default = null) — The function to be called when the user clicks the button on the alert
 
messageType:String (default = null) — The string value specifying the type of message in order to show the respective icon. The types can be Warning,Info, Error or OK icon.
 
flags:uint (default = 0x0004) — The uint value speciying the buttons to be shown on the Alert box.
Constant Detail

Error_Icon

Constant
public static const Error_Icon:* = Error

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

The constant specifying the Error Icon.

Info_Icon

Constant 
public static const Info_Icon:* = Info

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

The constant specifying the Info Icon.

Ok_Icon

Constant 
public static const Ok_Icon:* = Ok

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

The constant specifying the OK Icon.

Warning_Icon

Constant 
public static const Warning_Icon:* = Warning

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

The constant specifying the Warning Icon.




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

 

Legal Notices | Online Privacy Policy