Packagecom.soma.events
Classpublic class SomaEvent
InheritanceSomaEvent Inheritance CairngormEvent Inheritance flash.events.Event

Author: Romuald Quantin - www.soundstep.com

Information:
Blog page - SomaUI
How does it work - Soma Protest
Project Host - Google Code
Documentation - Soma ASDOC
Class version: 2.0
Actionscript version: 3.0

Copyright:

The contents of this file are subject to the Mozilla Public License
Version 1.1 (the "License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at

http://www.mozilla.org/MPL/

Software distributed under the License is distributed on an "AS IS" basis,
WITHOUT WARRANTY OF ANY KIND, either express or implied.
See the License for the specific language governing rights and
limitations under the License.

The Original Code is Soma.
The Initial Developer of the Original Code is Romuald Quantin.
Initial Developer are Copyright (C) 2008-2009 Soundstep. All Rights Reserved.

Usage:
Framework events dispatched through a single dispatcher.

Soma.getInstance().addEventListener(SomaEvent.LANGUAGE_CHANGED, eventHandler);
Soma.getInstance().addEventListener(SomaEvent.INITIALIZED, eventHandler);
     

See also

Soma


Public Properties
 PropertyDefined by
 Inheriteddata : *
The data property can be used to hold information to be passed with the event in cases where the developer does not want to extend the CairngormEvent class.
CairngormEvent
Public Methods
 MethodDefined by
  
SomaEvent(type:String, bubbles:Boolean = true, cancelable:Boolean = false)
Creates a SomaEvent instance.
SomaEvent
  
clone():Event
Duplicates an instance of an Event subclass.

Returns a new Event object that is a copy of the original instance of the Event object.
SomaEvent
  
dispatch():Boolean
Dispatch this event via the Cairngorm event dispatcher.
SomaEvent
  
toString():String
Returns a formatted string to display event information.
SomaEvent
Public Constants
 ConstantDefined by
  INITIALIZED : String = "com.soma.events.SomaEvent.INITIALIZED"
[static] Indicates when Soma has been fully initialized (this event will be triggered after the ContentEvent.LOADED).

Soma.getInstance().addEventListener(SomaEvent.INITIALIZED, eventHandler);
SomaEvent
  LANGUAGE_CHANGED : String = "com.soma.events.SomaEvent.LANGUAGE_CHANGED"
[static] Indicates when the Soma language URL string has been changed (see Soma class for more information).

Soma.getInstance().addEventListener(SomaEvent.LANGUAGE_CHANGED, eventHandler);
SomaEvent
Constructor detail
SomaEvent()constructor
public function SomaEvent(type:String, bubbles:Boolean = true, cancelable:Boolean = false)

Creates a SomaEvent instance.

Parameters
type:String — The type of the event, accessible as SomaEvent.type.
 
bubbles:Boolean (default = true) — Determines whether the Event object participates in the bubbling stage of the event flow. The default value is false.
 
cancelable:Boolean (default = false) — Determines whether the Event object can be canceled. The default values is false.
Method detail
clone()method
public override function clone():Event

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.

Returns
Event — A new Event object that is identical to the original.
dispatch()method 
public override function dispatch():Boolean

Dispatch this event via the Cairngorm event dispatcher.

Returns
Boolean
toString()method 
public override function toString():String

Returns a formatted string to display event information.

Returns
String — A String.
Constant detail
INITIALIZEDconstant
public static const INITIALIZED:String = "com.soma.events.SomaEvent.INITIALIZED"

Indicates when Soma has been fully initialized (this event will be triggered after the ContentEvent.LOADED).

Soma.getInstance().addEventListener(SomaEvent.INITIALIZED, eventHandler);

LANGUAGE_CHANGEDconstant 
public static const LANGUAGE_CHANGED:String = "com.soma.events.SomaEvent.LANGUAGE_CHANGED"

Indicates when the Soma language URL string has been changed (see Soma class for more information).

Soma.getInstance().addEventListener(SomaEvent.LANGUAGE_CHANGED, eventHandler);