Class PTDOMUtil

Object
   |
   +--PTDOMUtil

class PTDOMUtil

Static class containing DOM utility methods.

Usage:	
 	PTDOMUtil.getElementLeft(elem);
 

Field Detail

VERSION

<static> <final> Object VERSION

See Also:

Constant Field Values

PTDOMUtil

PTDOMUtil()

PTDOMUtil static object constructor

Returns:
New PTDOMUtil object. Author Stephan Morais

elementContains

<static> Boolean elementContains(containerElement, containedElement)

Checks if an element is contained within another element in the DOM hierarchy

Parameters:
containerElement -
containedElement -

Returns:
true if the first element is contained in the second

getElementById

<static> Element getElementById(id)

Wrapper for document.getElementById with performance improvements.

Parameters:
id - id of element to retrieve (string)

Returns:
an Element with the given id

getElementHeight

<static> Number getElementHeight(elm)

Gets the height of the specified element

Parameters:
elm - the element tag to be checked.

Returns:
the element's height in pixels

getElementLeft

<static> Number getElementLeft(elm)

Gets the page left position of the specified element

Parameters:
elm - the element tag to be checked.

Returns:
the element's position in pixels from the left of the page

getElementTop

<static> Number getElementTop(elm)

Gets the page left position of the specified element

Parameters:
elm - the element tag to be checked.

Returns:
the element's position in pixels from the left of the page

getElementWidth

<static> Number getElementWidth(elm)

Gets the width of the specified element

Parameters:
elm - the element tag to be checked.

Returns:
the element's width in pixels

getInnerHTML

<static> String getInnerHTML(node, formatHTML, replacementTagIdMap)

Retrieves the HTML code contained by the given node. Can format the HTML of all subnodes.

Parameters:
node - the DOM node whose contents are to be printed as HTML
formatHTML - formats the HTML in a visually appealing manner
replacementTagIdMap - an associative array of ids to HTML that is used to replace DOM elements with matching ids.

Returns:
formatted or unformatted HTML, excluding the HTML for the node argument.

getOuterHTML

<static> String getOuterHTML(node, formatHTML, replacementTagIdMap)

Retrieves the HTML code from the given node. Can format the HTML of the node and all subnodes.

Parameters:
node - the DOM node that is to be printed as HTML
formatHTML - formats the HTML in a visually appealing manner

Returns:
formatted or unformatted HTML, including the HTML for the node argument.

getWindowHeight

<static> Number getWindowHeight()

Gets the height of the window

Returns:
the window's height in pixels

getWindowWidth

<static> Number getWindowWidth()

Gets the width of the window

Returns:
the window's width in pixels

insertAdjacentElement

<static> void insertAdjacentElement(targetElement, insertWhere, elementToInsert)

Inserts an element into the DOM at a certain position relative to a specified element.

Parameters:
targetElement - element relative to which another element will be inserted into the DOM
insertWhere - 'beforeBegin' || 'afterBegin' || 'beforeEnd' || 'afterEnd': the relative position of the inserted element.
elementToInsert - the element to insert into the DOM

setElementOpacity

<static> Boolean setElementOpacity(element,value)

Sets the opacity value of an element, if functionality is available

Parameters:
element - the element whose opacity is to be set.
value - the precentage (0-100) of opacity

Returns:
true if the operation was successful

toggleVisibility

<static> void toggleVisibility(id)

This will toggle (set to none/block) display property for a div block.

Parameters:
id - the id if the element to toggle visibility for