Spec-Zone.ru › OpenJDK 25

Интерфейс Element

Все суперинтерфейсы:
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, в который он был перемещён.

См. также Спецификацию объектной модели документа (DOM) уровня 3, ядро.

Начиная с:
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

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

Модификатор и тип Метод Описание
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, этот метод объявляет указанный атрибут идентификаторным атрибутом, определённым пользователем.

Методы, объявленные в интерфейсе 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. DOM HTML возвращает tagName элемента HTML в канонической форме верхнего регистра независимо от регистра символов в исходном документе HTML.

getAttribute

String getAttribute(String name)
Получает значение атрибута по имени.
Параметры:
name — имя получаемого атрибута.
Возвращает:
Значение Attr в виде строки или пустую строку, если для этого атрибута не задано значение и не предусмотрено значение по умолчанию.

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. Для повторного использования узлов Attr в других элементах пользователь DOM должен явно клонировать их.

removeAttributeNode

Attr removeAttributeNode(Attr oldAttr) throws DOMException
Удаляет указанный узел атрибута. Если в DTD определено значение по умолчанию для удалённого узла Attr, немедленно появляется новый узел со значением по умолчанию, а также соответствующими URI пространства имён, локальным именем и префиксом, если применимо. Реализация может аналогичным образом обрабатывать значения по умолчанию из других схем, но приложениям следует использовать Document.normalizeDocument(), чтобы гарантировать актуальность этих сведений.
Параметры:
oldAttr — узел Attr, удаляемый из списка атрибутов.
Возвращает:
Удалённый узел Attr.
Вызывает исключение:
DOMException — NO_MODIFICATION_ALLOWED_ERR: возникает, если этот узел доступен только для чтения.
NOT_FOUND_ERR: возникает, если oldAttr не является атрибутом элемента.

getElementsByTagName

NodeList getElementsByTagName(String name)
Возвращает NodeList всех потомков Elements с заданным именем тега в порядке документа.
Параметры:
name — имя тега для поиска. Специальное значение "*" соответствует всем тегам.
Возвращает:
Список соответствующих узлов Element.

getAttributeNS

String getAttributeNS(String namespaceURI, String localName) throws DOMException
Получает значение атрибута по локальному имени и URI пространства имён.
Согласно [Пространства имён XML], если приложениям требуется отсутствие пространства имён, в качестве параметра namespaceURI методов необходимо использовать значение null.
Параметры:
namespaceURI — URI пространства имён получаемого атрибута.
localName — локальное имя получаемого атрибута.
Возвращает:
Значение Attr в виде строки или пустую строку, если для этого атрибута не задано значение и не предусмотрено значение по умолчанию.
Вызывает исключение:
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], если приложениям требуется отсутствие пространства имён, в качестве параметра namespaceURI методов необходимо использовать значение null.
Параметры:
namespaceURI — URI пространства имён создаваемого или изменяемого атрибута.
qualifiedName — квалифицированное имя создаваемого или изменяемого атрибута.
value — задаваемое значение в виде строки.
Вызывает исключение:
DOMException — INVALID_CHARACTER_ERR: возникает, если указанное квалифицированное имя не является именем XML согласно используемой версии XML, заданной в атрибуте Document.xmlVersion.
NO_MODIFICATION_ALLOWED_ERR: возникает, если этот узел доступен только для чтения.
NAMESPACE_ERR: возникает, если qualifiedName имеет неверный формат согласно спецификации «Пространства имён в XML»; если у qualifiedName есть префикс, а namespaceURI равно null; если у qualifiedName есть префикс "xml", а namespaceURI отличается от " http://www.w3.org/XML/1998/namespace"; если qualifiedName или его префикс равен "xmlns", а namespaceURI отличается от "http://www.w3.org/2000/xmlns/"; либо если namespaceURI равен "http://www.w3.org/2000/xmlns/", а ни qualifiedName, ни его префикс не равен "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], если приложениям требуется отсутствие пространства имён, в качестве параметра namespaceURI методов необходимо использовать значение null.
Параметры:
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
Получает узел Attr по локальному имени и URI пространства имён.
Согласно [Пространства имён XML], если приложениям требуется отсутствие пространства имён, в качестве параметра namespaceURI методов необходимо использовать значение null.
Параметры:
namespaceURI — URI пространства имён получаемого атрибута.
localName — локальное имя получаемого атрибута.
Возвращает:
Узел Attr с указанными локальным именем атрибута и 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], если приложениям требуется отсутствие пространства имён, в качестве параметра namespaceURI методов необходимо использовать значение null.
Параметры:
newAttr — узел Attr, добавляемый в список атрибутов.
Возвращает:
Если атрибут newAttr заменяет существующий атрибут с такими же локальным именем и URI пространства имён, возвращается заменённый узел Attr, в противном случае возвращается null.
Вызывает исключение:
DOMException — WRONG_DOCUMENT_ERR: возникает, если newAttr создан другим документом, а не тем, которым создан элемент.
NO_MODIFICATION_ALLOWED_ERR: возникает, если этот узел доступен только для чтения.
INUSE_ATTRIBUTE_ERR: возникает, если newAttr уже является атрибутом другого объекта Element. Для повторного использования узлов Attr в других элементах пользователь DOM должен явно клонировать их.
NOT_SUPPORTED_ERR: может возникнуть, если реализация не поддерживает функцию "XML", а язык, предоставляемый через Document, не поддерживает пространства имён XML (например, [HTML 4.01]).
Начиная с:
1.4, DOM Level 2

getElementsByTagNameNS

NodeList getElementsByTagNameNS(String namespaceURI, String localName) throws DOMException
Возвращает NodeList всех потомков Elements с заданными локальным именем и URI пространства имён в порядке документа.
Параметры:
namespaceURI — URI пространства имён элементов для поиска. Специальное значение "*" соответствует всем пространствам имён.
localName — локальное имя элементов для поиска. Специальное значение "*" соответствует всем локальным именам.
Возвращает:
Новый объект NodeList, содержащий все найденные элементы Elements.
Вызывает исключение:
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], если приложениям требуется отсутствие пространства имён, в качестве параметра namespaceURI методов необходимо использовать значение null.
Параметры:
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. Чтобы отменить объявление атрибута как идентификаторного атрибута, определённого пользователем, задайте для параметра isId значение false.
Чтобы указать атрибут по локальному имени и 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. Чтобы отменить объявление атрибута как идентификаторного атрибута, определённого пользователем, задайте для параметра isId значение false.
Параметры:
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. Чтобы отменить объявление атрибута как идентификаторного атрибута, определённого пользователем, задайте для параметра isId значение false.
Параметры:
idAttr — узел атрибута.
isId — является ли атрибут атрибутом типа ID.
Вызывает исключение:
DOMException — NO_MODIFICATION_ALLOWED_ERR: возникает, если этот узел доступен только для чтения.
NOT_FOUND_ERR: возникает, если указанный узел не является атрибутом этого элемента.
Начиная с:
1.5, DOM Level 3

Сообщить об ошибке или предложить улучшение
Дополнительные сведения об API и документацию для разработчиков см. в документации Java SE, содержащей более подробные описания для разработчиков, обзоры концепций, определения терминов, обходные решения и рабочие примеры кода. Другие версии.
Java является товарным знаком или зарегистрированным товарным знаком Oracle и/или её аффилированных лиц в США и других странах.
Авторское право © 1993, 2025, Oracle и/или её аффилированные лица, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
Все права защищены. Использование регулируется условиями лицензии и политикой распространения документации.

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

Spec-Zone.ru

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