Package | com.adobe.icc.editors.events |
Class | public class AssetEvent |
Inheritance | AssetEvent FlexEvent Event Object |
Language Version: | ActionScript 3.0 |
Product Version: | Asset Composer Building Block 9.5 |
Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
This event is dispatched by various asset domain classes to signify events related to operations being carried out on them. For example, the class LetterModel dispatches an event of this type when it is saved. The event can be leveraged to show certain cues on the UI accordingly.
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 | ||
eventPhase : uint [read-only]
The current phase in the event flow. | Event | ||
fault : Fault
The fault object encapsulating the error sent by the server. | AssetEvent | ||
target : Object [read-only]
The event target. | Event | ||
type : String [read-only]
The type of event. | Event |
Method | Defined By | ||
---|---|---|---|
Constructor. | AssetEvent | ||
Duplicates an instance of an Event subclass. | Event | ||
A utility function for implementing the toString() method in custom
ActionScript 3.0 Event classes. | Event | ||
Indicates whether an object has a specified property defined. | Object | ||
Checks whether the preventDefault() method has been called on the event. | Event | ||
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | ||
Cancels an event's default behavior if that behavior can be canceled. | Event | ||
Indicates whether the specified property exists and is enumerable. | Object | ||
Sets the availability of a dynamic property for loop operations. | Object | ||
Prevents processing of any event listeners in the current node and any subsequent nodes in
the event flow. | Event | ||
Prevents processing of any event listeners in nodes subsequent to the current node in the
event flow. | Event | ||
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | ||
Returns a string containing all the properties of the Event object. | Event | ||
Returns the primitive value of the specified object. | Object |
Constant | Defined By | ||
---|---|---|---|
SAVE_COMPLETE : String = "saveComplete" [static]
The AssetEvent.SAVE_COMPLETE constant defines the value of the
type property of the event object for a saveComplete event. | AssetEvent | ||
SAVE_FAULT : String = "saveFault" [static]
The AssetEvent.SAVE_FAULT constant defines the value of the
type property of the event object for a saveFault event. | AssetEvent | ||
SAVING : String = "saving" [static]
The AssetEvent.SAVING constant defines the value of the
type property of the event object for a saving event. | AssetEvent |
fault | property |
public var fault:Fault
Language Version: | ActionScript 3.0 |
Product Version: | Asset Composer Building Block 9.5 |
Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
The fault object encapsulating the error sent by the server. This property
is applicable only if the event type is saveFault
.
In case of other events, this property remains null and should be ignored.
AssetEvent | () | Constructor |
public function AssetEvent(type:String, bubbles:Boolean = true, cancelable:Boolean = false, fault:Fault = null)
Language Version: | ActionScript 3.0 |
Product Version: | Asset Composer Building Block 9.5 |
Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
Constructor.
Parameterstype:String — The event type; indicates the action that caused the event.
| |
bubbles:Boolean (default = true ) — 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.
| |
fault:Fault (default = null ) — The fault object related to the error sent by the server.
This is applicable only in case of the event type saveFault
|
SAVE_COMPLETE | Constant |
public static const SAVE_COMPLETE:String = "saveComplete"
Language Version: | ActionScript 3.0 |
Product Version: | Asset Composer Building Block 9.5 |
Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
The AssetEvent.SAVE_COMPLETE
constant defines the value of the
type
property of the event object for a saveComplete
event.
The saveComplete
event is dispatched when the domain object has been
successfully saved on the server. Unlike the saving
event, this is dispatched
in an aysnchronous manner only after the server has responded with a result for the save api
call.
This event can be used to stop UI animations indicating "save in progress" or to popup an info box indicating save success.
SAVE_FAULT | Constant |
public static const SAVE_FAULT:String = "saveFault"
Language Version: | ActionScript 3.0 |
Product Version: | Asset Composer Building Block 9.5 |
Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
The AssetEvent.SAVE_FAULT
constant defines the value of the
type
property of the event object for a saveFault
event.
The saveFault
event is dispatched when the server reports an error while
saving the asset on the server. Unlike the saving
event, this is dispatched
in an aysnchronous manner only after the server has responded with a result for the save api
call.
When this event is dispatched, the fault
property contains the fault object
encapsulating the error sent by the server. The fault
property can be used to
determine the faultCode and show an error message accordingly.
This event can be used to stop UI animations indicating "save in progress" or to popup an info box indicating save success.
SAVING | Constant |
public static const SAVING:String = "saving"
Language Version: | ActionScript 3.0 |
Product Version: | Asset Composer Building Block 9.5 |
Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
The AssetEvent.SAVING
constant defines the value of the
type
property of the event object for a saving
event.
The saving
event is dispatched when the save() method has been
called on the domain object. This event is dispatched before any server api
is invoked but after the domain client validations are complete. This is because
the actual save starts once the client validations are complete.
This event can be used to start a UI animation indicating "save in progress".
Related API Elements
Thu Dec 6 2018, 01:12 PM -08:00