Class Document

Документ

Представление XML-документа.

Методы

Метод Тип возврата Краткое описание
addContent(content) Document Добавляет данный узел в конец документа.
addContent(index, content) Document Вставляет данный узел по заданному индексу среди всех узлов, которые являются непосредственными дочерними элементами документа.
cloneContent() Content[] Создает неприсоединенные копии всех узлов, которые являются непосредственными дочерними элементами документа.
detachRootElement() Element Отключает и возвращает корневой узел Element документа.
getAllContent() Content[] Получает все узлы, являющиеся непосредственными дочерними элементами документа.
getContent(index) Content Получает узел по заданному индексу среди всех узлов, которые являются непосредственными дочерними элементами документа.
getContentSize() Integer Получает количество узлов, которые являются непосредственными дочерними элементами документа.
getDescendants() Content[] Получает все узлы, являющиеся прямыми или косвенными дочерними элементами документа, в том порядке, в котором они появляются в документе.
getDocType() DocType Получает объявление DocType документа.
getRootElement() Element Получает корневой узел Element документа.
hasRootElement() Boolean Определяет, имеет ли документ корневой узел Element .
removeContent() Content[] Удаляет все узлы, которые являются непосредственными дочерними элементами документа.
removeContent(content) Boolean Удаляет данный узел, если узел является непосредственным дочерним элементом документа.
removeContent(index) Content Удаляет узел по заданному индексу среди всех узлов, которые являются непосредственными дочерними элементами документа.
setDocType(docType) Document Устанавливает объявление DocType документа.
setRootElement(element) Document Устанавливает корневой узел Element документа.

Подробная документация

addContent(content)

Добавляет данный узел в конец документа. Аргументом content может быть объект Content или любой объект узла, соответствующий типу, указанному в ContentType . Однако обратите внимание, что документ может иметь только один дочерний узел Element , который неявно является корневым узлом Element .

Параметры

Имя Тип Описание
content Content узел для добавления

Возвращаться

Document — документ для связывания


addContent(index, content)

Вставляет данный узел по заданному индексу среди всех узлов, которые являются непосредственными дочерними элементами документа. Аргументом content может быть объект Content или любой объект узла, соответствующий типу, указанному в ContentType . Однако обратите внимание, что документ может иметь только один дочерний узел Element , который неявно является корневым узлом Element .

Параметры

Имя Тип Описание
index Integer индекс, по которому вставляется узел среди всех узлов, которые являются непосредственными дочерними элементами документа
content Content узел для вставки

Возвращаться

Document — документ для связывания


cloneContent()

Создает неприсоединенные копии всех узлов, которые являются непосредственными дочерними элементами документа.

Возвращаться

Content[] — массив неприсоединённых копий всех узлов, которые являются непосредственными дочерними элементами документа.


detachRootElement()

Отключает и возвращает корневой узел Element документа. Если в документе нет корневого узла Element , этот метод возвращает null .

Возвращаться

Element — отдельный узел Element или null , если документ не имеет корневого узла Element .


getAllContent()

Получает все узлы, являющиеся непосредственными дочерними элементами документа.

Возвращаться

Content[] — массив всех узлов, которые являются непосредственными дочерними элементами документа.


getContent(index)

Получает узел по заданному индексу среди всех узлов, которые являются непосредственными дочерними элементами документа. Если по данному индексу нет узла, этот метод возвращает null .

Параметры

Имя Тип Описание
index Integer индекс узла среди всех узлов, которые являются непосредственными дочерними элементами документа

Возвращаться

Content — узел или null , если узла по данному индексу нет.


getContentSize()

Получает количество узлов, которые являются непосредственными дочерними элементами документа.

Возвращаться

Integer — количество узлов, которые являются непосредственными дочерними элементами документа.


getDescendants()

Получает все узлы, являющиеся прямыми или косвенными дочерними элементами документа, в том порядке, в котором они появляются в документе.

Возвращаться

Content[] — массив всех узлов, которые являются прямыми или косвенными дочерними элементами документа.


getDocType()

Получает объявление DocType документа. Если в документе нет узла DocumentType , этот метод возвращает null .

Возвращаться

DocType — узел DocumentType или null , если документ не имеет узла DocumentType .


getRootElement()

Получает корневой узел Element документа. Если в документе нет корневого узла Element , этот метод возвращает null .

Возвращаться

Element — корневой узел Element или null , если в документе нет корневого узла Element .


hasRootElement()

Определяет, имеет ли документ корневой узел Element .

Возвращаться

Booleantrue , если документ имеет корневой узел Element ; false если нет


removeContent()

Удаляет все узлы, которые являются непосредственными дочерними элементами документа.

Возвращаться

Content[] — массив всех узлов, которые были непосредственными дочерними элементами документа до их удаления.


removeContent(content)

Удаляет данный узел, если узел является непосредственным дочерним элементом документа. Аргументом content может быть объект Content или любой объект узла, соответствующий типу, указанному в ContentType .

Параметры

Имя Тип Описание
content Content узел, который нужно удалить

Возвращаться

Booleantrue , если узел был непосредственным дочерним элементом и был удален; false если нет


removeContent(index)

Удаляет узел по заданному индексу среди всех узлов, которые являются непосредственными дочерними элементами документа. Если по данному индексу нет узла, этот метод возвращает null .

Параметры

Имя Тип Описание
index Integer индекс узла среди всех узлов, которые являются непосредственными дочерними элементами документа

Возвращаться

Content — узел, который был удален, или null , если узла по данному индексу нет.


setDocType(docType)

Устанавливает объявление DocType документа. Если в документе уже есть другой узел DocType , этот метод перезаписывает старый узел. Этот метод создает исключение, если документ уже содержит тот же узел DocType , который задается.

Параметры

Имя Тип Описание
docType DocType DocumentType для установки

Возвращаться

Document — документ для связывания


setRootElement(element)

Устанавливает корневой узел Element документа. Если в документе уже есть корневой узел Element , этот метод перезаписывает старый узел.

Параметры

Имя Тип Описание
element Element корневой узел Element для установки

Возвращаться

Document — документ для связывания