Get the background manager (containing the background container and the backgrounds).

   Soma.getInstance().background.container // access to container of the backgrounds
   Soma.getInstance().background.currentBackground // access to currently displayed background
   

Get the base manager library. The Base is a Sprite layer between the backgrounds Sprite layer and the site container layer and is meant to easily add DisplayObject (even from the XML) that are always on the screen (such as a logo).

   Soma.getInstance().base.container; // access to the container of the Base layer
   Soma.getInstance().base.getElementByID("my asset") // access to a Base DisplayObject (instantiated from the XML or by code).
   

Get the global BaseUI instance (used for loading class if centered and the layout if set to fixed).

Return the global ClassImport instance (use Soma.getInstance().registerClass and Soma.getInstance().getClass).

Get the config file.

   Soma.getInstance().config.siteName(); // access to the site name
   MyConfig(Soma.getInstance().config).myConfigMethod(); // access to a specific user method
   

Get the main container of the site (contains pages, menu and loading);

Get the content manager (containing the XML Site Definition).

   Soma.getInstance().content.data // access to the XML Site Definition
   

Current language String (example: "en") set using Soma.getInstance().initLanguage(true, "en");

static global value whether or not the user loading display (super class: com.soma.view.Loading, interface: com.soma.loader.ILoading) of the main global loader (Soma.getInstance().loader) will be centered in the layout (default true). It must be changed before starting Soma, if the value is true, the loading display class will be added to the global baseUI instance (Soma.getInstance().baseUI).

Whether or not Soma is initialized.

Whether or not the language is enabled.

Get the global library. It contains special assets registered by the framework such as SomaText, SomaVideo, ... and used by a NodeParser instance to dynamically instantiate assets from the XML Site Definition.

   Soma.getInstance().library.registerAsset("myAsset", "com.mypackage.MyAssetClass"); // register a custom asset class
   <myAsset id="myAssetID" x="10" y="10" /> // use of a registered custom asset in the XML Site Definition
   

Get the global loader (used to load the stylesheet, the XML Site Definition and the assets in the pages).

   var itemloaded:Dictionary = Soma.getInstance().loader.getLoadedItems(); // access to a list of items previously loaded
   Soma.getInstance().loader.add("image.jpg"); // add an image to load in the global loader
   Soma.getInstance().loader.start(); // start to load
   

Get the menu manager (containing the global menu if used).

   Soma.getInstance().menu.getMenu(Soma.getInstance().config.menuClassName) // access to the global menu
   

Get the page manager (containing the page container and the pages).

   Soma.getInstance().page.currentPage // access to the current page
   

Get the reference of the global BaseUI instance, the reference is the main container if the layout is set to fixed or the stage if the layout is set to liquid.

Get the style manager (containing stylesheets loaded).

   Soma.getInstance().style.loadStyleSheet("myStylesheet", "myNewStyleSheet.css"); // load a stylesheet
   Soma.getInstance().style.getStyleSheet("myStylesheet"); // get a stylesheet
   Soma.getInstance().style.getGlobalStyle("myStyle"); // get a style from the global stylesheet
   

Get the main document class registered when Soma starts, usually Sprite or MovieClip. To access to your own Document class methods and property you can cast to your own class: MyMainClass(Soma.getInstance().ui).myMethod()

Soma is an extendable Singleton, use Soma.getInstance(). See the Soma Protest source code for an example to extend Soma and alter the initializing/starting process.

Get a Class registered using the method Soma.getInstance().registerClass.

   var MyClassType:Class = Soma.getInstance().getClass("MyClass");
   

Soma is an extendable Singleton, getInstance() is returning the Soma instance to access to the framework and its components.

Get a model instance from Soma (managers).

   // access to the background manager (equals to Soma.getInstance().background);
   var background:BackgroundManager = Soma.getInstance().getModel(Soma.MODEL_BACKGROUND) as BackgroundManager;
   

Initialize a String language (the current language when Soma starts) to be used in the deep-linking URL with SWFAddress.
It must be used before starting Soma and it will prepend the value before the URL, example: mysite.com/#/home will become mysite.com/#/en/home.
The value can be changed at run-time using Soma.getInstance().currentLanguage and will dispatch a SomaEvent.LANGUAGE_CHANGED event through the framework.

   Soma.getInstance().initLanguage(true, "en");
   Soma.getInstance().addEventListener(SomaEvent.LANGUAGE_CHANGED, languageHandler);
   Soma.getInstance().currentLanguage = "de";
   

Register a Class with the ClassImport instance to force its import by the compiler (useful with getDefinitionByName). You can get the class using the method Soma.getInstance().getClass.

   Soma.getInstance().registerClass(MyClass);
   

Register the URL of a global stylesheet (css) to load at the initialization process. Soma will load the stylesheet (before the XML) and dispatch a StyleSheetEvent.LOADED event.

Soma.getInstance().registerGloBalStyleSheet("css/styles.css");
Soma.getInstance().addEventListener(StyleSheetEvent.LOADED, stylesheetHandler);
Soma.getInstance().start(this, "data/site.xml", new Config());

private function stylesheetHandler(e:StyleSheetEvent):void {
 trace(e.stylesheet);
 trace(Soma.getInstance().style.getStyleSheet(StyleManager.GLOBAL_STYLESHEET_ID));
}
      

Starts the Soma framework. The 3 parameters are required: the main document class, the URL of the XML Site definition describing the site structure and a Config file (interface: com.interface.IConfig) containing information needed by the framework.
Part 1: Soma starts, creates the containers and initializes the global managers (such as controller, loader, config, ...).
Part 2: Soma loads the XML Site definition (and stylesheet if set before starting).
Part 3: Soma initializes the managers that need the XML Site definition (such as menu, loading, pages, styles, ...).
Part 4: Soma dispatches a SomaEvent.INITIALIZED when done.

Soma.getInstance().addEventListener(SomaEvent.INITIALIZED, initialized);
Soma.getInstance().addEventListener(ContentEvent.LOADED, contentLoaded);
Soma.getInstance().registerGloBalStyleSheet("css/styles.css");
Soma.getInstance().start(this, "data/site.xml", new Config());

private function contentLoaded(e:ContentEvent = null):void {
    // xml and stylesheet have been loaded (components that don't require the XML Site Definition are initialized)
    trace(Soma.getInstance().container);
    trace(Soma.getInstance().content.data.toXMLString());
}

private function initialized(e:SomaEvent = null):void {
    // Soma is initialized
    trace(Soma.getInstance().page.currentPage);
}
      

Starts the Soma framework with an XML already loaded.

Soma.getInstance().start(this, myXMLSiteDefinition, new Config());

Indicates when an excluded page has been called.

See Soma Protest Page Excluded section.
Soma.getInstance().addEventListener(PageEvent.EXCLUDED, eventHandler);

See also

Indicates when a page that contains excluded page children has been called. See Soma Protest Page Excluded section.
Soma.getInstance().addEventListener(PageEvent.EXCLUDED_PARENT, eventHandler);

See also

Soma command to display a background using the id from the XML Site Definition, use from anywhere in the code:

The parameter should the ID of the background (id attribute in the XML Site Definition)

new BackgroundEvent(BackgroundEvent.HIDE, "myBackground").dispatch();

See also

Indicates when Soma has been initialized.

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

See also

Indicates the language (string in the URL) has been changed.

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

See also

Indicates when the XML Site Definition has been loaded.

Soma.getInstance().addEventListener(StyleSheetEvent.LOADED, eventHandler);

See also

Indicates when the XML Site Definition has been loaded.

Soma.getInstance().addEventListener(ContentEvent.LOADED, eventHandler);

See also

Soma command that will be received by the user's custom menu (IMenu) to update the state of this menu when a new page is about to be displayed.

This event is automatically dispatched by the PageManager instance in some case, such as a URL change (Soma.getInstance().page).

Can also be used as a command from anywhere in the code, the parameter should be the ID of the page (id attribute in the XML Site Definition):

new MenuEvent(MenuEvent.OPEN_MENU, "myID").dispatch();

See also

Soma command to display a page using the id from the XML Site Definition, use from anywhere in the code.

The parameter should the ID of the page (id attribute in the XML Site Definition)

new PageEvent(PageEvent.SHOW, "myPageID").dispatch();

See also

Soma command to display a background using the id from the XML Site Definition, use from anywhere in the code:

The parameter should the ID of the background (id attribute in the XML Site Definition)

new BackgroundEvent(BackgroundEvent.SHOW, "myBackground").dispatch();

See also

Soma command to open a new browser window in case the page in the XML Site Definition is an external link, example:

<page id="soundstep" externalLink="http://www.soundstep.com/">
<title><![CDATA[Soundstep]]></title>
</page>

This event can be automatically dispatched by the Singleton MenuContext (right-click menu).
Can also be used as a command from anywhere in the code:

new PageEvent(PageEvent.SHOW_EXTERNAL_LINK, null, "http://www.soundstep.com/").dispatch();
new PageEvent(PageEvent.SHOW_EXTERNAL_LINK, myPage.@id, myPage.@externalLink).dispatch();

See also

Indicates when a page is about to be instantiated by the PageManager instance (Soma.getInstance().page).

This event can be default prevented to stop the page manager to display and hide pages.

Soma.getInstance().addEventListener(PageEvent.STARTED, eventHandler);

See also

Indicates when a page has been instantiated and is about to be displayed.

Soma.getInstance().addEventListener(PageEvent.TRANSITION_IN, eventHandler);

See also

Indicates when a background is about to be displayed by the BackgroundManager instance (Soma.getInstance().background).

Soma.getInstance().addEventListener(BackgroundEvent.TRANSITION_IN, eventHandler);

See also

Indicates when a page has been displayed.

Soma.getInstance().addEventListener(PageEvent.TRANSITION_IN_COMPLETE, eventHandler);

See also

Indicates when a page is about to be hidden.

Soma.getInstance().addEventListener(PageEvent.TRANSITION_OUT, eventHandler);

See also

Indicates when a background is about to be hidden by the BackgroundManager instance (Soma.getInstance().background).

Soma.getInstance().addEventListener(BackgroundEvent.TRANSITION_OUT, eventHandler);

See also

Indicates when a page has been hidden.

Soma.getInstance().addEventListener(PageEvent.TRANSITION_OUT_COMPLETE, eventHandler);

See also

Indicates when the XML Site Definition has been updated.

Soma.getInstance().addEventListener(ContentEvent.UPDATED, eventHandler);

See also

Constant value used to defined that the layout of the site is a fixed user interface, the width and height are fixed values applied to the main container (Soma.getInstance().container). The values are set in the XML Site definition <site layout="fixed" width="800" height="600">.

Constant value used to defined that the layout of the site is a liquid user interface, the width and height of the main container is updated to fit the browser (Soma.getInstance().container). The values are set in the XML Site definition <site layout="liquid"> or <site>.

Constant value used to get a specific model class (manager) with the method getModel, example: Soma.getInstance().getModel(Soma.MODEL_BACKGROUND) equivalent to Soma.getInstance().background

Constant value used to get a specific model class (manager) with the method getModel, example: Soma.getInstance().getModel(Soma.MODEL_BASE) equivalent to Soma.getInstance().base

Constant value used to get a specific model class (manager) with the method getModel, example: Soma.getInstance().getModel(Soma.MODEL_BASEUI) equivalent to Soma.getInstance().baseUI

Constant value used to get a specific model class (manager) with the method getModel, example: Soma.getInstance().getModel(Soma.MODEL_CONFIG) equivalent to Soma.getInstance().config

Constant value used to get a specific model class (manager) with the method getModel, example: Soma.getInstance().getModel(Soma.MODEL_CONTENT) equivalent to Soma.getInstance().content

Constant value used to get a specific model class (manager) with the method getModel, example: Soma.getInstance().getModel(Soma.MODEL_LIBRARY) equivalent to Soma.getInstance().library

Constant value used to get a specific model class (manager) with the method getModel example: Soma.getInstance().getModel(Soma.MODEL_LOADER) equivalent to Soma.getInstance().loader

Constant value used to get a specific model class (manager) with the method getModel, example: Soma.getInstance().getModel(Soma.MODEL_MENU) equivalent to Soma.getInstance().menu

Constant value used to get a specific model class (manager) with the method getModel, example: Soma.getInstance().getModel(Soma.MODEL_PAGE) equivalent to Soma.getInstance().page

Constant value used to get a specific model class (manager) with the method getModel, example: Soma.getInstance().getModel(Soma.MODEL_STYLE) equivalent to Soma.getInstance().styles

Constant value of the Soma Version.