Rangeインタフェース

表2-24にRangeインタフェースで使用できるメソッドの概要を示します。

表2-24 Rangeメソッドの概要: DOMパッケージ

関数	概要
CompareBoundaryPoints()
cloneContent()
cloneRange()
deleteContents()
detach()	範囲を無効にします。
extractContent()
getCollapsed()	範囲が縮小されたかどうかを確認します。
getCommonAncestorContainer()	最も深い共通の祖先ノードを取得します。
getEndContainer()	終了コンテナ・ノードを取得します。
getEndOffset()	エンド・ポイントのオフセットを取得します。
getStartContainer()	開始コンテナ・ノードを取得します。
getStartOffset()	開始ポイントのオフセットを取得します。
insertNode()
selectNodeContent()
selectNode()
setEnd()	エンド・ポイントを設定します。
setEndAfter()
setEndBefore()
setStart()	開始ポイントを設定します。
setStartAfter()
setStartBefore()
surroundContents()
toString()

CompareBoundaryPoints()

境界点を比較します。

構文

CompareHowCode compareBoundaryPoints(
   unsigned short how,
   Range< Node>* sourceRange)
throw (DOMException);

パラメータ	説明
how	比較方法
sourceRange	比較の範囲

戻り値

(CompareHowCode) 比較の結果。

cloneContent()

子を含むノードの複製を作成します。

構文

Node* cloneContents() throw (DOMException);

戻り値

(Node*) 複製されたサブツリー。

cloneRange()

一定範囲のノードを複製します。

構文

Range< Node>* cloneRange();

戻り値

(Range< Node>*) 複製された新しい範囲。

deleteContents()

ノードのコンテンツを削除します。

構文

void deleteContents() throw (DOMException);

detach()

範囲を無効にします。オブジェクトが無効な状態になるため、このメソッドの使用はお薦めしません。デストラクタをコールする方法をお薦めします。

構文

void detach();

extractContent()

ノードを抽出します。

構文

Node* extractContents() throw (DOMException);

戻り値

(Node*) 抽出されたサブツリー。

getCollapsed()

範囲が縮小されているかどうかを確認します。

構文

boolean getCollapsed() const;

戻り値

(boolean) 範囲が縮小されている場合はTRUE、縮小されていない場合はFALSE。

getCommonAncestorContainer()

ノードの最も深い共通の祖先を取得します。

構文

Node* getCommonAncestorContainer() const;

戻り値

(Node*) 共通の祖先ノード。

getEndContainer()

コンテナ・ノードを取得します。

構文

Node* getEndContainer() const;

戻り値

(Node*) 終了コンテナ・ノード。

getEndOffset()

エンド・ポイントのオフセットを取得します。

構文

long getEndOffset() const;

戻り値

(long) オフセット。

getStartContainer()

開始コンテナ・ノードを取得します。

構文

Node* getStartContainer() const;

戻り値

(Node*) 開始コンテナ・ノード。

getStartOffset()

開始ポイントのオフセットを取得します。

構文

long getStartOffset() const;

戻り値

(long) オフセット。

insertNode()

ノードを挿入します。

構文

void insertNode(
   NodeRef< Node>& newNode)
throw (RangeException, DOMException);

パラメータ	説明
newNode	挿入するノード

selectNodeContent()

参照によりノード内容を選択します。

構文

void selectNodeContent(
   NodeRef< Node>& refNode)
throw (RangeException);

パラメータ	説明
refNode	参照ノード

selectNode()

ノードを選択します。

構文

void selectNode(
   NodeRef< Node>& refNode)
throw (RangeException);

パラメータ	説明
refNode	参照ノード

setEnd()

エンド・ポイントを設定します。

構文

void setEnd(
   NodeRef< Node>& refNode,
   long offset)
throw (RangeException, DOMException);

パラメータ	説明
refNode	参照ノード
offset	オフセット

setEndAfter()

指定されたノードの後に終了ポインタを設定します。

構文

void setEndAfter(
   NodeRef< Node>& refNode)
throw (RangeException);

パラメータ	説明
refNode	参照ノード

setEndBefore()

指定されたノードの前に終了を設定します。

構文

void setEndBefore(
   NodeRef< Node>& refNode)
throw (RangeException);

パラメータ	説明
refNode	参照ノード

setStart()

開始ポイントを設定します。

構文

void setStart(
   NodeRef< Node>& refNode,
   long offset)
throw (RangeException, DOMException);

パラメータ	説明
refNode	参照ノード
offset	オフセット

setStartAfter()

指定されたノードの後に開始ポインタを設定します。

構文

void setStartAfter(
   NodeRef< Node>& refNode)
throw (RangeException);

パラメータ	説明
refNode	参照ノード

setStartBefore()

指定されたノードの前に開始ポインタを設定します。

構文

void setStartBefore(
   NodeRef< Node>& refNode)
throw (RangeException);

パラメータ	説明
refNode	参照ノード

surroundContents()

あるノードを指定されたノードの子にします。

構文

void surroundContents(
   NodeRef< Node>& newParent)
throw (RangeException, DOMException);

パラメータ	説明
newParent	親ノード

toString()

項目を文字列に変換します。

構文

oratext* toString();

戻り値

(oratext*) 範囲の文字列表現。