nsIXFormsModelElement

Defines scriptable methods for manipulating instance data and updating computed and displayed values.
1.0
66
Introduced
Gecko 1.8
Obsolete
Gecko 1.9.1
Inherits from: nsISupports Last changed in Gecko 1.8 (Firefox 1.5 / Thunderbird 1.5 / SeaMonkey 1.0)

Method overview

nsIDOMDocument getInstanceDocument(in DOMString instanceID);
void rebuild();
void recalculate();
void refresh();
void revalidate();

Methods

getInstanceDocument()

nsIDOMDocument getInstanceDocument(
  in DOMString instanceID
);
Parameters
instanceID
The ID of the instance element to be returned.
Return value

An nsIDOMDocument.

Exceptions thrown
DOMException
If there is no matching instance data.

rebuild()

Signals the XForms Processor to rebuild any internal data structures used to track computational dependencies within the given XForms Model.

void rebuild();
Parameters

None.

recalculate()

Signals the XForms Processor to perform a full recalculation of the given XForms Model.

Note: Script invocation is not necessarily equivalent to performing the recalculate action handler. Though the script is assumed to have modified instance data prior to invoking recalculate, the DOM mutations are not cached. Thus, a full recalculation is necessary to ensure the proper changes are effected throughout the XForms Model.

void recalculate();
Parameters

None.

refresh()

Signals the XForms Processor to perform a full refresh of form controls bound to instance nodes for the given XForms Model.

void refresh();
Parameters

None.

revalidate()

Signals the XForms Processor to perform a full revalidation of the given XForms Model.

void revalidate();
Parameters

None.

See also