Class Index | File Index

Classes


Class Alfresco.component.SimpleDocList

Extends Alfresco.component.Base
SimpleDocList component.

Generates a simple DataTable-based document list view
Defined in: share.js
Constructor Summary
Constructor Attributes Constructor Name and Description
 
SimpleDocList constructor.
Field Summary
Field Attributes Field Name and Description
 
Holds IDs to register metadata tooltips with.
 
Object container for initialization options
 
Holds IDs to register preview tooltips with.
Fields borrowed from class Alfresco.component.Base:
modules, services, widgets
Method Summary
Method Attributes Method Name and Description
<static>  
Alfresco.component.SimpleDocList.generateComments(scope, record)
Generate "Comments" UI
<static>  
Alfresco.component.SimpleDocList.generateFavourite(scope, record)
Generate "Favourite" UI
<static>  
Alfresco.component.SimpleDocList.generateLikes(scope, record)
Generate "Likes" UI
 
Generates webscript parameters based on current filters, etc.
 
Generate base webscript url.
 
onLikes(row)
Like/Unlike event handler
 
Fired by YUI when parent element is available for scripting
 
Reloads the DataTable
 
renderCellDetail(elCell, oRecord, oColumn, oData)
Detail custom datacell formatter
 
renderCellThumbnail(elCell, oRecord, oColumn, oData)
Thumbnail 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.component.SimpleDocList(htmlid)
SimpleDocList constructor.
Parameters:
{String} htmlid
The HTML id of the parent element
Returns:
{Alfresco.component.SimpleDocList} The new SimpleDocList instance
Field Detail
{array} metadataTooltips
Holds IDs to register metadata tooltips with.

{object} options
Object container for initialization options

{array} previewTooltips
Holds IDs to register preview tooltips with.
Method Detail
<static> {string} Alfresco.component.SimpleDocList.generateComments(scope, record)
Generate "Comments" UI
Parameters:
{object} scope
DocumentLibrary instance
{object} record
DataTable record
Returns:
{string} HTML mark-up for Comments UI

<static> {string} Alfresco.component.SimpleDocList.generateFavourite(scope, record)
Generate "Favourite" UI
Parameters:
{object} scope
DocumentLibrary instance
{object} record
DataTable record
Returns:
{string} HTML mark-up for Favourite UI

<static> {string} Alfresco.component.SimpleDocList.generateLikes(scope, record)
Generate "Likes" UI
Parameters:
{object} scope
DocumentLibrary instance
{object} record
DataTable record
Returns:
{string} HTML mark-up for Likes UI

getParameters()
Generates webscript parameters based on current filters, etc.
Meant to be overridden depending on use case.

getWebscriptUrl()
Generate base webscript url.
Can be overridden.

onLikes(row)
Like/Unlike event handler
Parameters:
{HTMLElement} row
DOM reference to a TR element (or child thereof)

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

reloadDataTable()
Reloads the DataTable

renderCellDetail(elCell, oRecord, oColumn, oData)
Detail custom datacell formatter
Parameters:
{object} elCell
{object} oRecord
{object} oColumn
oData
{object|string}

renderCellThumbnail(elCell, oRecord, oColumn, oData)
Thumbnail custom datacell formatter
Parameters:
{object} elCell
{object} oRecord
{object} oColumn
oData
{object|string}

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