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

Текстовые данные узла, реализующего этот интерфейс. Реализация 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 - Присоединяемая 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: Возникает, если узел только для чтения.