dom.js
Utilities for manipulating the browser's Document Object Model Inspiration taken *heavily* from mochikit (http://mochikit.com/). You can use goog.dom.DomHelper to create new dom helpers that refer to a different document object. This is useful if you are working with frames or multiple windows.

File Location

dom/dom.js

Classes

goog.dom.DomHelper
Create an instance of a DOM helper with a new document object.

Public Protected Private

Enumerations

Global Functions

goog.dom.$(element) ⇒
(Element | null)
Use goog.dom.getElement instead. Alias for getElement.
Arguments:
element :
(Element | null | string)
Element ID or a DOM node.
Returns: 
(Element | null)
  The element with the given ID, or the node passed in.
code »
goog.dom.$$(opt_tag, opt_class, opt_el) ⇒
{length: number}
Use goog.dom.getElementsByTagNameAndClass instead. Alias for getElementsByTagNameAndClass.
Arguments:
opt_tag :
(null | string | undefined)
Element tag name.
opt_class :
(null | string | undefined)
Optional class name.
opt_el :
(Element | null | undefined)
Optional element to look in.
Returns: 
{length: number}
  Array-like list of elements (only a length property and numerical indices are guaranteed to exist).
code »
goog.dom.$dom(tagName, opt_attributes, var_args) ⇒
Element
Use goog.dom.createDom instead. Alias for createDom.
Arguments:
tagName :
string
Tag to create.
opt_attributes :
(Object | null | string | undefined)
If object, then a map of name-value pairs for attributes. If a string, then this is the className of the new element.
var_args :
(Object | null | string | undefined)
Further DOM nodes or strings for text nodes. If one of the var_args is an array, its children will be added as childNodes instead.
Returns: 
Element
  Reference to a DOM node.
code »
goog.dom.append(parent, var_args)
Appends a node with text or other nodes.
Arguments:
parent :
Node
The node to append nodes to.
var_args :
(goog.dom.Appendable | undefined)
The things to append to the node. If this is a Node it is appended as is. If this is a string then a text node is appended. If this is an array like object then fields 0 to length - 1 are appended.
code »
goog.dom.appendChild(parent, child)
Appends a child to a node.
Arguments:
parent :
(Node | null)
Parent.
child :
(Node | null)
Child.
code »
goog.dom.append_(doc, parent, args, startIndex)
Appends a node with text or other nodes.
Arguments:
doc :
Document
The document to create new nodes in.
parent :
Node
The node to append nodes to.
args :
Arguments
The values to add. See goog.dom.append.
startIndex :
number
The index of the array to start from.
code »
goog.dom.findCommonAncestor.apply()
No description.
code »
goog.dom.canHaveChildren(node) ⇒
boolean
Determines if the given node can contain children, intended to be used for HTML generation. IE natively supports node.canHaveChildren but has inconsistent behavior. Prior to IE8 the base tag allows children and in IE9 all nodes return true for canHaveChildren. In practice all non-IE browsers allow you to add children to any node, but the behavior is inconsistent: 
var a = document.createElement('br');
a.appendChild(document.createTextNode('foo'));
a.appendChild(document.createTextNode('bar'));
console.log(a.childNodes.length);  // 2
console.log(a.innerHTML);  // Chrome: "", IE9: "foobar", FF3.5: "foobar"
TODO(user): Rename shouldAllowChildren() ?
Arguments:
node :
(Node | null)
The node to check.
Returns: 
boolean
  Whether the node can contain children.
code »
goog.dom.canUseQuerySelector_(parent) ⇒
boolean
Prefer the standardized (http://www.w3.org/TR/selectors-api/), native and fast W3C Selectors API. However, the version of WebKit that shipped with Safari 3.1 and Chrome has a bug where it will not correctly match mixed- case class name selectors in quirks mode.
Arguments:
parent :
(Document | Element | null)
The parent document object.
Returns: 
boolean
  whether or not we can use parent.querySelector* APIs.
code »
goog.dom.compareNodeOrder(node1, node2) ⇒
number
Compares the document order of two nodes, returning 0 if they are the same node, a negative number if node1 is before node2, and a positive number if node2 is before node1. Note that we compare the order the tags appear in the document so in the tree text the B node is considered to be before the I node.
Arguments:
node1 :
(Node | null)
The first node to compare.
node2 :
(Node | null)
The second node to compare.
Returns: 
number
  0 if the nodes are the same node, a negative number if node1 is before node2, and a positive number if node2 is before node1.
code »
goog.dom.compareParentsDescendantNodeIe_(textNode, node) ⇒
number
Utility function to compare the position of two nodes, when textNode's parent is an ancestor of node. If this entry condition is not met, this function will attempt to reference a null object.
Arguments:
textNode :
(Node | null)
The textNode to compare.
node :
(Node | null)
The node to compare.
Returns: 
number
  -1 if node is before textNode, +1 otherwise.
code »
goog.dom.compareSiblingOrder_(node1, node2) ⇒
number
Utility function to compare the position of two nodes known to be non-equal siblings.
Arguments:
node1 :
(Node | null)
The first node to compare.
node2 :
(Node | null)
The second node to compare.
Returns: 
number
  -1 if node1 is before node2, +1 otherwise.
code »
goog.dom.contains(parent, descendant) ⇒
boolean
Whether a node contains another node.
Arguments:
parent :
(Node | null)
The node that should contain the other node.
descendant :
(Node | null)
The node to test presence of.
Returns: 
boolean
  Whether the parent node contains the descendent node.
code »
goog.dom.createDom(tagName, opt_attributes, var_args) ⇒
Element
Returns a dom node with a set of attributes. This function accepts varargs for subsequent nodes to be added. Subsequent nodes will be added to the first node as childNodes. So: createDom('div', null, createDom('p'), createDom('p')); would return a div with two child paragraphs
Arguments:
tagName :
string
Tag to create.
opt_attributes :
(Object | null | string | undefined)
If object, then a map of name-value pairs for attributes. If a string, then this is the className of the new element. If an array, the elements will be joined together as the className of the new element.
var_args :
(Object | null | string | undefined)
Further DOM nodes or strings for text nodes. If one of the var_args is an array or NodeList,i its elements will be added as childNodes instead.
Returns: 
Element
  Reference to a DOM node.
code »
goog.dom.createDom_(doc, args) ⇒
Element
Helper for createDom.
Arguments:
doc :
Document
The document to create the DOM in.
args :
Arguments
Argument object passed from the callers. See goog.dom.createDom for details.
Returns: 
Element
  Reference to a DOM node.
code »
goog.dom.createElement(name) ⇒
Element
Creates a new element.
Arguments:
name :
string
Tag name.
Returns: 
Element
  The new element.
code »
goog.dom.createTable(rows, columns, opt_fillWithNbsp) ⇒
Element
Create a table.
Arguments:
rows :
number
The number of rows in the table. Must be >= 1.
columns :
number
The number of columns in the table. Must be >= 1.
opt_fillWithNbsp :
(boolean | undefined)
If true, fills table entries with nsbps.
Returns: 
Element
  The created table.
code »
goog.dom.createTable_(doc, rows, columns, fillWithNbsp) ⇒
Element
Create a table.
Arguments:
doc :
Document
Document object to use to create the table.
rows :
number
The number of rows in the table. Must be >= 1.
columns :
number
The number of columns in the table. Must be >= 1.
fillWithNbsp :
boolean
If true, fills table entries with nsbps.
Returns: 
Element
  The created table.
code »
goog.dom.createTextNode(content) ⇒
Text
Creates a new text node.
Arguments:
content :
string
Content.
Returns: 
Text
  The new text node.
code »
goog.dom.findCommonAncestor(var_args) ⇒
(Node | null)
Find the deepest common ancestor of the given nodes.
Arguments:
var_args :
(Node | null | undefined)
The nodes to find a common ancestor of.
Returns: 
(Node | null)
  The common ancestor of the nodes, or null if there is none. null will only be returned if two or more of the nodes are from different documents.
code »
goog.dom.findNode(root, p) ⇒
(Node | null | undefined)
Finds the first descendant node that matches the filter function, using a depth first search. This function offers the most general purpose way of finding a matching element. You may also wish to consider goog.dom.query which can express many matching criteria using CSS selector expressions. These expressions often result in a more compact representation of the desired result.
Arguments:
root :
(Node | null)
The root of the tree to search.
p :
function ((Node | null)): boolean
The filter function.
Returns: 
(Node | null | undefined)
  The found node or undefined if none is found.
code »
goog.dom.findNodes(root, p) ⇒
(Array | null)
Finds all the descendant nodes that match the filter function, using a a depth first search. This function offers the most general-purpose way of finding a set of matching elements. You may also wish to consider goog.dom.query which can express many matching criteria using CSS selector expressions. These expressions often result in a more compact representation of the desired result.
Arguments:
root :
(Node | null)
The root of the tree to search.
p :
function ((Node | null)): boolean
The filter function.
Returns: 
(Array | null)
  The found nodes or an empty array if none are found.
code »
goog.dom.findNodes_(root, p, rv, findOne) ⇒
boolean
Finds the first or all the descendant nodes that match the filter function, using a depth first search.
Arguments:
root :
(Node | null)
The root of the tree to search.
p :
function ((Node | null)): boolean
The filter function.
rv :
(Array | null)
The found nodes are added to this array.
findOne :
boolean
If true we exit after the first found node.
Returns: 
boolean
  Whether the search is complete or not. True in case findOne is true and the node is found. False otherwise.
code »
goog.dom.flattenElement(element) ⇒
(Element | null | undefined)
Flattens an element. That is, removes it and replace it with its children. Does nothing if the element is not in the document.
Arguments:
element :
(Element | null)
The element to flatten.
Returns: 
(Element | null | undefined)
  The original element, detached from the document tree, sans children; or undefined, if the element was not in the document to begin with.
code »
goog.dom.getActiveElement(doc) ⇒
(Element | null)
Determines the active element in the given document.
Arguments:
doc :
(Document | null)
The document to look in.
Returns: 
(Element | null)
  The active element.
code »
goog.dom.getAncestor(element, matcher, opt_includeNode, opt_maxSearchSteps) ⇒
(Node | null)
Walks up the DOM hierarchy returning the first ancestor that passes the matcher function.
Arguments:
element :
(Node | null)
The DOM node to start with.
matcher :
function ((Node | null)): boolean
A function that returns true if the passed node matches the desired criteria.
opt_includeNode :
(boolean | undefined)
If true, the node itself is included in the search (the first call to the matcher will pass startElement as the node to test).
opt_maxSearchSteps :
(number | undefined)
Maximum number of levels to search up the dom.
Returns: 
(Node | null)
  DOM node that matched the matcher, or null if there was no match.
code »
goog.dom.getAncestorByClass(element, opt_class) ⇒
(Node | null)
Walks up the DOM hierarchy returning the first ancestor that has the passed class name. If the passed element matches the specified criteria, the element itself is returned.
Arguments:
element :
(Node | null)
The DOM node to start with.
opt_class :
(null | string | undefined)
The class name to match (or null/undefined to match any node regardless of class name).
Returns: 
(Node | null)
  The first ancestor that matches the passed criteria, or null if none match.
code »
goog.dom.getAncestorByTagNameAndClass(element, opt_tag, opt_class) ⇒
(Node | null)
Walks up the DOM hierarchy returning the first ancestor that has the passed tag name and/or class name. If the passed element matches the specified criteria, the element itself is returned.
Arguments:
element :
(Node | null)
The DOM node to start with.
opt_tag :
(null | string | undefined)
The tag name to match (or null/undefined to match any node regardless of tag name). Must be uppercase (goog.dom.TagName).
opt_class :
(null | string | undefined)
The class name to match (or null/undefined to match any node regardless of class name).
Returns: 
(Node | null)
  The first ancestor that matches the passed criteria, or null if none match.
code »
goog.dom.getChildren(element) ⇒
(Array | NodeList | null)
Returns an array containing just the element children of the given element.
Arguments:
element :
(Element | null)
The element whose element children we want.
Returns: 
(Array | NodeList | null)
  An array or array-like list of just the element children of the given element.
code »
goog.dom.getCompatMode() ⇒
string
use goog.dom.isCss1CompatMode instead. Returns the compatMode of the document.
Returns: 
string
  The result is either CSS1Compat or BackCompat.
code »
goog.dom.getDocument() ⇒
Document
Gets the document object being used by the dom library.
Returns: 
Document
  Document object.
code »
goog.dom.getDocumentHeight() ⇒
number
Calculates the height of the document.
Returns: 
number
  The height of the current document.
code »
goog.dom.getDocumentHeight_(win) ⇒
number
Calculates the height of the document of the given window. Function code copied from the opensocial gadget api: gadgets.window.adjustHeight(opt_height)
Arguments:
win :
(Window | null)
The window whose document height to retrieve.
Returns: 
number
  The height of the document of the given window.
code »
goog.dom.getDocumentScroll() ⇒
goog.math.Coordinate
Gets the document scroll distance as a coordinate object.
Returns: 
goog.math.Coordinate
  Object with values 'x' and 'y'.
code »
goog.dom.getDocumentScrollElement() ⇒
(Element | null)
Gets the document scroll element.
Returns: 
(Element | null)
  Scrolling element.
code »
goog.dom.getDocumentScrollElement_(doc) ⇒
(Element | null)
Helper for getDocumentScrollElement.
Arguments:
doc :
Document
The document to get the scroll element for.
Returns: 
(Element | null)
  Scrolling element.
code »
goog.dom.getDocumentScroll_(doc) ⇒
goog.math.Coordinate
Helper for getDocumentScroll.
Arguments:
doc :
Document
The document to get the scroll for.
Returns: 
goog.math.Coordinate
  Object with values 'x' and 'y'.
code »
goog.dom.getDomHelper(opt_element) ⇒
goog.dom.DomHelper
Gets the DomHelper object for the document where the element resides.
Arguments:
opt_element :
(Node | Window | null | undefined)
If present, gets the DomHelper for this element.
Returns: 
goog.dom.DomHelper
  The DomHelper.
code »
goog.dom.getElement(element) ⇒
(Element | null)
Alias for getElementById. If a DOM node is passed in then we just return that.
Arguments:
element :
(Element | null | string)
Element ID or a DOM node.
Returns: 
(Element | null)
  The element with the given ID, or the node passed in.
code »
goog.dom.getElementByClass(className, opt_el) ⇒
(Element | null)
Returns the first element with the provided className.
Arguments:
className :
string
the name of the class to look for.
opt_el :
(Document | Element | null | undefined)
Optional element to look in.
Returns: 
(Element | null)
  The first item with the class name provided.
code »
goog.dom.getElementsByClass(className, opt_el) ⇒
{length: number}
Returns an array of all the elements with the provided className.
Arguments:
className :
string
the name of the class to look for.
opt_el :
(Document | Element | null | undefined)
Optional element to look in.
Returns: 
{length: number}
  The items found with the class name provided.
code »
goog.dom.getElementsByTagNameAndClass(opt_tag, opt_class, opt_el) ⇒
{length: number}
Looks up elements by both tag and class name, using browser native functions (querySelectorAll, getElementsByTagName or getElementsByClassName) where possible. This function is a useful, if limited, way of collecting a list of DOM elements with certain characteristics. goog.dom.query offers a more powerful and general solution which allows matching on CSS3 selector expressions, but at increased cost in code size. If all you need is particular tags belonging to a single class, this function is fast and sleek.
Arguments:
opt_tag :
(null | string | undefined)
Element tag name.
opt_class :
(null | string | undefined)
Optional class name.
opt_el :
(Document | Element | null | undefined)
Optional element to look in.
Returns: 
{length: number}
  Array-like list of elements (only a length property and numerical indices are guaranteed to exist).
code »
goog.dom.getElementsByTagNameAndClass_(doc, opt_tag, opt_class, opt_el) ⇒
{length: number}
Helper for getElementsByTagNameAndClass.
Arguments:
doc :
Document
The document to get the elements in.
opt_tag :
(null | string | undefined)
Element tag name.
opt_class :
(null | string | undefined)
Optional class name.
opt_el :
(Document | Element | null | undefined)
Optional element to look in.
Returns: 
{length: number}
  Array-like list of elements (only a length property and numerical indices are guaranteed to exist).
code »
goog.dom.getFirstElementChild(node) ⇒
(Element | null)
Returns the first child node that is an element.
Arguments:
node :
(Node | null)
The node to get the first child element of.
Returns: 
(Element | null)
  The first child node of node that is an element.
code »
goog.dom.getFrameContentDocument(frame) ⇒
Document
Cross-browser function for getting the document element of a frame or iframe.
Arguments:
frame :
(Element | null)
Frame element.
Returns: 
Document
  The frame content document.
code »
goog.dom.getFrameContentWindow(frame) ⇒
(Window | null)
Cross-browser function for getting the window of a frame or iframe.
Arguments:
frame :
(HTMLFrameElement | HTMLIFrameElement | null)
Frame element.
Returns: 
(Window | null)
  The window associated with the given frame.
code »
goog.dom.getLastElementChild(node) ⇒
(Element | null)
Returns the last child node that is an element.
Arguments:
node :
(Node | null)
The node to get the last child element of.
Returns: 
(Element | null)
  The last child node of node that is an element.
code »
goog.dom.getNextElementNode_(node, forward) ⇒
(Element | null)
Returns the first node that is an element in the specified direction, starting with node.
Arguments:
node :
(Node | null)
The node to get the next element from.
forward :
boolean
Whether to look forwards or backwards.
Returns: 
(Element | null)
  The first element.
code »
goog.dom.getNextElementSibling(node) ⇒
(Element | null)
Returns the first next sibling that is an element.
Arguments:
node :
(Node | null)
The node to get the next sibling element of.
Returns: 
(Element | null)
  The next sibling of node that is an element.
code »
goog.dom.getNextNode(node) ⇒
(Node | null)
Returns the next node in source order from the given node.
Arguments:
node :
(Node | null)
The node.
Returns: 
(Node | null)
  The next node in the DOM tree, or null if this was the last node.
code »
goog.dom.getNodeAtOffset(parent, offset, opt_result) ⇒
(Node | null)
Returns the node at a given offset in a parent node. If an object is provided for the optional third parameter, the node and the remainder of the offset will stored as properties of this object.
Arguments:
parent :
(Node | null)
The parent node.
offset :
number
The offset into the parent node.
opt_result :
(Object | null | undefined)
Object to be used to store the return value. The return value will be stored in the form {node: Node, remainder: number} if this object is provided.
Returns: 
(Node | null)
  The node at the given offset.
code »
goog.dom.getNodeTextLength(node) ⇒
number
Returns the text length of the text contained in a node, without markup. This is equivalent to the selection length if the node was selected, or the number of cursor movements to traverse the node. Images & BRs take one space. New lines are ignored.
Arguments:
node :
(Node | null)
The node whose text content length is being calculated.
Returns: 
number
  The length of node's text content.
code »
goog.dom.getNodeTextOffset(node, opt_offsetParent) ⇒
number
Returns the text offset of a node relative to one of its ancestors. The text length is the same as the length calculated by goog.dom.getNodeTextLength.
Arguments:
node :
(Node | null)
The node whose offset is being calculated.
opt_offsetParent :
(Node | null | undefined)
The node relative to which the offset will be calculated. Defaults to the node's owner document's body.
Returns: 
number
  The text offset.
code »
goog.dom.getOuterHtml(element) ⇒
string
Gets the outerHTML of a node, which islike innerHTML, except that it actually contains the HTML of the node itself.
Arguments:
element :
(Element | null)
The element to get the HTML of.
Returns: 
string
  The outerHTML of the given element.
code »
goog.dom.getOwnerDocument(node) ⇒
Document
Returns the owner document for a node.
Arguments:
node :
(Node | Window | null)
The node to get the document for.
Returns: 
Document
  The document owning the node.
code »
goog.dom.getPageScroll(opt_window) ⇒
goog.math.Coordinate
Use goog.dom.getDocumentScroll instead. Gets the page scroll distance as a coordinate object.
Arguments:
opt_window :
(Window | null | undefined)
Optional window element to test.
Returns: 
goog.math.Coordinate
  Object with values 'x' and 'y'.
code »
goog.dom.getPreviousElementSibling(node) ⇒
(Element | null)
Returns the first previous sibling that is an element.
Arguments:
node :
(Node | null)
The node to get the previous sibling element of.
Returns: 
(Element | null)
  The first previous sibling of node that is an element.
code »
goog.dom.getPreviousNode(node) ⇒
(Node | null)
Returns the previous node in source order from the given node.
Arguments:
node :
(Node | null)
The node.
Returns: 
(Node | null)
  The previous node in the DOM tree, or null if this was the first node.
code »
goog.dom.getRawTextContent(node) ⇒
string
Returns the text content of the current node, without markup. Unlike getTextContent this method does not collapse whitespaces or normalize lines breaks.
Arguments:
node :
(Node | null)
The node from which we are getting content.
Returns: 
string
  The raw text content.
code »
goog.dom.getTextContent(node) ⇒
string
Returns the text content of the current node, without markup and invisible symbols. New lines are stripped and whitespace is collapsed, such that each character would be visible. In browsers that support it, innerText is used. Other browsers attempt to simulate it via node traversal. Line breaks are canonicalized in IE.
Arguments:
node :
(Node | null)
The node from which we are getting content.
Returns: 
string
  The text content.
code »
goog.dom.getTextContent_(node, buf, normalizeWhitespace)
Recursive support function for text content retrieval.
Arguments:
node :
(Node | null)
The node from which we are getting content.
buf :
(Array | null)
string buffer.
normalizeWhitespace :
boolean
Whether to normalize whitespace.
code »
goog.dom.getViewportSize(opt_window) ⇒
goog.math.Size
Gets the dimensions of the viewport. Gecko Standards mode: docEl.clientWidth Width of viewport excluding scrollbar. win.innerWidth Width of viewport including scrollbar. body.clientWidth Width of body element. docEl.clientHeight Height of viewport excluding scrollbar. win.innerHeight Height of viewport including scrollbar. body.clientHeight Height of document. Gecko Backwards compatible mode: docEl.clientWidth Width of viewport excluding scrollbar. win.innerWidth Width of viewport including scrollbar. body.clientWidth Width of viewport excluding scrollbar. docEl.clientHeight Height of document. win.innerHeight Height of viewport including scrollbar. body.clientHeight Height of viewport excluding scrollbar. IE6/7 Standards mode: docEl.clientWidth Width of viewport excluding scrollbar. win.innerWidth Undefined. body.clientWidth Width of body element. docEl.clientHeight Height of viewport excluding scrollbar. win.innerHeight Undefined. body.clientHeight Height of document element. IE5 + IE6/7 Backwards compatible mode: docEl.clientWidth 0. win.innerWidth Undefined. body.clientWidth Width of viewport excluding scrollbar. docEl.clientHeight 0. win.innerHeight Undefined. body.clientHeight Height of viewport excluding scrollbar. Opera 9 Standards and backwards compatible mode: docEl.clientWidth Width of viewport excluding scrollbar. win.innerWidth Width of viewport including scrollbar. body.clientWidth Width of viewport excluding scrollbar. docEl.clientHeight Height of document. win.innerHeight Height of viewport including scrollbar. body.clientHeight Height of viewport excluding scrollbar. WebKit: Safari 2 docEl.clientHeight Same as scrollHeight. docEl.clientWidth Same as innerWidth. win.innerWidth Width of viewport excluding scrollbar. win.innerHeight Height of the viewport including scrollbar. frame.innerHeight Height of the viewport exluding scrollbar. Safari 3 (tested in 522) docEl.clientWidth Width of viewport excluding scrollbar. docEl.clientHeight Height of viewport excluding scrollbar in strict mode. body.clientHeight Height of viewport excluding scrollbar in quirks mode.
Arguments:
opt_window :
(Window | null | undefined)
Optional window element to test.
Returns: 
goog.math.Size
  Object with values 'width' and 'height'.
code »
goog.dom.getViewportSize_(win) ⇒
goog.math.Size
Helper for getViewportSize.
Arguments:
win :
(Window | null)
The window to get the view port size for.
Returns: 
goog.math.Size
  Object with values 'width' and 'height'.
code »
goog.dom.getWindow(opt_doc) ⇒
(Window | null)
Gets the window object associated with the given document.
Arguments:
opt_doc :
(Document | null | undefined)
Document object to get window for.
Returns: 
(Window | null)
  The window associated with the given document.
code »
goog.dom.getWindow_(doc) ⇒
Window
Helper for getWindow.
Arguments:
doc :
Document
Document object to get window for.
Returns: 
Window
  The window associated with the given document.
code »
goog.dom.htmlToDocumentFragment(htmlString) ⇒
Node
Converts an HTML string into a document fragment.
Arguments:
htmlString :
string
The HTML string to convert.
Returns: 
Node
  The resulting document fragment.
code »
goog.dom.htmlToDocumentFragment_(doc, htmlString) ⇒
Node
Helper for htmlToDocumentFragment.
Arguments:
doc :
Document
The document.
htmlString :
string
The HTML string to convert.
Returns: 
Node
  The resulting document fragment.
code »
goog.dom.insertChildAt(parent, child, index)
Insert a child at a given index. If index is larger than the number of child nodes that the parent currently has, the node is inserted as the last child node.
Arguments:
parent :
(Element | null)
The element into which to insert the child.
child :
(Node | null)
The element to insert.
index :
number
The index at which to insert the new child node. Must not be negative.
code »
goog.dom.insertSiblingAfter(newNode, refNode)
Inserts a new node after an existing reference node (i.e. as the next sibling). If the reference node has no parent, then does nothing.
Arguments:
newNode :
(Node | null)
Node to insert.
refNode :
(Node | null)
Reference node to insert after.
code »
goog.dom.insertSiblingBefore(newNode, refNode)
Inserts a new node before an existing reference node (i.e. as the previous sibling). If the reference node has no parent, then does nothing.
Arguments:
newNode :
(Node | null)
Node to insert.
refNode :
(Node | null)
Reference node to insert before.
code »
goog.dom.isCss1CompatMode() ⇒
boolean
Returns true if the browser is in "CSS1-compatible" (standards-compliant) mode, false otherwise.
Returns: 
boolean
  True if in CSS1-compatible mode.
code »
goog.dom.isCss1CompatMode_(doc) ⇒
boolean
Returns true if the browser is in "CSS1-compatible" (standards-compliant) mode, false otherwise.
Arguments:
doc :
(Document | null)
The document to check.
Returns: 
boolean
  True if in CSS1-compatible mode.
code »
goog.dom.isElement(obj) ⇒
boolean
Whether the object looks like an Element.
Arguments:
obj :
*
The object being tested for Element likeness.
Returns: 
boolean
  Whether the object looks like an Element.
code »
goog.dom.isFocusableTabIndex(element) ⇒
boolean
Returns true if the element has a tab index that allows it to receive keyboard focus (tabIndex >= 0), false otherwise. Note that form elements natively support keyboard focus, even if they have no tab index.
Arguments:
element :
(Element | null)
Element to check.
Returns: 
boolean
  Whether the element has a tab index that allows keyboard focus.
code »
goog.dom.isNodeLike(obj) ⇒
boolean
Whether the object looks like a DOM node.
Arguments:
obj :
*
The object being tested for node likeness.
Returns: 
boolean
  Whether the object looks like a DOM node.
code »
goog.dom.isNodeList(val) ⇒
boolean
Returns true if the object is a NodeList. To qualify as a NodeList, the object must have a numeric length property and an item function (which has type 'string' on IE for some reason).
Arguments:
val :
(Object | null)
Object to test.
Returns: 
boolean
  Whether the object is a NodeList.
code »
goog.dom.isWindow(obj) ⇒
boolean
Returns true if the specified value is a Window object. This includes the global window for HTML pages, and iframe windows.
Arguments:
obj :
*
Variable to test.
Returns: 
boolean
  Whether the variable is a window.
code »
goog.dom.removeChildren(node)
Removes all the child nodes on a DOM node.
Arguments:
node :
(Node | null)
Node to remove children from.
code »
goog.dom.removeNode(node) ⇒
(Node | null)
Removes a node from its parent.
Arguments:
node :
(Node | null)
The node to remove.
Returns: 
(Node | null)
  The node removed if removed; else, null.
code »
goog.dom.replaceNode(newNode, oldNode)
Replaces a node in the DOM tree. Will do nothing if oldNode has no parent.
Arguments:
newNode :
(Node | null)
Node to insert.
oldNode :
(Node | null)
Node to replace.
code »
goog.dom.setFocusableTabIndex(element, enable)
Enables or disables keyboard focus support on the element via its tab index. Only elements for which goog.dom.isFocusableTabIndex returns true (or elements that natively support keyboard focus, like form elements) can receive keyboard focus. See http://go/tabindex for more info.
Arguments:
element :
(Element | null)
Element whose tab index is to be changed.
enable :
boolean
Whether to set or remove a tab index on the element that supports keyboard focus.
code »
goog.dom.setProperties(element, properties)
Sets multiple properties on a node.
Arguments:
element :
(Element | null)
DOM node to set properties on.
properties :
(Object | null)
Hash of property:value pairs.
code »
goog.dom.setTextContent(element, text)
Cross-browser function for setting the text content of an element.
Arguments:
element :
(Element | null)
The element to change the text content of.
text :
string
The string that should replace the current element content.
code »

Global Properties

goog.dom.COMPAT_MODE_KNOWN_ :
boolean
Whether we know the compatibility mode at compile time.
Code »
goog.dom.DIRECT_ATTRIBUTE_MAP_ :
(Object | null)
Map of attributes that should be set using element.setAttribute(key, val) instead of element[key] = val. Used by goog.dom.setProperties.
Code »
goog.dom.PREDEFINED_TAG_VALUES_ :
(Object | null)
Map of tags which have predefined values with regard to whitespace.
Code »
goog.dom.TAGS_TO_IGNORE_ :
(Object | null)
Map of tags whose content to ignore when calculating text length.
Code »
goog.dom.defaultDomHelper_ :
(goog.dom.DomHelper | null)
Cached default DOM helper.
Code »

Directory dom

File Reference