Comment
Наследование: java.lang.Object, com.aspose.words.Node, com.aspose.words.CompositeNode, com.aspose.words.InlineStory
public class Comment extends InlineStory
Представляет контейнер для текста комментария.
Чтобы узнать больше, посетитеWorking with Comments документальная статья.
Комментарий — это аннотация, привязанная к области текста или позиции в тексте. Комментарий может содержать произвольное количество контента блочного уровня.
ЕслиComment объект возникает сам по себе, комментарий привязывается к позицииComment объект.
Для привязки комментария к области текста требуются три объекта:Comment, CommentRangeStart а такжеCommentRangeEnd . Все три объекта должны иметь одинаковыйgetId() ценность.
Comment является узлом встроенного уровня и может быть только потомкомParagraph.
Comment может содержатьParagraph а такжеTable дочерние узлы.
Конструкторы
Конструктор | Описание |
---|---|
Comment(DocumentBase doc) | Инициализирует новый экземплярComment учебный класс. |
Comment(DocumentBase doc, String author, String initial, Date dateTime) | Инициализирует новый экземплярComment учебный класс. |
Методы
Метод | Описание |
---|---|
accept(DocumentVisitor visitor) | Принимает посетителя. |
addReply(String author, String initial, Date dateTime, String text) | Добавляет ответ на этот комментарий. |
appendChild(Node newChild) | Добавляет указанный узел в конец списка дочерних узлов для этого узла. |
clearRunAttrs() | |
dd() | |
deepClone(boolean isCloneChildren) | Создает дубликат узла. |
ensureMinimum() | Если последний дочерний элемент не является абзацем, создает и добавляет один пустой абзац. |
equals(Object arg0) | |
fetchInheritedRunAttr(int fontAttr) | |
getAncestor() | Возвращает родительский объект Comment. |
getAncestor(int ancestorType) | |
getAncestor(Class ancestorType) | Получает первого предка указанного типа объекта. |
getAuthor() | Получает имя автора комментария. |
getChild(int nodeType, int index, boolean isDeep) | |
getChildNodes() | Получает все непосредственные дочерние узлы этого узла. |
getChildNodes(int nodeType, boolean isDeep) | |
getClass() | |
getContainer() | |
getCount() | Получает количество непосредственных дочерних элементов этого узла. |
getCurrentNode() | |
getCustomNodeId() | Задает идентификатор пользовательского узла. |
getDateTime() | Получает дату и время создания комментария. |
getDirectRunAttr(int fontAttr) | |
getDocument() | Получает документ, которому принадлежит этот узел. |
getDocument_IInline() | |
getDone() | Получает флаг, указывающий, что комментарий помечен как выполненный. |
getFirstChild() | Получает первый дочерний элемент узла. |
getFirstParagraph() | Получает первый абзац в истории. |
getFont() | Предоставляет доступ к форматированию шрифта символа привязки этого объекта. |
getId() | Получает идентификатор комментария. |
getIdInternal() | |
getInitial() | Получает инициалы пользователя, связанного с конкретным комментарием. |
getLastChild() | Получает последний дочерний элемент узла. |
getLastParagraph() | Получает последний абзац в истории. |
getNextMatchingNode(Node curNode) | |
getNextSibling() | Получает узел, следующий сразу за этим узлом. |
getNodeType() | ВозвращаетNodeType.Comment. |
getParagraphs() | Получает коллекцию абзацев, которые являются непосредственными дочерними элементами истории. |
getParentIdInternal() | |
getParentNode() | Получает непосредственного родителя этого узла. |
getParentParagraph() | Извлекает родителяParagraph этого узла. |
getParentParagraph_IInline() | |
getPreviousSibling() | Получает узел, непосредственно предшествующий этому узлу. |
getRange() | ВозвращаетRange объект, который представляет часть документа, содержащегося в этом узле. |
getReplies() | Возвращает коллекциюComment объекты, которые являются непосредственными дочерними элементами указанного комментария. |
getStoryType() | ВозвращаетStoryType.Comments. |
getTables() | Получает коллекцию таблиц, которые являются непосредственными дочерними элементами истории. |
getText() | Получает текст этого узла и всех его дочерних элементов. |
hasChildNodes() | Возвращает true, если у этого узла есть дочерние узлы. |
hashCode() | |
indexOf(Node child) | Возвращает индекс указанного дочернего узла в массиве дочерних узлов. |
insertAfter(Node newChild, Node refChild) | Вставляет указанный узел сразу после указанного ссылочного узла. |
insertBefore(Node newChild, Node refChild) | Вставляет указанный узел непосредственно перед указанным ссылочным узлом. |
isComposite() | Возвращает true, так как этот узел может иметь дочерние узлы. |
isDeleteRevision() | Возвращает true, если этот объект был удален в Microsoft Word при включенном отслеживании изменений. |
isInsertRevision() | Возвращает true, если этот объект был вставлен в Microsoft Word при включенном отслеживании изменений. |
isMoveFromRevision() | Возвращаетtrue если этот объект был перемещен (удален) в Microsoft Word при включенном отслеживании изменений. |
isMoveToRevision() | Возвращаетtrue если этот объект был перемещен (вставлен) в Microsoft Word при включенном отслеживании изменений. |
iterator() | Обеспечивает поддержку для каждой итерации стиля над дочерними узлами этого узла. |
nextPreOrder(Node rootNode) | Получает следующий узел в соответствии с алгоритмом обхода дерева предварительного порядка. |
nodeTypeToString(int nodeType) | |
notify() | |
notifyAll() | |
prependChild(Node newChild) | Добавляет указанный узел в начало списка дочерних узлов для этого узла. |
previousPreOrder(Node rootNode) | Получает предыдущий узел в соответствии с алгоритмом обхода дерева предварительного порядка. |
remove() | Удаляет себя из родителя. |
removeAllChildren() | Удаляет все дочерние узлы текущего узла. |
removeAllReplies() | Удаляет все ответы на этот комментарий. |
removeChild(Node oldChild) | Удаляет указанный дочерний узел. |
removeMoveRevisions() | |
removeReply(Comment reply) | Удаляет указанный ответ на этот комментарий. |
removeRunAttr(int key) | |
removeSmartTags() | Удаляет всеSmartTag узлы-потомки текущего узла. |
selectNodes(String xpath) | Выбирает список узлов, соответствующих выражению XPath. |
selectSingleNode(String xpath) | Выбирает первый узел, соответствующий выражению XPath. |
setAuthor(String value) | Устанавливает имя автора комментария. |
setCustomNodeId(int value) | Задает идентификатор пользовательского узла. |
setDateTime(Date value) | Получает дату и время создания комментария. |
setDone(boolean value) | Устанавливает флаг, указывающий, что комментарий помечен как выполненный. |
setIdInternal(int value) | |
setInitial(String value) | Устанавливает инициалы пользователя, связанные с конкретным комментарием. |
setParentIdInternal(int value) | |
setRunAttr(int fontAttr, Object value) | |
setText(String text) | Это удобный метод, позволяющий легко задать текст комментария. |
toString() | |
toString(SaveOptions saveOptions) | Экспортирует содержимое узла в строку, используя указанные параметры сохранения. |
toString(int saveFormat) | |
wait() | |
wait(long arg0) | |
wait(long arg0, int arg1) |
Comment(DocumentBase doc)
public Comment(DocumentBase doc)
Инициализирует новый экземплярComment учебный класс.
КогдаComment создан, он принадлежит указанному документу, но еще не является его частью иParentNode нулевой.
Чтобы добавитьComment к документу используйте InsertAfter или InsertBefore для абзаца, в который вы хотите вставить комментарий.
После создания комментария не забудьте установить егоgetAuthor() / setAuthor(java.lang.String), getInitial() / setInitial(java.lang.String) а такжеgetDateTime() / setDateTime(java.util.Date) характеристики.
Параметры:
Параметр | Тип | Описание |
---|---|---|
doc | DocumentBase | Документ владельца. |
Comment(DocumentBase doc, String author, String initial, Date dateTime)
public Comment(DocumentBase doc, String author, String initial, Date dateTime)
Инициализирует новый экземплярComment учебный класс.
Параметры:
Параметр | Тип | Описание |
---|---|---|
doc | DocumentBase | Документ владельца. |
author | java.lang.String | Имя автора комментария. Не может быть нулевым. |
initial | java.lang.String | Инициалы автора комментария. Не может быть нулевым. |
dateTime | java.util.Date | Дата и время комментария. |
accept(DocumentVisitor visitor)
public boolean accept(DocumentVisitor visitor)
Принимает посетителя.
Перечисляет этот узел и все его дочерние элементы. Каждый узел вызывает соответствующий метод в DocumentVisitor.
Дополнительные сведения см. в шаблоне проектирования «Посетитель».
Параметры:
Параметр | Тип | Описание |
---|---|---|
visitor | DocumentVisitor | Посетитель, который будет посещать узлы. |
Возвращает: boolean - Истинно, если были посещены все узлы; false, если DocumentVisitor остановил операцию перед посещением всех узлов. ЗвонкиDocumentVisitor.visitCommentStart(com.aspose.words.Comment) , затем звонитNode.accept(com.aspose.words.DocumentVisitor) для всех дочерних узлов комментария и вызововDocumentVisitor.visitCommentEnd(com.aspose.words.Comment) в конце.
addReply(String author, String initial, Date dateTime, String text)
public Comment addReply(String author, String initial, Date dateTime, String text)
Добавляет ответ на этот комментарий.
Параметры:
Параметр | Тип | Описание |
---|---|---|
author | java.lang.String | Имя автора ответа. |
initial | java.lang.String | Автор инициалов для ответа. |
dateTime | java.util.Date | Дата и время ответа. |
text | java.lang.String | Текст ответа. |
Возвращает: Comment СозданныйComment узел для ответа. Из-за существующих ограничений MS Office в документе допускается только 1 уровень ответов. Исключение типа java.lang.IllegalStateException будет вызвано, если этот метод вызывается для существующего комментария Reply.
appendChild(Node newChild)
public Node appendChild(Node newChild)
Добавляет указанный узел в конец списка дочерних узлов для этого узла.
Если новый дочерний элемент уже находится в дереве, он сначала удаляется.
Если вставляемый узел был создан из другого документа, следует использоватьM:Aspose.Words.DocumentBase.ImportNode(Aspose.Words.Node,System.Boolean,Aspose.Words.ImportFormatMode) чтобы импортировать узел в текущий документ. Затем импортированный узел можно вставить в текущий документ.
Параметры:
Параметр | Тип | Описание |
---|---|---|
newChild | Node | Добавляемый узел. |
Возвращает: Node - Добавлен узел.
clearRunAttrs()
public void clearRunAttrs()
dd()
public void dd()
deepClone(boolean isCloneChildren)
public Node deepClone(boolean isCloneChildren)
Создает дубликат узла.
Этот метод служит конструктором копирования для узлов. Клонированный узел не имеет родителя, но принадлежит к тому же документу, что и исходный узел.
Этот метод всегда выполняет глубокую копию узла.isCloneChildren Параметр указывает, следует ли также выполнять копирование всех дочерних узлов.
Параметры:
Параметр | Тип | Описание |
---|---|---|
isCloneChildren | boolean | Значение true, чтобы рекурсивно клонировать поддерево в указанном узле; false, чтобы клонировать только сам узел. |
Возвращает: Node - Клонированный узел.
ensureMinimum()
public void ensureMinimum()
Если последний дочерний элемент не является абзацем, создает и добавляет один пустой абзац.
equals(Object arg0)
public boolean equals(Object arg0)
Параметры:
Параметр | Тип | Описание |
---|---|---|
arg0 | java.lang.Object |
Возвращает: логический
fetchInheritedRunAttr(int fontAttr)
public Object fetchInheritedRunAttr(int fontAttr)
Параметры:
Параметр | Тип | Описание |
---|---|---|
fontAttr | int |
Возвращает: java.lang.Объект
getAncestor()
public Comment getAncestor()
Возвращает родительский объект Comment. Возвращает null для комментариев верхнего уровня.
Возвращает: Comment - Родительский объект комментария.
getAncestor(int ancestorType)
public CompositeNode getAncestor(int ancestorType)
Параметры:
Параметр | Тип | Описание |
---|---|---|
ancestorType | int |
Возвращает: CompositeNode
getAncestor(Class ancestorType)
public CompositeNode getAncestor(Class ancestorType)
Получает первого предка указанного типа объекта.
Параметры:
Параметр | Тип | Описание |
---|---|---|
ancestorType | java.lang.Class | Тип объекта-предка для извлечения. |
Возвращает: CompositeNode - предок указанного типа или ноль, если предок этого типа не найден.
Тип предка совпадает, если он равен ancestorType или является производным от ancestorType.
getAuthor()
public String getAuthor()
Получает имя автора комментария.
Не может быть нулевым.
По умолчанию пустая строка.
Возвращает: java.lang.String — имя автора комментария.
getChild(int nodeType, int index, boolean isDeep)
public Node getChild(int nodeType, int index, boolean isDeep)
Параметры:
Параметр | Тип | Описание |
---|---|---|
nodeType | int | |
index | int | |
isDeep | boolean |
Возвращает: Node
getChildNodes()
public NodeCollection getChildNodes()
Получает все непосредственные дочерние узлы этого узла.
Примечание,getChildNodes() эквивалентно вызову GetChildNodes(NodeType.Any, false) и создает и возвращает новую коллекцию при каждом доступе к ней.
Если дочерних узлов нет, это свойство возвращает пустую коллекцию.
Возвращает: NodeCollection - Все непосредственные дочерние узлы этого узла.
getChildNodes(int nodeType, boolean isDeep)
public NodeCollection getChildNodes(int nodeType, boolean isDeep)
Параметры:
Параметр | Тип | Описание |
---|---|---|
nodeType | int | |
isDeep | boolean |
Возвращает: NodeCollection
getClass()
public final native Class<?> getClass()
Возвращает: java.lang.Класс
getContainer()
public CompositeNode getContainer()
Возвращает: CompositeNode
getCount()
public int getCount()
Получает количество непосредственных дочерних элементов этого узла.
Возвращает: int - количество непосредственных дочерних элементов этого узла.
getCurrentNode()
public Node getCurrentNode()
Возвращает: Node
getCustomNodeId()
public int getCustomNodeId()
Задает идентификатор пользовательского узла.
По умолчанию ноль.
Этот идентификатор можно установить и использовать произвольно. Например, как ключ для получения внешних данных.
Важное примечание: указанное значение не сохраняется в выходной файл и существует только в течение срока службы узла.
Возвращает: int - соответствующее значение int.
getDateTime()
public Date getDateTime()
Получает дату и время создания комментария.
По умолчанию 03.01.0001.
Возвращает: java.util.Date — дата и время создания комментария.
getDirectRunAttr(int fontAttr)
public Object getDirectRunAttr(int fontAttr)
Параметры:
Параметр | Тип | Описание |
---|---|---|
fontAttr | int |
Возвращает: java.lang.Объект
getDocument()
public DocumentBase getDocument()
Получает документ, которому принадлежит этот узел.
Узел всегда принадлежит документу, даже если он только что создан и еще не добавлен в дерево или удален из дерева.
Возвращает: DocumentBase - Документ, которому принадлежит этот узел.
getDocument_IInline()
public DocumentBase getDocument_IInline()
Возвращает: DocumentBase
getDone()
public boolean getDone()
Получает флаг, указывающий, что комментарий помечен как выполненный.
Возвращает: boolean — Флаг, указывающий, что комментарий помечен как выполненный.
getFirstChild()
public Node getFirstChild()
Получает первый дочерний элемент узла. Если нет первого дочернего узла, возвращается нуль.
Возвращает: Node - Первый дочерний узел.
getFirstParagraph()
public Paragraph getFirstParagraph()
Получает первый абзац в истории.
Возвращает: Paragraph - Первый абзац рассказа.
getFont()
public Font getFont()
Предоставляет доступ к форматированию шрифта символа привязки этого объекта.
Возвращает: Font - соответствующийFont ценность.
getId()
public int getId()
Получает идентификатор комментария.
Идентификатор комментария позволяет привязать комментарий к области текста в документе. Область должна быть разграничена с помощьюCommentRangeStart а такжеCommentRangeEnd объект, использующий то же значение идентификатора, что иComment объект.
Вы бы использовали это значение при поискеCommentRangeStart а такжеCommentRangeEnd узлы, которые связаны с этим комментарием.
Идентификаторы комментариев должны быть уникальными для всего документа, и Aspose.Words автоматически поддерживает идентификаторы комментариев при загрузке, сохранении и объединении документов.
Возвращает: int - идентификатор комментария.
getIdInternal()
public int getIdInternal()
Возвращает: инт
getInitial()
public String getInitial()
Получает инициалы пользователя, связанного с конкретным комментарием.
Не может быть нулевым.
По умолчанию пустая строка.
Возвращает: java.lang.String — Инициалы пользователя, связанные с конкретным комментарием.
getLastChild()
public Node getLastChild()
Получает последний дочерний элемент узла. Если последнего дочернего узла нет, возвращается нуль.
Возвращает: Node - Последний дочерний узел.
getLastParagraph()
public Paragraph getLastParagraph()
Получает последний абзац в истории.
Возвращает: Paragraph - Последний абзац в рассказе.
getNextMatchingNode(Node curNode)
public Node getNextMatchingNode(Node curNode)
Параметры:
Параметр | Тип | Описание |
---|---|---|
curNode | Node |
Возвращает: Node
getNextSibling()
public Node getNextSibling()
Получает узел, следующий сразу за этим узлом. Если следующего узла нет, возвращается нуль.
Возвращает: Node - Узел, непосредственно следующий за этим узлом.
getNodeType()
public int getNodeType()
ВозвращаетNodeType.Comment.
Возвращает: инт -NodeType.Comment . Возвращаемое значение является одним изNodeType константы.
getParagraphs()
public ParagraphCollection getParagraphs()
Получает коллекцию абзацев, которые являются непосредственными дочерними элементами истории.
Возвращает: ParagraphCollection - Набор абзацев, которые являются непосредственными потомками истории.
getParentIdInternal()
public int getParentIdInternal()
Возвращает: инт
getParentNode()
public CompositeNode getParentNode()
Получает непосредственного родителя этого узла.
Если узел был только что создан и еще не добавлен в дерево, или если он был удален из дерева, родитель имеет значение null.
Возвращает: CompositeNode - Непосредственный родитель этого узла.
getParentParagraph()
public Paragraph getParentParagraph()
Извлекает родителяParagraph этого узла.
Возвращает: Paragraph - соответствующийParagraph ценность.
getParentParagraph_IInline()
public Paragraph getParentParagraph_IInline()
Возвращает: Paragraph
getPreviousSibling()
public Node getPreviousSibling()
Получает узел, непосредственно предшествующий этому узлу. Если предыдущего узла нет, возвращается нуль.
Возвращает: Node - Узел, непосредственно предшествующий этому узлу.
getRange()
public Range getRange()
ВозвращаетRange объект, который представляет часть документа, содержащегося в этом узле.
Возвращает: Range - АRange объект, который представляет часть документа, содержащегося в этом узле.
getReplies()
public CommentCollection getReplies()
Возвращает коллекциюComment объекты, которые являются непосредственными дочерними элементами указанного комментария.
Возвращает: CommentCollection - КоллекцияComment объекты, которые являются непосредственными дочерними элементами указанного комментария.
getStoryType()
public int getStoryType()
ВозвращаетStoryType.Comments.
Возвращает: инт -StoryType.Comments . Возвращаемое значение является одним изStoryType константы.
getTables()
public TableCollection getTables()
Получает коллекцию таблиц, которые являются непосредственными дочерними элементами истории.
Возвращает: TableCollection - Коллекция таблиц, которые являются непосредственными дочерними элементами истории.
getText()
public String getText()
Получает текст этого узла и всех его дочерних элементов.
Возвращаемая строка включает все управляющие и специальные символы, как описано вControlChar.
Возвращает: java.lang.String
hasChildNodes()
public boolean hasChildNodes()
Возвращает true, если у этого узла есть дочерние узлы.
Возвращает: boolean — Истинно, если у этого узла есть дочерние узлы.
hashCode()
public native int hashCode()
Возвращает: инт
indexOf(Node child)
public int indexOf(Node child)
Возвращает индекс указанного дочернего узла в массиве дочерних узлов. Возвращает -1, если узел не найден среди дочерних узлов.
Параметры:
Параметр | Тип | Описание |
---|---|---|
child | Node |
Возвращает: инт
insertAfter(Node newChild, Node refChild)
public Node insertAfter(Node newChild, Node refChild)
Вставляет указанный узел сразу после указанного ссылочного узла.
Если refChild имеет значение null, вставляет newChild в начало списка дочерних узлов.
Если новый дочерний элемент уже находится в дереве, он сначала удаляется.
Если вставляемый узел был создан из другого документа, следует использоватьM:Aspose.Words.DocumentBase.ImportNode(Aspose.Words.Node,System.Boolean,Aspose.Words.ImportFormatMode) чтобы импортировать узел в текущий документ. Затем импортированный узел можно вставить в текущий документ.
Параметры:
Параметр | Тип | Описание |
---|---|---|
newChild | Node | Узел для вставки. |
refChild | Node | Узел, который является эталонным узлом. newNode размещается после refNode. |
Возвращает: Node - Вставленный узел.
insertBefore(Node newChild, Node refChild)
public Node insertBefore(Node newChild, Node refChild)
Вставляет указанный узел непосредственно перед указанным ссылочным узлом.
Если refChild имеет значение null, вставляет newChild в конец списка дочерних узлов.
Если новый дочерний элемент уже находится в дереве, он сначала удаляется.
Если вставляемый узел был создан из другого документа, следует использоватьM:Aspose.Words.DocumentBase.ImportNode(Aspose.Words.Node,System.Boolean,Aspose.Words.ImportFormatMode) чтобы импортировать узел в текущий документ. Затем импортированный узел можно вставить в текущий документ.
Параметры:
Параметр | Тип | Описание |
---|---|---|
newChild | Node | Узел для вставки. |
refChild | Node | Узел, который является эталонным узлом. Новый дочерний элемент помещается перед этим узлом. |
Возвращает: Node - Вставленный узел.
isComposite()
public boolean isComposite()
Возвращает true, так как этот узел может иметь дочерние узлы.
Возвращает: boolean — True, так как этот узел может иметь дочерние узлы.
isDeleteRevision()
public boolean isDeleteRevision()
Возвращает true, если этот объект был удален в Microsoft Word при включенном отслеживании изменений.
Возвращает: boolean — Истинно, если этот объект был удален в Microsoft Word при включенном отслеживании изменений.
isInsertRevision()
public boolean isInsertRevision()
Возвращает true, если этот объект был вставлен в Microsoft Word при включенном отслеживании изменений.
Возвращает: boolean — True, если этот объект был вставлен в Microsoft Word при включенном отслеживании изменений.
isMoveFromRevision()
public boolean isMoveFromRevision()
Возвращаетtrue если этот объект был перемещен (удален) в Microsoft Word при включенном отслеживании изменений.
Возвращает: логический -true если этот объект был перемещен (удален) в Microsoft Word при включенном отслеживании изменений.
isMoveToRevision()
public boolean isMoveToRevision()
Возвращаетtrue если этот объект был перемещен (вставлен) в Microsoft Word при включенном отслеживании изменений.
Возвращает: логический -true если этот объект был перемещен (вставлен) в Microsoft Word при включенном отслеживании изменений.
iterator()
public Iterator iterator()
Обеспечивает поддержку для каждой итерации стиля над дочерними узлами этого узла.
Возвращает: java.util.Iterator
nextPreOrder(Node rootNode)
public Node nextPreOrder(Node rootNode)
Получает следующий узел в соответствии с алгоритмом обхода дерева предварительного порядка.
Параметры:
Параметр | Тип | Описание |
---|---|---|
rootNode | Node | Верхний узел (предел) обхода. |
Возвращает: Node - Следующий узел в порядке предварительного заказа. Null, если достигнут rootNode.
nodeTypeToString(int nodeType)
public static String nodeTypeToString(int nodeType)
Параметры:
Параметр | Тип | Описание |
---|---|---|
nodeType | int |
Возвращает: java.lang.String
notify()
public final native void notify()
notifyAll()
public final native void notifyAll()
prependChild(Node newChild)
public Node prependChild(Node newChild)
Добавляет указанный узел в начало списка дочерних узлов для этого узла.
Если новый дочерний элемент уже находится в дереве, он сначала удаляется.
Если вставляемый узел был создан из другого документа, следует использоватьM:Aspose.Words.DocumentBase.ImportNode(Aspose.Words.Node,System.Boolean,Aspose.Words.ImportFormatMode) чтобы импортировать узел в текущий документ. Затем импортированный узел можно вставить в текущий документ.
Параметры:
Параметр | Тип | Описание |
---|---|---|
newChild | Node | Добавляемый узел. |
Возвращает: Node - Добавлен узел.
previousPreOrder(Node rootNode)
public Node previousPreOrder(Node rootNode)
Получает предыдущий узел в соответствии с алгоритмом обхода дерева предварительного порядка.
Параметры:
Параметр | Тип | Описание |
---|---|---|
rootNode | Node | Верхний узел (предел) обхода. |
Возвращает: Node - Предыдущий узел в порядке предварительного заказа. Null, если достигнут rootNode.
remove()
public void remove()
Удаляет себя из родителя.
removeAllChildren()
public void removeAllChildren()
Удаляет все дочерние узлы текущего узла.
removeAllReplies()
public void removeAllReplies()
Удаляет все ответы на этот комментарий. Все составляющие узлы ответов будут удалены из документа.
removeChild(Node oldChild)
public Node removeChild(Node oldChild)
Удаляет указанный дочерний узел.
Родительский элемент oldChild устанавливается равным нулю после удаления узла.
Параметры:
Параметр | Тип | Описание |
---|---|---|
oldChild | Node | Узел для удаления. |
Возвращает: Node - Удаленный узел.
removeMoveRevisions()
public void removeMoveRevisions()
removeReply(Comment reply)
public void removeReply(Comment reply)
Удаляет указанный ответ на этот комментарий. Все составляющие узлы ответа будут удалены из документа.
Параметры:
Параметр | Тип | Описание |
---|---|---|
reply | Comment | Узел комментария удаляющего ответа. |
removeRunAttr(int key)
public void removeRunAttr(int key)
Параметры:
Параметр | Тип | Описание |
---|---|---|
key | int |
removeSmartTags()
public void removeSmartTags()
Удаляет всеSmartTag узлы-потомки текущего узла. Этот метод не удаляет содержимое смарт-тегов.
selectNodes(String xpath)
public NodeList selectNodes(String xpath)
Выбирает список узлов, соответствующих выражению XPath.
На данный момент поддерживаются только выражения с именами элементов. Выражения, использующие имена атрибутов, не поддерживаются.
Параметры:
Параметр | Тип | Описание |
---|---|---|
xpath | java.lang.String | Выражение XPath. |
Возвращает: NodeList - Список узлов, соответствующих запросу XPath.
selectSingleNode(String xpath)
public Node selectSingleNode(String xpath)
Выбирает первый узел, соответствующий выражению XPath.
На данный момент поддерживаются только выражения с именами элементов. Выражения, использующие имена атрибутов, не поддерживаются.
Параметры:
Параметр | Тип | Описание |
---|---|---|
xpath | java.lang.String | Выражение XPath. |
Возвращает: Node - Первый узел, соответствующий запросу XPath, или нуль, если соответствующий узел не найден.
setAuthor(String value)
public void setAuthor(String value)
Устанавливает имя автора комментария.
Не может быть нулевым.
По умолчанию пустая строка.
Параметры:
Параметр | Тип | Описание |
---|---|---|
value | java.lang.String | Имя автора комментария. |
setCustomNodeId(int value)
public void setCustomNodeId(int value)
Задает идентификатор пользовательского узла.
По умолчанию ноль.
Этот идентификатор можно установить и использовать произвольно. Например, как ключ для получения внешних данных.
Важное примечание: указанное значение не сохраняется в выходной файл и существует только в течение срока службы узла.
Параметры:
Параметр | Тип | Описание |
---|---|---|
value | int | Соответствующее целочисленное значение. |
setDateTime(Date value)
public void setDateTime(Date value)
Получает дату и время создания комментария.
По умолчанию 03.01.0001.
Параметры:
Параметр | Тип | Описание |
---|---|---|
value | java.util.Date | Дата и время, когда был сделан комментарий. |
setDone(boolean value)
public void setDone(boolean value)
Устанавливает флаг, указывающий, что комментарий помечен как выполненный.
Параметры:
Параметр | Тип | Описание |
---|---|---|
value | boolean | Флаг, указывающий, что комментарий помечен как выполненный. |
setIdInternal(int value)
public void setIdInternal(int value)
Параметры:
Параметр | Тип | Описание |
---|---|---|
value | int |
setInitial(String value)
public void setInitial(String value)
Устанавливает инициалы пользователя, связанные с конкретным комментарием.
Не может быть нулевым.
По умолчанию пустая строка.
Параметры:
Параметр | Тип | Описание |
---|---|---|
value | java.lang.String | Инициалы пользователя, связанные с конкретным комментарием. |
setParentIdInternal(int value)
public void setParentIdInternal(int value)
Параметры:
Параметр | Тип | Описание |
---|---|---|
value | int |
setRunAttr(int fontAttr, Object value)
public void setRunAttr(int fontAttr, Object value)
Параметры:
Параметр | Тип | Описание |
---|---|---|
fontAttr | int | |
value | java.lang.Object |
setText(String text)
public void setText(String text)
Это удобный метод, позволяющий легко задать текст комментария.
Этот метод позволяет быстро задать текст комментария из строки. Строка может содержать разрывы абзацев, это соответственно создаст абзацы текста в комментарии. Если вы хотите вставить в комментарий более сложные элементы, например, закладки или таблицы, или применить расширенное форматирование, то вам нужно использовать соответствующие классы узлов для построения текста комментария.
Параметры:
Параметр | Тип | Описание |
---|---|---|
text | java.lang.String | Новый текст комментария. |
toString()
public String toString()
Возвращает: java.lang.String
toString(SaveOptions saveOptions)
public String toString(SaveOptions saveOptions)
Экспортирует содержимое узла в строку, используя указанные параметры сохранения.
Параметры:
Параметр | Тип | Описание |
---|---|---|
saveOptions | SaveOptions | Указывает параметры, управляющие способом сохранения узла. |
Возвращает: java.lang.String — содержимое узла в указанном формате.
toString(int saveFormat)
public String toString(int saveFormat)
Параметры:
Параметр | Тип | Описание |
---|---|---|
saveFormat | int |
Возвращает: java.lang.String
wait()
public final void wait()
wait(long arg0)
public final native void wait(long arg0)
Параметры:
Параметр | Тип | Описание |
---|---|---|
arg0 | long |
wait(long arg0, int arg1)
public final void wait(long arg0, int arg1)
Параметры:
Параметр | Тип | Описание |
---|---|---|
arg0 | long | |
arg1 | int |