Интерфейс HTMLDocument

Все суперинтерфейсы:: Document, Node

public interface HTMLDocument extends Document

HTMLDocument является корнем иерархии HTML и содержит всё содержимое. Помимо предоставления доступа к иерархии, он также предоставляет некоторые удобные методы для получения определённых наборов сведений из документа.

Следующие свойства объявлены устаревшими в пользу соответствующих свойств элемента BODY: alinkColor background bgColor fgColor linkColor vlinkColor В DOM Level 2 метод getElementById наследуется от интерфейса Document, куда он был перемещён.

См. также спецификацию объектной модели документа (DOM) Level 2.

Начиная с:: 1.4, DOM Level 2

Краткое описание полей

Поля, объявленные в интерфейсе Node

ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

Модификатор и тип	Поле	Описание
`static final short`	`ATTRIBUTE_NODE`	Узел является `Attr`.
`static final short`	`CDATA_SECTION_NODE`	Узел является `CDATASection`.
`static final short`	`COMMENT_NODE`	Узел является `Comment`.
`static final short`	`DOCUMENT_FRAGMENT_NODE`	Узел является `DocumentFragment`.
`static final short`	`DOCUMENT_NODE`	Узел является `Document`.
`static final short`	`DOCUMENT_POSITION_CONTAINED_BY`	Узел содержится в опорном узле.
`static final short`	`DOCUMENT_POSITION_CONTAINS`	Узел содержит опорный узел.
`static final short`	`DOCUMENT_POSITION_DISCONNECTED`	Узлы не связаны.
`static final short`	`DOCUMENT_POSITION_FOLLOWING`	Узел следует за опорным узлом.
`static final short`	`DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC`	Определение порядка предшествования и следования зависит от реализации.
`static final short`	`DOCUMENT_POSITION_PRECEDING`	Второй узел предшествует опорному узлу.
`static final short`	`DOCUMENT_TYPE_NODE`	Узел является `DocumentType`.
`static final short`	`ELEMENT_NODE`	Узел является `Element`.
`static final short`	`ENTITY_NODE`	Узел является `Entity`.
`static final short`	`ENTITY_REFERENCE_NODE`	Узел является `EntityReference`.
`static final short`	`NOTATION_NODE`	Узел является `Notation`.
`static final short`	`PROCESSING_INSTRUCTION_NODE`	Узел является `ProcessingInstruction`.
`static final short`	`TEXT_NODE`	Узел является узлом `Text`.

Краткое описание методов

Модификатор и тип	Метод	Описание
`void`	`close()`	Закрывает поток документа, открытый методом `open()`, и принудительно выполняет отрисовку.
`HTMLCollection`	`getAnchors()`	Коллекция всех элементов-якорей (`A`), имеющих значение атрибута `name`.
`HTMLCollection`	`getApplets()`	Коллекция всех элементов `OBJECT` документа, включая апплеты и элементы `APPLET` (устаревшие).
`HTMLElement`	`getBody()`	Элемент, содержащий содержимое документа.
`String`	`getCookie()`	Файлы cookie, связанные с этим документом.
`String`	`getDomain()`	Доменное имя сервера, с которого был получен документ, или `null`, если сервер нельзя идентифицировать по доменному имени.
`NodeList`	`getElementsByName(String elementName)`	Возвращает коллекцию элементов, значение `name` которых задано параметром `elementName` (коллекция может быть пустой).
`HTMLCollection`	`getForms()`	Коллекция всех форм документа.
`HTMLCollection`	`getImages()`	Коллекция всех элементов `IMG` документа.
`HTMLCollection`	`getLinks()`	Коллекция всех элементов `AREA` и элементов-якорей (`A`), имеющих значение атрибута `href`.
`String`	`getReferrer()`	Возвращает URI страницы, с которой была выполнена ссылка на эту страницу.
`String`	`getTitle()`	Заголовок документа, заданный элементом `TITLE` в его заголовочной части.
`String`	`getURL()`	Полный URI документа.
`void`	`open()`	Примечание.
`void`	`setBody(HTMLElement body)`
`void`	`setCookie(String cookie)`
`void`	`setTitle(String title)`
`void`	`write(String text)`	Записывает строку текста в поток документа, открытый методом `open()`.
`void`	`writeln(String text)`	Записывает строку текста, за которой следует символ новой строки, в поток документа, открытый методом `open()`.

Методы, объявленные в интерфейсе Document

adoptNode, createAttribute, createAttributeNS, createCDATASection, createComment, createDocumentFragment, createElement, createElementNS, createEntityReference, createProcessingInstruction, createTextNode, getDoctype, getDocumentElement, getDocumentURI, getDomConfig, getElementById, getElementsByTagName, getElementsByTagNameNS, getImplementation, getInputEncoding, getStrictErrorChecking, getXmlEncoding, getXmlStandalone, getXmlVersion, importNode, normalizeDocument, renameNode, setDocumentURI, setStrictErrorChecking, setXmlStandalone, setXmlVersion

Модификатор и тип	Метод	Описание
`Node`	`adoptNode(Node source)`	Пытается перенести узел из другого документа в этот документ.
`Attr`	`createAttribute(String name)`	Создаёт `Attr` с заданным именем.
`Attr`	`createAttributeNS(String namespaceURI, String qualifiedName)`	Создаёт атрибут с заданным квалифицированным именем и URI пространства имён.
`CDATASection`	`createCDATASection(String data)`	Создаёт узел `CDATASection`, значением которого является указанная строка.
`Comment`	`createComment(String data)`	Создаёт узел `Comment` с указанной строкой.
`DocumentFragment`	`createDocumentFragment()`	Создаёт пустой объект `DocumentFragment`.
`Element`	`createElement(String tagName)`	Создаёт элемент указанного типа.
`Element`	`createElementNS(String namespaceURI, String qualifiedName)`	Создаёт элемент с заданными квалифицированным именем и URI пространства имён.
`EntityReference`	`createEntityReference(String name)`	Создаёт объект `EntityReference`.
`ProcessingInstruction`	`createProcessingInstruction(String target, String data)`	Создаёт узел `ProcessingInstruction` с заданными строками имени и данных.
`Text`	`createTextNode(String data)`	Создаёт узел `Text` с указанной строкой.
`DocumentType`	`getDoctype()`	Объявление типа документа (см. `DocumentType`), связанное с этим документом.
`Element`	`getDocumentElement()`	Этот удобный атрибут предоставляет прямой доступ к дочернему узлу, являющемуся элементом документа.
`String`	`getDocumentURI()`	Местоположение документа или `null`, если оно не определено либо если `Document` был создан с помощью `DOMImplementation.createDocument`.
`DOMConfiguration`	`getDomConfig()`	Конфигурация, используемая при вызове `Document.normalizeDocument()`.
`Element`	`getElementById(String elementId)`	Возвращает `Element`, атрибут ID которого имеет заданное значение.
`NodeList`	`getElementsByTagName(String tagname)`	Возвращает `NodeList` всех `Elements`, содержащихся в документе и имеющих заданное имя тега, в порядке следования в документе.
`NodeList`	`getElementsByTagNameNS(String namespaceURI, String localName)`	Возвращает `NodeList` всех `Elements` с заданными локальным именем и URI пространства имён в порядке следования в документе.
`DOMImplementation`	`getImplementation()`	Объект `DOMImplementation`, обрабатывающий этот документ.
`String`	`getInputEncoding()`	Атрибут, указывающий кодировку, использованную для этого документа во время разбора.
`boolean`	`getStrictErrorChecking()`	Атрибут, указывающий, выполняется ли проверка ошибок.
`String`	`getXmlEncoding()`	Атрибут, указывающий в составе объявления XML кодировку этого документа.
`boolean`	`getXmlStandalone()`	Атрибут, указывающий в составе объявления XML, является ли этот документ автономным.
`String`	`getXmlVersion()`	Атрибут, указывающий в составе объявления XML номер версии этого документа.
`Node`	`importNode(Node importedNode, boolean deep)`	Импортирует узел из другого документа в этот документ, не изменяя и не удаляя исходный узел из исходного документа; этот метод создаёт новую копию исходного узла.
`void`	`normalizeDocument()`	Этот метод действует так, как если бы документ проходил цикл сохранения и загрузки, приводя его к «нормальной» форме.
`Node`	`renameNode(Node n, String namespaceURI, String qualifiedName)`	Переименовывает существующий узел типа `ELEMENT_NODE` или `ATTRIBUTE_NODE`.
`void`	`setDocumentURI(String documentURI)`	Местоположение документа или `null`, если оно не определено либо если `Document` был создан с помощью `DOMImplementation.createDocument`.
`void`	`setStrictErrorChecking(boolean strictErrorChecking)`	Атрибут, указывающий, выполняется ли проверка ошибок.
`void`	`setXmlStandalone(boolean xmlStandalone)`	Атрибут, указывающий в составе объявления XML, является ли этот документ автономным.
`void`	`setXmlVersion(String xmlVersion)`	Атрибут, указывающий в составе объявления XML номер версии этого документа.

Методы, объявленные в интерфейсе Node

appendChild, cloneNode, compareDocumentPosition, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData

Модификатор и тип	Метод	Описание
`Node`	`appendChild(Node newChild)`	Добавляет узел `newChild` в конец списка дочерних узлов этого узла.
`Node`	`cloneNode(boolean deep)`	Возвращает дубликат этого узла, то есть служит универсальным конструктором копирования для узлов.
`short`	`compareDocumentPosition(Node other)`	Сравнивает опорный узел (то есть узел, для которого вызывается этот метод) с другим узлом (переданным в качестве параметра) по их положению в документе в соответствии с порядком документа.
`NamedNodeMap`	`getAttributes()`	Объект `NamedNodeMap`, содержащий атрибуты этого узла (если это `Element`), или `null` в противном случае.
`String`	`getBaseURI()`	Абсолютный базовый URI этого узла или `null`, если реализации не удалось получить абсолютный URI.
`NodeList`	`getChildNodes()`	Объект `NodeList`, содержащий все дочерние узлы этого узла.
`Object`	`getFeature(String feature, String version)`	Этот метод возвращает специализированный объект, реализующий специализированные API указанной функции и версии, как указано в .
`Node`	`getFirstChild()`	Первый дочерний узел этого узла.
`Node`	`getLastChild()`	Последний дочерний узел этого узла.
`String`	`getLocalName()`	Возвращает локальную часть квалифицированного имени этого узла.
`String`	`getNamespaceURI()`	URI пространства имён этого узла или `null`, если он не задан (см. ).
`Node`	`getNextSibling()`	Узел, непосредственно следующий за этим узлом.
`String`	`getNodeName()`	Имя этого узла в зависимости от его типа; см. таблицу выше.
`short`	`getNodeType()`	Код, представляющий тип базового объекта, как определено выше.
`String`	`getNodeValue()`	Значение этого узла в зависимости от его типа; см. таблицу выше.
`Document`	`getOwnerDocument()`	Объект `Document`, связанный с этим узлом.
`Node`	`getParentNode()`	Родительский узел этого узла.
`String`	`getPrefix()`	Префикс пространства имён этого узла или `null`, если он не задан.
`Node`	`getPreviousSibling()`	Узел, непосредственно предшествующий этому узлу.
`String`	`getTextContent()`	Этот атрибут возвращает текстовое содержимое данного узла и его потомков.
`Object`	`getUserData(String key)`	Получает объект, связанный с ключом в этом узле.
`boolean`	`hasAttributes()`	Возвращает значение, указывающее, имеет ли этот узел (если это элемент) какие-либо атрибуты.
`boolean`	`hasChildNodes()`	Возвращает значение, указывающее, есть ли у этого узла дочерние узлы.
`Node`	`insertBefore(Node newChild, Node refChild)`	Вставляет узел `newChild` перед существующим дочерним узлом `refChild`.
`boolean`	`isDefaultNamespace(String namespaceURI)`	Этот метод проверяет, является ли указанный `namespaceURI` пространством имён по умолчанию.
`boolean`	`isEqualNode(Node arg)`	Проверяет, равны ли два узла.
`boolean`	`isSameNode(Node other)`	Возвращает значение, указывающее, является ли этот узел тем же узлом, что и заданный.
`boolean`	`isSupported(String feature, String version)`	Проверяет, реализует ли DOM-реализация определённую функцию и поддерживается ли эта функция данным узлом, как указано в .
`String`	`lookupNamespaceURI(String prefix)`	Ищет URI пространства имён, связанный с заданным префиксом, начиная с этого узла.
`String`	`lookupPrefix(String namespaceURI)`	Ищет префикс, связанный с заданным URI пространства имён, начиная с этого узла.
`void`	`normalize()`	Приводит все узлы `Text` на всей глубине поддерева под этим `Node`, включая узлы-атрибуты, к «нормальной» форме, в которой узлы `Text` разделяются только структурными элементами (например, элементами, комментариями, инструкциями обработки, разделами CDATA и ссылками на сущности); то есть смежных узлов `Text` и пустых узлов `Text` не существует.
`Node`	`removeChild(Node oldChild)`	Удаляет дочерний узел, указанный параметром `oldChild`, из списка дочерних узлов и возвращает его.
`Node`	`replaceChild(Node newChild, Node oldChild)`	Заменяет дочерний узел `oldChild` узлом `newChild` в списке дочерних узлов и возвращает узел `oldChild`.
`void`	`setNodeValue(String nodeValue)`	Значение этого узла в зависимости от его типа; см. таблицу выше.
`void`	`setPrefix(String prefix)`	Префикс пространства имён этого узла или `null`, если он не задан.
`void`	`setTextContent(String textContent)`	Этот атрибут возвращает текстовое содержимое данного узла и его потомков.
`Object`	`setUserData(String key, Object data, UserDataHandler handler)`	Связывает объект с ключом в этом узле.

Подробное описание методов

getTitle

String getTitle()

Заголовок документа, заданный элементом TITLE в его заголовочной части.

setTitle

void setTitle(String title)

getReferrer

String getReferrer()

Возвращает URI страницы, с которой была выполнена ссылка на эту страницу. Значение представляет собой пустую строку, если пользователь перешёл на страницу напрямую (не по ссылке, а, например, с помощью закладки).

getDomain

String getDomain()

Доменное имя сервера, с которого был получен документ, или null, если сервер нельзя идентифицировать по доменному имени.

getURL

String getURL()

Полный URI документа.

getBody

HTMLElement getBody()

Элемент, содержащий содержимое документа. В документах с содержимым BODY возвращает элемент BODY. В документах с набором фреймов возвращает самый внешний элемент FRAMESET.

setBody

void setBody(HTMLElement body)

getImages

HTMLCollection getImages()

Коллекция всех элементов IMG документа. Для обратной совместимости поведение ограничено элементами IMG.

getApplets

HTMLCollection getApplets()

Коллекция всех элементов OBJECT документа, включая апплеты и элементы APPLET (устаревшие).

getLinks

HTMLCollection getLinks()

Коллекция всех элементов AREA и элементов-якорей (A), имеющих значение атрибута href.

getForms

HTMLCollection getForms()

Коллекция всех форм документа.

getAnchors

HTMLCollection getAnchors()

Коллекция всех элементов-якорей (A), имеющих значение атрибута name. Примечание. По причинам обратной совместимости возвращаемый набор якорей содержит только те якоря, которые созданы с атрибутом name, но не те, которые созданы с атрибутом id.

getCookie

String getCookie()

Файлы cookie, связанные с этим документом. Если их нет, значение представляет собой пустую строку. В противном случае значение является строкой — разделённым точками с запятой списком пар «имя, значение» для всех файлов cookie, связанных со страницей. Например, name=value;expires=date.

setCookie

void setCookie(String cookie)

open

void open()

Примечание. Этот метод и следующие за ним методы позволяют пользователю добавлять к структурной модели документа или заменять её с помощью строк неразобранного HTML. На момент написания рассматривались альтернативные методы предоставления аналогичной функциональности для HTML- и XML-документов. В будущем следующие методы могут быть объявлены устаревшими в пользу более универсального механизма.
Открывает поток документа для записи. Если целевой объект содержит документ, этот метод очищает его.

close

void close()

Закрывает поток документа, открытый методом open(), и принудительно выполняет отрисовку.

write

void write(String text)

Записывает строку текста в поток документа, открытый методом open(). Текст разбирается и включается в структурную модель документа.

Параметры:: text — строка, которую необходимо разобрать и включить в структуру структурной модели документа.

writeln

void writeln(String text)

Записывает строку текста, за которой следует символ новой строки, в поток документа, открытый методом open(). Текст разбирается и включается в структурную модель документа.

Параметры:: text — строка, которую необходимо разобрать и включить в структуру структурной модели документа.

getElementsByName

NodeList getElementsByName(String elementName)

Возвращает коллекцию элементов (возможно, пустую), значение name которых задано параметром elementName.

Параметры:: elementName — значение атрибута name для элемента.
Возвращает:: Соответствующие элементы.

© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.