Spec-Zone.ru › OpenJDK 8

Интерфейс Element

Все суперинтерфейсы:
Node
Все известные подинтерфейсы:
Detail, DetailEntry, SOAPBody, SOAPBodyElement, SOAPElement, SOAPEnvelope, SOAPFault, SOAPFaultElement, SOAPHeader, SOAPHeaderElement
Все известные реализующие классы:
IIOMetadataNode

public interface Element
extends Node

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

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

См. также Спецификацию Document Object Model (DOM) Level 3 Core.

Поля

Поля, унаследованные от интерфейса 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]).
С:
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: Возникает, если 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]).
С:
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]).
С:
DOM Level 2

getAttributeNodeNS

Attr getAttributeNodeNS(String namespaceURI,
                        String localName)
                 throws DOMException

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

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

setAttributeNodeNS

Attr setAttributeNodeNS(Attr newAttr)
                 throws DOMException

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

Параметры:
newAttr - Узел Attr для добавления в список атрибутов.
Возвращает:
Если атрибут newAttr заменяет существующий атрибут с тем же локальным именем и URI пространства имён, возвращается заменённый узел Attr, в противном случае возвращается %%%CODE_BLOCK_185%%.
Вызывает:
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]).
С:
DOM Level 2

getElementsByTagNameNS

NodeList getElementsByTagNameNS(String namespaceURI,
                                String localName)
                         throws DOMException

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

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

hasAttribute

boolean hasAttribute(String name)

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

Параметры:
name - Имя атрибута для поиска.
Возвращает:
true , если атрибут с заданным именем указан в этом элементе или имеет значение по умолчанию, false в противном случае.
С:
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]).
С:
DOM Level 2

getSchemaTypeInfo

TypeInfo getSchemaTypeInfo()

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

С:
DOM Level 3

setIdAttribute

void setIdAttribute(String name,
                    boolean isId)
             throws DOMException

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

Параметры:
name - Имя атрибута.
isId - Является ли атрибут типа ID.
Вызывает:
DOMException - NO_MODIFICATION_ALLOWED_ERR: Вызывается, если этот узел только для чтения.
NOT_FOUND_ERR: Вызывается, если указанный узел не является атрибутом этого элемента.
С:
DOM Level 3

setIdAttributeNS

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

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

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

setIdAttributeNode

void setIdAttributeNode(Attr idAttr,
                        boolean isId)
                 throws DOMException

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

Параметры:
idAttr - Узел атрибута.
isId - Является ли атрибут типа ID.
Вызывает:
DOMException - NO_MODIFICATION_ALLOWED_ERR: Вызывается, если этот узел только для чтения.
NOT_FOUND_ERR: Вызывается, если указанный узел не является атрибутом этого элемента.
С:
DOM Level 3

© 1993, 2020, 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.

Spec-Zone.ru

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