DOMUtils.jsm File Reference

Javascript source for the DOM utility services. More...

Go to the source code of this file.

Functions

function sbDOMHighlighter (aWindow, aElement, aValue, aAttribute, aBlinkDuration)
 
function DOMEventListenerSet ()
 

Variables

 EXPORTED_SYMBOLS
 
const Cc = Components.classes
 
const Ci = Components.interfaces
 
const Cr
 
sbDOMHighlighter highlightElement
 
DOMEventListenerSet prototype constructor = DOMEventListenerSet
 
DOMEventListenerSet prototype
 
var sbColorUtils
 

Detailed Description

Javascript source for the DOM utility services.

Definition in file DOMUtils.jsm.

Function Documentation

function DOMEventListenerSet ( )

Construct a DOM event listener set object.

Definition at line 766 of file DOMUtils.jsm.

Here is the caller graph for this function:

function sbDOMHighlighter (   aWindow,
  aElement,
  aValue,
  aAttribute,
  aBlinkDuration 
)

Construct a DOM highlighter object to highlight the element specified by aElement within the window specified by aWindow and return the highlighter object. The element is highlighted by setting one of its attributes to a particular value. A CSS rule can then be set up to apply highlight styling to the element based on the attribute and value. The attribute to set is specified by aAttribute. The attribute is set to the value specified by aValue. If the attribute is "class", the value is added to the class attribute instead of replacing it entirely. If aAttribute is not specified, the "class" attribute is used as the default. If aValue is not specified, a default value is also used. If the "class" attribute is being used, "highlight" is used as the value to add to the "class" attribute. Otherwise, the attribute is set to the value "true". Blink the highlighting for the duration specified by aBlinkDuration. If the duration is not specified, choose a default duration. If the duration is negative, do not blink.

Parameters
aWindowWindow containing element.
aElementElement to highlight.
aValueValue to set highlight.
aAttributeAttribute to use to highlight.
aBlinkDurationDuration of blinking in milliseconds.

Definition at line 485 of file DOMUtils.jsm.

Variable Documentation

const Cc = Components.classes

Definition at line 50 of file DOMUtils.jsm.

Definition at line 51 of file DOMUtils.jsm.

Definition at line 773 of file DOMUtils.jsm.

const Cr

Definition at line 52 of file DOMUtils.jsm.

EXPORTED_SYMBOLS
Initial value:
= [ "DOMUtils",
"sbDOMHighlighter",
"DOMEventListenerSet",
"sbColorUtils" ]

Definition at line 38 of file DOMUtils.jsm.

sbDOMHighlighter highlightElement

Highlight the element specified by aElement within the window specified by aWindow and return the highlighter object. The element is highlighted by setting one of its attributes to a particular value. A CSS rule can then be set up to apply highlight styling to the element based on the attribute and value. The attribute to set is specified by aAttribute. The attribute is set to the value specified by aValue. If the attribute is "class", the value is added to the class attribute instead of replacing it entirely. If aAttribute is not specified, the "class" attribute is used as the default. If aValue is not specified, a default value is also used. If the "class" attribute is being used, "highlight" is used as the value to add to the "class" attribute. Otherwise, the attribute is set to the value "true". Blink the highlighting for the duration specified by aBlinkDuration. If the duration is not specified, choose a default duration. If the duration is negative, do not blink.

Parameters
aWindowWindow containing element.
aElementElement to highlight.
aValueValue to set highlight.
aAttributeAttribute to use to highlight.
aBlinkDurationDuration of blinking in milliseconds.
Returns
Highlighter object.

Definition at line 549 of file DOMUtils.jsm.

Definition at line 776 of file DOMUtils.jsm.

var sbColorUtils

Definition at line 915 of file DOMUtils.jsm.