org.silex.core.Api

This class handle the loading process and has references to singletons.  In the repository : /trunk/core/Api.as

Version

1

Author

Alexandre Hoyau

Summary
org.silex.core.ApiThis class handle the loading process and has references to singletons.
Variables
isSilexServertrue only if you use the whole SILEX server framework (Wysiwyg etc)
parentThe object which contains the api singleton.
configDynamic object which contains all the constants localized or configuration.
constantsStatic object.
authenticationReference to the Authentication singleton.
interpreterReference to the Interpreter singleton.
filterReference to the Filter singleton.
applicationReference to the Application singleton.
sequencerReference to the Sequencer singleton.
comReference to the Com singleton.
deeplinkReference to the Deeplink singleton.
dynDataManagerReference to the DynDataManager singleton.
utilsReference to the Utils singleton.
xmlDomReference to the XmlDom singleton.
toolsManagerReference to the ToolsManager singleton.
Properties
rootUrlRoot url of the application (read only).
Functions
main
ApiConstructor.
getSilexV1method referenced by _global.getSilex()<br/> will return this
getConfigDataCalled when a property of config object is requested.
globalContextChangeCallback function called when the global context of the website changes.

Variables

isSilexServer

var isSilexServer: Boolean

true only if you use the whole SILEX server framework (Wysiwyg etc)

parent

var parent: MovieClip

The object which contains the api singleton.  It is the root of the silex server if isSilexServer is true.

config

var config: Object

Dynamic object which contains all the constants localized or configuration.  If a variable is called on this object and does not exist, SILEX try to find the variable in the constants object before returning null.  This is the process used to override the constants values.

constants

var constants: org.silex.core.Constants

Static object.  Contains the default - hard coded, constant values.

authentication

var authentication: org.silex.core.Authentication

Reference to the Authentication singleton.

See Also

Authentication

interpreter

var interpreter: org.silex.core.Interpreter

Reference to the Interpreter singleton.

See Also

Interpreter

filter

var filter: org.silex.core.Filter

Reference to the Filter singleton.

See Also

Filter

application

var application: org.silex.core.Application

Reference to the Application singleton.

See Also

Application

sequencer

var sequencer: org.silex.core.Sequencer

Reference to the Sequencer singleton.

See Also

Sequencer

com

var com: org.silex.core.Com

Reference to the Com singleton.

See Also

Com

deeplink

var deeplink: org.silex.core.Deeplink

Reference to the Deeplink singleton.

See Also

Deeplink

dynDataManager

var dynDataManager: org.silex.core.DynDataManager

Reference to the DynDataManager singleton.

See Also

DynDataManager

utils

var utils: org.silex.core.Utils

Reference to the Utils singleton.

See Also

Utils

xmlDom

var xmlDom: org.silex.core.XmlDom

Reference to the XmlDom singleton.

See Also

XmlDom

toolsManager

var toolsManager: org.silex.ui.ToolsManager

Reference to the ToolsManager singleton.

See Also

ToolsManager

Properties

rootUrl

function get rootUrl():String

Root url of the application (read only).

Functions

main

static function main(mc)

Api

function Api(apiContainer_mc: MovieClip,
argIsSilexServer: Boolean)

Constructor.  Initialize all the framework’s classes.  Start the loading process (config, preload, layout, xml, ...).

getSilexV1

function getSilexV1(target_mc: MovieClip)

method referenced by _global.getSilex()<br/> will return this

getConfigData

function getConfigData(name_str: String):Object

Called when a property of config object is requested.  Returns the corresponding property of _root (passed to flash by javascript).  If it is undefined, then look in the constants.

Parameters

param name_str the name of the constant or config variable to retrieve

Returns

the value of the desired constant or config variable

globalContextChange

function globalContextChange(prop,
oldVal,
newVal)

Callback function called when the global context of the website changes.  Causes all layers to refresh.

Parameters

param oldVal old value of the context
param newVal new value of the context
var isSilexServer: Boolean
true only if you use the whole SILEX server framework (Wysiwyg etc)
var parent: MovieClip
The object which contains the api singleton.
var config: Object
Dynamic object which contains all the constants localized or configuration.
var constants: org.silex.core.Constants
Static object.
var authentication: org.silex.core.Authentication
Reference to the Authentication singleton.
var interpreter: org.silex.core.Interpreter
Reference to the Interpreter singleton.
var filter: org.silex.core.Filter
Reference to the Filter singleton.
var application: org.silex.core.Application
Reference to the Application singleton.
var sequencer: org.silex.core.Sequencer
Reference to the Sequencer singleton.
var com: org.silex.core.Com
Reference to the Com singleton.
var deeplink: org.silex.core.Deeplink
Reference to the Deeplink singleton.
var dynDataManager: org.silex.core.DynDataManager
Reference to the DynDataManager singleton.
var utils: org.silex.core.Utils
Reference to the Utils singleton.
var xmlDom: org.silex.core.XmlDom
Reference to the XmlDom singleton.
var toolsManager: org.silex.ui.ToolsManager
Reference to the ToolsManager singleton.
function get rootUrl():String
Root url of the application (read only).
static function main(mc)
function Api(apiContainer_mc: MovieClip,
argIsSilexServer: Boolean)
Constructor.
function getSilexV1(target_mc: MovieClip)
method referenced by _global.getSilex()<br/> will return this
function getConfigData(name_str: String):Object
Called when a property of config object is requested.
function globalContextChange(prop,
oldVal,
newVal)
Callback function called when the global context of the website changes.
This class is used to authenticate users it uses amfphp in the repository : /trunk/core/Authentication.as
This class is used to execute SILEX commands.
This class is used to filter SILEX accessors.
Sequencer class is a sequencer for SILEX sequences.
This class is the communication unit of SILEX : communication with php, javascript, mySql.
This class handles the deeplinks : when to change the deeplink through javascript and when to open pages corresponding to the html deeplink value.
This class does all the work of saving/reading sections data in/from db.
In Utils class we put all the usefull functions used to deal with medias and standard user interactions.
XmlDom class deals with xml files.