DomHelper (Closure Library API Documentation

Alias for {@code getElement}.

Returns:

The element with the given ID, or the node passed in.

code »

$$() ⇒

{length: number}

Alias for {@code getElementsByTagNameAndClass}.

Returns:

{length: number}

Array-like list of elements (only a length property and numerical indices are guaranteed to exist).

code »

$dom() ⇒

Alias for {@code createDom}.

Returns:

Reference to a DOM node.

code »

appendChild()

Appends a child to a node.

code »

contains() ⇒

Whether a node contains another node.

Returns:

Whether the parent node contains the descendent node.

code »

createDom(tagName, opt_attributes, var_args) ⇒

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 An easy way to move all child nodes of an existing element to a new parent element is: createDom('div', null, oldElement.childNodes); which will remove all child nodes from the old element and add them as child nodes of the new DIV.

Arguments:

tagName :

Tag to create.

opt_attributes :

Object | string

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 | string | Array | NodeList

Further DOM nodes or strings for text nodes. If one of the var_args is an array or NodeList, its elements will be added as childNodes instead.

Returns:

Reference to a DOM node.

code »

createElement(name) ⇒

Creates a new element.

Arguments:

name :

Tag name.

Returns:

The new element.

code »

createTextNode(content) ⇒

!Text

Creates a new text node.

Arguments:

content :

Content.

Returns:

!Text

The new text node.

code »

findNode() ⇒

(Node, undefined)

Finds the first descendant node that matches the filter function. This does a depth first search.

Returns:

(Node, undefined)

The found node or undefined if none is found.

code »

findNodes() ⇒

Array.<Node>

Finds all the descendant nodes that matches the filter function. This does a depth first search.

Returns:

Array.<Node>

The found nodes or an empty array if none are found.

code »

flattenElement() ⇒

Element | undefined

Flattens an element. That is, removes it and replace it with its children.

Returns:

Element | undefined

The original element, detached from the document tree, sans children, or undefined if the element was already not in the document.

code »

getAncestor() ⇒

Walks up the DOM hierarchy returning the first ancestor that passes the matcher function.

Returns:

DOM node that matched the matcher, or null if there was no match.

code »

getAncestorByTagNameAndClass() ⇒

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.

Returns:

The first ancestor that matches the passed criteria, or null if none match.

code »

getCompatMode() ⇒

Returns the compatMode of the document.

Returns:

The result is either CSS1Compat or BackCompat.

code »

getDocument() ⇒

Gets the document object being used by the dom library.

Returns:

Document object.

code »

getDocumentHeight() ⇒

Calculates the height of the document.

Returns:

The height of the document.

code »

getDocumentScroll() ⇒

!goog.math.Coordinate

Gets the document scroll distance as a coordinate object.

Returns:

!goog.math.Coordinate

Object with properties 'x' and 'y'.

code »

getDocumentScrollElement() ⇒

Gets the document scroll element.

Returns:

Scrolling element.

code »

getDomHelper() ⇒

!goog.dom.DomHelper

Gets the dom helper object for the document where the element resides.

Returns:

!goog.dom.DomHelper

The DomHelper.

code »

getElement(element) ⇒

Alias for {@code getElementById}. If a DOM node is passed in then we just return that.

Arguments:

element :

string | Element

Element ID or a DOM node.

Returns:

The element with the given ID, or the node passed in.

code »

getElementsByTagNameAndClass(opt_tag, opt_class, opt_el) ⇒

{length: number}

Looks up elements by both tag and class name, using browser native functions ({@code querySelectorAll}, {@code getElementsByTagName} or {@code getElementsByClassName}) where possible. The returned array is a live NodeList or a static list depending on the code path taken.

Arguments:

opt_tag :

?string

Element tag name or * for all tags.

opt_class :

?string

Optional class name.

opt_el :

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 »

getFirstElementChild() ⇒

Returns the first child node that is an element.

Returns:

The first child node of {@code node} that is an element.

code »

getFrameContentDocument() ⇒

!HTMLDocument

Cross browser function for getting the document element of an iframe.

Returns:

!HTMLDocument

The frame content document.

code »

getFrameContentWindow() ⇒

Window

Cross browser function for getting the window of a frame or iframe.

Returns:

Window

The window associated with the given frame.

code »

getLastElementChild() ⇒

Returns the last child node that is an element.

Returns:

The last child node of {@code node} that is an element.

code »

getNextElementSibling() ⇒

Returns the first next sibling that is an element.

Returns:

The next sibling of {@code node} that is an element.

code »

getNodeTextLength() ⇒

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.

Returns:

The length of {@code node}'s text content.

code »

getNodeTextOffset() ⇒

Returns the text offset of a node relative to one of its ancestors. The text length is the same as the length calculated by {@code goog.dom.getNodeTextLength}.

Returns:

The text offset.

code »

getOwnerDocument() ⇒

Returns the owner document for a node.

Returns:

The document owning the node.

code »

getPreviousElementSibling() ⇒

Returns the first previous sibling that is an element.

Returns:

The first previous sibling of {@code node} that is an element.

code »

getTextContent() ⇒

Returns the text contents of the current node, without markup. 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.

Returns:

The text content.

code »

getViewportSize(opt_window) ⇒

!goog.math.Size

Gets the dimensions of the viewport.

Arguments:

opt_window :

Window

Optional window element to test. Defaults to the window of the Dom Helper.

Returns:

!goog.math.Size

Object with values 'width' and 'height'.

code »

getWindow() ⇒

!Window

Gets the window object associated with the document.

Returns:

!Window

The window associated with the given document.

code »

htmlToDocumentFragment(htmlString) ⇒

!Node

Converts an HTML string into a node or a document fragment. A single Node is used if the {@code htmlString} only generates a single node. If the {@code htmlString} generates multiple nodes then these are put inside a {@code DocumentFragment}.

Arguments:

htmlString :

The HTML string to convert.

Returns:

!Node

The resulting node.

code »

insertSiblingAfter()

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.

code »

insertSiblingBefore()

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.

code »

isCss1CompatMode() ⇒

Returns true if the browser is in "CSS1-compatible" (standards-compliant) mode, false otherwise.

Returns:

True if in CSS1-compatible mode.

code »

isNodeLike() ⇒

Whether the object looks like a DOM node.

Returns:

Whether the object looks like a DOM node.

code »

removeChildren()

Removes all the child nodes on a DOM node.

code »

removeNode() ⇒

Removes a node from its parent.

Returns:

The node removed if removed; else, null.

code »

replaceNode()

Replaces a node in the DOM tree. Will do nothing if {@code oldNode} has no parent.

code »

setDocument(document)

Sets the document object.

Arguments:

document :