Интерфейс CharacterData

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.

Методы

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: Возникает, если узел только для чтения.