Sandbox Builder, associate plugins to define the different parts of the API
This is the default builder used in Core Module to create a new instance of the Sandbox for a new module. It loads all plugins defined in the framework in the namespace lb.core.plugins.
The default Sandbox Builder is intended to be replaced with a custom builder to add methods to the Sandbox API or replace methods to implement a different behavior.
A custom builder is an object with a method buildSandbox(id) which returns a new instance of the Sandbox.
The custom builder can be configured by calling setOptions on the application core:
lb.core.application.setOptions({ lbBuilder: your.customBuilder })To develop your own custom builder, you can start by creating a new module as a closure assigned to your own namespace. You can then define the method buildSandbox(id), calling the same method in the default Sandbox Builder and returning the resulting Sandbox. You may now customize the Sandbox instance returned by the default Sandbox Builder before returning it.
The default Sandbox Builder uses plugins, located in lb.core.plugins, to customize the bare instance of Sandbox resulting from a call to the Sandbox constructor. A plugin is a function which takes the sandbox as parameter and customizes it by adding, removing, or replacing methods. Each plugin defined in lb.core.plugins adds methods to the Sandbox grouped in a property named after the plugin, e.g. sandbox.css for the plugin lb.core.plugins.css.
Eric Bréchemier © 2011, Some Rights Reserved Legal-Box SAS © 2010-2011, All Rights Reserved
BSD License http://creativecommons.org/licenses/BSD/
2011-08-14
| lb. | Sandbox Builder, associate plugins to define the different parts of the API |
| Functions | |
| buildSandbox(id) | Build a new instance of Sandbox from parts defined by plugins. |
Build a new instance of Sandbox from parts defined by plugins.
| id | string, the identifier of the module for whom the Sandbox instance is intended. |
The module identifier may be used to customize the Sandbox methods included, e.g. to restrict usage of AJAX methods to a specific Data module, or to provide DOM manipulation methods only to User Interface modules and not to Data modules. There is no such customization done in the default Sandbox Builder, which always returns similar instances of Sandbox with the same set of methods.