sbDataRemoteUtils.js File Reference

Go to the source code of this file.

Functions
Components utils	import ("resource://app/jsmodules/SBDataRemoteUtils.jsm")
function	SBDataBindElementProperty (aKey, aElement, aProperty, aIsBool, aIsNot, aEvalString)
	Create a DataRemote and bind an Element's property to the data. This method creates a DataRemote associated with the key passed in and binds the element's property to the data. Changes to the value of the data will automatically be reflected in the value of the property. More...
function	SBDataBindElementAttribute (aKey, aElement, aAttribute, aIsBool, aIsNot, aEvalString)
	Create a DataRemote and bind an Element's attribute to the data. This method creates a DataRemote associated with the key passed in and binds the element's attribute to the data. Changes to the value of the data will automatically be reflected in the value of the attribute. More...

Variables
const	SB_NewDataRemote = new Components.Constructor("@songbirdnest.com/Songbird/DataRemote;1", "sbIDataRemote", "init")

Function Documentation

Components utils import

(

"resource://app/jsmodules/SBDataRemoteUtils.jsm"

)

function SBDataBindElementAttribute	(		aKey,
			aElement,
			aAttribute,
			aIsBool,
			aIsNot,
			aEvalString
	)

Create a DataRemote and bind an Element's attribute to the data. This method creates a DataRemote associated with the key passed in and binds the element's attribute to the data. Changes to the value of the data will automatically be reflected in the value of the attribute.

Parameters

aKey	- The string identifier for the data to be changed.
aElement	- A nsIDOMElement whose attribute is to be bound, or the name of an element in the current document
aAttribute	- An attribute of aElement that will be bound
aIsBool	- Is the attribute (and therefore the data) a true/false value
aIsNot	- Should the attributes value be the opposite of the data. Only used if the aIsBool is true.
aEvalString	- A string of javascript to be executed to determine the value of the attribute. It can use the variable "value" in order to take action on the value of the data.

Returns

The newly created and bound DataRemote.

See Also

DatatRemote

Definition at line 116 of file sbDataRemoteUtils.js.

function SBDataBindElementProperty	(		aKey,
			aElement,
			aProperty,
			aIsBool,
			aIsNot,
			aEvalString
	)

Create a DataRemote and bind an Element's property to the data. This method creates a DataRemote associated with the key passed in and binds the element's property to the data. Changes to the value of the data will automatically be reflected in the value of the property.

Parameters

aKey	- The string identifier for the data to be changed.
aElement	- A nsIDOMElement whose property is to be bound, or the name of an element in the current document
aProperty	- A property of aElement that will be bound.
aIsBool	- Is the attribute (and therefore the data) a true/false value?
aIsNot	- Should the attributes value be the opposite of the data. Only used if the aIsBool is true.
aEvalString	- A string of javascript to be executed to determine the value of the property. It can use the variable "value" in order to take action on the value of the data.

Returns

The newly created and bound DataRemote.

See Also

DatatRemote

Definition at line 78 of file sbDataRemoteUtils.js.

Variable Documentation

const SB_NewDataRemote = new Components.Constructor("@songbirdnest.com/Songbird/DataRemote;1", "sbIDataRemote", "init")

Definition at line 57 of file sbDataRemoteUtils.js.