org.w3c.dom

インタフェース CharacterData

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

Node

既知のすべてのサブインタフェース:

CDATASection, Comment, Text, Text

public interface CharacterData
extends Node

CharacterData インタフェースは、属性とメソッドのセットを追加して Node を拡張することにより、DOM 内の文字データにアクセスできるようにします。こうしたセットについては、これらを実際に使用するオブジェクトの項で説明するのではなく、ここでまとめて説明しておきます。直接 CharacterData に対応する DOM オブジェクトは存在しませんが、Text やその他のオブジェクトはそこからインタフェースを継承します。このインタフェース内のすべての offsets が 0 から始まります。

DOMString インタフェースで説明したように、DOM 内のテキスト文字列は UTF-16 で、つまり、16 ビット単位のシーケンスとして表されます。次の説明では、「16 ビット単位」という表現で、CharacterData へのインデックス付けが 16 ビット単位で行われるということを示します。

「Document Object Model (DOM) Level 3 Core Specification」も参照してください。

フィールドのサマリー

インタフェース 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() 次の 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, 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()

次の data メソッドおよび substringData メソッドを介して利用可能な 16 ビット単位の数。この値は 0 である可能性があります。つまり、CharacterData ノードは空である可能性があります。

substringData

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

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 が負であるか、または data 内の 16 ビット単位の数より大きい場合に発生します。
NO_MODIFICATION_ALLOWED_ERR: このノードが読み取り専用の場合に発生します。

deleteData

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

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 が負の値であるか、data 内の 16 ビット単位の数より大きい場合、または指定された count が負である場合に発生します。
NO_MODIFICATION_ALLOWED_ERR: このノードが読み取り専用の場合に発生します。