Packagesystem.events
Classpublic class StringEvent
InheritanceStringEvent Inheritance BasicEvent Inheritance flash.events.Event

The StringEvent to dispatch an event who contains a specific Number context.

Example :

     import system.events.StringEvent ;
     var e:StringEvent = new StringEvent("change", "hello world") ;
     trace( e.string ) ; // hello world
     



Public Properties
 PropertyDefined By
 Inheritedcontext : *
Determinates the optional context of this event.
BasicEvent
  string : String
Determinates the String value of this custom event.
StringEvent
 Inheritedtarget : Object
[override] Indicates the custom event target.
BasicEvent
 InheritedtimeStamp : uint
[read-only] Indicates the timestamp of the event.
BasicEvent
 Inheritedtype : String
[override] Returns the type of event.
BasicEvent
Public Methods
 MethodDefined By
  
StringEvent(type:String, str:String = null, target:Object = null, context:* = null, bubbles:Boolean = false, cancelable:Boolean = false, time:Number = 0)
Creates a new StringEvent instance.
StringEvent
  
clone():Event
[override] Returns the shallow copy of this event.
StringEvent
 Inherited
dispatch(channel:String = null):void
Dispatch the event with the global event flow.
BasicEvent
 Inherited
toString():String
[override] Returns the string representation of this event.
BasicEvent
Protected Methods
 MethodDefined By
 Inherited
setTimeStamp(time:uint = 0):void
Sets the timestamp of the event (used this method only in internal in the Event class).
BasicEvent
Property Detail
stringproperty
string:String

Determinates the String value of this custom event.


Implementation
    public function get string():String
    public function set string(value:String):void
Constructor Detail
StringEvent()Constructor
public function StringEvent(type:String, str:String = null, target:Object = null, context:* = null, bubbles:Boolean = false, cancelable:Boolean = false, time:Number = 0)

Creates a new StringEvent instance.

Parameters
type:String — the string type of the instance. 
 
str:String (default = null) — the String value of this event.
 
target:Object (default = null) — the target of the event.
 
context:* (default = null) — the optional context object of the event.
 
bubbles:Boolean (default = false) — indicates if the event is a bubbling event.
 
cancelable:Boolean (default = false) — indicates if the event is a cancelable event.
 
time:Number (default = 0) — this optional parameter is used in the eden deserialization to copy the timestamp value of this event.
Method Detail
clone()method
override public function clone():Event

Returns the shallow copy of this event.

Returns
Event — the shallow copy of this event.