Интерфейс CharacterData

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

Все известные подинтерфейсы:: CDATASection, Comment, Text

public interface CharacterData extends Node

Интерфейс CharacterData расширяет интерфейс Node набором атрибутов и методов для доступа к данным символов в DOM. Для ясности этот набор определен здесь, а не на каждом объекте, использующем эти атрибуты и методы. Никакие объекты DOM не соответствуют напрямую CharacterData, хотя Text и другие наследуют этот интерфейс от него. Все методы в этом интерфейсе начинаются с 0.

Как объяснено в интерфейсе DOMString, строковые значения в DOM представлены в формате UTF-16, т.е. в виде последовательности 16-битных единиц. В дальнейшем термин «16-битные единицы» используется при необходимости, чтобы указать, что индексирование в CharacterData выполняется по 16-битным единицам.

См. также Спецификацию 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

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

Модификатор и тип	Метод	Описание
`void`	`appendData(String arg)`	Добавляет строку в конец данных символов узла.
`void`	`deleteData(int offset, int count)`	Удаляет диапазон 16-битных единиц из узла.
`String`	`getData()`	Данные символов узла, реализующего этот интерфейс.
`int`	`getLength()`	Количество 16-битных единиц, доступных через `data` и метод `substringData` ниже.
`void`	`insertData(int offset, String arg)`	Вставляет строку в указанный смещение 16-битной единицы.
`void`	`replaceData(int offset, int count, String arg)`	Заменяет символы, начиная с указанного смещения 16-битной единицы, заданной строкой.
`void`	`setData(String data)`	Данные символов узла, реализующего этот интерфейс.
`String`	`substringData(int offset, int count)`	Извлекает диапазон данных из узла.

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

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

getData

String getData() throws DOMException

Данные символов узла, реализующего этот интерфейс. Реализация DOM может не устанавливать произвольные ограничения на количество данных, которые могут храниться в узле CharacterData. Однако ограничения реализации могут означать, что данные всего узла могут не поместиться в одну переменную DOMString. В таких случаях пользователь может вызвать substringData для получения данных в кусках подходящего размера.

Возбуждает:: DOMException - DOMSTRING_SIZE_ERR: Возникает, когда возвращаются больше символов, чем помещается в переменную DOMString на платформе реализации.

setData

void setData(String data) throws DOMException

Возбуждает:: DOMException - NO_MODIFICATION_ALLOWED_ERR: Возникает, когда узел является только для чтения.

getLength

int getLength()

Количество 16-битных единиц, доступных через data и метод substringData ниже. Может быть равно нулю, т.е. узлы CharacterData могут быть пустыми.

substringData

String substringData(int offset, int count) throws DOMException

Извлекает диапазон данных из узла.

Параметры:: offset - Начальное смещение подстроки для извлечения.; count - Количество 16-битных единиц для извлечения.
Возвращает:: Указанная подстрока. Если сумма offset и count превышает length, то возвращаются все 16-битные единицы до конца данных.
Возбуждает:: DOMException - INDEX_SIZE_ERR: Возникает, если указанное offset отрицательно или больше количества 16-битных единиц в data, или если указанное count отрицательно.
DOMSTRING_SIZE_ERR: Возникает, если указанный диапазон текста не помещается в переменную DOMString.

appendData

void appendData(String arg) throws DOMException

Добавляет строку в конец данных символов узла. При успехе data предоставляет доступ к конкатенации data и указанной DOMString.

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

insertData

void insertData(int offset, String arg) throws DOMException

Вставляет строку в указанное смещение 16-битной единицы.

Параметры:: offset - Смещение символа, в которое необходимо вставить.; arg - Вставляемая DOMString.
Возбуждает:: DOMException - INDEX_SIZE_ERR: Возникает, если указанное offset отрицательно или больше количества 16-битных единиц в data.
NO_MODIFICATION_ALLOWED_ERR: Возникает, если этот узел только для чтения.

deleteData

void deleteData(int offset, int count) throws DOMException

Удаляет диапазон 16-битных единиц из узла. При успехе data и length отражают изменение.

Параметры:: offset - Смещение для начала удаления.; count - Количество 16-битных единиц для удаления. Если сумма offset и count превышает length, то удаляются все 16-битные единицы от offset до конца данных.
Возбуждает:: DOMException - INDEX_SIZE_ERR: Возникает, если указанное offset отрицательно или больше количества 16-битных единиц в data, или если указанное count отрицательно.
NO_MODIFICATION_ALLOWED_ERR: Возникает, если этот узел только для чтения.

replaceData

void replaceData(int offset, int count, String arg) throws DOMException

Заменяет символы, начиная с указанного смещения 16-битной единицы, заданной строкой.

Параметры:: offset - Смещение для начала замены.; count - Количество 16-битных единиц для замены. Если сумма offset и count превышает length, то все 16-битные единицы до конца данных заменяются; (т.е. эффект тот же, что и вызов метода remove с тем же диапазоном, за которым следует вызов метода append).; arg - DOMString, которым нужно заменить диапазон.
Возбуждает:: DOMException - INDEX_SIZE_ERR: Возникает, если указанное offset отрицательно или больше количества 16-битных единиц в data, или если указанное count отрицательно.
NO_MODIFICATION_ALLOWED_ERR: Возникает, если этот узел только для чтения.

© 1993, 2021, 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/17/docs/api/java.xml/org/w3c/dom/CharacterData.html