Class ecm.widget.ItemCommentsPane


Extends dijit.layout.BorderContainer.
Provides a widget that is used to view comments of or add comments to an item. Also provides controls to edit and delete accessible comments.
Defined in: <ecm\widget\ItemCommentsPane.js>.

Constructor Summary

Constructor Attributes Constructor Name and Description
 
ecm.widget.ItemCommentsPane()

Method Summary

Method Attributes Method Name and Description
 
cancelNewComment()
Discards the new comment that we being made.
 
isDirty()
Determines if there is a new comment that hasn't been added yet.
 
onAddComment(comment)
An event function called after a new comment is added.
 
onCancelNewComment()
An event function called when a comment is being made is discarded.
 
onNewComment()
An event function called when a comment is being made.
 
onRenderComments(comments)
An event function called after the comments pane is rendered.
 
postCreate()
Overrides postCreate to make necessary event connections.
 
render()
Displays the comments of the item.
 
resize(changeSize)
Overrides resize to make necessary adjustments to the size of containing widgets before resizing.
 
save(callback, errorback)
Adds if there is a new comment that hasn't been added yet.
 
scrollToLastRow()
Scrolls to the last row in the comments list.
 
uninitialize()

Constructor Detail

ecm.widget.ItemCommentsPane()

Since:
2.0.2

Method Detail

cancelNewComment()

Discards the new comment that we being made.

{Boolean} isDirty()

Determines if there is a new comment that hasn't been added yet.
Returns:
{Boolean} A value of true if there is a new comment, otherwise false.

onAddComment(comment)

An event function called after a new comment is added.
Parameters:
comment
A ecm.model.Comment object added.

onCancelNewComment()

An event function called when a comment is being made is discarded.

onNewComment()

An event function called when a comment is being made.

onRenderComments(comments)

An event function called after the comments pane is rendered.
Parameters:
comments
A ecm.model.ResultSet object containing ecm.model.Comment objects.

postCreate()

Overrides postCreate to make necessary event connections.

render()

Displays the comments of the item.

resize(changeSize)

Overrides resize to make necessary adjustments to the size of containing widgets before resizing.
Parameters:
changeSize

save(callback, errorback)

Adds if there is a new comment that hasn't been added yet.
Parameters:
callback
errorback

scrollToLastRow()

Scrolls to the last row in the comments list.

uninitialize()