Class Alfresco.SiteFinder

Site Finder component.

Constructor Summary
Constructor Attributes	Constructor Name and Description
	Alfresco.SiteFinder(htmlId) SiteFinder constructor.

Field Summary
Field Attributes	Field Name and Description
	buttons List of Join/Leave buttons
	memberOfSites List of sites the current user is a member of
	membershipsRetrieved Flag to determine whether membership details have been
	options Object container for initialization options
	pendingInvites Provides easy look-up of pending invites for this user
	searchTerm Search term used for the site search.

Fields borrowed from class Alfresco.component.Base:: modules, services, widgets

Method Summary
Method Attributes	Method Name and Description
	doCancelRequest(event, site) Cancel Join Request event handler
	doDelete(event, site) Delete event handler
	doJoin(event, site) Join event handler
	doLeave(event, site) Leave event handler
	doRequestJoin(event, site) Request Join event handler
	doSearch() Search event handler
	onReady() Fired by YUI when parent element is available for scripting.
	onRowDeleteEvent(event) Fired by YUI:s DataTable when a row has been added to the data table list.
	onSiteDeleted(layer, args) Fired any another component, DeleteSite, to let other components know

Methods borrowed from class Alfresco.component.Base:: attachLinkClickListeners, bind, createYUIButtons, destroy, fire, invokeAction, msg, onComponentLoaded, onComponentsLoaded, onReadyWrapper, refresh, setMessages, setOptions

Constructor Detail

Alfresco.SiteFinder(htmlId)

SiteFinder constructor.

Parameters:
{String} htmlId: The HTML id of the parent element

Returns:: {Alfresco.SiteFinder} The new SiteFinder instance

Field Detail

{array} buttons

List of Join/Leave buttons

{object} memberOfSites

List of sites the current user is a member of

{boolean} membershipsRetrieved

Flag to determine whether membership details have been
retrieved yet, until they have join/leave buttons can
not be shown

{object} options

Object container for initialization options

{object} pendingInvites

Provides easy look-up of pending invites for this user

{string} searchTerm

Search term used for the site search.

Method Detail

doCancelRequest(event, site)

Cancel Join Request event handler

Parameters:
{object} event: The event object
{string} site: The shortName of the site to cancel join request for

doDelete(event, site)

Delete event handler

Parameters:
{object} event: The event object
{object} site: An object literal of the site to delete

doJoin(event, site)

Join event handler

Parameters:
{object} event: The event object
{string} site: The shortName of the site to join

doLeave(event, site)

Leave event handler

Parameters:
{object} event: The event object
{string} site: The shortName of the site to leave

doRequestJoin(event, site)

Request Join event handler

Parameters:
{object} event: The event object
{string} site: The shortName of the site to request joining

doSearch()

Search event handler

onReady()

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

onRowDeleteEvent(event)

Fired by YUI:s DataTable when a row has been added to the data table list.
Keeps track of added files.

Parameters:
{object} event: a DataTable "rowDelete" event

onSiteDeleted(layer, args)

Fired any another component, DeleteSite, to let other components know
that a site has been deleted.
Performs the search again.

Parameters:
{object} layer: Event fired (unused)
{array} args: Event parameters (unused)

Classes

Class Alfresco.SiteFinder