Class Element

Object
   |
   +--Element

class Element

Element
Defined in dom.js

Field Detail

elm

<private> Object elm

BORDER_BOX

<static> Number BORDER_BOX

Border box

CONTENT_BOX

<static> Number CONTENT_BOX

Content box

MARGIN_BOX

<static> Number MARGIN_BOX

Margin box

PADDING_BOX

<static> Number PADDING_BOX

Padding box

Element

Element(name, parent, style, html, attrs)

The Element class contains methods that can be applied to any DOM element through the $ and $E functions

addClass

Object addClass(<String> cl)

Adds a CSS class on the element

Parameters:
cl - CSS class

clear

Object clear(<Boolean> useDom)

Remove all HTML contents from the element

Parameters:
useDom - Whether to use DOM or not

empty

Boolean empty()

Verify if the element is empty

getBorder

Number getBorder(<String> side)

Get the element's border value for a given side

Parameters:
side - Border side (top, right, bottom or left)

getBorderBox

Object getBorderBox()

Get the element's border box

getChildNodes

Array getChildNodes()

Collects the element's child nodes, skipping all text nodes. Extends and returns all child nodes in an array

getComputedStyle

String getComputedStyle(<String> prop)

Retrieves the computed value of a given style property

Parameters:
prop - Property name

getComputedStyles

Object getComputedStyles()

Gets all computed styles of the element

getDimensions

Object getDimensions()

Get the dimensions of the element. The results are returned as an object, containing 2 properties: width and height

getElementsByClassName

Array getElementsByClassName(clsNames)

Search for all elements that match the given set of class names

Parameters:
clsName - CSS class names (one or more, space separated)

getInnerText

String getInnerText()

Collects the contents of all text nodes inside the element

getNextSiblings

Array getNextSiblings()

Get the element's next siblings

getOpacity

Number getOpacity()

Gets the element's opacity level. The level is returned as a decimal number between 0 and 1

getPaddingBox

Object getPaddingBox()

Get the element's padding box

getParentByTagName

Object getParentByTagName(<String> tag)

Finds an element's ancestor by tag name

Parameters:
tag - Tag to be searched

getParentNodes

Array getParentNodes()

Collects the ancestor nodes of the element

getPosition

Object getPosition(<Number> tbt)

Retrieve the absolute position of the element. This method returns an object containing 2 properties: x (left offset) and y (top offset)

Parameters:
tbt - Box type (0, 1, 2 or 3)

getPreviousSiblings

Array getPreviousSiblings()

Get the element's previous siblings

getSiblings

Array getSiblings()

Get all element's siblings

getStyle

Object getStyle(<String> prop)

Reads a style property of the element. For better results, always provide property name using CSS property declaration style, e.g.: background-color, border-left-width, font-family

Parameters:
prop - Property name

getTag

String getTag()

Get the element's tag

hasAttribute

Boolean hasAttribute(<String> attr)

Checks if the element has a given attribute. This method doesn't override native browser implementations.

Parameters:
attr - Attribute name

hasClass

Boolean hasClass(<String> cl)

Checks if the element contains a given CSS class

Parameters:
cl - CSS class

hide

Object hide()

Hides the element

insert

Object insert(<String> ins, position, <Boolean> evalScripts)

Inserts HTML code inside the element. The 'position' argument allows to define where the HTML contents must be inserted : "before" the element, on the "top" or on the "bottom" of the element or "after" the element

Parameters:
ins - HTML or element to insert
evalScripts - Whether to eval scripts. Defaults to false
pos - Insertion position. Defaults to "bottom"

insertAfter

Object insertAfter(ref)

Insert the node after a given reference node. That means the new node is inserted between the reference node and the reference node's next sibling

Parameters:
Object - ] ref Reference node

isChildOf

Boolean isChildOf(<Object> anc)

Checks if the element is child of a given element

Parameters:
anc - Ancestor element

isVisible

Boolean isVisible()

Verify if the element is visible

isWithin

Object isWithin(<Object> p1, <Object> p2)

Checks if the element is within a given pair of coordinates. The coordinates must be objects containing x and y members: {x: 10, y : 20}. p1 coordinate is the top-left corner

Parameters:
p1 - Top-left coordinate
p2 - Bottom-right coordinate

Returns:
Boolean

moveTo

Object moveTo(<Number> x, <Number> y)

Moves the element to the given x and y coordinates

Parameters:
x - X coordinate
y - Y coordinate

readAttribute

Object readAttribute(<String> attr)

Reads the value of an element's attribute

Parameters:
attr - Attribute name

recursivelyCollect

Array recursivelyCollect(<String> prop)

Recursively collects elements associated by the 'prop' property The property 'prop' must point to a single DOM element. Returns an array of extended elements.

Parameters:
prop - Property

recursivelySum

Number recursivelySum(<String> prop)

Recursively sums the values of a given property on all ancestors of the element

Parameters:
prop - Property name

remove

Object remove()

Remove the element from its parent node

removeClass

Object removeClass(<String> cl)

Removes a CSS class from the element

Parameters:
cl - CSS class

replace

Object replace(<Object> rep, evalScripts)

Replaces the element with the given HTML code

Parameters:
rep - Replacement code or element
eval - Whether to eval scripts. Defaults to false

resizeTo

Object resizeTo(<Number> w, <Number> h)

Resizes the element to the given width and height values

Parameters:
w - Width
h - Height

scrollTo

Object scrollTo()

Scrolls the window to the element's position

setInnerText

Object setInnerText(<String> text)

Defines the text content of the element

Parameters:
text - Text content

setOpacity

Object setOpacity(<Number> op)

Sets the element's opacity level. The opacity level must be a decimal number between 0 and 1

Parameters:
op - Opacity level

setParentNode

Object setParentNode(<Object> p)

Sets the element's parent node. Stores the old parent in a property called oldParent and move the node to the child nodes of the new parent

Parameters:
p - New parent

setStyle

Object setStyle(<Object> prop, <Object> value)

Set one or more style properties of the element

Parameters:
prop - Hash of properties or property name
value - Property value

show

Object show()

Shows the element

swapStyles

Object swapStyles(<Object> props, <Function> func)

Swaps in/out style properties in order to call a given function

Parameters:
props - Style properties
func - Function to be called

toggleClass

Object toggleClass(<String> cl)

Adds/removes a CSS class on the element

Parameters:
cl - CSS class

toggleDisplay

Object toggleDisplay()

Toggles the element's visibility

update

Object update(<Object> upd, <Boolean> evalScripts, <Boolean> useDom)

Set the HTML contents of the element. By setting 'useDom' to true, a temporary div element will be created and its child nodes will be copied to the target element.

Parameters:
upd - HTML or element to update with
evalScripts - Whether to eval scripts. Defaults to false
useDom - Whether to use DOM. Defaults to false

writeAttribute

Object writeAttribute(<Object> attr, <Object> value)

Writes one or more element's attributes

Parameters:
attr - Attribute name or attributes hash
value - Attribute value

extend

<static> void extend(<Object> props)

Adds a list of methods to the element extensions. All passed methods will become available in extended elements and as static methods of the Element class

Parameters:
props - New methods