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 |
---|---|
Method Summary
Method Attributes | Method Name and Description |
---|---|
Discards the new comment that we being made.
|
|
destroy()
|
|
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.
|
|
An event function called when a comment is being made is discarded.
|
|
onChange()
|
|
onDeleteComment(comment)
An event function called after a comment is deleted.
|
|
An event function called when a comment is being made.
|
|
onRenderComments(comments)
An event function called after the comments pane is rendered.
|
|
Overrides
postCreate to make necessary event connections. |
|
render(callback)
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.
|
|
Scrolls to the last row in the comments list.
|
Method Detail
cancelNewComment()
Discards the new comment that we being made.
destroy()
{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.
onChange()
onDeleteComment(comment)
An event function called after a comment is deleted.
- Parameters:
- comment
- A ecm.model.Comment object deleted.
onEmptyComments()
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(callback)
Displays the comments of the item.
- Parameters:
- callback
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.