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

The StringEvent to dispatch an event with a String object.


Public Properties
 PropertyDefined by
 Inheritedcontext : *
Returns the optional context of this event.
BasicEvent
 Inheritedtarget : Object
Returns the event target.
BasicEvent
 InheritedtimeStamp : Number
Returns the timestamp of the event.
BasicEvent
 Inheritedtype : String
Returns the type of event.
BasicEvent
Public Methods
 MethodDefined by
  
StringEvent(type:String, s:String = "", target:Object = null, context:Boolean = null, bubbles:Boolean = false, cancelable:Number = false, time:* = 0)
Creates a new StringEvent instance.
StringEvent
  
clone():Event
Returns the shallow copy of this event.
StringEvent
 Inherited
dispatch(channel:String = null):void
Dispatch the event with the global event flow.
BasicEvent
 Inherited
getContext():*
Returns the optional context of this event.
BasicEvent
  
getString():String
Returns the String value.
StringEvent
 Inherited
getTarget():Object
Returns the event target.
BasicEvent
 Inherited
getTimeStamp():Number
Returns the timestamp of the event.
BasicEvent
 Inherited
getType():String
Returns the type of event.
BasicEvent
 Inherited
setContext(context:*):void
Sets the optional context object of this event.
BasicEvent
  
setString(s:String):void
Sets the String value.
StringEvent
 Inherited
setTarget(target:Object):void
Sets the event target.
BasicEvent
 Inherited
setType(type:String):void
Sets the event type of this event.
BasicEvent
 Inherited
toString():String
Returns the string representation of this event.
BasicEvent
Protected Methods
 MethodDefined by
 Inherited
setTimeStamp(time:Number):void
Sets the timestamp of the event (used this method only in internal in the Event class).
BasicEvent
Constructor detail
StringEvent()constructor
public function StringEvent(type:String, s:String = "", target:Object = null, context:Boolean = null, bubbles:Boolean = false, cancelable:Number = false, time:* = 0)

Creates a new StringEvent instance.

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

Returns the shallow copy of this event.

Returns
Event — the shallow copy of this event.
getString()method 
public function getString():String

Returns the String value.

Returns
String — the String value.
setString()method 
public function setString(s:String):void

Sets the String value.

Parameters
s:String