Class Firebug.HTMLLib.NodeSearch
Class used to search a DOM tree for the given text. Will display
the search results in a IO Box.
Defined in: htmlLib.js.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
Firebug.HTMLLib.NodeSearch(text, root, panelNode, ioBox, walker)
Constructs a NodeSearch instance.
|
| Method Attributes | Method Name and Description |
|---|---|
|
find(revert, caseSensitive)
Finds the first match within the document.
|
|
|
findNextMatch(revert, caseSensitive)
Finds the next match in the document.
|
|
|
reset()
Resets the search to the beginning of the document.
|
Class Detail
Firebug.HTMLLib.NodeSearch(text, root, panelNode, ioBox, walker)
Constructs a NodeSearch instance.
- Parameters:
- {String} text
- Text to search for
- {Object} root
- Root of search. This may be an element or a document
- {Object} panelNode
- Panel node containing the IO Box representing the DOM tree.
- {Object} ioBox
- IO Box to display the search results in
- {Object} walker
- Optional walker parameter.
Method Detail
find(revert, caseSensitive)
Finds the first match within the document.
- Parameters:
- {boolean} revert
- true to search backward, false to search forward
- {boolean} caseSensitive
- true to match exact case, false to ignore case
- Returns:
- true if no more matches were found, but matches were found previously.
findNextMatch(revert, caseSensitive)
Finds the next match in the document.
The return value is an object with the fields
- node: Node that contains the match
- isValue: true if the match is a match due to the value of the node, false if it is due to the name
- match: Regular expression result from the match
- Parameters:
- {boolean} revert
- true to search backward, false to search forward
- {boolean} caseSensitive
- true to match exact case, false to ignore case
- Returns:
- Match object if found
reset()
Resets the search to the beginning of the document.