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

CatalogLoadEvent  - AS3 ADEP Composite Application

Packagecom.adobe.mosaic.om.events
Classpublic class CatalogLoadEvent
InheritanceCatalogLoadEvent Inheritance BaseEvent Inheritance Event Inheritance Object

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



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
  catalog : ICatalog
[read-only] Returns the catalog node that was loaded
CatalogLoadEvent
 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
 InheritedeventPhase : uint
[read-only] The current phase in the event flow.
Event
 Inheritedmessage : String
[read-only] Returns a message string.
BaseEvent
  NAMESPACE : String
[static] [read-only] The namespace for messages of this type.
CatalogLoadEvent
 Inheritedobject : *
[read-only] Returns the node that was added.
BaseEvent
 Inheritedtarget : Object
[read-only] The event target.
Event
 Inheritedtype : String
[read-only] The type of event.
Event
Public Methods
 MethodDefined By
  
Constructor.
CatalogLoadEvent
  
[override] Clones this CatalogLoadEvent instance.
CatalogLoadEvent
 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
  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
Property Detail

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
Constructor Detail

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.

Parameters
type:String — Event type
 
catalog:ICatalog — Event ICatalog
 
msg:String — Event message
Method Detail

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);
        }
     }
     

Returns
Event — clone The cloned CatalogLoadEvent
Constant Detail

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.