Элемент интерфейса

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

Все известные подинтерфейсы:: HTMLAnchorElement, HTMLAppletElement, HTMLAreaElement, HTMLBaseElement, HTMLBaseFontElement, HTMLBodyElement, HTMLBRElement, HTMLButtonElement, HTMLDirectoryElement, HTMLDivElement, HTMLDListElement, HTMLElement, HTMLFieldSetElement, HTMLFontElement, HTMLFormElement, HTMLFrameElement, HTMLFrameSetElement, HTMLHeadElement, HTMLHeadingElement, HTMLHRElement, HTMLHtmlElement, HTMLIFrameElement, HTMLImageElement, HTMLInputElement, HTMLIsIndexElement, HTMLLabelElement, HTMLLegendElement, HTMLLIElement, HTMLLinkElement, HTMLMapElement, HTMLMenuElement, HTMLMetaElement, HTMLModElement, HTMLObjectElement, HTMLOListElement, HTMLOptGroupElement, HTMLOptionElement, HTMLParagraphElement, HTMLParamElement, HTMLPreElement, HTMLQuoteElement, HTMLScriptElement, HTMLSelectElement, HTMLStyleElement, HTMLTableCaptionElement, HTMLTableCellElement, HTMLTableColElement, HTMLTableElement, HTMLTableRowElement, HTMLTableSectionElement, HTMLTextAreaElement, HTMLTitleElement, HTMLUListElement

Все известные реализующие классы:: IIOMetadataNode

public interface Element extends Node

Интерфейс Element представляет элемент в документе HTML или XML. Элементы могут иметь атрибуты; так как интерфейс Element наследуется от Node, общий интерфейс Node атрибут attributes может использоваться для получения набора всех атрибутов для элемента. В интерфейсе Element есть методы для получения объекта Attr по имени или значения атрибута по имени. В XML, где значение атрибута может содержать ссылки на сущности, следует получить объект Attr для изучения потенциально достаточно сложной поддеревья, представляющей значение атрибута. С другой стороны, в HTML, где все атрибуты имеют простые строковые значения, методы для прямого доступа к значению атрибута могут безопасно использоваться в качестве удобства.

Примечание: В DOM Level 2 метод normalize унаследован от интерфейса Node , куда он был перемещен.

См. также Спецификацию уровня 3 Core документа Object Model (DOM).

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

Поля, объявленные в интерфейсе org.w3c.dom.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

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

Модификатор и тип	Метод	Описание
`String`	`getAttribute(String name)`	Получает значение атрибута по имени.
`Attr`	`getAttributeNode(String name)`	Получает узел атрибута по имени.
`Attr`	`getAttributeNodeNS(String namespaceURI, String localName)`	Получает узел `Attr` по локальному имени и URI пространства имен.
`String`	`getAttributeNS(String namespaceURI, String localName)`	Получает значение атрибута по локальному имени и URI пространства имен.
`NodeList`	`getElementsByTagName(String name)`	Возвращает `NodeList` всех дочерних `Elements` с заданным именем тега в порядке документа.
`NodeList`	`getElementsByTagNameNS(String namespaceURI, String localName)`	Возвращает `NodeList` всех дочерних `Elements` с заданным локальным именем и URI пространства имен в порядке документа.
`TypeInfo`	`getSchemaTypeInfo()`	Информация о типе, связанная с этим элементом.
`String`	`getTagName()`	Имя элемента.
`boolean`	`hasAttribute(String name)`	Возвращает `true` , когда атрибут с заданным именем указан в этом элементе или имеет значение по умолчанию, `false` в противном случае.
`boolean`	`hasAttributeNS(String namespaceURI, String localName)`	Возвращает `true` , когда атрибут с заданным локальным именем и URI пространства имен указан в этом элементе или имеет значение по умолчанию, `false` в противном случае.
`void`	`removeAttribute(String name)`	Удаляет атрибут по имени.
`Attr`	`removeAttributeNode(Attr oldAttr)`	Удаляет указанный узел атрибута.
`void`	`removeAttributeNS(String namespaceURI, String localName)`	Удаляет атрибут по локальному имени и URI пространства имен.
`void`	`setAttribute(String name, String value)`	Добавляет новый атрибут.
`Attr`	`setAttributeNode(Attr newAttr)`	Добавляет новый узел атрибута.
`Attr`	`setAttributeNodeNS(Attr newAttr)`	Добавляет новый атрибут.
`void`	`setAttributeNS(String namespaceURI, String qualifiedName, String value)`	Добавляет новый атрибут.
`void`	`setIdAttribute(String name, boolean isId)`	Если параметр `isId` равен `true`, этот метод объявляет указанный атрибут атрибутом ID, определяемым пользователем.
`void`	`setIdAttributeNode(Attr idAttr, boolean isId)`	Если параметр `isId` равен `true`, этот метод объявляет указанный атрибут атрибутом ID, определяемым пользователем.
`void`	`setIdAttributeNS(String namespaceURI, String localName, boolean isId)`	Если параметр `isId` равен `true`, этот метод объявляет указанный атрибут атрибутом ID, определяемым пользователем.

Методы, объявленные в интерфейсе org.w3c.dom.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

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

getTagName

String getTagName()

Имя элемента. Если Node.localName отличается от null, этот атрибут является квалифицированным именем. Например, в:

 <elementExample id="demo"> ...
 </elementExample> ,

tagName имеет значение "elementExample". Обратите внимание, что это сохраняет регистр в XML, как и все операции DOM. HTML DOM возвращает tagName HTML-элемента в канонической форме заглавных букв, независимо от регистра в исходном HTML-документе.

getAttribute

String getAttribute(String name)

Извлекает значение атрибута по имени.

Параметры:: name - Имя атрибута для извлечения.
Возвращает:: Значение атрибута в виде строки или пустую строку, если у этого атрибута нет заданного или значения по умолчанию.

setAttribute

void setAttribute(String name, String value) throws DOMException

Добавляет новый атрибут. Если атрибут с этим именем уже присутствует в элементе, его значение изменяется на значение параметра value. Это значение — простая строка; она не анализируется при установке. Любой разметка (например, синтаксис, распознаваемый как ссылка на сущность) обрабатывается как текстовая строка, и должна быть соответствующим образом экранирована реализацией при записи. Для присваивания значения атрибута, содержащего ссылки на сущности, пользователь должен создать узел Attr, а также любые узлы Text и EntityReference, создать соответствующее поддерево и использовать setAttributeNode, чтобы назначить его в качестве значения атрибута.
Для установки атрибута с квалифицированным именем и URI пространства имен используйте метод setAttributeNS.

Параметры:: name - Имя атрибута для создания или изменения.; value - Значение для установки в строковом формате.
Исключения:: DOMException - INVALID_CHARACTER_ERR: Вызывается, если указанное имя не является именем XML в соответствии с используемой версией XML, указанной в атрибуте Document.xmlVersion.
NO_MODIFICATION_ALLOWED_ERR: Вызывается, если этот узел является только для чтения.

removeAttribute

void removeAttribute(String name) throws DOMException

Удаляет атрибут по имени. Если значение по умолчанию для удаленного атрибута определено в DTD, новый атрибут сразу появляется со значением по умолчанию, а также с соответствующим URI пространства имен, локальным именем и префиксом, когда это применимо. Реализация может аналогично обрабатывать значения по умолчанию из других схем, но приложения должны использовать Document.normalizeDocument(), чтобы гарантировать, что эта информация актуальна.
Если атрибут с этим именем не найден, этот метод не оказывает никакого эффекта.
Для удаления атрибута по локальному имени и URI пространства имен используйте метод removeAttributeNS.

Параметры:: name - Имя атрибута для удаления.
Исключения:: DOMException - NO_MODIFICATION_ALLOWED_ERR: Вызывается, если этот узел является только для чтения.

getAttributeNode

Attr getAttributeNode(String name)

Возвращает узел атрибута по имени.
Для получения узла атрибута по квалифицированному имени и URI пространства имен используйте метод getAttributeNodeNS.

Параметры:: name - Имя (nodeName) атрибута для извлечения.
Возвращает:: Узел Attr с указанным именем (nodeName) или null, если такого атрибута нет.

setAttributeNode

Attr setAttributeNode(Attr newAttr) throws DOMException

Добавляет новый узел атрибута. Если атрибут с таким именем (nodeName) уже присутствует в элементе, он заменяется новым. Замена узла атрибута самим собой не оказывает никакого эффекта.
Для добавления нового узла атрибута с квалифицированным именем и URI пространства имен используйте метод setAttributeNodeNS.

Параметры:: newAttr - Узел Attr для добавления в список атрибутов.
Возвращает:: Если атрибут newAttr заменяет существующий атрибут, возвращается замененный узел Attr, в противном случае возвращается null.
Исключения:: DOMException - WRONG_DOCUMENT_ERR: Вызывается, если newAttr был создан из другого документа, чем тот, который создал элемент.
NO_MODIFICATION_ALLOWED_ERR: Вызывается, если этот узел является только для чтения.
INUSE_ATTRIBUTE_ERR: Вызывается, если newAttr уже является атрибутом другого объекта Element. Пользователь DOM должен явно клонировать узлы Attr для их повторного использования в других элементах.

removeAttributeNode

Attr removeAttributeNode(Attr oldAttr) throws DOMException

Удаляет указанный узел атрибута. Если значение по умолчанию для удаленного узла Attr атрибута определено в DTD, новый узел появляется сразу же со значением по умолчанию, а также с соответствующим URI пространства имен, локальным именем и префиксом, когда это применимо. Реализация может аналогично обрабатывать значения по умолчанию из других схем, но приложения должны использовать Document.normalizeDocument(), чтобы гарантировать, что эта информация актуальна.

Параметры:: oldAttr - Узел Attr для удаления из списка атрибутов.
Возвращает:: Узел Attr атрибута, который был удален.
Исключения:: DOMException - NO_MODIFICATION_ALLOWED_ERR: Вызывается, если этот узел является только для чтения.
NOT_FOUND_ERR: Вызывается, если oldAttr не является атрибутом элемента.

getElementsByTagName

NodeList getElementsByTagName(String name)

Возвращает список всех дочерних элементов с заданным именем тега в порядке документа.

Параметры:: name - Имя тега для сопоставления. Специальное значение "*" соответствует всем тегам.
Возвращает:: Список узлов Element элементов, соответствующих условию.

getAttributeNS

String getAttributeNS(String namespaceURI, String localName) throws DOMException

Извлекает значение атрибута по локальному имени и URI пространства имен.
Согласно [XML Namespaces], приложения должны использовать значение null в качестве параметра namespaceURI для методов, если они хотят не использовать пространство имен.

Параметры:: namespaceURI - URI пространства имен атрибута для извлечения.; localName - Локальное имя атрибута для извлечения.
Возвращает:: Значение атрибута в виде строки или пустую строку, если у этого атрибута нет заданного или значения по умолчанию.
Исключения:: DOMException - NOT_SUPPORTED_ERR: Может быть вызвано, если реализация не поддерживает функцию "XML" и язык, экспонируемый через документ, не поддерживает XML Namespaces (например, [HTML 4.01]).
С:: 1.4, DOM Level 2

setAttributeNS

void setAttributeNS(String namespaceURI, String qualifiedName, String value) throws DOMException

Добавляет новый атрибут. Если атрибут с тем же локальным именем и URI пространства имен уже присутствует в элементе, его префикс изменяется на префиксную часть qualifiedName, а его значение изменяется на значение параметра value. Это значение — простая строка; она не анализируется при установке. Любой разметка (например, синтаксис, распознаваемый как ссылка на сущность) обрабатывается как текстовая строка, и должна быть соответствующим образом экранирована реализацией при записи. Для присваивания значения атрибута, содержащего ссылки на сущности, пользователь должен создать узел Attr, а также любые узлы Text и EntityReference, создать соответствующее поддерево и использовать setAttributeNodeNS или setAttributeNode для присвоения его в качестве значения атрибута.
Согласно [XML Namespaces], приложения должны использовать значение null в качестве параметра namespaceURI для методов, если они хотят не использовать пространство имен.

Параметры:: namespaceURI - URI пространства имен добавляемого или изменяемого атрибута.; qualifiedName - Квалифицированное имя добавляемого или изменяемого атрибута.; value - Значение для установки в строковом формате.
Исключения:: DOMException - INVALID_CHARACTER_ERR: Вызывается, если указанное квалифицированное имя не является именем XML в соответствии с используемой версией XML, указанной в атрибуте Document.xmlVersion.
NO_MODIFICATION_ALLOWED_ERR: Вызывается, если этот узел является только для чтения.
NAMESPACE_ERR: Вызывается, если URI пространства имен имеет неправильный формат согласно спецификации пространств имен в XML, если у qualifiedName есть префикс и qualifiedName имеет префикс, который является "xml", а namespaceURI отличается от " http://www.w3.org/XML/1998/namespace", если qualifiedName имеет префикс "xmlns" и namespaceURI отличается от "http://www.w3.org/2000/xmlns/", или если qualifiedName равно "http://www.w3.org/2000/xmlns/" и ни qualifiedName ни его префикс не является "xmlns".
NOT_SUPPORTED_ERR: Может быть вызвано, если реализация не поддерживает функцию "XML" и язык, экспонируемый через документ, не поддерживает XML Namespaces (например, [HTML 4.01]).
С:: 1.4, DOM Level 2

removeAttributeNS

void removeAttributeNS(String namespaceURI, String localName) throws DOMException

Удаляет атрибут по локальному имени и URI пространства имён. Если для удаляемого атрибута определено значение по умолчанию в DTD, сразу же появляется новый атрибут со значением по умолчанию, а также соответствующим URI пространства имён, локальным именем и префиксом, если применимо. Реализация может аналогичным образом обрабатывать значения по умолчанию из других схем, но приложения должны использовать Document.normalizeDocument() для гарантии актуальности этой информации.
Если атрибут с этим локальным именем и URI пространства имён не найден, этот метод не оказывает никакого действия.
В соответствии с [XML Namespaces], приложения должны использовать значение null в качестве параметра namespaceURI для методов, если они хотят использовать отсутствие пространства имён.

Parameters:: namespaceURI - URI пространства имён удаляемого атрибута.; localName - Локальное имя удаляемого атрибута.
Throws:: DOMException - NO_MODIFICATION_ALLOWED_ERR: Возникает, если этот узел только для чтения.
NOT_SUPPORTED_ERR: Может возникнуть, если реализация не поддерживает функцию "XML" и язык, доступный через Document, не поддерживает XML-пространства имён (например, [HTML 4.01]).
Since:: 1.4, DOM Level 2

getAttributeNodeNS

Attr getAttributeNodeNS(String namespaceURI, String localName) throws DOMException

Возвращает узел атрибута Attr по локальному имени и URI пространства имён.
В соответствии с [XML Namespaces], приложения должны использовать значение null в качестве параметра namespaceURI для методов, если они хотят использовать отсутствие пространства имён.

Parameters:: namespaceURI - URI пространства имён атрибута для извлечения.; localName - Локальное имя атрибута для извлечения.
Returns:: Узел атрибута Attr с указанным локальным именем атрибута и URI пространства имён или null если такого атрибута нет.
Throws:: DOMException - NOT_SUPPORTED_ERR: Может возникнуть, если реализация не поддерживает функцию "XML" и язык, доступный через Document, не поддерживает XML-пространства имён (например, [HTML 4.01]).
Since:: 1.4, DOM Level 2

setAttributeNodeNS

Attr setAttributeNodeNS(Attr newAttr) throws DOMException

Добавляет новый атрибут. Если атрибут с таким локальным именем и URI пространства имён уже присутствует в элементе, он заменяется новым. Замена узла атрибута на сам себя не оказывает никакого эффекта.
В соответствии с [XML Namespaces], приложения должны использовать значение null в качестве параметра namespaceURI для методов, если они хотят использовать отсутствие пространства имён.

Parameters:: newAttr - Узел Attr для добавления в список атрибутов.
Returns:: Если атрибут newAttr заменяет существующий атрибут с тем же локальным именем и URI пространства имён, возвращается заменённый узел Attr атрибута, в противном случае возвращается null.
Throws:: DOMException - WRONG_DOCUMENT_ERR: Возникает, если newAttr был создан из другого документа, чем тот, который создал элемент.
NO_MODIFICATION_ALLOWED_ERR: Возникает, если этот узел только для чтения.
INUSE_ATTRIBUTE_ERR: Возникает, если newAttr уже является атрибутом другого объекта Element. Пользователь DOM должен явно клонировать узлы Attr для их повторного использования в других элементах.
NOT_SUPPORTED_ERR: Может возникнуть, если реализация не поддерживает функцию "XML" и язык, доступный через Document, не поддерживает XML-пространства имён (например, [HTML 4.01]).
Since:: 1.4, DOM Level 2

getElementsByTagNameNS

NodeList getElementsByTagNameNS(String namespaceURI, String localName) throws DOMException

Возвращает коллекцию NodeList всех дочерних узлов Elements с заданным локальным именем и URI пространства имён в порядке документа.

Parameters:: namespaceURI - URI пространства имён элементов для сопоставления. Специальное значение "*" соответствует всем пространствам имён.; localName - Локальное имя элементов для сопоставления. Специальное значение "*" соответствует всем локальным именам.
Returns:: Новый объект коллекции NodeList, содержащий все соответствующие узлы Elements.
Throws:: DOMException - NOT_SUPPORTED_ERR: Может возникнуть, если реализация не поддерживает функцию "XML" и язык, доступный через Document, не поддерживает XML-пространства имён (например, [HTML 4.01]).
Since:: 1.4, DOM Level 2

hasAttribute

boolean hasAttribute(String name)

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

Parameters:: name - Имя атрибута для поиска.
Returns:: true при указании атрибута с заданным именем в этом элементе или наличии значения по умолчанию, false в противном случае.
Since:: 1.4, DOM Level 2

hasAttributeNS

boolean hasAttributeNS(String namespaceURI, String localName) throws DOMException

Возвращает true при указании атрибута с заданным локальным именем и URI пространства имён в этом элементе или наличии значения по умолчанию, false в противном случае.
В соответствии с [XML Namespaces], приложения должны использовать значение null в качестве параметра namespaceURI для методов, если они хотят использовать отсутствие пространства имён.

Parameters:: namespaceURI - URI пространства имён атрибута для поиска.; localName - Локальное имя атрибута для поиска.
Returns:: true при указании атрибута с заданным локальным именем и URI пространства имён в этом элементе или наличии значения по умолчанию, false в противном случае.
Throws:: DOMException - NOT_SUPPORTED_ERR: Может возникнуть, если реализация не поддерживает функцию "XML" и язык, доступный через Document, не поддерживает XML-пространства имён (например, [HTML 4.01]).
Since:: 1.4, DOM Level 2

getSchemaTypeInfo

TypeInfo getSchemaTypeInfo()

Информация о типе, связанная с этим элементом.

Since:: 1.5, DOM Level 3

setIdAttribute

void setIdAttribute(String name, boolean isId) throws DOMException

Если параметр isId равен true, этот метод объявляет указанный атрибут как атрибут идентификатора, определяемый пользователем. Это влияет на значение Attr.isId и поведение Document.getElementById, но не изменяет используемые схемы, в частности, это не влияет на Attr.schemaTypeInfo указанного узла Attr. Используйте значение false для параметра isId для отмены объявления атрибута как атрибута идентификатора, определяемого пользователем.
Для указания атрибута по локальному имени и URI пространства имён используйте метод setIdAttributeNS.

Parameters:: name - Имя атрибута.; isId - Является ли атрибут идентификатором.
Throws:: DOMException - NO_MODIFICATION_ALLOWED_ERR: Возникает, если этот узел только для чтения.
NOT_FOUND_ERR: Возникает, если указанный узел не является атрибутом этого элемента.
Since:: 1.5, DOM Level 3

setIdAttributeNS

void setIdAttributeNS(String namespaceURI, String localName, boolean isId) throws DOMException

Parameters:: namespaceURI - URI пространства имён атрибута.; localName - Локальное имя атрибута.; isId - Является ли атрибут идентификатором.
Throws:: DOMException - NO_MODIFICATION_ALLOWED_ERR: Возникает, если этот узел только для чтения.
NOT_FOUND_ERR: Возникает, если указанный узел не является атрибутом этого элемента.
Since:: 1.5, DOM Level 3

setIdAttributeNode

void setIdAttributeNode(Attr idAttr, boolean isId) throws DOMException

Parameters:: idAttr - Узел атрибута.; isId - Является ли атрибут идентификатором.
Throws:: DOMException - NO_MODIFICATION_ALLOWED_ERR: Возникает, если этот узел только для чтения.
NOT_FOUND_ERR: Возникает, если указанный узел не является атрибутом этого элемента.
Since:: 1.5, DOM Level 3

© 1993, 2023, 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.
https://docs.oracle.com/en/java/javase/21/docs/api/java.xml/org/w3c/dom/Element.html