Public Member Functions | Public Attributes

nsIDOMNSElement Interface Reference

import "nsIDOMNSElement.idl";

Collaboration diagram for nsIDOMNSElement:

List of all members.

Public Member Functions

nsIDOMNodeList getElementsByClassName (in DOMString classes)
nsIDOMClientRectList getClientRects ()
nsIDOMClientRect getBoundingClientRect ()
 Returns the union of all rectangles in the getClientRects() list.
void setCapture ([optional] in boolean retargetToElement)
 Set this during a mousedown event to grab and retarget all mouse events to this element until the mouse button is released or releaseCapture is called.
void releaseCapture ()
 If this element has captured the mouse, release the capture.
boolean mozMatchesSelector ([Null(Stringify)] in DOMString selector)
 Returns whether this element would be selected by the given selector string.

Public Attributes

attribute long scrollTop
 The vertical scroll position of the element, or 0 if the element is not scrollable.
attribute long scrollLeft
 The horizontal scroll position of the element, or 0 if the element is not scrollable.
readonly attribute long scrollHeight
 The height of the scrollable area of the element.
readonly attribute long scrollWidth
 The width of the scrollable area of the element.
readonly attribute long clientTop
 The height in CSS pixels of the element's top border.
readonly attribute long clientLeft
 The width in CSS pixels of the element's left border and scrollbar if it is present on the left side.
readonly attribute long clientHeight
 The width in CSS pixels of the element's padding box.
readonly attribute long clientWidth
 The height in CSS pixels of the element's padding box.
readonly attribute nsIDOMElement firstElementChild
 Similar as the attributes on nsIDOMNode, but navigates just elements rather than all nodes.
readonly attribute nsIDOMElement lastElementChild
readonly attribute nsIDOMElement previousElementSibling
readonly attribute nsIDOMElement nextElementSibling
readonly attribute unsigned long childElementCount
 Returns the number of child nodes that are nsIDOMElements.
readonly attribute nsIDOMNodeList children
 Returns a live nsIDOMNodeList of the current child elements.
readonly attribute
nsIDOMDOMTokenList 
classList
 Returns a DOMTokenList object reflecting the class attribute.

Member Function Documentation

nsIDOMClientRect nsIDOMNSElement::getBoundingClientRect (  ) 

Returns the union of all rectangles in the getClientRects() list.

Empty rectangles are ignored, except that if all rectangles are empty, we return an empty rectangle positioned at the top-left of the first rectangle in getClientRects().

nsIDOMClientRectList nsIDOMNSElement::getClientRects (  ) 
nsIDOMNodeList nsIDOMNSElement::getElementsByClassName ( in DOMString  classes  ) 
boolean nsIDOMNSElement::mozMatchesSelector ( [Null(Stringify)] in DOMString  selector  ) 

Returns whether this element would be selected by the given selector string.

See <http://dev.w3.org/2006/webapi/selectors-api2/>

void nsIDOMNSElement::releaseCapture (  ) 

If this element has captured the mouse, release the capture.

If another element has captured the mouse, this method has no effect.

void nsIDOMNSElement::setCapture ( [optional] in boolean  retargetToElement  ) 

Set this during a mousedown event to grab and retarget all mouse events to this element until the mouse button is released or releaseCapture is called.

If retargetToElement is true, then all events are targetted at this element. If false, events can also fire at descendants of this element.


Member Data Documentation

readonly attribute unsigned long nsIDOMNSElement::childElementCount

Returns the number of child nodes that are nsIDOMElements.

Defined by the ElementTraversal spec.

Returns a live nsIDOMNodeList of the current child elements.

Returns a DOMTokenList object reflecting the class attribute.

readonly attribute long nsIDOMNSElement::clientHeight

The width in CSS pixels of the element's padding box.

If the element is scrollable, the scroll bars are included inside this height.

readonly attribute long nsIDOMNSElement::clientLeft

The width in CSS pixels of the element's left border and scrollbar if it is present on the left side.

readonly attribute long nsIDOMNSElement::clientTop

The height in CSS pixels of the element's top border.

readonly attribute long nsIDOMNSElement::clientWidth

The height in CSS pixels of the element's padding box.

If the element is scrollable, the scroll bars are included inside this width.

Similar as the attributes on nsIDOMNode, but navigates just elements rather than all nodes.

Defined by the ElementTraversal spec.

readonly attribute long nsIDOMNSElement::scrollHeight

The height of the scrollable area of the element.

If the element is not scrollable, scrollHeight is equivalent to the offsetHeight.

The horizontal scroll position of the element, or 0 if the element is not scrollable.

This property may be assigned a value to change the horizontal scroll position.

The vertical scroll position of the element, or 0 if the element is not scrollable.

This property may be assigned a value to change the vertical scroll position.

readonly attribute long nsIDOMNSElement::scrollWidth

The width of the scrollable area of the element.

If the element is not scrollable, scrollWidth is equivalent to the offsetWidth.


The documentation for this interface was generated from the following file: