Class Index | File Index

Classes


Class Alfresco.PeopleFinder

Extends Alfresco.component.Base
PeopleFinder component.
Constructor Summary
Constructor Attributes Constructor Name and Description
 
PeopleFinder constructor.
Field Summary
Field Attributes Field Name and Description
 
Map of the users the current user is following
 
Keeps track if this component is searching or not
 
Users for whom the action is not allowed
 
Object container for initialization options
 
Current search term, obtained from form input field.
 
Selected users. Keeps a list of selected users for correct Add button state.
 
Single selected user, for when in single select mode
 
Object container for storing YUI button instances, indexed by username.
Fields borrowed from class Alfresco.component.Base:
modules, services, widgets
Method Summary
Method Attributes Method Name and Description
 
Public function to clear the results DataTable
 
onPersonDeselected(layer, args)
Person Deselected event handler
 
onPersonFollow(e, p_obj)
Follow person button click handler
 
onPersonSelect(e, p_obj)
Select person button click handler
 
onPersonSelected(layer, args)
Person Selected event handler
 
onPersonUnfollow(e, p_obj)
Unfollow person button click handler
 
Fired by YUI when parent element is available for scripting.
 
onSearchClick(e, p_obj)
Search button click event handler
Methods borrowed from class Alfresco.component.Base:
attachLinkClickListeners, bind, createYUIButtons, destroy, fire, invokeAction, msg, onComponentLoaded, onComponentsLoaded, onReadyWrapper, refresh, setMessages, setOptions
Constructor Detail
Alfresco.PeopleFinder(htmlId)
PeopleFinder constructor.
Parameters:
{String} htmlId
The HTML id of the parent element
Returns:
{Alfresco.PeopleFinder} The new PeopleFinder instance
Field Detail
{object} following
Map of the users the current user is following

{Boolean} isSearching
Keeps track if this component is searching or not

{array} notAllowed
Users for whom the action is not allowed

{object} options
Object container for initialization options

{string} searchTerm
Current search term, obtained from form input field.

{object} selectedUsers
Selected users. Keeps a list of selected users for correct Add button state.

{string} singleSelectedUser
Single selected user, for when in single select mode

{object} userSelectButtons
Object container for storing YUI button instances, indexed by username.
Method Detail
clearResults()
Public function to clear the results DataTable

onPersonDeselected(layer, args)
Person Deselected event handler
Parameters:
{object} layer
Event fired
{array} args
Event parameters (depends on event type)

onPersonFollow(e, p_obj)
Follow person button click handler
Parameters:
{object} e
DomEvent
{object} p_obj
Object passed back from addListener method

onPersonSelect(e, p_obj)
Select person button click handler
Parameters:
{object} e
DomEvent
{object} p_obj
Object passed back from addListener method

onPersonSelected(layer, args)
Person Selected event handler
Parameters:
{object} layer
Event fired
{array} args
Event parameters (depends on event type)

onPersonUnfollow(e, p_obj)
Unfollow person 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.
Component initialisation, including instantiation of YUI widgets and event listener binding.

onSearchClick(e, p_obj)
Search button click event handler
Parameters:
{object} e
DomEvent
{object} p_obj
Object passed back from addListener method

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