API Docs for: 0.0.2
Show:

ObjectFactory Class

Defined in: api/src/object-factory.js:1
Module: ludo

Internal class designed to create ludoJS class instances. The global ludo.factory is an instance of this class

Methods

create

(
  • config
)
ludo.Core

Defined in api/src/object-factory.js:10

Creates an instance of a class by "type" attribute

Parameters:

Returns:

ludo.Core: object

ludo.factory.createNamespace

(
  • ns
)

Defined in api/src/object-factory.js:64

Method used to create global name space for your web applications. This methods makes ludoJS aware of the namespace and register a global variable window[ns] for it if it does not exists. It makes it possible for ludoJS to find classes by type attribute.

Parameters:

Example:

ludo.factory.createNamespace('MyApp');
...
...
MyApp.MyClass = new Class({
    Extends: ludo.View,
        type : 'MyApp.MyClass'
});

var view = new ludo.View({
    children:[{
        type : 'MyApp.MyClass'
        }]
});

Notice that "Namespace" is used as prefix in type attribute in the last snippet. For standard ludoJS components, you could write type:"View". For views in your namespaces, you should always use the syntax "Namespace.ClassName"

registerClass

(
  • typeName
  • classReference
)

Defined in api/src/object-factory.js:33

Register a class for quick lookup. First argument is the value of the type attribute you want to support. It is not required to call this for each class you create. The alternative is to register a namespace by calling ludo.factory.registerNamespace('MyApp'). However, if you have a lot of classes, it will increase performance by registering your classes. ludoJS will then know it instantly and doesn't have to traverse the name space tree to find it.

Parameters:

  • typeName String
  • classReference ludo.Core

Example:

    ludo.factory.createNamespace('MyApp');
MyApp.MyView = new Class({
    Extends: ludo.View,
    type: 'MyApp.MyView'
});
ludo.factory.register('MyApp.MyView', MyApp.MyView);
    ...
...
new ludo.View({
    ...
    children:[{
        type:'MyApp.MyView' // ludoJS now knows how to find this class
        }]
    });