Interface NodeIterator

ノード集合、例えば NodeList 内のノード集合、特別な Node に決定される文書の下位ツリー、問い合わせの結果、または任意の他のノード集合を通って歩くために、Iterator を使用する。イテレートされるノード集合は、 NodeIterator の実装によって決定される。 DOM Level 2 は、文書下位ツリーのドキュメントオーダートラバーサルに、単一の NodeIterator 実装を規定する。これらのイテレータのインスタンスは、 DocumentTraversal .createNodeIterator() 呼出しによって生成される。

プロパティ:

`nodeiteratorObject`.`expandEntityReferences`

boolean型, 読取専用

このフラグの値は、実体参照ノードの子がイテレータから可視であるかどうかを決定する。 false ならば、それとその子孫は拒絶される。この拒絶は whatToShow とフィルタに先行することに注意。またこれは今のところ、 NodeIterators がスキップしている判別可能なノードではなく完璧な下位ツリーを拒絶してよい唯一の状況であることにも注意。

実体参照を展開し実体参照ノード自身を露出しない文書のビューを生成するために、イテレータ生成時に whatToShow フラグを使用して実体参照ノードを隠し、expandEntityReferences を true に設定する。実体参照を展開しない文書のビューを生成するために、 whatToShow フラグを使用して実体参照ノードを表し、expandEntityReferences を false に設定する。

`nodeiteratorObject`.`filter`

NodeFilter型, 読取専用

スクリーンノードに使用される NodeFilter 。

`nodeiteratorObject`.`root`

Node型, 読取専用

生成時に規定される、 NodeIterator のルートノード。

`nodeiteratorObject`.`whatToShow`

unsigned long型, 読取専用

このプロパティは、ノード型がイテレータ経由で表されるかどうかを判定する。使用可能な定数の集合は NodeFilter インターフェイスに定義される。 whatToShow によって受け入れられないノードはスキップされるが、その子は依然として考慮される。このスキップはどんなフィルタにも先行することに注意。

メソッド:

`nodeiteratorObject`.`detach`( )

任意の計算上のリソースを開放しイテレータを INVALID 状態に置き、その上をイテレートする集合から NodeIterator を引き離す。 detach が呼出された後の nextNode また previousNode の呼び出しは、例外 INVALID_STATE_ERR を発生させる。

戻り値:

(無し)

`nodeiteratorObject`.`nextNode`( )

集合内の次のノードを返し、集合内でのイテレータの位置を進める。 NodeIterator が生成された後、最初の nextNode() 呼出しは集合内の最初のノードを返す。

戻り値:

Node 型。イテレートされている集合内における次の Node, また集合内にこれ以上メンバばが存在しない場合は null。

例外:

INVALID_STATE_ERR / DOMException: detach メソッドが呼出された後にこのメソッドが呼出される場合に発生。

`nodeiteratorObject`.`previousNode`( )

集合内の前のノードを返し、集合内での NodeIterator の位置を前に戻す。

戻り値:

Node 型。イテレートされている集合内における前の Node, また集合内にこれ以上メンバが存在しない場合は null。

例外:

INVALID_STATE_ERR / DOMException: detach メソッドが呼出された後にこのメソッドが呼出される場合に発生。

IDL 定義:

// Introduced in DOM Level 2: interface NodeIterator { readonly attribute Node root; readonly attribute unsigned long whatToShow; readonly attribute NodeFilter filter; readonly attribute boolean expandEntityReferences; Node nextNode() raises(DOMException); Node previousNode() raises(DOMException); void detach(); };