Class Alfresco.util.ComponentManager
Keeps track of Alfresco components on a page. Components should register() upon creation to be compliant.
Defined in: alfresco.js
| Field Attributes | Field Name and Description |
|---|---|
| <inner> |
Array of registered components.
|
| Method Attributes | Method Name and Description |
|---|---|
| <static> |
Alfresco.util.ComponentManager.find(p_oParams)
Allows components to find other registered components by name, id or both
|
| <static> |
Alfresco.util.ComponentManager.findFirst(p_sName)
Allows components to find first registered components by name only
|
| <static> |
Alfresco.util.ComponentManager.get(p_sId)
Get component by Id
|
| <static> |
Alfresco.util.ComponentManager.list()
List all registered components
|
| <static> |
Alfresco.util.ComponentManager.register(p_aComponent)
Main entrypoint for components wishing to register themselves with the ComponentManager
|
| <static> |
Alfresco.util.ComponentManager.reregister(p_aComponent)
Re-register a component with the ComponentManager
|
| <static> |
Alfresco.util.ComponentManager.unregister(p_aComponent)
Unregister a component from the ComponentManager
|
Field Detail
<inner>
{Array}
components
Array of registered components.
Method Detail
<static>
{Array}
Alfresco.util.ComponentManager.find(p_oParams)
Allows components to find other registered components by name, id or both
e.g. find({name: "Alfresco.DocumentLibrary"})
e.g. find({name: "Alfresco.DocumentLibrary"})
- Parameters:
- {object} p_oParams
- List of paramters to search by
- Returns:
- {Array} Array of components found in the search
<static>
{object|null}
Alfresco.util.ComponentManager.findFirst(p_sName)
Allows components to find first registered components by name only
e.g. findFirst("Alfresco.DocumentLibrary")
e.g. findFirst("Alfresco.DocumentLibrary")
- Parameters:
- {string} p_sName
- Name of registered component to search on
- Returns:
- {object|null} Component found in the search
<static>
{object|null}
Alfresco.util.ComponentManager.get(p_sId)
Get component by Id
e.g. get("global_x002e_header-sites-menu")
e.g. get("global_x002e_header-sites-menu")
- Parameters:
- {string} p_sId
- Id of registered component to return
- Returns:
- {object|null} Component with given Id
<static>
{array}
Alfresco.util.ComponentManager.list()
List all registered components
- Returns:
- {array} array of components
<static>
Alfresco.util.ComponentManager.register(p_aComponent)
Main entrypoint for components wishing to register themselves with the ComponentManager
- Parameters:
- {object} p_aComponent
- Component instance to be registered
<static>
Alfresco.util.ComponentManager.reregister(p_aComponent)
Re-register a component with the ComponentManager
Component ID cannot be updated via this function, use separate unregister(), register() calls instead.
Component ID cannot be updated via this function, use separate unregister(), register() calls instead.
- Parameters:
- {object} p_aComponent
- Component instance to be unregistered, then registered again
<static>
Alfresco.util.ComponentManager.unregister(p_aComponent)
Unregister a component from the ComponentManager
- Parameters:
- {object} p_aComponent
- Component instance to be unregistered