com.adobe.gravity.utility.events

# AugmentedErrorEvent - AS3 ADEP Client Component

Package | com.adobe.gravity.utility.events
Class | public class AugmentedErrorEvent
Inheritance | AugmentedErrorEvent ErrorEvent TextEvent Event Object

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10

Runtime Versions: | AIR 1.1, Flash Player 9

The AugmentedErrorEvent extends the ErrorEvent class to provide access to the original Error object.

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | bubbles : Boolean [read-only] Indicates whether an event is a bubbling event. | Event
|  | cancelable : Boolean [read-only] Indicates whether the behavior associated with the event can be prevented. | Event
|  | constructor : Object A reference to the class object or constructor function for a given object instance. | Object
|  | currentTarget : Object [read-only] The object that is actively processing the Event object with an event listener. | Event
|  | error : Error [read-only] The original Error object. | AugmentedErrorEvent
|  | errorID : int [read-only] Contains the reference number associated with the specific error. | ErrorEvent
|  | eventPhase : uint [read-only] The current phase in the event flow. | Event
|  | target : Object [read-only] The event target. | Event
|  | text : String For a textInput event, the character or sequence of characters entered by the user. | TextEvent
|  | type : String [read-only] The type of event. | Event

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | AugmentedErrorEvent(error:Error, type:String = "error", bubbles:Boolean = false) Constructor. | AugmentedErrorEvent
|  | clone():Event [override] Creates a copy of the ErrorEvent object and sets the value of each property to match that of the original. | AugmentedErrorEvent
|  | formatToString(className:String, ... arguments):String A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes. | Event
|  | hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined. | Object
|  | isDefaultPrevented():Boolean Checks whether the preventDefault() method has been called on the event. | Event
|  | 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
|  | preventDefault():void Cancels an event's default behavior if that behavior can be canceled. | Event
|  | propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable. | Object
|  | setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations. | Object
|  | stopImmediatePropagation():void Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow. | Event
|  | stopPropagation():void Prevents processing of any event listeners in nodes subsequent to the current node in the event flow. | Event
|  | toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions. | Object
|  | toString():String [override] Returns a string that contains all the properties of the ErrorEvent object. | ErrorEvent
|  | valueOf():Object Returns the primitive value of the specified object. | Object

Public Constants
Hide Inherited Public Constants
Show Inherited Public Constants

| Constant | Defined By
--- | --- | ---
|  | ERROR : String = "error" [static] The AugmentedErrorEvent.ERROR constant defines the value of the type property of the event object for an error event. | AugmentedErrorEvent

Property Detail

### error

property

`error:Error` [read-only]

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10

Runtime Versions: | AIR 1.1, Flash Player 9

The original Error object.

Implementation
`public function get error():Error`
Constructor Detail

### AugmentedErrorEvent

()
Constructor

`public function AugmentedErrorEvent(error:Error, type:String = "error", bubbles:Boolean = false)`

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10

Runtime Versions: | AIR 1.1, Flash Player 9

Constructor.

Parameters

| `error:Error` — The original Error object. Must not be null.
| `type:String` (default = "`error`")`` — The event type; generally the default type of "error" should be preferred, so that all errors can be caught without resorting to adding many handlers.
| `bubbles:Boolean` (default = `false`)`` — Determines whether the Event object participates in the bubbling stage of the event flow. The default value is false.

Method Detail

### clone

()
method

`override public function clone():Event`

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10

Runtime Versions: | AIR 1.1, Flash Player 9

Creates a copy of the ErrorEvent object and sets the value of each property to match that of the original.

Returns

| `Event` — A new ErrorEvent object with property values that match those of the original.

Constant Detail

### ERROR

Constant

`public static const ERROR:String = "error"`

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10

Runtime Versions: | AIR 1.1, Flash Player 9

The `AugmentedErrorEvent.ERROR` constant defines the value of the `type` property of the event object for an `error` event.

The properties of the event object have the following values:

Property | Value
--- | ---
`bubbles` | false
`cancelable` | false
`currentTarget` | The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`error` | The Error object associated with this event.
`target` | The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00