CharacterData
インターフェイスは、DOMにおいて文字データにアクセスするプロパティとメソッドの集合を持つノードを展開する。明解にするため、この集合はこれらのプロパティ・メソッドを用いる各オブジェクトではなくここで定義される。 CharacterData
に直接該当するDOMオブジェクトはないが、 Text
その他はこのインターフェイスを継承する。このインターフェイスの全ての offset
は 0
から開始する。
DOMString
インターフェイスの項で説明したように、DOMにおける原文の文字列は UTF-16、すなわち、16ビット単位の並びで表現される。以後、16ビット単位で行うCharacterData上のインデクシングを示す必要がある時は、用語 16ビット単位 を用いる。
data
CharacterData
ノードに格納できるデータ量に恣意的な制限を設けないでよい。しかし、実装の制限は、ノードのデータ全体が単一の DOMString
に相応しくないかもしれないことを意味するかもしれない。そういう場合、利用者は substringData
を呼んで適切な大きさの断片でデータを取得してよい。DOMString
変数の適正より多くの文字が返されようとする時に発生。length
unsigned
long
型, 読取専用
appendData
( arg )ノードの文字データの末尾に文字列を追加する。成功すると、 data
は、 data
と指定された DOMString
の連結へのアクセスを提供する。
(無し)
deleteData
( offset, count )ノードから 16ビット単位 の範囲を取り除く。成功すると、 data
と length
は変更の影響を受ける。
offset
と count
の合計が length
より大きい場合、データの offset
から末尾までの全ての16ビット単位が削除される。(無し)
offset
が負である場合、また data
内の16ビット単位の数よりも大きい場合、また指定された count
が負である場合に発生。insertData
( offset, arg )指定された 16ビット単位 オフセット位置に文字列を挿入する。
(無し)
offset
が負であるか、また data
内の16ビット単位の数よりも大きい場合に発生。replaceData
( offset, count, arg )指定された 16ビット単位 オフセットで始まる文字を、指定された文字列で置き換える。
offset
と count
の合計が length
よりも大きい場合、データの末尾までの全16ビット単位が置き換えられる; (即ち、同じ範囲で remove
メソッドを呼び、続けて append
メソッドを行うのと効果は同じである)。DOMString
。(無し)
offset
が負であるか data
内の16ビット単位の数よりも大きい場合、また指定された count
が負である場合に発生。substringData
( offset, count )ノードからある範囲のデータを抽出する。
DOMString 型。指定された部分文字列。 offset
と count
の合計が length
より大きい場合、データの末尾までの全ての16ビット単位が返される。
offset
負であるか、または data
内の16ビット単位の数より大きい場合、指定された count
が負である場合に発生。DOMString
に適さない場合に発生。interface CharacterData : Node { attribute DOMString data; // raises(DOMException) on setting // raises(DOMException) on retrieval readonly attribute unsigned long length; DOMString substringData(in unsigned long offset, in unsigned long count) raises(DOMException); void appendData(in DOMString arg) raises(DOMException); void insertData(in unsigned long offset, in DOMString arg) raises(DOMException); void deleteData(in unsigned long offset, in unsigned long count) raises(DOMException); void replaceData(in unsigned long offset, in unsigned long count, in DOMString arg) raises(DOMException); };