Class Index | File Index

Classes


Class Alfresco.TopicReplies

Discussion TopicReplies component.
Defined in: replies.js
Constructor Summary
Constructor Attributes Constructor Name and Description
 
TopicReplies constructor.
Field Summary
Field Attributes Field Name and Description
 
Stores editing related data
 
Object container for initialization options
 
Stores the displayed data
 
Object container for storing YUI widget instances.
Method Summary
Method Attributes Method Name and Description
 
Find the data object for a reply given its node reference.
 
onAddReply(nodeRef)
Handler for the add reply action links.
 
onAddReplyToPost(tagId, target)
Tag selected handler (document details)
 
Fired by YUILoaderHelper when required component script files have
 
onEditReply(nodeRef)
Handler for the edit reply action links.
 
Edit form cancel button click handler
 
onFormSubmitFailure(response, obj)
Form submit failure handler
 
onFormSubmitSuccess(response, obj)
Form submit success handler
 
Fired by YUI when parent element is available for scripting.
 
Called when the mouse enters into a list item.
 
Called whenever the mouse exits a list item.
 
onTopicDataChanged(layer, args)
onLoadReplies handler
 
renderReply(parentDiv, data, highlight)
Renders an individual reply element
 
renderReplyView(div, data)
Renders the view part of a reply element
 
Renders the UI of the component
 
rerenderReplyUI(nodeRef, highlight)
Re-renders the view UI for a reply element
 
Set multiple initialization options at once.
 
Set multiple initialization options at once.
 
Handler for the show/hide replies toggle links
 
toNodeRef(safeRef)
Converts a html-id safe nodeRef to a real one.
 
toSafeRef(nodeRef)
Converts a node reference to a html-id safe string.
Constructor Detail
Alfresco.TopicReplies(htmlId)
TopicReplies constructor.
Parameters:
{String} htmlId
The HTML id of the parent element
Returns:
{Alfresco.TopicReplies} The new Reply instance
Field Detail
editData
Stores editing related data

{object} options
Object container for initialization options

repliesData
Stores the displayed data

{object} widgets
Object container for storing YUI widget instances.
Method Detail
{string} findReplyDataObject(nodeRef)
Find the data object for a reply given its node reference.
Parameters:
{string} nodeRef
the nodeRef of the reply to find the data for
Returns:
{string} a reply data object or null if not found

onAddReply(nodeRef)
Handler for the add reply action links.
Parameters:
nodeRef

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

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

onEditReply(nodeRef)
Handler for the edit reply action links.
Parameters:
nodeRef

onFormCancelButtonClick(type, args)
Edit form cancel button click handler
Parameters:
type
args

onFormSubmitFailure(response, obj)
Form submit failure handler
Parameters:
response
obj

onFormSubmitSuccess(response, obj)
Form submit success handler
Parameters:
response
obj

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

onReplyElementMouseEntered(layer, args)
Called when the mouse enters into a list item.
Parameters:
layer
args

onReplyElementMouseExited(layer, args)
Called whenever the mouse exits a list item.
Parameters:
layer
args

onTopicDataChanged(layer, args)
onLoadReplies handler
Parameters:
layer
args

renderReply(parentDiv, data, highlight)
Renders an individual reply element
Parameters:
parentDiv
data
highlight

renderReplyView(div, data)
Renders the view part of a reply element
Parameters:
div
data

renderUI()
Renders the UI of the component

rerenderReplyUI(nodeRef, highlight)
Re-renders the view UI for a reply element
Parameters:
nodeRef
highlight

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

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

showHideChildren(nodeRef)
Handler for the show/hide replies toggle links
Parameters:
nodeRef

{string} toNodeRef(safeRef)
Converts a html-id safe nodeRef to a real one.
Parameters:
{string} safeRef
a nodeReference where the separators have been replaced by _
Returns:
{string} a valid node reference

{string} toSafeRef(nodeRef)
Converts a node reference to a html-id safe string.
Parameters:
{string} nodeRef
a nodeReference where the separators have been replaced by _
Returns:
{string} a nodeRef string usable in html id values

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