Class Index | File Index

Classes


Class Alfresco.InvitationList

Extends Alfresco.component.Base
InvitationList component.
Defined in: invitationlist.js
Constructor Summary
Constructor Attributes Constructor Name and Description
 
InvitationList constructor.
Field Summary
Field Attributes Field Name and Description
 
Object container for storing YUI widget instances used in the list cells
 
Object container for initialization options
 
Auto-incremented unique id for each element added to the table.
Fields borrowed from class Alfresco.component.Base:
modules, services, widgets
Method Summary
Method Attributes Method Name and Description
 
getRoleLabel(record)
Returns the role label for a given record.
 
Event handler for "Invite" button click. Initiates the invite process
 
onPersonSelected(layer, args)
Event handler for "personSelected" bubbling event.
 
Fired by YUI when parent element is available for scripting.
 
onRoleSelect(sType, aArgs, p_obj)
Called when the user select a role in the role dropdown
 
onSelectAllRoles(sType, aArgs, p_obj)
Select all roles dropdown event handler
 
Remove invitee action handler
Methods borrowed from class Alfresco.component.Base:
attachLinkClickListeners, bind, createYUIButtons, destroy, fire, invokeAction, msg, onComponentLoaded, onComponentsLoaded, onReadyWrapper, refresh, setMessages, setOptions
Constructor Detail
Alfresco.InvitationList(htmlId)
InvitationList constructor.
Parameters:
{String} htmlId
The HTML id of the parent element
Returns:
{Alfresco.InvitationList} The new InvitationList instance
Field Detail
{Array} listWidgets
Object container for storing YUI widget instances used in the list cells

{object} options
Object container for initialization options

{integer} uniqueRecordId
Auto-incremented unique id for each element added to the table.
Method Detail
getRoleLabel(record)
Returns the role label for a given record.
Parameters:
record
{YAHOO.widget.Record} YUI DataTable record

inviteButtonClick(e)
Event handler for "Invite" button click. Initiates the invite process
Parameters:
{Object} e
Event arguments

onPersonSelected(layer, args)
Event handler for "personSelected" bubbling event.
Adds a person to the list.
Parameters:
{object} layer
Event fired
{array} args
Event parameters (depends on event type)

onReady()
Fired by YUI when parent element is available for scripting.
Component initialisation, including instantiation of YUI widgets and event listener binding.

onRoleSelect(sType, aArgs, p_obj)
Called when the user select a role in the role dropdown
Parameters:
{String} sType
event type
{Array} aArgs
event arguments
{Object} p_obj
object containing record and role to set

onSelectAllRoles(sType, aArgs, p_obj)
Select all roles dropdown event handler
Parameters:
{String} sType
event type
{Array} aArgs
event arguments
{Object} p_obj
object containing record and role to set

removeInvitee(row)
Remove invitee action handler
Parameters:
{HTMLElement} row
DOM reference to a TR element (or child thereof)

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