Interface TreeWalker

TreeWalker オブジェクトは、 whatToShow フラグと (もしあれば) フィルタで定義される文書のビューを使った、文書ツリーや下位ツリーのナビゲートに使用される。 TreeWalker を使ってナビゲーションを行う任意の関数は、 TreeWalker で定義されるビューを自動的にサポートする。

下位ツリーの論理ビューからのノードの省略は、完全なフィルタされない文書内の同じ下位ツリーと実質的に異なる構造の中に結果を持てる。 TreeWalker ビュー内の兄弟であるノード同士は、本来のビュー内部では大きく離れた異なるノードの子であってもよい。具体的には、ノードと文書のルートノードを除くノード全てをスキップする NodeFilter を考える。元文書がどれだけネストした構造であっても、結果の論理ビューにおいて全テキストノードは兄弟であり、ルートノードの直接の子として出現する。

プロパティ:

`treewalkerObject`.`currentNode`

Node型

TreeWalker が現在位置しているノード。
DOM ツリーの変更は、現在のノードを TreeWalker に関連付けられたフィルタによってもう受け入れられないようにしてもよい。 currentNode はまた明示的に任意のノードに設定されてもよく、このときそのノードが root ノードによって規定される下位ツリー内部であるか、またフィルタと whatToShow フラグによって受け入れられるかどうかは問わない。それゆえトラバーサルは、要求される方向でのフィルタの適用により、それが現在のビューの一部でなかったとしても currentNode に関連が発生する; トラバーサル出来ない場合は、 currentNode は変更されない。

`treewalkerObject`.`expandEntityReferences`

boolean型, 読取専用

このフラグの値は、実体参照ノードの子が TreeWalker から可視であるかどうかを判定する。 false ならば、実体参照ノードの子とその子孫は拒絶される。この拒絶は whatToShow とフィルタがある場合もそれより優先されることに注意。
実体参照を展開し実体参照ノード自身を露出しない文書ビューを生成するためには、 TreeWalker 生成時に whatToShow フラグで実体参照ノードを隠し、 expandEntityReferences を true に設定する。実体参照ノードを持ち実体を展開しない文書ビューの生成には、 whatToShow フラグで実体参照ノードを現し expandEntityReferences を false に設定する。

`treewalkerObject`.`filter`

NodeFilter型, 読取専用

スクリーンノードに使用するフィルタ。

`treewalkerObject`.`root`

Node型, 読取専用

生成されたときに規定された TreeWalker の root ノード。

`treewalkerObject`.`whatToShow`

unsigned long型, 読取専用

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

メソッド:

`treewalkerObject`.`firstChild`( )

現在のノードの可視である最初の子まで TreeWalker を移動し、新しいノードを返す。現在のノードが可視の子を持たなければ、 null を返し、現在のノードを維持する。

戻り値:

Node 型。新しいノード。現在のノードが TreeWalker の論理ビュー内に可視である子を持たない場合は null 。

`treewalkerObject`.`lastChild`( )

現在のノードの可視である最後の子まで TreeWalker を移動し、新しいノードを返す。現在のノードが可視の子を持たなければ、 null を返し、現在のノードを維持する。

戻り値:

Node 型。新しいノード。現在のノードが TreeWalker の論理ビュー内に子を持たない場合は null 。

`treewalkerObject`.`nextNode`( )

現在のノードに関連するドキュメントオーダー内で次の可視ノードまで TreeWalker を移動し、新しいノードを返す。現在のノードが次ノードを持たない場合、また nextNode 検索が TreeWalker の root ノードから上に上がろうとする場合は null を返し、現在のノードを維持する。

戻り値:

Node 型。新しいノード。現在のノードが TreeWalker の論理ビュー内に次ノードを持たない場合は null 。

`treewalkerObject`.`nextSibling`( )

現在のノードの次の兄弟まで TreeWalker を移動し、新しいノードを返す。現在のノードが可視である次の兄弟を持たない場合は null を返し、現在のノードを維持する。

戻り値:

Node 型。新しいノード。現在のノードが TreeWalker の論理ビュー内に次の兄弟を持たない場合は null 。

`treewalkerObject`.`parentNode`( )

現在のノードに最も接近する可視の祖先ノードまで移動しそれを返す。 parentNode 検索が TreeWalker の root ノードから上に上がろうとする場合、また祖先ノードの検索に失敗した場合は、このメソッドは現在の位置を維持し null を返す。

戻り値:

Node 型。新しい親ノード。現在のノードが TreeWalker の論理ビュー内に親を持たない場合は null 。

`treewalkerObject`.`previousNode`( )

現在のノードに関連するドキュメントオーダー内で前の可視ノードまで TreeWalker を移動し、新しいノードを返す。現在のノードが前のノードを持たない場合、また previousNode 検索が TreeWalker の root ノードから上に上がろうとする場合は、 null を返し現在のノードを維持する。

戻り値:

Node 型。新しいノード。現在のノードが TreeWalker の論理ビュー内に前のノードを持たない場合は null 。

`treewalkerObject`.`previousSibling`( )

現在のノードの前の兄弟まで TreeWalker を移動し、新しいノードを返す。現在のノードが可視である前の兄弟を持たない場合は、 null を返し、現在のノードを維持する。

戻り値:

Node 型。新しいノード。現在のノードが TreeWalker の論理ビュー内に前の兄弟を持たない場合は null 。

IDL 定義:

// Introduced in DOM Level 2: interface TreeWalker { readonly attribute Node root; readonly attribute unsigned long whatToShow; readonly attribute NodeFilter filter; readonly attribute boolean expandEntityReferences; attribute Node currentNode; // raises(DOMException) on setting Node parentNode(); Node firstChild(); Node lastChild(); Node previousSibling(); Node nextSibling(); Node previousNode(); Node nextNode(); };