Class Index | File Index

Classes


Class Alfresco.DiscussionsTopicList

DiscussionsTopicList component.
Defined in: topiclist.js
Constructor Summary
Constructor Attributes Constructor Name and Description
 
DiscussionsTopicList constructor.
Field Summary
Field Attributes Field Name and Description
 
Tells whether an action is currently ongoing.
 
Current filter to filter topic list.
 
Object container for initialization options
 
Offset of first record on page
 
Object literal used to generate unique tag ids
 
Total number of topics in the current view (across all pages)
 
Object container for storing YUI widget instances.
Method Summary
Method Attributes Method Name and Description
 
onChangeFilter(layer, args)
DiscussionsTopicList View change filter event handler
 
Fired by YUILoaderHelper when required component script files have
 
Deactivate All Controls event handler
 
Handler for the delete topic action links.
 
DiscussionsTopicList Refresh Required event handler
 
Handler for the edit topic action links
 
Custom event handler to highlight row.
 
Custom event handler to unhighlight row.
 
Fired by YUI when parent element is available for scripting.
 
onSimpleView(e, p_obj)
Action handler for the simple view toggle button
 
onTagSelected(tagId, target)
Tag selected handler (document details)
 
Handler for the view topic action links
 
Set messages for this component.
 
Set multiple initialization options at once.
 
Update the list title.
Constructor Detail
Alfresco.DiscussionsTopicList(htmlId)
DiscussionsTopicList constructor.
Parameters:
{String} htmlId
The HTML id of the parent element
Returns:
{Alfresco.DiscussionsTopicList} The new DiscussionsTopicList instance
Field Detail
{boolean} busy
Tells whether an action is currently ongoing.
See:
_setBusy/_releaseBusy

{object} currentFilter
Current filter to filter topic list.

{object} options
Object container for initialization options

{int} recordOffset
Offset of first record on page
Default Value:
0

{object} tagId
Object literal used to generate unique tag ids

{int} totalRecords
Total number of topics in the current view (across all pages)
Default Value:
0

{object} widgets
Object container for storing YUI widget instances.
Method Detail
onChangeFilter(layer, args)
DiscussionsTopicList View change filter event handler
Parameters:
{object} layer
Event fired (unused)
{array} args
Event parameters (new filterId)

onComponentsLoaded()
Fired by YUILoaderHelper when required component script files have
been loaded into the browser.

onDeactivateAllControls(layer, args)
Deactivate All Controls event handler
Parameters:
{object} layer
Event fired
{array} args
Event parameters (depends on event type)

onDeleteTopic(row)
Handler for the delete topic action links.
Parameters:
row

onDiscussionsTopicListRefresh(layer, args)
DiscussionsTopicList Refresh Required event handler
Parameters:
{object} layer
Event fired (unused)
{array} args
Event parameters (unused)

onEditTopic(row)
Handler for the edit topic action links
Parameters:
row

onEventHighlightRow()
Custom event handler to highlight row.
Parameters:
oArgs.event
{HTMLEvent} Event object.
oArgs.target
{HTMLElement} Target element.

onEventUnhighlightRow()
Custom event handler to unhighlight row.
Parameters:
oArgs.event
{HTMLEvent} Event object.
oArgs.target
{HTMLElement} Target element.

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

onSimpleView(e, p_obj)
Action handler for the simple view toggle button
Parameters:
e
p_obj

onTagSelected(tagId, target)
Tag selected handler (document details)
Parameters:
{string} tagId
Tag name.
{HTMLElement} target
Target element clicked.

onViewTopic(row)
Handler for the view topic action links
Parameters:
{object} row
DataTable row representing file to be actioned

{Alfresco.DocumentList} setMessages(obj)
Set messages for this component.
Parameters:
{object} obj
Object literal specifying a set of messages
Returns:
{Alfresco.DocumentList} returns 'this' for method chaining

setOptions(obj)
Set multiple initialization options at once.
Parameters:
{object} obj
Object literal specifying a set of options

updateListTitle()
Update the list title.

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