Search:

jgrouse.dom.Element

module jgrouse.dom.Element
Contains utilities for DOM manipulations
Defined in jgrouse/dom/Element.js

Function Summary
addClassName(DOMElement element, String className)
Add HTML class on DOM node.
addStyle(DOMElement element, String style, String value)
addStyle(DOMElement element, Object obj)
Adds CSS style to DOM node.
clearAttribute(DOMElement element, String attr)
Remove attribute from DOM node
clearAttributes(DOMElement element)
Removes all attributes from node
clearStyle(DOMElement element, String styleName)
Removes CSS style from DOM node
clearStyles(DOMElement element)
Remove all declared styles from DOM node
DOMNode[] collect(DOMNode element, traverseCallback testCallback)
Find all nodes matching certain criteria.
disposeDom(DOMElement element)
Dispose DOM node.
forEach(DOMElement element, jgrouse.arrayIteratorCallback callback, Boolean backwards)
Invoke given callback for each child of the node
String getAttribute(DOMElement element, String attrName)
Get attribute of DOM node
DOMAttribute[] getAttributes(DOMElement domNode)
Get all specified attributes pf DOM node.
getComputedStyle(DOMElement element, String style)
Retrieves computed CSS style (i.e.
Object getStyles(DOMElement element)
Retrieve CSS styles from DOM node
boolean hasClass(DOMElement element, String className)
Check if DOM node has given HTML class
boolean isShowing(DOMElement element)
Checks if given DOM node is reacheable from document root and has style.display != 'none'.
moveChildrenToNewParent(DOMElement dstParent, DOMElement srcParent)
Move all children from one DOM node to another DOM node
removeClassName(DOMElement element, String className)
Remove HTML class from DOM node
scrollToView(DOMElement domElement, String align)
DOMElement search(DOMElement element, traverseCallback testCallback)
Find DOM node matching certain criteria
setAttribute(DOMElement element, String attrName, String value)
Add or update node's attribute
setAttributes(DOMElement element, Object attributes)
Set several attributes on node.
setClass(DOMElement className, String className)
Set HTML class on DOM node.
setStyles(DOMElement element, String style, String value)
setStyles(DOMElement element, Object obj)
setStyles(DOMElement element, String style)
Set CSS style(s) on DOM node.
walkTree(DOMElement element, traverseCallback testCallback)
Travese the DOM tree for given element, calling callback function for each node.

Function Interface Summary
boolean traverseCallback(DOMElement element)

Function Details

function addClassName

addClassName(DOMElement element, String className)
Add HTML class on DOM node.
Parameters:
element - target node
className - name of class to add
Defined in jgrouse.dom.Element

function addStyle

addStyle(DOMElement element, String style, String value)
addStyle(DOMElement element, Object obj)
Adds CSS style to DOM node.
Parameters:
Add one style
element - target node
style - name of CSS style
value - value of style
Add several styles
element - target node
obj - object containing name/value pairs of CSS styles and values
Defined in jgrouse.dom.Element

function clearAttribute

clearAttribute(DOMElement element, String attr)
Remove attribute from DOM node
Parameters:
element - target node
attr - name of attribute to remove.
Defined in jgrouse.dom.Element

function clearAttributes

clearAttributes(DOMElement element)
Removes all attributes from node
Parameters:
element - node to be cleared from attributes
Defined in jgrouse.dom.Element

function clearStyle

clearStyle(DOMElement element, String styleName)
Removes CSS style from DOM node
Parameters:
element - target node
styleName - name of CSS style to be removed.
Defined in jgrouse.dom.Element

function clearStyles

clearStyles(DOMElement element)
Remove all declared styles from DOM node
Parameters:
element - target node
Defined in jgrouse.dom.Element

function collect

DOMNode[] collect(DOMNode element, traverseCallback testCallback)
Find all nodes matching certain criteria.
Parameters:
element - starting point
testCallback - function that should be called for each node. Should return true if the element should be added to result set
Returns:
array with matching elements
Defined in jgrouse.dom.Element

function disposeDom

disposeDom(DOMElement element)
Dispose DOM node.
Parameters:
element - element to be disposed
Defined in jgrouse.dom.Element

function forEach

forEach(DOMElement element, jgrouse.arrayIteratorCallback callback, Boolean backwards)
Invoke given callback for each child of the node
Parameters:
element - target node
callback - function to be called for each child node.
backwards - indicator if iteration should start from last child to first child. Optional, defautl value is false
Defined in jgrouse.dom.Element

function getAttribute

String getAttribute(DOMElement element, String attrName)
Get attribute of DOM node
Parameters:
element - source element
attrName - name of attribute to read
Returns:
value of read attribute
Defined in jgrouse.dom.Element

function getAttributes

DOMAttribute[] getAttributes(DOMElement domNode)
Get all specified attributes pf DOM node.
Parameters:
domNode
Returns:
array of DOMAttribute[] objects
Defined in jgrouse.dom.Element

function getComputedStyle

getComputedStyle(DOMElement element, String style)
Retrieves computed CSS style (i.e. inherited from parent nodes, classes, etc) for DOM node.
Parameters:
element - target element
style - name of CSS style
Defined in jgrouse.dom.Element

function getStyles

Object getStyles(DOMElement element)
Retrieve CSS styles from DOM node
Parameters:
element - target node
Returns:
object containing name/value pairs for CSS styles. Names are camelized and could be browser-specific.
Defined in jgrouse.dom.Element

function hasClass

boolean hasClass(DOMElement element, String className)
Check if DOM node has given HTML class
Parameters:
element - target node
className - class name to check
Returns:
true if the element has given HTML class
Defined in jgrouse.dom.Element

function isShowing

boolean isShowing(DOMElement element)
Checks if given DOM node is reacheable from document root and has style.display != 'none'.
Parameters:
element - target node
Returns:
true if the node is reacheable from document root
Defined in jgrouse.dom.Element

function moveChildrenToNewParent

moveChildrenToNewParent(DOMElement dstParent, DOMElement srcParent)
Move all children from one DOM node to another DOM node
Parameters:
dstParent - destination node
srcParent - source node
Defined in jgrouse.dom.Element

function removeClassName

removeClassName(DOMElement element, String className)
Remove HTML class from DOM node
Parameters:
element - target node
className - name of class to remove
Defined in jgrouse.dom.Element

function scrollToView

scrollToView(DOMElement domElement, String align)
Parameters:
domElement
align - 'left', 'top' or null
Defined in jgrouse.dom.Element

function search

DOMElement search(DOMElement element, traverseCallback testCallback)
Find DOM node matching certain criteria
Parameters:
element - starting point
testCallback - callback function to be called for each node.
Returns:
found node or null if no nodes were found
Defined in jgrouse.dom.Element

function setAttribute

setAttribute(DOMElement element, String attrName, String value)
Add or update node's attribute
Parameters:
element - target node
attrName - name of attribute to set/update
value - data to be set
Defined in jgrouse.dom.Element

function setAttributes

setAttributes(DOMElement element, Object attributes)
Set several attributes on node. Old attributes are being removed first.
Parameters:
element - target node
attributes - object containing names/values of attributes to set
Defined in jgrouse.dom.Element

function setClass

setClass(DOMElement className, String className)
Set HTML class on DOM node. Replaces any existing classes
Parameters:
className
className - name of class to set
Defined in jgrouse.dom.Element

function setStyles

setStyles(DOMElement element, String style, String value)
setStyles(DOMElement element, Object obj)
setStyles(DOMElement element, String style)
Set CSS style(s) on DOM node. Existing styles are removed.
Parameters:
Set one style
element - target node
style - name of CSS style
value - value of style
Set several styles
element - target node
obj - object containing name/value pairs of CSS styles and values
Set several styles from string
element - target node
style - textual representation of styles
Defined in jgrouse.dom.Element

function walkTree

walkTree(DOMElement element, traverseCallback testCallback)
Travese the DOM tree for given element, calling callback function for each node. If the callback function returns true, then traversing is interrupted
Parameters:
element - starting element
testCallback - callback function to be called for each node
Defined in jgrouse.dom.Element

Function Interface Details

ifunction traverseCallback

boolean traverseCallback(DOMElement element)
Parameters:
element currently being traversed
Returns:
true if element matches certaint criteria
Defined in jgrouse.dom.Element