Class Index | File Index

Classes


Class Alfresco.component.DataLists

Extends Alfresco.component.Base
Data Lists: DataLists component.

Displays a list of datalists
Defined in: datalists.js
Constructor Summary
Constructor Attributes Constructor Name and Description
 
DataLists constructor.
Field Summary
Field Attributes Field Name and Description
 
NodeRef of the Data Lists container retrieved from the Repository
 
Data Lists metadata retrieved from the Repository
 
Number of data lists in the Repository
 
List title look-up from listType
 
Object container for initialization options
Fields borrowed from class Alfresco.component.Base:
modules, services, widgets
Method Summary
Method Attributes Method Name and Description
 
getListTypeTitle(listType)
Look-up a list title from it's type
 
onDataListCreated(layer, args)
Data List created event handler
 
Data List modified event handler
 
onDeleteList(listName)
Delete List event handler
 
onEditList(listName)
Edit List event handler
 
onNewList(e, p_obj)
New List button click handler
 
Fired by YUI when parent element is available for scripting.
 
Retrieves the Data Lists from the Repo
 
renderDataLists(highlightName)
Renders the Data Lists into the DOM
Methods borrowed from class Alfresco.component.Base:
attachLinkClickListeners, bind, createYUIButtons, destroy, fire, invokeAction, msg, onComponentLoaded, onComponentsLoaded, onReadyWrapper, refresh, setMessages, setOptions
Constructor Detail
Alfresco.component.DataLists(htmlId)
DataLists constructor.
Parameters:
{String} htmlId
The HTML id of the parent element
Returns:
{Alfresco.component.DataLists} The new DataLists instance
Field Detail
{Object} containerNodeRef
NodeRef of the Data Lists container retrieved from the Repository

{Object} dataLists
Data Lists metadata retrieved from the Repository

{Object} dataListsLength
Number of data lists in the Repository

{Object} listTypeTitles
List title look-up from listType

{object} options
Object container for initialization options
Method Detail
{string} getListTypeTitle(listType)
Look-up a list title from it's type
Parameters:
{string} listType
List type
Returns:
{string} List type title

onDataListCreated(layer, args)
Data List created event handler
Parameters:
{object} layer
Event fired (unused)
{array} args
Event parameters (unused)

onDataListDetailsUpdated(layer, args)
Data List modified event handler
Parameters:
{object} layer
Event fired (unused)
{array} args
Event parameters (unused)

onDeleteList(listName)
Delete List event handler
Parameters:
{string} listName
Name of the list to edit

onEditList(listName)
Edit List event handler
Parameters:
{string} listName
Name of the list to edit

onNewList(e, p_obj)
New List button click handler
Parameters:
{object} e
DomEvent
{object} p_obj
Object passed back from addListener method

onReady()
Fired by YUI when parent element is available for scripting.

populateDataLists(callback)
Retrieves the Data Lists from the Repo
Parameters:
{Object} callback
Optional callback literal {fn, scope, obj} whose function is invoked once list has been retrieved

renderDataLists(highlightName)
Renders the Data Lists into the DOM
Parameters:
{String} highlightName
Optional name of list to highlight after rendering

Documentation generated by JsDoc Toolkit 2.4.0 on Thu Feb 16 2012 12:24:24 GMT-0000 (GMT)