org.w3c.dom.ranges
インタフェース Range

public interface Range

「Document Object Model (DOM) Level 2 Traversal and Range Specification」も参照してください。

導入されたバージョン:

DOM Level 2

フィールドの概要

static short	END_TO_END sourceRange の終了境界点と compareBoundaryPoints が呼び出される Range の終了境界点を比較します。
static short	END_TO_START sourceRange の終了境界点と compareBoundaryPoints が呼び出される Range の開始境界点を比較します。
static short	START_TO_END sourceRange の開始境界点と compareBoundaryPoints が呼び出される Range の終了境界点を比較します。
static short	START_TO_START sourceRange の開始境界点と compareBoundaryPoints が呼び出される Range の開始境界点を比較します。

メソッドの概要

DocumentFragment	cloneContents() Range の内容を複製します。
Range	cloneRange() この Range の境界点と同等の境界点を持つ新規 Range を作成します。
void	collapse(boolean toStart) 境界点の 1 つに Range を折りたたみます。
short	compareBoundaryPoints(short how, Range sourceRange) ドキュメントの 2 つの Range の境界点を比較します。
void	deleteContents() 削除された内容への参照を返すことなく、含まれているドキュメントまたはドキュメントのフラグメントから Range の内容を削除します。
void	detach() Range が現在では使用されていないことおよび実装がこの Range に関連するリソースを放棄する可能性があることを示すために呼び出されます。
DocumentFragment	extractContents() 含まれているドキュメントまたはドキュメントのフラグメントから Range の内容を移動します。
boolean	getCollapsed() Range が折りたたまれている場合は true。
Node	getCommonAncestorContainer() Range の 2 つの境界点のもっとも深い共通上位コンテナ。
Node	getEndContainer() 内部で Range が終了するノード。
int	getEndOffset() Range の終了ノード内のオフセット。
Node	getStartContainer() 内部で Range が始まるノード。
int	getStartOffset() Range の開始ノード内のオフセット。
void	insertNode(Node newNode) ノードを Document または DocumentFragment の Range の開始位置に挿入します。
void	selectNode(Node refNode) ノードとその内容を選択します。
void	selectNodeContents(Node refNode) ノード内の内容を選択します。
void	setEnd(Node refNode, int offset) Range の終了を記述する属性を設定します。
void	setEndAfter(Node refNode) Range の終了をノードのあとに設定します。
void	setEndBefore(Node refNode) 終了位置をノードの前に設定します。
void	setStart(Node refNode, int offset) Range の開始を記述する属性を設定します。
void	setStartAfter(Node refNode) 開始位置をノードのあとに設定します。
void	setStartBefore(Node refNode) 開始位置をノードの前に設定します。
void	surroundContents(Node newParent) Range の内容を所定のノードの親として再設定し、再設定したノードを Range の開始位置に挿入します。
String	toString() Range の内容を文字列として返します。

フィールドの詳細

START_TO_START

static final short START_TO_START

sourceRange の開始境界点と compareBoundaryPoints が呼び出される Range の開始境界点を比較します。

関連項目:

定数フィールド値

START_TO_END

static final short START_TO_END

sourceRange の開始境界点と compareBoundaryPoints が呼び出される Range の終了境界点を比較します。

関連項目:

定数フィールド値

END_TO_END

static final short END_TO_END

sourceRange の終了境界点と compareBoundaryPoints が呼び出される Range の終了境界点を比較します。

関連項目:

定数フィールド値

END_TO_START

static final short END_TO_START

sourceRange の終了境界点と compareBoundaryPoints が呼び出される Range の開始境界点を比較します。

関連項目:

定数フィールド値

メソッドの詳細

getStartContainer

Node getStartContainer()
                       throws DOMException

内部で Range が始まるノード。

例外:

DOMException - INVALID_STATE_ERR:このオブジェクト上ですでに detach() が呼び出されている場合に発生する

getStartOffset

int getStartOffset()
                   throws DOMException

Range の開始ノード内のオフセット。

例外:

DOMException - INVALID_STATE_ERR:このオブジェクト上ですでに detach() が呼び出されている場合に発生する

getEndContainer

Node getEndContainer()
                     throws DOMException

内部で Range が終了するノード。

例外:

DOMException - INVALID_STATE_ERR:このオブジェクト上ですでに detach() が呼び出されている場合に発生する

getEndOffset

int getEndOffset()
                 throws DOMException

Range の終了ノード内のオフセット。

例外:

DOMException - INVALID_STATE_ERR:このオブジェクト上ですでに detach() が呼び出されている場合に発生する

getCollapsed

boolean getCollapsed()
                     throws DOMException

Range が折りたたまれている場合は true。

例外:

DOMException - INVALID_STATE_ERR:このオブジェクト上ですでに detach() が呼び出されている場合に発生する

getCommonAncestorContainer

Node getCommonAncestorContainer()
                                throws DOMException

Range の 2 つの境界点のもっとも深い共通上位コンテナ。

例外:

DOMException - INVALID_STATE_ERR:このオブジェクト上ですでに detach() が呼び出されている場合に発生する

setStart

void setStart(Node refNode,
              int offset)
              throws RangeException,
                     DOMException

Range の開始を記述する属性を設定します。

パラメータ:

refNode - refNode 値。このパラメータは null 以外でなければならない

offset - startOffset 値

例外:

RangeException - INVALID_NODE_TYPE_ERR:refNode または refNode の上位が Entity、Notation、または DocumentType ノードの場合に発生する

DOMException - INDEX_SIZE_ERR:offset が負であるか、refNode の子の単位数よりも大きい場合に発生する。refNode が CharacterData ノード (Text または Comment ノードなど) または ProcessingInstruction ノードの型の場合、子の単位は16 ビット単位である。ほかのすべてのケースで、子の単位は Nodes である
INVALID_STATE_ERR:このオブジェクト上ですでに detach() が呼び出されている場合に発生する
WRONG_DOCUMENT_ERR:refNode が、この範囲を生成したドキュメントとは異なるドキュメントから が生成された場合に発生する

setEnd

void setEnd(Node refNode,
            int offset)
            throws RangeException,
                   DOMException

Range の終了を記述する属性を設定します。

パラメータ:

refNode - refNode 値。このパラメータは null 以外でなければならない

offset - endOffset 値

例外:

RangeException - INVALID_NODE_TYPE_ERR:refNode または refNode の上位が Entity、Notation、または DocumentType ノードの場合に発生する

DOMException - INDEX_SIZE_ERR:offset が負であるか、refNode の子の単位数よりも大きい場合に発生する。refNode が CharacterData ノード (Text または Comment ノードなど) または ProcessingInstruction ノードの型の場合、子の単位は16 ビット単位である。ほかのすべてのケースで、子の単位は Nodes である
INVALID_STATE_ERR:このオブジェクト上ですでに detach() が呼び出されている場合に発生する
WRONG_DOCUMENT_ERR:refNode が、この範囲を生成したドキュメントとは異なるドキュメントから が生成された場合に発生する

setStartBefore

void setStartBefore(Node refNode)
                    throws RangeException,
                           DOMException

開始位置をノードの前に設定します。

パラメータ:

refNode - Range は refNode の前から始まる

例外:

RangeException - INVALID_NODE_TYPE_ERR:refNode が Attr、Document、または DocumentFragment ノードではない場合、または refNode が Document、DocumentFragment、Attr、Entity、または Notation ノードの場合に発生する

DOMException - INVALID_STATE_ERR:このオブジェクト上ですでに detach() が呼び出されている場合に発生する
WRONG_DOCUMENT_ERR:refNode が、この範囲を生成したドキュメントとは異なるドキュメントから が生成された場合に発生する

setStartAfter

void setStartAfter(Node refNode)
                   throws RangeException,
                          DOMException

開始位置をノードのあとに設定します。

パラメータ:

refNode - Range は refNode のあとから始まる

例外:

RangeException - INVALID_NODE_TYPE_ERR:refNode が Attr、Document、または DocumentFragment ノードではない場合、または refNode が Document、DocumentFragment、Attr、Entity、または Notation ノードの場合に発生する

DOMException - INVALID_STATE_ERR:このオブジェクト上ですでに detach() が呼び出されている場合に発生する
WRONG_DOCUMENT_ERR:refNode が、この範囲を生成したドキュメントとは異なるドキュメントから が生成された場合に発生する

setEndBefore

void setEndBefore(Node refNode)
                  throws RangeException,
                         DOMException

終了位置をノードの前に設定します。

パラメータ:

refNode - Range は refNode の前で終わる

例外:

RangeException - INVALID_NODE_TYPE_ERR:refNode が Attr、Document、または DocumentFragment ノードではない場合、または refNode が Document、DocumentFragment、Attr、Entity、または Notation ノードの場合に発生する

DOMException - INVALID_STATE_ERR:このオブジェクト上ですでに detach() が呼び出されている場合に発生する
WRONG_DOCUMENT_ERR:refNode が、この範囲を生成したドキュメントとは異なるドキュメントから が生成された場合に発生する

setEndAfter

void setEndAfter(Node refNode)
                 throws RangeException,
                        DOMException

Range の終了をノードのあとに設定します。

パラメータ:

refNode - Range は refNode のあとで終わる

例外:

RangeException - INVALID_NODE_TYPE_ERR:refNode が Attr、Document、または DocumentFragment ノードではない場合、または refNode が Document、DocumentFragment、Attr、Entity、または Notation ノードの場合に発生する

DOMException - INVALID_STATE_ERR:このオブジェクト上ですでに detach() が呼び出されている場合に発生する
WRONG_DOCUMENT_ERR:refNode が、この範囲を生成したドキュメントとは異なるドキュメントから が生成された場合に発生する

collapse

void collapse(boolean toStart)
              throws DOMException

境界点の 1 つに Range を折りたたみます。

パラメータ:

toStart - true の場合、Range を開始境界点に折りたたみ、false の場合、終了境界点に折りたたむ

例外:

DOMException - INVALID_STATE_ERR:このオブジェクト上ですでに detach() が呼び出されている場合に発生する

selectNode

void selectNode(Node refNode)
                throws RangeException,
                       DOMException

ノードとその内容を選択します。

パラメータ:

refNode - 選択するノード

例外:

RangeException - INVALID_NODE_TYPE_ERR:refNode の上位が Entity、Notation、または DocumentType ノードの場合、または refNode が Document、DocumentFragment、Attr、Entity、または Notation ノードの場合に発生する

DOMException - INVALID_STATE_ERR:このオブジェクト上ですでに detach() が呼び出されている場合に発生する
WRONG_DOCUMENT_ERR:refNode が、この範囲を生成したドキュメントとは異なるドキュメントから が生成された場合に発生する

selectNodeContents

void selectNodeContents(Node refNode)
                        throws RangeException,
                               DOMException

ノード内の内容を選択します。

パラメータ:

refNode - 内容が選択されるノード

例外:

RangeException - INVALID_NODE_TYPE_ERR:refNode または refNode の上位が Entity、Notation、または DocumentType ノードの場合に発生する

DOMException - INVALID_STATE_ERR:このオブジェクト上ですでに detach() が呼び出されている場合に発生する
WRONG_DOCUMENT_ERR:refNode が、この範囲を生成したドキュメントとは異なるドキュメントから が生成された場合に発生する

compareBoundaryPoints

short compareBoundaryPoints(short how,
                            Range sourceRange)
                            throws DOMException

ドキュメントの 2 つの Range の境界点を比較します。

パラメータ:

how - 前述のように比較の種類を表すコード

sourceRange - 現在の Range の比較対象の Range

戻り値:

Range の対応する境界点が sourceRange の対応する境界点の前、同等、またはあとかに応じて、それぞれ -1、0、または 1

例外:

DOMException - WRONG_DOCUMENT_ERR:2 つの Range が同じ Document または DocumentFragment にない場合に発生する
INVALID_STATE_ERR:このオブジェクト上ですでに detach() が呼び出されている場合に発生する

deleteContents

void deleteContents()
                    throws DOMException

削除された内容への参照を返すことなく、含まれているドキュメントまたはドキュメントのフラグメントから Range の内容を削除します。

例外:

DOMException - NO_MODIFICATION_ALLOWED_ERR:Range の内容の一部が読み取り専用の場合、または Range の内容を含むノードのいずれかが読み取り専用の場合に発生する
INVALID_STATE_ERR:このオブジェクト上ですでに detach() が呼び出されている場合に発生する

extractContents

DocumentFragment extractContents()
                                 throws DOMException

含まれているドキュメントまたはドキュメントのフラグメントから Range の内容を移動します。

戻り値:

抽出された内容を含んでいる DocumentFragment

例外:

DOMException - NO_MODIFICATION_ALLOWED_ERR:Range の内容の一部が読み取り専用の場合、または Range の内容を含むノードのいずれかが読み取り専用の場合に発生する
HIERARCHY_REQUEST_ERR:DocumentType ノードが新しい DocumentFragment に抽出される場合に発生する
INVALID_STATE_ERR:このオブジェクト上ですでに detach() が呼び出されている場合に発生する

cloneContents

DocumentFragment cloneContents()
                               throws DOMException

Range の内容を複製します。

戻り値:

この Range と同等の内容を含む DocumentFragment

例外:

DOMException - HIERARCHY_REQUEST_ERR:DocumentType ノードが新しい DocumentFragment に抽出される場合に発生する
INVALID_STATE_ERR:このオブジェクト上ですでに detach() が呼び出されている場合に発生する

insertNode

void insertNode(Node newNode)
                throws DOMException,
                       RangeException

ノードを Document または DocumentFragment の Range の開始位置に挿入します。コンテナが Text ノードの場合、このノードは Text ノードの splitText メソッドが挿入点で実行されたときのように Range の開始位置で分割されます。隣接する Text ノードは自動的に結合されます。挿入されるノードが DocumentFragment ノードの場合、DocumentFragment ノード自体ではなくその子が挿入されます。

パラメータ:

newNode - Range の開始位置に挿入されるノード

例外:

DOMException - NO_MODIFICATION_ALLOWED_ERR:Range の開始の上位コンテナが読み取り専用の場合に発生する
WRONG_DOCUMENT_ERR:newNode および Range の開始のコンテナが同じドキュメントから作成されていなかった場合に発生する
HIERARCHY_REQUEST_ERR:Range の開始のコンテナが newNode の型の子を許可しない型のコンテナの場合、または newNode がコンテナの上位である場合に発生する
INVALID_STATE_ERR:このオブジェクト上ですでに detach() が呼び出されている場合に発生する

RangeException - INVALID_NODE_TYPE_ERR:newNode が Attr、Entity、Notation、または Document ノードの場合に発生する

surroundContents

void surroundContents(Node newParent)
                      throws DOMException,
                             RangeException

Range の内容を所定のノードの親として再設定し、再設定したノードを Range の開始位置に挿入します。

パラメータ:

newParent - 内容を囲むノード

例外:

DOMException - NO_MODIFICATION_ALLOWED_ERR:Range のどちらかの境界点の上位コンテナが読み取り専用の場合に発生する
WRONG_DOCUMENT_ERR:newParent および Range の開始のコンテナが同じドキュメントから作成されていなかった場合に発生する
HIERARCHY_REQUEST_ERR:Range の開始のコンテナが newParent の型の子を許可しない型のコンテナである場合、または newParent がコンテナの上位の場合、あるいは node が、node の型によって許可されていない型の子ノードで終わる場合に発生する
INVALID_STATE_ERR:このオブジェクト上ですでに detach() が呼び出されている場合に発生する

RangeException - BAD_BOUNDARYPOINTS_ERR:Range が部分的にテキスト以外のノードを選択した場合に発生する
INVALID_NODE_TYPE_ERR:node が Attr、Entity、DocumentType、Notation、Document、または DocumentFragment ノードの場合に発生する

cloneRange

Range cloneRange()
                 throws DOMException

この Range の境界点と同等の境界点を持つ新規 Range を作成します。

戻り値:

重複する Range

例外:

DOMException - INVALID_STATE_ERR:このオブジェクト上ですでに detach() が呼び出されている場合に発生する

toString

String toString()
                throws DOMException

Range の内容を文字列として返します。この文字列には、マークアップではなくデータの文字だけが含まれます。

オーバーライド:

クラス Object 内の toString

戻り値:

Range の内容

例外:

DOMException - INVALID_STATE_ERR:このオブジェクト上ですでに detach() が呼び出されている場合に発生する

detach

void detach()
            throws DOMException

Range が現在では使用されていないことおよび実装がこの Range に関連するリソースを放棄する可能性があることを示すために呼び出されます。これ以降、この Range 上でメソッドや属性を取得するものを呼び出すと、エラーコード INVALID_STATE_ERR で DOMException がスローされます。

例外:

DOMException - INVALID_STATE_ERR:このオブジェクト上ですでに detach() が呼び出されている場合に発生する