API Preview tool | The Dojo Toolkit

dojo/NodeList-traverse.js

Provides:
- dojo.NodeList-traverse
dojo.NodeList._buildArrayFromCallback
- type
```
Function
```
- parameters:
  - callback: (typeof Function)
- source: [view]
    var ary = [];
    for(var i = 0; i < this.length; i++){
     var items = callback.call(this[i], this[i], ary);
     if(items){
      ary = ary.concat(items);
     }
    }
    return ary;
- summary
```
builds a new array of possibly differing size based on the input list.
Since the returned array is likely of different size than the input array,
the array's map function cannot be used.
```
dojo.NodeList._getUniqueAsNodeList
- type
```
Function
```
- parameters:
  - nodes: (typeof )
- source: [view]
    var ary = [];
    //Using for loop for better speed.
    for(var i = 0, node; node = nodes[i]; i++){
     //Should be a faster way to do this. dojo.query has a private
     //_zip function that may be inspirational, but there are pathways
     //in query that force nozip?
     if(node.nodeType == 1 && dojo.indexOf(ary, node) == -1){
      ary.push(node);
     }
    }
    return this._wrap(ary, null, this._NodeListCtor); //dojo.NodeList
- summary
```
given a list of nodes, make sure only unique
elements are returned as our NodeList object.
Does not call _stash().
```
- returns
```
dojo.NodeList
```
dojo.NodeList._getUniqueNodeListWithParent
- type
```
Function
```
- parameters:
  - nodes: (typeof )
  - query: (typeof )
- source: [view]
    var ary = this._getUniqueAsNodeList(nodes);
    ary = (query ? dojo._filterQueryResult(ary, query) : ary);
    return ary._stash(this); //dojo.NodeList
- summary
```
gets unique element nodes, filters them further
with an optional query and then calls _stash to track parent NodeList.
```
- returns
```
dojo.NodeList
```

dojo.NodeList._getRelatedUniqueNodes

type
```
Function
```
parameters:
- query: (typeof String)
- callback: (typeof Function)
source: [view]
return this._getUniqueNodeListWithParent(this._buildArrayFromCallback(callback), query); //dojo.NodeList

summary

cycles over all the nodes and calls a callback
to collect nodes for a possible inclusion in a result.
The callback will get two args: callback(node, ary),
where ary is the array being used to collect the nodes.

returns
```
dojo.NodeList
```

dojo.NodeList.children

type
```
Function
```
parameters:
- query: (typeof String)
```
a CSS selector.
```
source: [view]
  return this._getRelatedUniqueNodes(query, function(node, ary){
   return dojo._toArray(node.childNodes);
  }); //dojo.NodeList

summary

Returns all immediate child elements for nodes in this dojo.NodeList.
Optionally takes a query to filter the child elements.

description

.end() can be used on the returned dojo.NodeList to get back to the
original dojo.NodeList.

return_summary

dojo.NodeList, all immediate child elements for the nodes in this dojo.NodeList.

example

assume a DOM created by this markup:

	<div class="container">
		<div class="red">Red One</div>
		Some Text
		<div class="blue">Blue One</div>
		<div class="red">Red Two</div>
		<div class="blue">Blue Two</div>
	</div>
Running this code:

	dojo.query(".container").children();
returns the four divs that are children of the container div.
Running this code:

	dojo.query(".container").children(".red");
returns the two divs that have the class "red".

dojo.NodeList.closest

type
```
Function
```

parameters:

query: (typeof String)
```
a CSS selector.
```

root: (typeof String|DOMNode)

If specified, query is relative to &quot;root&quot; rather than document body.

source: [view]
  return this._getRelatedUniqueNodes(null, function(node, ary){
   do{
    if(dojo._filterQueryResult([node], query, root).length){
     return node;
    }
   }while(node != root && (node = node.parentNode) && node.nodeType == 1);
   return null; //To make rhino strict checking happy.
  }); //dojo.NodeList

summary

Returns closest parent that matches query, including current node in this
dojo.NodeList if it matches the query.

description

.end() can be used on the returned dojo.NodeList to get back to the
original dojo.NodeList.

return_summary

dojo.NodeList, the closest parent that matches the query, including the current
node in this dojo.NodeList if it matches the query.

returns
```
To make rhino strict checking happy.
```

example

assume a DOM created by this markup:

	<div class="container">
		<div class="red">Red One</div>
		Some Text
		<div class="blue">Blue One</div>
		<div class="red">Red Two</div>
		<div class="blue">Blue Two</div>
	</div>
Running this code:

	dojo.query(".red").closest(".container");
returns the div with class "container".

dojo.NodeList.parent

type
```
Function
```
parameters:
- query: (typeof String)
```
a CSS selector.
```
source: [view]
  return this._getRelatedUniqueNodes(query, function(node, ary){
   return node.parentNode;
  }); //dojo.NodeList

summary

Returns immediate parent elements for nodes in this dojo.NodeList.
Optionally takes a query to filter the parent elements.

description

.end() can be used on the returned dojo.NodeList to get back to the
original dojo.NodeList.

return_summary

dojo.NodeList, immediate parent elements for nodes in this dojo.NodeList.

example

assume a DOM created by this markup:

	<div class="container">
		<div class="red">Red One</div>
		<div class="blue first"><span class="text">Blue One</span></div>
		<div class="red">Red Two</div>
		<div class="blue"><span class="text">Blue Two</span></div>
	</div>
Running this code:

	dojo.query(".text").parent();
returns the two divs with class "blue".
Running this code:

	dojo.query(".text").parent(".first");
returns the one div with class "blue" and "first".

dojo.NodeList.parents

type
```
Function
```
parameters:
- query: (typeof String)
```
a CSS selector.
```
source: [view]
  return this._getRelatedUniqueNodes(query, function(node, ary){
   var pary = []
   while(node.parentNode){
    node = node.parentNode;
    pary.push(node);
   }
   return pary;
  }); //dojo.NodeList

summary

Returns all parent elements for nodes in this dojo.NodeList.
Optionally takes a query to filter the child elements.

description

.end() can be used on the returned dojo.NodeList to get back to the
original dojo.NodeList.

return_summary

dojo.NodeList, all parent elements for nodes in this dojo.NodeList.

example

assume a DOM created by this markup:

	<div class="container">
		<div class="red">Red One</div>
		<div class="blue first"><span class="text">Blue One</span></div>
		<div class="red">Red Two</div>
		<div class="blue"><span class="text">Blue Two</span></div>
	</div>
Running this code:

	dojo.query(".text").parents();
returns the two divs with class "blue", the div with class "container",

	the body element and the html element.
Running this code:

	dojo.query(".text").parents(".container");
returns the one div with class "container".

dojo.NodeList.siblings

type
```
Function
```
parameters:
- query: (typeof String)
```
a CSS selector.
```
source: [view]
  return this._getRelatedUniqueNodes(query, function(node, ary){
   var pary = []
   var nodes = (node.parentNode && node.parentNode.childNodes);
   for(var i = 0; i < nodes.length; i++){
    if(nodes[i] != node){
     pary.push(nodes[i]);
    }
   }
   return pary;
  }); //dojo.NodeList

summary

Returns all sibling elements for nodes in this dojo.NodeList.
Optionally takes a query to filter the sibling elements.

description

.end() can be used on the returned dojo.NodeList to get back to the
original dojo.NodeList.

return_summary

dojo.NodeList, all sibling elements for nodes in this dojo.NodeList.

example

assume a DOM created by this markup:

	<div class="container">
		<div class="red">Red One</div>
		Some Text
		<div class="blue first">Blue One</div>
		<div class="red">Red Two</div>
		<div class="blue">Blue Two</div>
	</div>
Running this code:

	dojo.query(".first").siblings();
returns the two divs with class "red" and the other div

	with class "blue" that does not have "first".
Running this code:

	dojo.query(".first").siblings(".red");
returns the two div with class "red".

dojo.NodeList.next

type
```
Function
```
parameters:
- query: (typeof String)
```
a CSS selector.
```
source: [view]
  return this._getRelatedUniqueNodes(query, function(node, ary){
   var next = node.nextSibling;
   while(next && next.nodeType != 1){
    next = next.nextSibling;
   }
   return next;
  }); //dojo.NodeList

summary

Returns the next element for nodes in this dojo.NodeList.
Optionally takes a query to filter the next elements.

description

.end() can be used on the returned dojo.NodeList to get back to the
original dojo.NodeList.

return_summary

dojo.NodeList, the next element for nodes in this dojo.NodeList.

example

assume a DOM created by this markup:

	<div class="container">
		<div class="red">Red One</div>
		Some Text
		<div class="blue first">Blue One</div>
		<div class="red">Red Two</div>
		<div class="blue last">Blue Two</div>
	</div>
Running this code:

	dojo.query(".first").next();
returns the div with class "red" and has innerHTML of "Red Two".
Running this code:

	dojo.query(".last").next(".red");
does not return any elements.

dojo.NodeList.nextAll

type
```
Function
```
parameters:
- query: (typeof String)
```
a CSS selector.
```
source: [view]
  return this._getRelatedUniqueNodes(query, function(node, ary){
   var pary = []
   var next = node;
   while((next = next.nextSibling)){
    if(next.nodeType == 1){
     pary.push(next);
    }
   }
   return pary;
  }); //dojo.NodeList

summary

Returns all sibling elements that come after the nodes in this dojo.NodeList.
Optionally takes a query to filter the sibling elements.

description

.end() can be used on the returned dojo.NodeList to get back to the
original dojo.NodeList.

return_summary

dojo.NodeList, all sibling elements that come after the nodes in this dojo.NodeList.

example

assume a DOM created by this markup:

	<div class="container">
		<div class="red">Red One</div>
		Some Text
		<div class="blue first">Blue One</div>
		<div class="red next">Red Two</div>
		<div class="blue next">Blue Two</div>
	</div>
Running this code:

	dojo.query(".first").nextAll();
returns the two divs with class of "next".
Running this code:

	dojo.query(".first").nextAll(".red");
returns the one div with class "red" and innerHTML "Red Two".

dojo.NodeList.prev

type
```
Function
```
parameters:
- query: (typeof String)
```
a CSS selector.
```
source: [view]
  return this._getRelatedUniqueNodes(query, function(node, ary){
   var prev = node.previousSibling;
   while(prev && prev.nodeType != 1){
    prev = prev.previousSibling;
   }
   return prev;
  }); //dojo.NodeList

summary

Returns the previous element for nodes in this dojo.NodeList.
Optionally takes a query to filter the previous elements.

description

.end() can be used on the returned dojo.NodeList to get back to the
original dojo.NodeList.

return_summary

dojo.NodeList, the previous element for nodes in this dojo.NodeList.

example

assume a DOM created by this markup:

	<div class="container">
		<div class="red">Red One</div>
		Some Text
		<div class="blue first">Blue One</div>
		<div class="red">Red Two</div>
		<div class="blue">Blue Two</div>
	</div>
Running this code:

	dojo.query(".first").prev();
returns the div with class "red" and has innerHTML of "Red One".
Running this code:

	dojo.query(".first").prev(".blue");
does not return any elements.

dojo.NodeList.prevAll

type
```
Function
```
parameters:
- query: (typeof String)
```
a CSS selector.
```
source: [view]
  return this._getRelatedUniqueNodes(query, function(node, ary){
   var pary = []
   var prev = node;
   while((prev = prev.previousSibling)){
    if(prev.nodeType == 1){
     pary.push(prev);
    }
   }
   return pary;
  }); //dojo.NodeList

summary

Returns all sibling elements that come before the nodes in this dojo.NodeList.
Optionally takes a query to filter the sibling elements.

description

The returned nodes will be in reverse DOM order -- the first node in the list will
be the node closest to the original node/NodeList.
.end() can be used on the returned dojo.NodeList to get back to the
original dojo.NodeList.

return_summary

dojo.NodeList, all sibling elements that come before the nodes in this dojo.NodeList.

example

assume a DOM created by this markup:

	<div class="container">
		<div class="red prev">Red One</div>
		Some Text
		<div class="blue prev">Blue One</div>
		<div class="red second">Red Two</div>
		<div class="blue">Blue Two</div>
	</div>
Running this code:

	dojo.query(".second").prevAll();
returns the two divs with class of "prev".
Running this code:

	dojo.query(".first").prevAll(".red");
returns the one div with class "red prev" and innerHTML "Red One".

dojo.NodeList.andSelf

type
```
Function
```
source: [view]
return this.concat(this._parent);

summary

Adds the nodes from the previous dojo.NodeList to the current dojo.NodeList.

description

.end() can be used on the returned dojo.NodeList to get back to the
original dojo.NodeList.

return_summary
```
dojo.NodeList
```

example

assume a DOM created by this markup:

	<div class="container">
		<div class="red prev">Red One</div>
		Some Text
		<div class="blue prev">Blue One</div>
		<div class="red second">Red Two</div>
		<div class="blue">Blue Two</div>
	</div>
Running this code:

	dojo.query(".second").prevAll().andSelf();
returns the two divs with class of "prev", as well as the div with class "second".

dojo.NodeList.first

type
```
Function
```
source: [view]
return this._wrap(((this[0] && [this[0]]) || []), this); //dojo.NodeList

summary

Returns the first node in this dojo.NodeList as a dojo.NodeList.

description

.end() can be used on the returned dojo.NodeList to get back to the
original dojo.NodeList.

return_summary

dojo.NodeList, with the first node in this dojo.NodeList

returns
```
dojo.NodeList
```

example

assume a DOM created by this markup:

	<div class="container">
		<div class="red">Red One</div>
		<div class="blue first">Blue One</div>
		<div class="red">Red Two</div>
		<div class="blue last">Blue Two</div>
	</div>
Running this code:

	dojo.query(".blue").first();
returns the div with class "blue" and "first".

dojo.NodeList.last

type
```
Function
```
source: [view]
return this._wrap((this.length ? [this[this.length - 1]] : []), this); //dojo.NodeList

summary

Returns the last node in this dojo.NodeList as a dojo.NodeList.

description

.end() can be used on the returned dojo.NodeList to get back to the
original dojo.NodeList.

return_summary

dojo.NodeList, with the last node in this dojo.NodeList

returns
```
dojo.NodeList
```

example

assume a DOM created by this markup:

	<div class="container">
		<div class="red">Red One</div>
		<div class="blue first">Blue One</div>
		<div class="red">Red Two</div>
		<div class="blue last">Blue Two</div>
	</div>
Running this code:

	dojo.query(".blue").last();
returns the last div with class "blue",

dojo.NodeList.even

type
```
Function
```
source: [view]
  return this.filter(function(item, i){
   return i % 2 != 0;
  }); //dojo.NodeList

summary

Returns the even nodes in this dojo.NodeList as a dojo.NodeList.

description

.end() can be used on the returned dojo.NodeList to get back to the
original dojo.NodeList.

return_summary

dojo.NodeList, with the even nodes in this dojo.NodeList

example

assume a DOM created by this markup:

	<div class="container">
		<div class="interior red">Red One</div>
		<div class="interior blue">Blue One</div>
		<div class="interior red">Red Two</div>
		<div class="interior blue">Blue Two</div>
	</div>
Running this code:

	dojo.query(".interior").even();
returns the two divs with class "blue"

dojo.NodeList.odd

type
```
Function
```
source: [view]
  return this.filter(function(item, i){
   return i % 2 == 0;
  }); //dojo.NodeList

summary

Returns the odd nodes in this dojo.NodeList as a dojo.NodeList.

description

.end() can be used on the returned dojo.NodeList to get back to the
original dojo.NodeList.

return_summary

dojo.NodeList, with the odd nodes in this dojo.NodeList

example

assume a DOM created by this markup:

	<div class="container">
		<div class="interior red">Red One</div>
		<div class="interior blue">Blue One</div>
		<div class="interior red">Red Two</div>
		<div class="interior blue">Blue Two</div>
	</div>
Running this code:

	dojo.query(".interior").odd();
returns the two divs with class "red"

dojo.NodeList-traverse
- type
```
Object
```
- summary
dojo
- type
```
Object
```
- summary

dojo/NodeList-traverse.js

Provides:

dojo.NodeList._buildArrayFromCallback

dojo.NodeList._getUniqueAsNodeList

dojo.NodeList._getUniqueNodeListWithParent

dojo.NodeList._getRelatedUniqueNodes

dojo.NodeList.children

dojo.NodeList.closest

dojo.NodeList.parent

dojo.NodeList.parents

dojo.NodeList.siblings

dojo.NodeList.next

dojo.NodeList.nextAll

dojo.NodeList.prev

dojo.NodeList.prevAll

dojo.NodeList.andSelf

dojo.NodeList.first

dojo.NodeList.last

dojo.NodeList.even

dojo.NodeList.odd

dojo.NodeList-traverse

dojo