CharacterData (Org.W3C.DOM Package)

Node を継承します。CharacterData インターフェースは、DOM の文字データにアクセスするための 属性とメソッドのセットで Node を拡張します。直接 CharacterData に 対応する DOM オブジェクトはありませんが、Text などは CharacterData から インターフェースを継承します。このインターフェースでは、オフセットが 0 から始まります。

メソッドについては、以下を参照してください。

appendData

文字列をノードの文字データの最後に追加します。正しく実行されると一連のデータと指定された DOMString にアクセスできるようになります。

構文:

public void appendData(java.lang.String arg)
                throws DOMException

パラメータ

arg - 追加する DOMString です。

例外処理:

DOMException - NO_MODIFICATION_ALLOWED_ERR: このノードが読み込み専用の場合に発生します。

deleteData

ノードから一定範囲の文字列を取り除きます。正しく実行されるとデータと長さに変更が反映されます。

構文:

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

パラメータ

offset - 文字列を取り除く開始位置のオフセットです。

count - 削除する文字数です。offset と count の合計がノードの長さを超える場合、オフセットからデータの最後までのすべての文字列が削除されます。

例外処理:

DOMException - INDEX_SIZE_ERR: 指定した offset が負の数か、データ内の文字数より大きい場合に発生します。指定した count が負の数でも発生します。

NO_MODIFICATION_ALLOWED_ERR: このノードが読み込み専用の場合に発生します。

getData

このインターフェースを使用するノードの文字データです。DOM の実装は、CharacterData ノードに格納できるデータ量に任意の制限をつけない可能性があります。しかし、実装制限はノードデータの全体が単体の DOMString に収まらないことも意味します。この場合、ユーザーが適切なサイズでデータを取り出すために substringData を呼び出すこともできます。

構文:

public java.lang.String getData()
                throws DOMException

例外処理:

DOMException - NO_MODIFICATION_ALLOWED_ERR: ノードが読み込み専用の場合に発生します。

DOMException - DOMSTRING_SIZE_ERR: 実装プラットフォーム上の DOMString 変数の許容量を超える文字列が返された場合に発生します。

getLength

データや substringData メソッドを通して利用可能な文字列数です。値がゼロの場合もあります。例えば CharacterData ノードが空の場合です。

構文:

public int getLength()

insertData

指定した文字のオフセットに文字列を挿入します。

構文:

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

パラメータ

offset - 文字列の挿入箇所です。

arg - 挿入する DOMString です。

例外処理:

DOMException - INDEX_SIZE_ERR: 指定したオフセットが負の数か、データの文字数よりも大きい場合に発生します。

NO_MODIFICATION_ALLOWED_ERR: このノードが読み込み専用の場合に発生します。

replaceData

文字列を、指定した文字列のオフセットの位置で指定した文字列に置き換えます。

構文:

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

パラメータ

offset - 置換の始点となるオフセットです。

count - 置換する文字数です。offset と count の合計がノードの長さを超える場合、データの最後までのすべての文字列が置換されます (例: この作用は、同一の長さで remove メソッドを呼び出し、append メソッドを実行するのと同じです)。

arg - 指定範囲を置き換える DOMString です。

例外処理:

DOMException - INDEX_SIZE_ERR: 指定した offset が負の数か、データ内の文字数より大きい場合に発生します。指定した count が負の数でも発生します。

NO_MODIFICATION_ALLOWED_ERR: このノードが読み込み専用の場合に発生します。

setData

構文:

public void setData(java.lang.String data)
             throws DOMException

substringData

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

構文:

public java.lang.String substringData(int offset, int count)
                   throws DOMException

パラメータ

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

count - 抽出する文字数です。

戻り値:

指定した部分文字列を返します。offset と count の合計がノードの長さを超える場合、データの最後までのすべての文字列が返されます。

例外処理:

DOMException - INDEX_SIZE_ERR: 指定した offset が負の数か、データ内の文字数より大きい場合に発生します。指定した count が負の数でも発生します。

DOMSTRING_SIZE_ERR: 指定したテキストの範囲が DOMString の許容量を超える場合に発生します。