Class Index | File Index

Classes


Class Alfresco.component.Base

Defined in: alfresco.js
Constructor Summary
Constructor Attributes Constructor Name and Description
 
Alfresco.component.Base(name, id, components)
Alfresco.component.Base constructor.
Field Summary
Field Attributes Field Name and Description
 
Object container for storing module instances.
 
Object container for initialization options
 
Object container for storing service instances.
 
Object container for storing YUI widget instances.
Method Summary
Method Attributes Method Name and Description
 
bind(method)
Asserts a method always is called with this component's scope
 
msg(messageId)
Gets a custom message
 
Fired by YUILoaderHelper when required component script files have
 
Set messages for this component.
 
Set multiple initialization options at once.
Constructor Detail
Alfresco.component.Base(name, id, components)
Alfresco.component.Base constructor.
Parameters:
{String} name
The name of the component
{String} id
he DOM ID of the parent element
{Array} components
Optional: Array of required YAHOO
Returns:
{object} The new instance
Field Detail
{object} modules
Object container for storing module instances.
Default Value:
null

{object} options
Object container for initialization options

{object} services
Object container for storing service instances.

{object} widgets
Object container for storing YUI widget instances.
Default Value:
null
Method Detail
{function} bind(method)
Asserts a method always is called with this component's scope
Parameters:
{function} method
The function to bind to the scope of this component
Returns:
{function} The function bound to a different scope

{string} msg(messageId)
Gets a custom message
Parameters:
{string} messageId
The messageId to retrieve
Returns:
{string} The custom message

onComponentsLoaded()
Fired by YUILoaderHelper when required component script files have
been loaded into the browser.

{object} setMessages(obj)
Set messages for this component.
Parameters:
{object} obj
Object literal specifying a set of messages
Returns:
{object} returns 'this' for method chaining

{object} setOptions(obj)
Set multiple initialization options at once.
Parameters:
{object} obj
Object literal specifying a set of options
Returns:
{object} returns 'this' for method chaining

Documentation generated by JsDoc Toolkit 2.4.0 on Fri Oct 14 2011 12:53:45 GMT+0100 (BST)