apex4x/Help/$A API/Core/Query.txt

The Comprehensive ARIA Development Suite

��

Function: query(stringCSSSelectorOrNodeArray, domElementContext, functionFilterCallback(key, value))



Description: Processes a filtered list of matching elements and returns an array of nodes.



Returns: filtered Array, or $A object if chained.



Note: The query() function will always return an array, even when empty.



The callback function that executes on every object in the array also acts as a filter. By returning false from the callback, it will prevent that object from being returned as part of the final array returned from the $A.query() function.



Example:



// Get an array of matching elements in the document context.

var myArray = $A.query("h1, h2, h3");



// Get an array of matching elements in the context of a container element.

var myArray = $A.query("button", domElement);



// Process an array of elements

var myArray = $A.query([domElement1, domElement2], function(index, object) {

  // Do something with each object.

});



// Process an array of elements within the document context.

var myArray = $A.query("button.toggle", function(index, object) {

  // Do something with each object.

});



// Process an array of elements within the context of a specific container element.

var myArray = $A.query("button.toggle", domElement, function(index, object) {

  // Do something with each object.

});



// Process an array of elements and filter specific objects so they are not returned as part of the final array.

var myArray = $A.query("button.toggle", function(index, element) {

  // Prevent disabled buttons from being added to myArray when returned.

  return (element.disabled) ? false : true;

});



// Or the same using chaining



// Get an array of matching elements in the document context.

var myChain = $A(document).query("h1, h2, h3");



// Get an array of matching elements in the context of a container element.

var myChain = $A(domElement).query("button");



// Process an array of elements

var myChain = $A(document).query([domElement1, domElement2], function(index, object) {

  // Do something with each object.

});



// Process an array of elements within the document context.

var myChain = $A(document).query("button.toggle", function(index, object) {

  // Do something with each object.

});



// Process an array of elements within the context of a specific container element.

var myChain = $A(domElement).query("button.toggle", function(index, object) {

  // Do something with each object.

});



// Process an array of elements and filter specific objects so they are not returned as part of the final array.

var myArray = $A(domElement).query("button.toggle", function(index, element) {

  // Prevent disabled buttons from being added to myArray when returned.

  return (element.disabled) ? false : true;

});



// To return the modified element within a chain, use the "return()" method.



var myArray = myChain.return();