Spec-Zone.ru › OpenJDK 24

Интерфейс элемента

Все суперинтерфейсы:
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 Спецификации Document Object Model (DOM).

С момента:
1.4, DOM Level 2

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

Поля, объявленные в интерфейсе 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, этот метод объявляет указанный атрибут атрибутом идентификатора, определяемым пользователем.
void setIdAttributeNode(Attr idAttr, boolean isId)
Если параметр isId имеет значение true, этот метод объявляет указанный атрибут атрибутом идентификатора, определяемым пользователем.
void setIdAttributeNS(String namespaceURI, String localName, boolean isId)
Если параметр isId имеет значение true, этот метод объявляет указанный атрибут атрибутом идентификатора, определяемым пользователем.

Методы, объявленные в интерфейсе 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 - Имя тега для сопоставления. Специальное значение "*" соответствует всем тегам.
Возвращает:
Список соответствующих узлов элементов.

getAttributeNS

String getAttributeNS(String namespaceURI, String localName) throws DOMException
Возвращает значение атрибута по локальному имени и URI пространства имён.
В соответствии с [XML Namespaces], приложения должны использовать значение null в качестве параметра namespaceURI для методов, если они не хотят использовать пространство имён.
Параметры:
namespaceURI - URI пространства имён атрибута для извлечения.
localName - Локальное имя атрибута для извлечения.
Возвращает:
Значение атрибута в виде строки или пустая строка, если у атрибута нет заданного или значения по умолчанию.
Исключения:
DOMException - NOT_SUPPORTED_ERR: Может быть поднято, если реализация не поддерживает функцию "XML", и язык, используемый через Document, не поддерживает XML пространства имён (например, [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 Namespaces, если у URI пространства имён есть префикс и префикс не соответствует null, если префикс URI пространства имён равен "xml", а URI пространства имён отличается от " http://www.w3.org/XML/1998/namespace", если у URI пространства имён или его префикса значение "xmlns" и URI пространства имён отличается от "http://www.w3.org/2000/xmlns/", или если URI пространства имён равно "http://www.w3.org/2000/xmlns/", и ни у URI пространства имён, ни у его префикса значение не равно "xmlns".
NOT_SUPPORTED_ERR: Может быть поднято, если реализация не поддерживает функцию "XML" и язык, используемый через Document, не поддерживает XML пространства имён (например, [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 для методов, если они хотят не использовать пространство имён.
Параметры:
namespaceURI - URI пространства имён удаляемого атрибута.
localName - Локальное имя удаляемого атрибута.
Исключения:
DOMException - NO_MODIFICATION_ALLOWED_ERR: Возникает, если этот узел является только для чтения.
NOT_SUPPORTED_ERR: Может быть вызвано, если реализация не поддерживает функцию "XML", и язык, представленный через Document, не поддерживает XML пространства имён (например, [HTML 4.01]).
С тех пор:
1.4, DOM Level 2

getAttributeNodeNS

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

setAttributeNodeNS

Attr setAttributeNodeNS(Attr newAttr) throws DOMException
Добавляет новый атрибут. Если атрибут с таким локальным именем и URI пространства имён уже присутствует в элементе, он заменяется новым. Замена узла атрибута на себя не имеет эффекта.
В соответствии с [XML Namespaces], приложения должны использовать значение null в качестве параметра namespaceURI для методов, если они хотят не использовать пространство имён.
Параметры:
newAttr - Узел Attr для добавления в список атрибутов.
Возвращает:
Если атрибут newAttr заменяет существующий атрибут с тем же локальным именем и URI пространства имён, возвращается заменённый узел Attr, в противном случае возвращается null.
Исключения:
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]).
С тех пор:
1.4, DOM Level 2

getElementsByTagNameNS

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

hasAttribute

boolean hasAttribute(String name)
Возвращает true, если атрибут с заданным именем указан в этом элементе или имеет значение по умолчанию, false в противном случае.
Параметры:
name - Имя атрибута для поиска.
Возвращает:
true, если атрибут с заданным именем указан в этом элементе или имеет значение по умолчанию, false в противном случае.
С тех пор:
1.4, DOM Level 2

hasAttributeNS

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

getSchemaTypeInfo

TypeInfo getSchemaTypeInfo()
Информация о типе, связанная с этим элементом.
С тех пор:
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.
Параметры:
name - Имя атрибута.
isId - Является ли атрибут атрибутом типа ID.
Исключения:
DOMException - NO_MODIFICATION_ALLOWED_ERR: Возникает, если этот узел является только для чтения.
NOT_FOUND_ERR: Возникает, если указанный узел не является атрибутом этого элемента.
С тех пор:
1.5, DOM Level 3

setIdAttributeNS

void setIdAttributeNS(String namespaceURI, String localName, boolean isId) throws DOMException
Если параметр isId имеет значение true, этот метод объявляет указанный атрибут атрибутом идентификатора. Это влияет на значение Attr.isId и поведение Document.getElementById, но не изменяет какую-либо схему, которая может быть в использовании, в частности, это не влияет на Attr.schemaTypeInfo указанного узла атрибута Attr. Используйте значение false для параметра isId, чтобы отменить объявление атрибута как атрибута идентификатора.
Параметры:
namespaceURI - URI пространства имён атрибута.
localName - Локальное имя атрибута.
isId - Является ли атрибут атрибутом типа ID.
Исключения:
DOMException - NO_MODIFICATION_ALLOWED_ERR: Возникает, если этот узел является только для чтения.
NOT_FOUND_ERR: Возникает, если указанный узел не является атрибутом этого элемента.
С тех пор:
1.5, DOM Level 3

setIdAttributeNode

void setIdAttributeNode(Attr idAttr, boolean isId) throws DOMException
Если параметр isId равен true, этот метод объявляет указанный атрибут в качестве атрибута идентификатора, определяемого пользователем. Это влияет на значение Attr.isId и поведение Document.getElementById, но не изменяет никакую схему, которая может быть в использовании, в частности, это не влияет на Attr.schemaTypeInfo указанного узла Attr. Используйте значение false для параметра isId, чтобы отменить объявление атрибута в качестве атрибута идентификатора, определяемого пользователем.
Параметры:
idAttr - Узел атрибута.
isId - Является ли атрибут атрибутом типа ID.
Исключения:
DOMException - NO_MODIFICATION_ALLOWED_ERR: Вызывается, если этот узел является только для чтения.
NOT_FOUND_ERR: Вызывается, если указанный узел не является атрибутом этого элемента.
С тех пор:
1.5, DOM Level 3

© 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.
https://download.java.net/java/early_access/jdk24/docs/api/java.xml/org/w3c/dom/Element.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API