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

ServiceEvent  - AS3 ADEP Client Component

Packagecom.adobe.gravity.framework
Classpublic class ServiceEvent
InheritanceServiceEvent Inheritance Event Inheritance 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 ServiceEvent class indicates changes in service properties or availability.



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
 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
  serviceClass : Class
[read-only] The service class.
ServiceEvent
  serviceReference : IServiceReference
[read-only] The service undergoing a lifecycle change.
ServiceEvent
 Inheritedtarget : Object
[read-only] The event target.
Event
 Inheritedtype : String
[read-only] The type of event.
Event
Public Methods
 MethodDefined By
  
ServiceEvent(type:String, reference:IServiceReference, clazz:Class)
Constructor.
ServiceEvent
  
[override] Duplicates an instance of an Event subclass.
ServiceEvent
 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
  SERVICE_MODIFIED : String = "serviceModified"
[static] The serviceModified event type indicates that the properties of the service have been modified.
ServiceEvent
  SERVICE_REGISTERED : String = "serviceRegistered"
[static] The serviceRegistered event type indicates that the service has been registered.
ServiceEvent
  SERVICE_UNREGISTERING : String = "serviceUnregistering"
[static] The serviceUnregistering event type indicates that the service is in the process of being unregistered.
ServiceEvent
Property Detail

serviceClass

property
serviceClass:Class  [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 service class.



Implementation
    public function get serviceClass():Class

serviceReference

property 
serviceReference:IServiceReference  [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 service undergoing a lifecycle change.



Implementation
    public function get serviceReference():IServiceReference
Constructor Detail

ServiceEvent

()Constructor
public function ServiceEvent(type:String, reference:IServiceReference, clazz:Class)

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
type:String — event type.
 
reference:IServiceReference — service reference for the affected service.
 
clazz:Class — service class.
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

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 — A new Event object that is identical to the original.
Constant Detail

SERVICE_MODIFIED

Constant
public static const SERVICE_MODIFIED:String = "serviceModified"

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 serviceModified event type indicates that the properties of the service have been modified.

SERVICE_REGISTERED

Constant 
public static const SERVICE_REGISTERED:String = "serviceRegistered"

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 serviceRegistered event type indicates that the service has been registered.

SERVICE_UNREGISTERING

Constant 
public static const SERVICE_UNREGISTERING:String = "serviceUnregistering"

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 serviceUnregistering event type indicates that the service is in the process of being unregistered.