Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes
nsIXFormsContextControl Interface Reference

Interface for elements that sets the XPath context of its children. More...

import "nsIXFormsContextControl.idl";

Inheritance diagram for nsIXFormsContextControl:
Inheritance graph
[legend]
Collaboration diagram for nsIXFormsContextControl:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void getContext (out AString aModelID, out nsIDOMNode aContextNode, out long aContextPosition, out long aContextSize)
 Used by children to retrieve the context of their parent.
void setContext (in nsIDOMNode aContextNode, in long aContextPosition, in long aContextSize)
 Used by parents to set the context for children.
void addRemoveAbortedControl (in nsIXFormsControl aControl, in boolean aAddControl)
 Each context control maintains an 'aborted bind' list.
boolean bind ()
 This tells the form control to update its node binding based on the current instance data.
void refresh ()
 This tells the form control to update its state based on the current instance data.

Public Attributes

attribute boolean onDeferredBindList
 Determines whether this control is already on the deferred bind list.

Detailed Description

Interface for elements that sets the XPath context of its children.

Definition at line 50 of file nsIXFormsContextControl.idl.


Member Function Documentation

Each context control maintains an 'aborted bind' list.

This list is used to track xforms controls that this context control contains which have tried to bind but couldn't because this context control wasn't bound yet, either.

Parameters:
aControlThe XForms control that couldn't bind because this context control wasn't ready.
addControlIf true, aControl is added to the list. If false aControl will be removed from the list and also aControl will lose its link to this control.

This tells the form control to update its node binding based on the current instance data.

Returns:
Did the binding change the context?
void nsIXFormsContextControl::getContext ( out AString  aModelID,
out nsIDOMNode  aContextNode,
out long  aContextPosition,
out long  aContextSize 
)

Used by children to retrieve the context of their parent.

Parameters:
aModelIDThe modelID
aContextNodeThe context node
aContextPositionThe context position
aContextSizeThe context size
Note:
The actual model ID must be returned. An empty |aModelID| should only be returned if the default model has an id="".

This tells the form control to update its state based on the current instance data.

void nsIXFormsContextControl::setContext ( in nsIDOMNode  aContextNode,
in long  aContextPosition,
in long  aContextSize 
)

Used by parents to set the context for children.

Parameters:
aContextNodeThe context node
aContextPositionThe context position
aContextSizeThe context size

Member Data Documentation

Determines whether this control is already on the deferred bind list.

Definition at line 59 of file nsIXFormsControlBase.idl.


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