Package | com.adobe.mosaic.om.events |
Class | public class CatalogLoadEvent |
Inheritance | CatalogLoadEvent ![]() ![]() ![]() |
Language Version: | ActionScript 3.0 |
Product Version: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10 |
Runtime Versions: | AIR 2.6, Flash Player 10.2 |
CatalogLoadEvent
class defines a transient notification of catalog load results.
CatalogLoadEvent
objects are not retained or stored after all their listeners have been processed.
CatalogLoadEvent
objects are used to communicate information and do not need to be
persisted or referenced.
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 | |
catalog : ICatalog [read-only]
Returns the catalog node that was loaded
| CatalogLoadEvent | ||
![]() | 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 | |
![]() | message : String [read-only]
Returns a message string. | BaseEvent | |
NAMESPACE : String [static] [read-only]
The namespace for messages of this type. | CatalogLoadEvent | ||
![]() | object : * [read-only]
Returns the node that was added. | BaseEvent | |
![]() | target : Object [read-only]
The event target. | Event | |
![]() | type : String [read-only]
The type of event. | Event |
Method | Defined By | ||
---|---|---|---|
Constructor. | CatalogLoadEvent | ||
[override]
Clones this CatalogLoadEvent instance. | CatalogLoadEvent | ||
![]() |
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 | ||
---|---|---|---|
FAILURE : String = "catalogLoadEventFailure" [static]
The message type sent when a catalog fails to load. | CatalogLoadEvent | ||
SUCCESS : String = "catalogLoadEventSuccess" [static]
The message type sent when a catalog is loaded successfully. | CatalogLoadEvent |
catalog | property |
catalog:ICatalog
[read-only] Language Version: | ActionScript 3.0 |
Product Version: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10 return catalog ICatalog |
Runtime Versions: | AIR 2.6, Flash Player 10.2 |
Returns the catalog node that was loaded
Implementation
public function get catalog():ICatalog
Related API Elements
NAMESPACE | property |
NAMESPACE:String
[read-only] Language Version: | ActionScript 3.0 |
Product Version: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10 |
Runtime Versions: | AIR 2.6, Flash Player 10.2 |
The namespace for messages of this type.
Implementation
public static function get NAMESPACE():String
CatalogLoadEvent | () | Constructor |
public function CatalogLoadEvent(type:String, catalog:ICatalog, msg:String)
Language Version: | ActionScript 3.0 |
Product Version: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10 |
Runtime Versions: | AIR 2.6, Flash Player 10.2 |
Constructor.
Parameterstype:String — Event type
| |
catalog:ICatalog — Event ICatalog
| |
msg:String — Event message
|
clone | () | method |
override public function clone():Event
Language Version: | ActionScript 3.0 |
Product Version: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10 |
Runtime Versions: | AIR 2.6, Flash Player 10.2 |
Clones this CatalogLoadEvent instance. Duplicates an instance of an Event subclass.
Returns a new Event object that is a copy of the original instance of the Event object.
You do not normally call clone()
; the EventDispatcher class calls it automatically
when you redispatch an event—that is, when you call dispatchEvent(event)
from a handler
that is handling event
.
The new Event object includes all the properties of the original.
When creating your own custom Event class, you must override the
inherited Event.clone()
method in order for it to duplicate the
properties of your custom class. If you do not set all the properties that you add
in your event subclass, those properties will not have the correct values when listeners
handle the redispatched event.
In this example, PingEvent
is a subclass of Event
and therefore implements its own version of clone()
.
class PingEvent extends Event { var URL:String; public override function clone():Event { return new PingEvent(type, bubbles, cancelable, URL); } }
Event — clone The cloned CatalogLoadEvent
|
FAILURE | Constant |
public static const FAILURE:String = "catalogLoadEventFailure"
Language Version: | ActionScript 3.0 |
Product Version: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10 |
Runtime Versions: | AIR 2.6, Flash Player 10.2 |
The message type sent when a catalog fails to load.
SUCCESS | Constant |
public static const SUCCESS:String = "catalogLoadEventSuccess"
Language Version: | ActionScript 3.0 |
Product Version: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10 |
Runtime Versions: | AIR 2.6, Flash Player 10.2 |
The message type sent when a catalog is loaded successfully.
Thu Dec 4 2014, 05:50 PM -08:00