com.grapecity.documents.excel

Interface ICommentThreaded

public interface ICommentThreaded

Since:

8/5/2021

Method Summary

Modifier and Type	Method and Description
ICommentThreaded	addReply(java.lang.String text) adds a reply to its replies collection if the threaded comment is a top-level comment.
ICommentThreaded	addReply(java.lang.String text, java.lang.String author) adds a reply to its replies collection if the threaded comment is a top-level comment.
void	delete() Deletes the specified threaded comment and all replies associated with that comment.
IAuthor	getAuthor() Gets the author object of the threaded comment.
java.util.Date	getDate() Returns a date that represents the date and time that a threaded comment was added in local time.
boolean	getIsResolved() gets the resolve value.
ICommentThreaded	getParent() Returns the parent object for the specified object.
ICommentsThreaded	getReplies() returns a CommentsThreaded collection of CommentThreaded objects that are replies if the specified comment.
java.lang.String	getText() Gets the threaded comment's text.
ICommentThreaded	next() Returns the ICommentThreaded object that represents the next threaded comment.
ICommentThreaded	previous() Returns the ICommentThreaded object that represents the previous threaded comment.
void	setIsResolved(boolean value) Makes the threaded comment impossible to edit and reply.
void	setText(java.lang.String text) Sets the threaded comment's text.

Method Detail

addReply

ICommentThreaded addReply(java.lang.String text)

adds a reply to its replies collection if the threaded comment is a top-level comment. If this threaded comment is a reply,it will add a reply to its Parent's replies collection.

Parameters:

text - the string is content of the reply.

addReply

ICommentThreaded addReply(java.lang.String text,
                          java.lang.String author)

adds a reply to its replies collection if the threaded comment is a top-level comment. If this threaded comment is a reply,it will add a reply to its Parent's replies collection.

Parameters:

text - the string is content of the reply.

delete

void delete()

Deletes the specified threaded comment and all replies associated with that comment. If threaded comment is a reply, delete itself from the parent's reply list.

setIsResolved

void setIsResolved(boolean value)

Makes the threaded comment impossible to edit and reply.

getIsResolved

boolean getIsResolved()

gets the resolve value.

getText

java.lang.String getText()

Gets the threaded comment's text.

setText

void setText(java.lang.String text)

Sets the threaded comment's text.

getReplies

ICommentsThreaded getReplies()

returns a CommentsThreaded collection of CommentThreaded objects that are replies if the specified comment. The replies are sorted by time stamp. If this threaded comment is a reply,returns an empty collection.

getAuthor

IAuthor getAuthor()

Gets the author object of the threaded comment.

getDate

java.util.Date getDate()

Returns a date that represents the date and time that a threaded comment was added in local time.

Returns:

next

ICommentThreaded next()

Returns the ICommentThreaded object that represents the next threaded comment. Returns null if the top-level threaded comment is the last threaded comment on a sheet. Returns null if the reply threaded comment is the last reply of a threaded comment's replies.

previous

ICommentThreaded previous()

Returns the ICommentThreaded object that represents the previous threaded comment. Returns null if the top-level threaded comment is the first threaded comment on a sheet. Returns null if the reply threaded comment is the first reply of a threaded comment's replies.

getParent

ICommentThreaded getParent()

Returns the parent object for the specified object. The top-level threaded comment's parent is null.