com.aspose.words

Class Comment

java.lang.Object

com.aspose.words.Node

com.aspose.words.CompositeNode

com.aspose.words.InlineStory

com.aspose.words.Comment

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Iterable

public final class Comment
extends InlineStory

Represents a container for text of a comment.

To learn more, visit the Working with Comments documentation article.

A comment is an annotation which is anchored to a region of text or to a position in text. A comment can contain an arbitrary amount of block-level content.

If a Comment object occurs on its own, the comment is anchored to the position of the Comment object.

To anchor a comment to a region of text three objects are required: Comment, CommentRangeStart and CommentRangeEnd. All three objects need to share the same getId() value.

Comment is an inline-level node and can only be a child of Paragraph.

Comment can contain Paragraph and Table child nodes.

See Also:

CommentRangeStart, CommentRangeEnd

Constructor Summary

Constructors

Constructor and Description
Comment(DocumentBase doc) Initializes a new instance of the Comment class.
Comment(DocumentBase doc, java.lang.String author, java.lang.String initial, java.util.Date dateTime) Initializes a new instance of the Comment class.

Method Summary

Modifier and Type	Method and Description
boolean	accept(DocumentVisitor visitor) Accepts a visitor.
Comment	addReply(java.lang.String author, java.lang.String initial, java.util.Date dateTime, java.lang.String text) Adds a reply to this comment.
Comment	getAncestor() Returns the parent Comment object.
java.lang.String	getAuthor() Gets the author name for a comment.
java.util.Date	getDateTime() Gets the date and time that the comment was made.
boolean	getDone() Gets flag indicating that the comment has been marked done.
int	getId() Gets the comment identifier.
int	getIdInternal()
java.lang.String	getInitial() Gets the initials of the user associated with a specific comment.
int	getNodeType() Returns NodeType.Comment.
int	getParentIdInternal()
CommentCollection	getReplies() Returns a collection of Comment objects that are immediate children of the specified comment.
int	getStoryType() Returns StoryType.Comments.
void	removeAllReplies() Removes all replies to this comment.
void	removeMoveRevisions()
void	removeReply(Comment reply) Removes the specified reply to this comment.
void	setAuthor(java.lang.String value) Sets the author name for a comment.
void	setDateTime(java.util.Date value) Gets the date and time that the comment was made.
void	setDone(boolean value) Sets flag indicating that the comment has been marked done.
void	setIdInternal(int value)
void	setInitial(java.lang.String value) Sets the initials of the user associated with a specific comment.
void	setParentIdInternal(int value)
void	setText(java.lang.String text) This is a convenience method that allows to easily set text of the comment.

Methods inherited from class com.aspose.words.InlineStory

clearRunAttrs, ensureMinimum, fetchInheritedRunAttr, getDirectRunAttr, getDocument_IInline, getFirstParagraph, getFont, getLastParagraph, getParagraphs, getParentParagraph_IInline, getParentParagraph, getTables, isDeleteRevision, isInsertRevision, isMoveFromRevision, isMoveToRevision, removeRunAttr, setRunAttr

Methods inherited from class com.aspose.words.CompositeNode

acceptChildren, acceptCore, appendChild, coreRemoveSelfOnly, getChild, getChildNodes, getChildNodes, getContainer, getCount, getCurrentNode, getFirstChild, getLastChild, getNextMatchingNode, getText, hasChildNodes, indexOf, insertAfter, insertBefore, isComposite, iterator, prependChild, removeAllChildren, removeChild, removeSmartTags, selectNodes, selectSingleNode

Methods inherited from class com.aspose.words.Node

dd, deepClone, getAncestor, getAncestor, getCustomNodeId, getDocument, getNextSibling, getParentNode, getPreviousSibling, getRange, memberwiseClone, nextPreOrder, nodeTypeToString, previousPreOrder, remove, setCustomNodeId, toString, toString, toString, visitorActionToBool

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

Comment

public Comment(DocumentBase doc)

Initializes a new instance of the Comment class.

When Comment is created, it belongs to the specified document, but is not yet part of the document and ParentNode is null.

To append Comment to the document use InsertAfter or InsertBefore on the paragraph where you want the comment inserted.

After creating a comment, don't forget to set its getAuthor() / setAuthor(java.lang.String), getInitial() / setInitial(java.lang.String) and getDateTime() / setDateTime(java.util.Date) properties.

Parameters:

doc - The owner document.

Comment

public Comment(DocumentBase doc,
               java.lang.String author,
               java.lang.String initial,
               java.util.Date dateTime)

Initializes a new instance of the Comment class.

Parameters:

doc - The owner document.

author - The author name for the comment. Cannot be null.

initial - The author initials for the comment. Cannot be null.

dateTime - The date and time for the comment.

Method Detail

getNodeType

public final int getNodeType()

Returns NodeType.Comment.

Specified by:

getNodeType in class Node

Returns:

NodeType.Comment. The returned value is one of NodeType constants.

getStoryType

public final int getStoryType()

Returns StoryType.Comments.

Specified by:

getStoryType in class InlineStory

Returns:

StoryType.Comments. The returned value is one of StoryType constants.

getId

public final int getId()

Gets the comment identifier.

The comment identifier allows to anchor a comment to a region of text in the document. The region must be demarcated using the CommentRangeStart and CommentRangeEnd object sharing the same identifier value as the Comment object.

You would use this value when looking for the CommentRangeStart and CommentRangeEnd nodes that are linked to this comment.

Comment identifiers are supposed to be unique across a document and Aspose.Words automatically maintains comment identifiers when loading, saving and combining documents.

Returns:

The comment identifier.

getIdInternal

public final int getIdInternal()

setIdInternal

public final void setIdInternal(int value)

getParentIdInternal

public final int getParentIdInternal()

setParentIdInternal

public final void setParentIdInternal(int value)

getInitial

public final java.lang.String getInitial()

Gets the initials of the user associated with a specific comment.

Cannot be null.

Default is empty string.

Returns:

The initials of the user associated with a specific comment.

setInitial

public final void setInitial(java.lang.String value)

Sets the initials of the user associated with a specific comment.

Cannot be null.

Default is empty string.

Parameters:

value - The initials of the user associated with a specific comment.

getDateTime

public final java.util.Date getDateTime()

Gets the date and time that the comment was made.

Default is 03.01.0001.

Returns:

The date and time that the comment was made.

setDateTime

public final void setDateTime(java.util.Date value)

Gets the date and time that the comment was made.

Default is 03.01.0001.

Parameters:

value - The date and time that the comment was made.

getAuthor

public final java.lang.String getAuthor()

Gets the author name for a comment.

Cannot be null.

Default is empty string.

Returns:

The author name for a comment.

setAuthor

public final void setAuthor(java.lang.String value)

Sets the author name for a comment.

Cannot be null.

Default is empty string.

Parameters:

value - The author name for a comment.

accept

public final boolean accept(DocumentVisitor visitor)
                     throws java.lang.Exception

Accepts a visitor.

Enumerates over this node and all of its children. Each node calls a corresponding method on DocumentVisitor.

For more info see the Visitor design pattern.

Specified by:

accept in class Node

Parameters:

visitor - The visitor that will visit the nodes.

Returns:

True if all nodes were visited; false if DocumentVisitor stopped the operation before visiting all nodes.

Throws:

java.lang.Exception

addReply

public final Comment addReply(java.lang.String author,
                              java.lang.String initial,
                              java.util.Date dateTime,
                              java.lang.String text)
                       throws java.lang.Exception

Adds a reply to this comment.

Parameters:

author - The author name for the reply.

initial - The author initials for the reply.

dateTime - The date and time for the reply.

text - The reply text.

Returns:

The created Comment node for the reply.

Throws:

java.lang.Exception

removeReply

public final void removeReply(Comment reply)
                       throws java.lang.Exception

Removes the specified reply to this comment. All constituent nodes of the reply will be deleted from the document.

Parameters:

reply - The comment node of the deleting reply.

Throws:

java.lang.Exception

removeAllReplies

public final void removeAllReplies()
                            throws java.lang.Exception

Removes all replies to this comment. All constituent nodes of the replies will be deleted from the document.

Throws:

java.lang.Exception

setText

public final void setText(java.lang.String text)

This is a convenience method that allows to easily set text of the comment.

This method allows to quickly set text of a comment from a string. The string can contain paragraph breaks, this will create paragraphs of text in the comment accordingly. If you want to insert more complex elements into the comment, for example bookmarks or tables or apply rich formatting, then you need to use the appropriate node classes to build up the comment text.

Parameters:

text - The new text of the comment.

getAncestor

public final Comment getAncestor()

Returns the parent Comment object. Returns null for top-level comments.

Returns:

The parent Comment object.

getReplies

public final CommentCollection getReplies()

Returns a collection of Comment objects that are immediate children of the specified comment.

Returns:

A collection of Comment objects that are immediate children of the specified comment.

getDone

public final boolean getDone()

Gets flag indicating that the comment has been marked done.

Returns:

Flag indicating that the comment has been marked done.

setDone

public final void setDone(boolean value)

Sets flag indicating that the comment has been marked done.

Parameters:

value - Flag indicating that the comment has been marked done.

removeMoveRevisions

public final void removeMoveRevisions()