Class Alfresco.dashlet.MySites

Dashboard MySites component.

Constructor Summary
Constructor Attributes	Constructor Name and Description
	Alfresco.dashlet.MySites(htmlId) Dashboard MySites constructor.

Field Summary
Field Attributes	Field Name and Description
	createSite CreateSite module instance.
	options Object container for initialization options
	sites Site data

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

Method Summary
Method Attributes	Method Name and Description
	filterAccept(filter, site) Determine whether a given site should be displayed or not depending on the current filter selection
	generateFavourite(record) Generate "Favourite" UI
	generateIMAPFavourite(record) Generate "IMAP Favourite" UI
	generateLikes(record) Generate "Likes" UI
	loadSites() Load sites list
	onCreateSite(event) Fired by YUI Link when the "Create site" label is clicked
	onDeleteSite(row) Adds an event handler for bringing up the delete site dialog for the specific site
	onFavouriteSite(row) Adds an event handler that adds or removes the site as favourite site
	onImapFavouriteSite(row) Adds an event handler that adds or removes the site as favourite site
	onLikes(row) Like/Unlike event handler
	onPreferencesLoaded(p_response, p_items) Process response from sites and preferences queries
	onReady() Fired by YUI when parent element is available for scripting
	onSiteDeleted(layer, args) Fired by DeleteSite module when a site has been deleted.
	onSitesLoaded(p_response) Retrieve user preferences after sites data has loaded
	onTypeFilterChanged(p_sType, p_aArgs) Date drop-down changed event handler
	renderCellActions(elCell, oRecord, oColumn, oData) Actions custom datacell formatter
	renderCellDetail(elCell, oRecord, oColumn, oData) Name & description custom datacell formatter
	renderCellIcon(elCell, oRecord, oColumn, oData) Icon custom datacell formatter

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

Constructor Detail

Alfresco.dashlet.MySites(htmlId)

Dashboard MySites constructor.

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

Returns:: {Alfresco.dashlet.MySites} The new component instance

Field Detail

{Alfresco.module.CreateSite} createSite

CreateSite module instance.

{object} options

Object container for initialization options

{array} sites

Site data

Method Detail

{boolean} filterAccept(filter, site)

Determine whether a given site should be displayed or not depending on the current filter selection

Parameters:
{string} filter: Filter to set
{object} site: Site object literal

Returns:: {boolean}

{string} generateFavourite(record)

Generate "Favourite" UI

Parameters:
{object} record: DataTable record

Returns:: {string} HTML mark-up for Favourite UI

{string} generateIMAPFavourite(record)

Generate "IMAP Favourite" UI

Parameters:
{object} record: DataTable record

Returns:: {string} HTML mark-up for Favourite UI

{string} generateLikes(record)

Generate "Likes" UI

Parameters:
{object} record: DataTable record

Returns:: {string} HTML mark-up for Likes UI

loadSites()

Load sites list

onCreateSite(event)

Fired by YUI Link when the "Create site" label is clicked

Parameters:
{domEvent} event: DOM event

onDeleteSite(row)

Adds an event handler for bringing up the delete site dialog for the specific site

Parameters:
{object} row: DataTable row representing site to be actioned

onFavouriteSite(row)

Adds an event handler that adds or removes the site as favourite site

Parameters:
{object} row: DataTable row representing site to be actioned

onImapFavouriteSite(row)

Adds an event handler that adds or removes the site as favourite site

Parameters:
{object} row: DataTable row representing site to be actioned

onLikes(row)

Like/Unlike event handler

Parameters:
{HTMLElement} row: DOM reference to a TR element (or child thereof)

onPreferencesLoaded(p_response, p_items)

Process response from sites and preferences queries

Parameters:
{object} p_response: Response from "api/people/{userId}/preferences" query
{object} p_items: Response from "api/people/{userId}/sites" query

onReady()

Fired by YUI when parent element is available for scripting

onSiteDeleted(layer, args)

Fired by DeleteSite module when a site has been deleted.

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

onSitesLoaded(p_response)

Retrieve user preferences after sites data has loaded

Parameters:
{object} p_response: Response from "api/people/{userId}/sites" query

onTypeFilterChanged(p_sType, p_aArgs)

Date drop-down changed event handler

Parameters:
{string} p_sType: The event
{array} p_aArgs

renderCellActions(elCell, oRecord, oColumn, oData)

Actions custom datacell formatter

Parameters:
{object} elCell
{object} oRecord
{object} oColumn
oData: {object|string}

renderCellDetail(elCell, oRecord, oColumn, oData)

Name & description custom datacell formatter

Parameters:
{object} elCell
{object} oRecord
{object} oColumn
oData: {object|string}

renderCellIcon(elCell, oRecord, oColumn, oData)

Icon custom datacell formatter

Parameters:
{object} elCell
{object} oRecord
{object} oColumn
oData: {object|string}

Classes

Class Alfresco.dashlet.MySites