Интерфейс 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 Specification.

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

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

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

Исключения:: 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 - Строку для добавления.
Исключения:: DOMException - NO_MODIFICATION_ALLOWED_ERR: Возникает, если этот узел является только для чтения.

insertData

void insertData(int offset, String arg) throws DOMException

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

Параметры:: offset - Смещение символа для вставки.; arg - Строку для вставки.
Исключения:: 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 - Строка, на которую необходимо заменить диапазон.
Исключения:: DOMException - INDEX_SIZE_ERR: Возникает, если указанное offset отрицательное или больше, чем количество 16-битных единиц в data, или если указанное count отрицательное.
NO_MODIFICATION_ALLOWED_ERR: Возникает, если этот узел является только для чтения.

© 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/CharacterData.html