org.w3c.dom
インタフェース CharacterData

すべてのスーパーインタフェース:

Node

既知のサブインタフェースの一覧:

CDATASection, Comment, Text

public interface CharacterData

extends Node

CharacterData インタフェースは、DOM 内で文字データにアクセスするための一連の属性とメソッドのセットにより Node を拡張します。わかり易くするため、このセットはこれらの属性やメソッドを使用する各オブジェクトではなく、この項で定義されます。Text などが CharacterData からインタフェースを継承している場合でも、直接 CharacterData に対応する DOM オブジェクトはありません。このインタフェースのすべての offsets は、0 から開始されます。

DOMString インタフェースで説明されているとおり、DOM のテキスト文字列は UTF-16、つまり 16 ビット単位のシーケンスで表されます。以降、CharacterData の索引作成が 16 ビット単位で行われることを示すのに、16 ビット単位という用語を使用することにします。

詳細については、 「Document Object Model (DOM) Level 2 Core Specification」 も参照してください。

フィールドの概要

インタフェース org.w3c.dom.Node から継承したフィールド

ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, 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() data と次に説明する substringData メソッドを介して使用できる 16 ビット単位の個数。
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, getAttributes, getChildNodes, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, hasAttributes, hasChildNodes, insertBefore, isSupported, normalize, removeChild, replaceChild, setNodeValue, setPrefix

メソッドの詳細

getData

public String getData()
               throws DOMException

このインタフェースを実装するノードの文字データ。DOM 実装では、CharacterData ノードに格納されるデータ量に、任意の制限を設けることはありません。ただし、ノードの全体データが単一の DOMString に適合しないことを実装の制限と言うことがあります。このような場合、ユーザは substringData を呼び出して、データを適当なサイズの要素に分割して取得できます。

例外:

DOMException - NO_MODIFICATION_ALLOWED_ERR: ノードが読み取り専用の場合に発行される

DOMException - DOMSTRING_SIZE_ERR: 実装プラットフォームの DOMString 変数に適合しない多数の文字型を返すときに発生する

setData

public void setData(String data)
             throws DOMException

このインタフェースを実装するノードの文字データ。DOM 実装では、CharacterData ノードに格納されるデータ量に、任意の制限を設けることはありません。ただし、ノードの全体データが単一の DOMString に適合しないことを実装の制限と言うことがあります。このような場合、ユーザは substringData を呼び出して、データを適当なサイズの要素に分割して取得できます。

例外:

DOMException - NO_MODIFICATION_ALLOWED_ERR: ノードが読み取り専用の場合に発行される

DOMException - DOMSTRING_SIZE_ERR: 実装プラットフォームの DOMString 変数に適合しない多数の文字型を返すときに発生する

getLength

public int getLength()

data と次に説明する substringData メソッドを介して使用できる 16 ビット単位の個数。これは CharacterData ノードが空であることを示す値 0 (ゼロ) を持ちます。

substringData

public String substringData(int offset,
                            int count)
                     throws DOMException

ノードから特定のデータ範囲を抽出します。

パラメータ:

offset - 抽出するサブ文字列のオフセット

count - 抽出する 16 ビット単位の個数

戻り値:

指定されたサブ文字列。offset と count の合計が length を超える場合は、データの末尾に 16 ビット単位のすべての数が返される

例外:

DOMException - INDEX_SIZE_ERR: 指定された offset が負の数であるか data に格納されている 16 ビット単位の個数よりも大きい場合、または指定された count が負の数である場合に発行される
DOMSTRING_SIZE_ERR: 指定されたテキストの範囲が DOMString に収まらない場合に発行される

appendData

public void appendData(String arg)
                throws DOMException

ノードの文字データの末尾に文字列を追加します。成功すると、data は、連結 data と指定された DOMString へのアクセスを提供します。

パラメータ:

arg - 追加する DOMString

例外:

DOMException - NO_MODIFICATION_ALLOWED_ERR: このノードが読み取り専用の場合に発行される

insertData

public void insertData(int offset,
                       String arg)
                throws DOMException

指定された 16 ビット単位のオフセットに文字列を挿入します。

パラメータ:

offset - 挿入位置を示す文字オフセット

arg - 挿入する DOMString

例外:

DOMException - INDEX_SIZE_ERR: 指定された offset が負の数であるか data に格納されている 16 ビット単位の個数よりも大きい場合、または指定された count が負の数である場合に発行される
NO_MODIFICATION_ALLOWED_ERR: このノードが読み取り専用の場合に発行される

deleteData

public void deleteData(int offset,
                       int count)
                throws DOMException

ノードから 16 ビット単位の特定範囲を削除します。成功すると、data と length に変更が反映されます。

パラメータ:

offset - 削除の開始位置を示すオフセット

count - 削除する 16 ビット単位の数。offset と count の合計が length を超える場合は、データの末尾の offset から 16 ビット単位のすべての数が削除される

例外:

DOMException - INDEX_SIZE_ERR: 指定された offset が負の数であるか data に格納されている 16 ビット単位の個数よりも大きい場合、または指定された count が負の数である場合に発行される
NO_MODIFICATION_ALLOWED_ERR: このノードが読み取り専用の場合に発行される

replaceData

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

指定された 16 ビット単位のオフセットで開始する文字を、特定の文字列に置き換えます。

パラメータ:

offset - 置換の開始位置を示すオフセット

count - 置き換える 16 ビット単位の数。offset と count の合計が length を超える場合、データの末尾にあるすべての 16 ビット単位が置き換えられます (つまり、append メソッド呼び出しがあとに続く、同じ範囲の remove メソッド呼び出しと同じ効果を持つ)。

arg - 指定された範囲を置換する DOMString

例外:

DOMException - INDEX_SIZE_ERR: 指定された offset が負の数であるか data に格納されている 16 ビット単位の個数よりも大きい場合、または指定された count が負の数である場合に発行される
NO_MODIFICATION_ALLOWED_ERR: このノードが読み取り専用の場合に発行される