Class Element

Object
   |
   +--Element

class Element

Defined in prototype.js

Field Detail

_extend

<static> Object _extend

Replace prototype.js's Element.extend() to re-extend elements after scriptaculous' effects.js is loaded.

_makePositioned

<static> Object _makePositioned

Fix prototype.js's Element.makePositioned() to ignore table rows.

ClassNames

<static> Object ClassNames

CSS_LENGTH

<static> Object CSS_LENGTH

CSS_PROPERTIES

<static> Object CSS_PROPERTIES

Element

Element(tagName, attributes)

collectTextNodes

<static> void collectTextNodes(element)

collectTextNodesIgnoreClass

<static> void collectTextNodesIgnoreClass(element, className)

create

<static> Object create(name, attributes, text, rawhtml)

Creates a new element with the specified name and attributes.

Parameters:
name - New element name.
attributes - (optional) Object whose properties will be used to set the new element's attributes.
text - (optional) Text for the new element.
rawhtml - (optional) True to treat text as raw html, false (the default) to escape text.

Returns:
New element.

dislocate

<static> Object dislocate(element, to, form)

Dislocates specified element.

Parameters:
element - Element to dislocate.
to - (optional) New parent element.
form - (optional) Form from which to dislocate.

extend

<static> Object extend(element)

findAncestor

<static> Object findAncestor(element, index, tagName, className)

Find nth ancestor (or self) of element with specified tagName regex or className regex.

Parameters:
element - Element whose nth ancestor to find (0 = first/self, 1 = second/parent, etc).
index - Index of matching ancestor.
tagName - (optional) Regex to match against ancestor tagName.
className - (optional) Regex to match against ancestor className.

Returns:
Matched ancestor or null.

findChild

<static> Object findChild(element, index, tagName, className)

Find nth direct child of element with specified tagName regex or className regex.

Parameters:
element - Element whose nth child to find.
index - Index of matching child.
tagName - (optional) Regex to match against child tagName.
className - (optional) Regex to match against child className.

Returns:
Matched child or null.

findChildren

<static> Object findChildren(element, only, recursive, tagName)

findObstructingObjects

<static> Object findObstructingObjects(element)

Returns list of elements on the page (such as applets, flash objects, selectboxes in ie6, etc) which obstruct html layered over those elements.

Parameters:
element - (optional) Ignore obstructors in this element.

findParent

<static> Object findParent(element, name, attributes)

Finds parent (or self) with specified tag name and/or attributes.

Parameters:
element - DOM element or id from which to start search.
name - Tag name of element for which to search (ie "DIV").
attributes - (optional) Map of properties to match to element attributes.

Returns:
Matched element or null.

Deprecated use findAncestor()

forceRerendering

<static> void forceRerendering(element)

getAttribute

<static> Object getAttribute(element, qname, ns, localname)

Gets the specified element attribute as a string value. Fixes ie's non-standard getAttribute() behavior.

Parameters:
element - Element object.
qname - Attribute name.
ns - (optional) Attribute namespace.
localname - (optional) Attribute local name.

Returns:
String attribute value or "".

getInlineOpacity

<static> void getInlineOpacity(element)

getRole

<static> Object getRole(element)

Gets the WAI role for the specified element.

Parameters:
element - Element object or id.

Returns:
(Unprefixed) WAI role (ex: "progressbar"), or empty string if has no role.

getState

<static> Object getState(element, state)

Gets the state value for the specified element and WAI state.

Parameters:
element - Element object or id.
state - (Unprefixed) WAI state (ex: "disabled").

Returns:
State value (ex: "true"), or empty string if has no state value.

getStyles

<static> Object getStyles(element)

hideObstructingObjects

<static> Object hideObstructingObjects(element)

Hides obstructing elements.

Parameters:
element - (optional) Ignore obstructors in this element.

hideOverlappingObjects

<static> Object hideOverlappingObjects(element, rect)

Hide overlapping embeds and selectboxes.

Parameters:
element - Element or id of element for which to hide overlapping objects.
rect - (optional) Element's rectangle (will calculate if null).

isDescendantOrSelf

<static> Object isDescendantOrSelf(e0, e1)

True if e1 is descendant of e0 or is e0.

Parameters:
e0 - Ancestor element.
e1 - Descendant element.

Returns:
true if e1 is descenant of e0 or is e0.

isParent

<static> Object isParent(child, element)

offsetSize

<static> Object offsetSize(element, type)

relocate

<static> Object relocate(element)

Relocates specified element back to original (prior to dislocation) position.

Parameters:
element - Element to relocate.

setAttribute

<static> void setAttribute(element, qname, value, ns, localname)

Sets the specified element attribute as a string value. Fixes ie's non-standard setAttribute() behavior.

Parameters:
element - Element object.
qname - Attribute name.
value - String attribute value.
ns - (optional) Attribute namespace.
localname - (optional) Attribute local name.

setContentZoom

<static> Object setContentZoom(element, percent)

setRole

<static> void setRole(element, role)

Sets the WAI role for the specified element.

Parameters:
element - Element object or id.
role - (Unprefixed) WAI role (ex: "progressbar"), or empty string to indicate no role.

setState

<static> void setState(element, state, value)

Sets the state value for the specified element and WAI state.

Parameters:
element - Element object or id.
state - (Unprefixed) WAI state (ex: "disabled").
value - State value (ex: "true"), or empty string to indicate no state value.

showObstructingObjects

<static> Object showObstructingObjects(element)

Shows obstructing elements.

Parameters:
element - (optional) Ignore obstructors in this element.

showOverlappingObjects

<static> Object showOverlappingObjects(element)

Re-show overlapping embeds and selectboxes.

Parameters:
element - Element or id of element for which to re-show overlapping objects.

updateOuter

<static> void updateOuter(element, html)

Replaces the specified element with the specified html representing the new "outerHTML" of the element. The difference between this and Element#replace is that this does not remove the original element, rather, it updates it with the new content and attributes.

Parameters:
element - Element or id.
html - Html with which to replace element.