compact2, compact3

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: このノードが読取り専用の場合に発生します。