| Package | com.soma.interfaces |
| Interface | public interface IConfig |
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
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:
Soma needs a config file to start and initialize the structure, this config must implement IConfig.
You can start with the Soma Protest Config File as an example to build your own.
Method init
This method is called by Soma during the initialization process, you can initialize the required variables and your own variables.
Method get siteName
This method should return the name of you site, it will be used in the title of the Browser.
Method get landingPageID
This method should return the id attribute value of one of the XML page node, this page will be the first page instantiated by the PageManager (unless there the URL point to another page).
Method get loadingClassName
This method should return the class name of the loading display that will be used by the global SomaLoader instance (Soma.getInstance().loader).
The loading Class must be registered (example in the same config class: registerClass(BasicLoading)) to force its import.
An empty String can be returned in case you are not using any.
Method get menuClassName
This method should return the class name of the main menu that will be used by the framework (Soma.getInstance().menu).
The menu Class must be registered (example in the same config class: registerClass(BasicMenu)) to force its import.
An empty String can be returned in case you are not using any.
See also
| Property | Defined by | ||
|---|---|---|---|
| landingPageID : String [read-only]
Returns the id attribute of an XML page node, (landing page or default page instantiated by the PageManager).
| IConfig | ||
| loadingClassName : String [read-only]
Returns the default loading class name.
| IConfig | ||
| menuClassName : String [read-only]
Returns the main menu class name.
| IConfig | ||
| siteName : String [read-only]
Returns the site name.
| IConfig | ||
| Method | Defined by | ||
|---|---|---|---|
|
init():void
Initializes variables (is called by the Soma).
| IConfig | ||
| landingPageID | property |
landingPageID:String [read-only]Returns the id attribute of an XML page node, (landing page or default page instantiated by the PageManager).
Implementation public function get landingPageID():String
| loadingClassName | property |
loadingClassName:String [read-only]Returns the default loading class name.
Implementation public function get loadingClassName():String
| menuClassName | property |
menuClassName:String [read-only]Returns the main menu class name.
Implementation public function get menuClassName():String
| siteName | property |
siteName:String [read-only]Returns the site name.
Implementation public function get siteName():String
| init | () | method |
public function init():voidInitializes variables (is called by the Soma).