XForms 1.1

2.1.1 The xforms-version-exception Event

Target: the default model

Bubbles: Yes

Cancelable: No

Context Info:

<model>
  <message level="modal" ev:event="xforms-version-exception" ref="event('errorinformation')"/>
  ...
</model>

Default Action: Fatal error.

2.2.1 No-namespace schema for XForms 1.1

XForms 1.1 includes a schema with no target namespace which allows XForms to be incorporated into another namespace using the XML Schema include facility. This kind of schema is sometimes referred to as a Chameleon schema.

<switch>
  <case id="in" selected="true">
    <input ref="yourname">
      <label>Please tell me your name</label>
      <toggle ev:event="DOMActivate" case="out"/>
    </input>
  </case>
  <case id="out" selected="false">
    <p>Hello <output ref="yourname" />
      <trigger id="editButton">
        <label>Edit</label>
        <toggle ev:event="DOMActivate" case="in"/>
      </trigger>
    </p>
  </case>
</switch>

2.2.2 Namespaced schema for XForms 1.1

XForms 1.1 also includes a schema which has a target namespace specified and as such is compatible with the XForms 1.0 definition. This schema includes all of the no-namespace schema and assigns is a target namespace of http://www.w3.org/2002/xforms

<switch xmlns="http://www.w3.org/2002/xforms">
  <case id="in" selected="true">
    <input ref="yourname">
      <label>Please tell me your name</label>
      <toggle ev:event="DOMActivate" case="out"/>
    </input>
  </case>
  <case id="out" selected="false">
    <html:p>Hello <output ref="yourname" />
      <trigger id="editButton">
        <label>Edit</label>
        <toggle ev:event="DOMActivate" case="in"/>
      </trigger>
    </html:p>
  </case>
</switch>

2.4.1 The power() Function

number power(number, number)

Raises the first argument to the power of the second argument, returning the result. If the calculation does not result in a real number, then NaN is returned.

Examples:

power(-1, 0.5)

if (prin>0 and dur>0 and rate>0, prin*rate/(1-power(1+rate, -dur)), 0)

2.4.2 The luhn() Function

boolean luhn(string?)

If the string parameter conforms to the pattern restriction of the xforms:ID-card-number type, then this function applies the luhn formula described in [ISO 7812-1:2000] and returns true if the number satisfies the formula. Otherwise, false is returned. If the parameter is omitted, it defaults to the string-value of the current context node.

Examples (see also 2.7 New Data Type: ID Card Number):

luhn(.)

luhn('4111-1111-1111-1111')

luhn('123')

2.4.3 The current() Function

node-set current()

Returns the context node used to initialize the evaluation of the containing XPath expression.

Examples:

<xforms:instance xmlns="">
	<converter>
		<amount>100</amount>
		<currency>jpy</currency>
		<convertedAmount></convertedAmount>
	</converter>
</xforms:instance>

<xforms:instance xmlns="" id="convTable">
	<convTable date="20040212" currency="cdn">
		<rate currency="eur">0.59376</rate>
		<rate currency="mxn">8.37597</rate>
		<rate currency="jpy">80.23451</rate>
		<rate currency="usd">0.76138</rate>
	</convTable>
</xforms:instance>

<bind nodeset="convertedAmount" 
      calculate="../amount * 
                 instance('convTable')/rate[@currency=current()/../currency]"/>

<xforms:instance xmlns="" id="i1">
	<months>
		<mon>01</mon>
		<mon>02</mon>
		<mon>03</mon>
	</months>
</xforms:instance>
<xforms:instance xmlns="" id="i2">
	<months>
		<month code="01">Jan</month>
		<month code="02">Feb</month>
		<month code="03">Mar</month>
	</months>
</xforms:instance>

<repeat nodeset="mon">
	<output value="instance('i2')/month[@code = current()]/>
</repeat>

2.4.4 The choose() Function

object choose(boolean, object, object)

If the boolean parameter is true, then the first object is returned, otherwise the second object is returned. If the types of the two object parameters are not the same (e.g. one node-set and the other a string), then the type of the object returned is determined by rationalizing the types of the two object parameters in the same manner as XPath comparison.

Example:

choose(count(x) > 0, x, y)

2.4.5 The id() Function

node-set id(object, node-set?)

The object parameter provides one or more IDREFs. This may be in the form of a string containing a space-separated list of IDREFs or a node-set, each node of which contains an IDREF. The node-set parameter provides nodes in one or more documents to be searched. If the node-set parameter is not given or is empty, then the document to be searched is the one containing the context node of the function call. For each node in the node-set parameter (or its default), the set of element nodes are collected with IDs that match the IDREFs from the object parameter. The result of this function is a node-set containing the union of the collected element nodes from each string. An element node can be assigned an ID by means of an xml:id attribute or an attribute that is assigned the type ID by a DTD or xsd:ID by an XML schema.

Example:

id('X Y', instance('Z'))

2.4.6 The property() Function

string property(string)

This function accepts a string identifying a property name. If the property name is not recognized, empty string is returned. The property definitions for this function are as follows:

Examples:

property('version')

property('conformance-level')

2.4.7 The days-to-date() Function

string days-to-date(number)

This function returns a string containing a lexical xsd:date that corresponds to the number of days passed as the parameter according to the following rules:

The number parameter is rounded to the nearest whole number, and the result is interpreted as the difference between the desired date and 1970-01-01. An input parameter value of NaN results in output of the empty string.

Examples:

days-to-date(11688)

days-to-date(-1)

2.4.8 The seconds-to-dateTime() Function

string seconds-to-dateTime(number)

This function returns string containing a lexical xsd:dateTime that corresponds to the number of seconds passed as the parameter according to the following rules:

The number parameter is rounded to the nearest whole number, and the result is interpreted as the difference between the desired dateTime and 1970-01-01T00:00:00Z. An input parameter value of NaN results in output of the empty string.

Example:

seconds-to-dateTime(0)

2.4.9 The local-date() Function

string local-date()

This function returns a lexical xsd:date obtained as if by the following rules: the result of now() is converted to a local date based on the user agent time zone information. If no time zone information is available, then the date portion of the result of now() is returned. In either case, the time zone is omitted from the return result.

Example:

local-date()

2.4.10 The local-dateTime() Function

string local-dateTime()

This function returns a lexical xsd:dateTime obtained as if by the following rules: the result of now() is converted to a local dateTime based on the user agent time zone information. If no time zone information is available, then the result of now() is returned.

Example:

local-dateTime()

2.4.11 The encode() Function

string encode(string, string?)

This function accepts a string of data and an optional string indicating an encoding method. The data string is serialized as UTF-8, and the result is encoded by the indicated method and returned by the function. This recommendation defines the values hex and base64 for the second string parameter that indicates the encoding method. If the parameter is missing, then the default is base64. The hex and base64 encoding methods of this function correspond to the encodings defined in [XML Schema part 2] for the datatypes hexBinary and base64Binary, respectively. Any other string value given for the encoding method results in an xforms-compute-exception.

Example:

encode('abc', 'hex')

2.4.12 The decode() Function

string decode(string, string?)

This function accepts a string of data and an optional string indicating the encoding of the data. This recommendation defines the values hex and base64 for the second string parameter that indicates the data encoding. If the parameter is missing, then the default is base64. The hex and base64 encoding methods of this function correspond to the encodings defined in [XML Schema part 2] for the datatypes hexBinary and base64Binary, respectively. Any other string value given for the encoding method results in an xforms-compute-exception.

The data is base64 or hex decoded. An xforms-compute-exception occurs if the data violates any base64 or hex encoding rules, such as containing invalid characters for the encoding. If the decoding succeeds, the result is interpreted as a UTF-8 serialization, and it is converted to an XPath string.If the decoded data is found to violate the UTF-8 encoding rules, then an empty string is returned. Otherwise, the XPath string result is returned.

Examples:

decode('616263', 'hex')

decode('abcdefg', 'hex')

2.4.13 The digest() Function

string digest(string, string, string?)

This function accepts a string of data, a string indicating a cryptographic hashing algorithm, and an optional string indicating an encoding method. The data string is serialized as UTF-8, the hash value is then computed using the indicated hash algorithm, and the hash value is then encoded by the indicated method, and the result is returned by the function. The following table presents the keywords for the second string parameter and the corresponding hash algorithms:

This recommendation defines the values hex and base64 for the third string parameter that indicates the encoding method. If the parameter is missing, then the default is base64. The hex and base64 encoding methods of this function correspond to the encodings defined in [XML Schema part 2] for the datatypes hexBinary and base64Binary, respectively. Any other string value given for the encoding method results in an xforms-compute-exception.

hash-encode('abc', 'sha1', 'hex')

hash-encode('abc', 'md5', 'hex')

hash-encode('abc', 'sha256', 'hex')

2.4.14 The hmac() Function

string hmac(string, string, string, string?)

This function accepts a string for a key or shared secret, a string of data, a string indicating a cryptographic hashing algorithm, and an optional string indicating an encoding method. The key and data strings are serialized as UTF-8, and they are subjected to the HMAC algorithm defined in [HMAC] and parameterized by the the hash algorithm indicated by the third parameter. The result is encoded with the method indicated by the fourth parameter, and the result is returned by the function.

The following table presents the keywords for the third string parameter and the corresponding hash algorithms:

This recommendation defines the values hex and base64 for the fourth string parameter that indicates the encoding method. If the parameter is missing, then the default is base64. The hex and base64 encoding methods of this function correspond to the encodings defined in [XML Schema part 2] for the datatypes hexBinary and base64Binary, respectively. Any other string value given for the encoding method results in an xforms-compute-exception.

2.4.15 The random() Function

number random(boolean?)

This function generates and returns a uniformly distributed random or pseudorandom number between 0.0 and 1.0. This function accepts an optional boolean parameter that is false by default. If true, the random number generator for this function is first seeded with a source of randomness before generating the return value. A typical implementation may seed the random number generator with the current system time in milliseconds when random(true) is invoked, and it may apply a linear congruential formula to generate return values on successive invocations of the function.

Example:

random()

2.4.16 Modification to Exceptions Generated by Errors in Functions

The boolean-from-string() function returns false when its string parameter does not match a case-insensitive comparison to the valid lexical values for an xsd:boolean, rather than halting processing with an xforms-compute-exception event.

When an error occurs in an XPath function, an xforms-compute-exception occurs only if the function appears in the expression of a model item property. When an error occurs in a function that appears in any other XForms attribute that contains an XPath expression, such as nodeset, ref or at, then an xforms-binding exception occurs.

2.5.1 The xforms-insert Event

Dispatched in response to: Successful insertion of a node by an XForms insert action.

Target: instance

Bubbles: Yes

Cancelable: No

Context Info:

Default Action: None; notification event only.

2.5.2 The xforms-delete Event

Dispatched in response to: Successful deletion of a node by an XForms delete action.

Target: instance

Bubbles: Yes

Cancelable: No

Context Info:

Default Action: None; notification event only.

2.5.3 The xforms-submit-error Event

Dispatched as an indication of: failure of a submission process

Target: submission

Bubbles: Yes

Cancelable: No

Context Info:

Default Action: None; notification event only.

2.5.4 The xforms-submit-done Event

Dispatched as an indication of: successful completion of a submission process

Target: submission

Bubbles: Yes

Cancelable: No

Context Info:

Default Action: None; notification event only.

2.5.5 The xforms-link-exception Event

Dispatched as an indication of: a failure in link traversal of a linking attribute.

Target: model

Bubbles: Yes

Cancelable: No

Context Info:

Default Action: Fatal error.

2.5.6 The xforms-link-error Event

Dispatched as an indication of: a failure in link traversal in a situation not critical to form processing.

Target: model

Bubbles: Yes

Cancelable: No

Context Info:

Default Action: None; notification event only.

2.5.7 The xforms-compute-exception Event

Dispatched as an indication of: an error occurring during XPath evaluation.

Target: model

Bubbles: Yes

Cancelable: No

Context Info:

Default Action: Fatal error.

2.10.1 References to Elements within a repeat Element

When the target element that is identified by the IDREF of a source object has one or more repeat elements as ancestors, then the set of ancestor repeats are partitioned into two subsets, those in common with the source element and those that are not in common. Any ancestor repeat elements of the target element not in common with the source element are descendants of the repeat elements that the source and target element have in common, if any.

For the repeat elements that are in common, the desired target object exists in the same set of run-time objects that contains the source object. Then, for each ancestor repeat of the target element that is not in common with the source element, the current index of the repeat determines the set of run-time objects that contains the desired target object.

2.10.2 References to Elements within a bind Element

When a source object expresses a Single Node Binding or Node Set Binding with a bind attribute, the IDREF of the bind attribute is resolved to a target bind object whose associated nodeset is used by the Single Node Binding or Node Set Binding. However, if the target bind element has one or more bind element ancestors, then the identified bind may be a target element that is associated with more than one target bind object.

If a target bind element is outermost, or if all of its ancestor bind elements have nodeset attributes that select only one node, then the target bind only has one associated bind object, so this is the desired target bind object whose nodeset is used in the Single Node Binding or Node Set Binding. Otherwise, the in-scope evaluation context node of the source object containing the bind attribute is used to help select the appropriate target bind object from among those associated with the target bind element.

From among the bind objects associated with the target bind element, if there exists a bind object created with the same in-scope evaluation context node as the source object, then that bind object is the desired target bind object. Otherwise, the IDREF resolution produced a null search result.

3.1.1 The insert Action

The insert action is used to create a new node of instance data by cloning an existing instance node. Attributes of action insert specify the node to be cloned and the location within instance data where the clone will appear. The clone is a deep copy of the original node except the contents of nodes of type xsd:ID are modified to remain as unique values in the instance data after the clone is inserted.

Common Attributes: Common (optional), Events (optional), Node Set Binding (required)

If the bind attribute appears, it provides the insert context. If the model attribute is given and indicates a model different than the one containing the in-scope evaluation context node, then the in-scope evaluation context is changed prior to evaluation of the Special Attributes of the insert element. The size and position are changed to 1, and the node is changed to the document element node of the default instance of the indicated model.

Special Attributes:

context

Optional XPath expression used to change the in-scope evaluation context for the insert element. This attribute is ignored if the bind attribute is provided. If the context attribute is not given, then the default insert context is the in-scope evaluation context. Otherwise, the XPath expression is evaluated using the in-scope evaluation context, and the first node rule is applied to obtain the insert context. The insert action is terminated with no effect if the insert context is the empty node-set or if the context attribute is not given and the Node Set Binding node-set is empty.

origin

Optional XPath expression indicating the node to be cloned. If the attribute is not given and the Node Set Binding node-set is empty, then the insert action is terminated with no effect. Otherwise, if this attribute is not given, then the last node of the Node Set Binding node-set is cloned. If the attribute is given, it is evaluated in the insert context using the first node rule. If the result is a node, then it is cloned, and otherwise the insert action is terminated with no effect.

at

Optional XPath expression evaluated to determine the insert location within the Node Set Binding node-set. If the Node Set Binding node-set is empty, then this attribute is ignored. If the attribute is not given, then the default is the size of the Node Set Binding node-set. Otherwise, the insert location is determined from this attribute as follows:

1. The evaluation context node is the first node in document order from the Node Set Binding node-set, the context size is the size of the Node Set Binding node-set, and the context position is 1.

2. The return value is processed according to the rules of the XPath function round(). For example, the literal 1.5 becomes 2, and the literal 'string' becomes NaN.

3. If the result is in the range 1 to the Node Set Binding node-set size, then the insert location is equal to the result. If the result is non-positive, then the insert location is 1. Otherwise, the result is NaN or exceeds the Node Set Binding node-set size, so the insert location is the Node Set Binding node-set size.

The insert location node is the node in the Node Set Binding node-set at the position given by the insert location.

position

Optional selector that indicates where to put the cloned node relative to the insert location. Valid values are before and after, and the latter is the default. This attribute is ignored if the Node Set Binding node-set is empty. If the node at the insert location within the Node Set Binding node-set is the document element of an instance, then this attribute is ignored.

Provided the insert action has not been terminated due to the conditions stated above, the processing rules for the insert action are as follows:

1. The target location of the insertion for the cloned node is determined as follows:

   1. If the Node Set Binding node-set is empty, then the target location is before the first child or attribute of the insert context node, based on the node type of the cloned node.

   2. If the node type of the cloned node does not match the node type of the insert location node, then the target location is before the first child or attribute of the insert location node node, based on the node type of the cloned node.

   3. If the Node Set Binding node-set and insert location indicate the root element of an instance, then that instance root element location is the target location.

   4. Otherwise, the target location is immediately before or after the insert location node, based on the position attribute setting or its default.

2. The cloned node is inserted at the target location. If the target location was the root element of an instance, then the cloned node replaces the instance root element. If the cloned node is a duplicate of another attribute in its parent element, then the duplicate attribute is removed. If the cloned node cannot be placed at the target location due to a node type conflict, then the insert action is terminated with no effect.

3. The index for any repeat that is bound to a homogeneous collection where the cloned node was added is updated to point to the newly inserted node, and the index of any repeat nested within an updated repeat is re-initialized to the startindex of the nested repeat.

4. The XForms action system's deferred update flags for rebuild, recalculate, revalidate and refresh are set.

5. The insert action is successfully completed by dispatching the xforms-insert event.

...
<xforms:instance id="people">
  <people xmlns=""/>
</xforms:instance>
<xforms:instance id="personProto">
  <person xmlns="">
      <name>Jane Q. Public</name>
  </person>
</xforms:instance>
...
<xforms:trigger>
  <xforms:label>Append new person</xforms:label>
  <xforms:insert context="instance('people')" nodeset="person" origin="instance('personProto')" ev:event="DOMActivate"/>
</xforms:trigger>

<xforms:trigger>
  <xforms:label>Prepend new person</xforms:label>
  <xforms:insert context="instance('people')" nodeset="person" origin="instance('personProto')" 
                 at="1" position="before" ev:event="DOMActivate"/>
</xforms:trigger>
...
		

...
<xforms:instance id="people">
  <people xmlns="">
    <person>
      <name>Jane Q. Public</name>
    </person>
    <person>
      <name>John Hancock</name>
    </person>
  </people>
</xforms:instance>
...
<xforms:instance id="peopleProto">
  <people xmlns=""/>
</xforms:instance>
...
<trigger>
  <label>Clear Person List</label>
  <insert context="instance('people')" nodeset="." origin="instance('peopleProto')" ev:event="DOMActivate"/>
</trigger>
...
		

<insert nodeset="some/node"/>
		

<xforms:instance xmlns="">
   <data>
      <item show="true">...</item>
      <item>...</item>
      <item willbesecondattr="true" show="false">...</item>
      <item willbesecondattr="false" show="false">...</item>
   </data>
</xforms:instance>
...
<insert nodeset="item[2]" origin="item[1]/@show"/>
<insert nodeset="item[3]" origin="item[1]/@show"/>
<insert nodeset="item[4]/@show" origin="item[1]/@show"/>
...
		

...
<xforms:instance xmlns="">
   <purchaseOrder>
        <subtotal/>
        <tax/>
        <total/>
   </purchaseOrder>
</xforms:instance>
<xforms:instance xmlns="" id="prototypes">
    <prototypes>
       ...
       <item>
           <product/>
           <quantity/>
           <unitcost/>
           <price/>
       </item>
    </prototypes>
</xforms:instance>
...
<repeat nodeset="/purchaseOrder/item">
   ...
</repeat>
...
<xforms:trigger>
  <xforms:label>Add to purchase order</xforms:label>
  <xforms:action ev:event="DOMActivate>
    <xforms:insert context="/purchaseOrder" nodeset="item" at="index('R')" origin="instance('prototypes')/item"/>
    <xforms:setfocus control="R"/>
  </xforms:action>
</xforms:trigger>
			

3.1.2 The delete Action

This action deletes a node from instance data.

Common Attributes: Common (optional), Events (optional), Node Set Binding (required)

If the bind attribute appears, it provides the delete context. If the model attribute is given and indicates a model different than the one containing the in-scope evaluation context node, then the in-scope evaluation context is changed prior to evaluation of the Special Attributes of the delete element. The size and position are changed to 1, and the node is changed to the document element node of the default instance of the indicated mode.

Special Attributes:

context

Optional XPath expression used to change the in-scope evaluation context for the delete element. This attribute is ignored if the bind attribute is provided. If the attribute is not given, then the default delete context is the in-scope evaluation context. Otherwise, the XPath expression is evaluated using the in-scope evaluation context, and the first node rule is applied to obtain the delete context. The delete action is terminated with no effect if the delete context is the empty node-set or if the context attribute is not given and the Node Set Binding node-set is empty.

at

Optional XPath expression evaluated to determine the delete location within the Node Set Binding node-set. If the Node Set Binding node-set empty, then this attribute is ignored. If the attribute is not given, then the default is the size of the Node Set Binding node-set. Otherwise, the delete location is determined from this attribute as follows:

1. The evaluation context node is the first node in document order from the Node Set Binding node-set, the context size is the size of the Node Set Binding node-set, and the context position is 1.

2. The return value is processed according to the rules of the XPath function round(). For example, the literal 1.5 becomes 2, and the literal 'string' becomes NaN.

3. If the result is in the range 1 to the Node Set Binding node-set size, then the delete location is equal to the result. If the result is non-positive, then the delete location is 1. Otherwise, the result is NaN or exceeds the Node Set Binding node-set size, so the delete location is the Node Set Binding node-set size.

Provided the insert action has not been terminated due to the conditions stated above, the rules for delete processing are as follows:

1. The node at the delete location in the Node Set Binding node-set is deleted, except if the node is the root document element of an instance then the delete action is terminated with no effect.

2. The index for any repeat that is bound to a homogeneous collection that contained the deleted node is not changed except:

   1. When the last remaining item in the collection is removed, the index position becomes 0.

   2. When the index was pointing to the deleted node, which was the last item in the collection, the index is changed to point to the new last node of the collection and the indexes of inner repeats are reinitialized.

   3. When the index was pointing to the deleted node, which was not the last item in the collection, the index position is not changed but the indexes of inner repeats are re-initialized.

   To re-initialize a repeat index means to set it to the startindex value.

3. The XForms action system's deferred update flags for rebuild, recalculate, revalidate and refresh are set.

4. The delete action is successfully completed by dispatching the event xforms-delete.

...
<xforms:trigger>
  <xforms:label>Delete from purchase order</xforms:label>
  <xforms:action ev:event="DOMActivate>
    <xforms:delete context="/purchaseOrder" nodeset="item" at="index('R')"/>
    <xforms:insert context="/purchaseOrder" if="not(item)"
                   nodeset="item" origin="instance('prototypes')/item"/>
    <xforms:setfocus control="R"/>
  </xforms:action>
</xforms:trigger>
			

3.5.1 The name and target Child Elements

In XForms 1.0, the dispatch action dispatches and event given by attribute name to an element identified by the target attribute. This section defines new child elements of dispatch that provide a means of specifying the name and target of the event with instance data.

Element: name

Common attributes: None

Special Attributes:

value

Optional attribute containing an XPath expression to evaluate using the in-scope evaluation context. To obtain the event name, the result of the expression is processed as if by call to the XPath string function.

The event name of the dispatch action is given by the name attribute or the name element. If both are given, the element takes precedence. Due to the addition of the element, the name attribute is no longer required, but either the name attribute or the name element must appear. The name element can provide the event name with either its string content or the value attribute. If both are given, then the value attribute takes precedence.

Element: target

Common attributes: None

Special Attributes:

value

Optional attribute containing an XPath expression to evaluate using the in-scope evaluation context. To obtain the event target, the result of the expression is processed as if by call to the XPath string function.

The event target of the dispatch action is given by the target attribute or the target element. If both are given, the element takes precedence. Due to the addition of the element, the target attribute is no longer required, but either the target attribute or the target element must appear. The target element can provide an IDREF for the event target with either its string content or the value attribute. If both are given, then the value attribute takes precedence.

3.5.2 Delayed Event Dispatching

A new attribute named delay of type xsd:nonNegativeInteger is defined for the dispatch action. The attribute is optional with a default of 0. The attribute indicates the minimum number of milliseconds to delay dispatching of the event to the target. A new child element of dispatch named delay is also defined as follows:

Element: delay

Common attributes: None

Special Attributes:

value

Optional attribute containing an XPath expression to evaluate using the in-scope evaluation context. To obtain the event delay, the result of the expression is processed as if by call to the XPath string function. If the result does not conform lexically to xsd:nonNegativeInteger, then the result of 0 is used.

The event delay of the dispatch action is given by the delay attribute or the delay element. If both are given, the element takes precedence. The delay element can provide the delay with either its string content or the value attribute. If both are given, then the value attribute takes precedence.

If the event delay is 0, then the specified event is dispatched as the result of the dispatch action. Otherwise, the event delay is greater than 0, and the specified event is added to the delayed event queue unless an event with the same name and target element already exists on the delayed event queue. The dispatch action has no effect if the event delay is greater than zero and the specified event is already in the delayed event queue.

If a run-time element is destroyed, then any delayed events targeted at that element are removed from the delayed event queue. A run-time element may be destroyed for a number of reasons, including shutdown of the form or removal of form controls associated by a repeat with an instance data node that is destroyed.

As soon as possible after the specified delay has elapsed, the event is removed from the delayed event queue and then dispatched. In the same manner used to handle user-generated events or the completion of an asynchronous submission, the dispatch and processing of delayed events is done without interrupting the processing of another event and its event handlers.

3.7.1 The xforms-close Event

This event, dispatched to the default model element, results in closing down the owner document. In a rendering environment, this may close down the user agent that renders the document.

Target: the default model

Bubbles: Yes

Cancelable: Yes

Context Info: None.

Default Action: The owner document is closed down.

4.1.1 The validate Attribute on Element submission

The submission element must allow a new optional attribute named validate of type boolean. The default value is true.

If the value of attribute validate is true by declaration or default, then the processing of a submission is unchanged from XForms 1.0, i.e. the instance being submitted must be valid for processing to proceed.

If the value of attribute validate is false, then the processing of a submission is changed from XForms 1.0 in the following way: The instance data will not be validated, and the submission processing will be allowed to proceed even if there is a selected instance data node that is either required but empty or not valid according to the definition provided in the text of the xforms-revalidate event.

4.1.2 The relevant Attribute on Element submission

The submission element must allow a new optional attribute named relevant of type boolean. The default value is true.

If the value of attribute relevant is true by declaration or default, then the processing of a submission is unchanged from XForms 1.0, i.e. the instance being submitted will not contain instance data nodes whose model item property relevant evaluates to false().

If the value of attribute relevant is false, then the processing of a submission is changed from XForms 1.0 in the following way: When the instance is serialized it will contain all selected instance data nodes, including instance data nodes whose model item property relevant evaluates to false().

4.1.3 The serialize Attribute on Element submission

The submission element must allow a new optional attribute named serialize of type boolean. The default value is true.

If the value of attribute serialize is true by declaration or default, then the processing of a submission is unchanged from XForms 1.0, i.e. the submission serialization logic occurs.

If the value of attribute serialize is false, then the processing of a submission is changed from XForms 1.0 in the following way: instance data is not serialized or submitted.

4.1.4 The mode Attribute on Element submission

The submission element must allow a new optional attribute named mode of type string. The valid values for this attribute are synchronous and asynchronous. The default value is asynchronous.

If the value of attribute mode is synchronous, then the default processing of xforms-submit must include the steps that apply the response returned from the submission. The default processing must block further action processing and the XForms processor must suspend user interaction with form controls until the submission response is returned. The user agent may signify that it has entered a waiting state (e.g. with an hourglass cursor), and the user agent may provide a means of terminating the submission, which would correspond to an error response from the submission.

If the value of attribute mode is asynchronous, whether by declaration or default, then the default processing of xforms-submit concludes once the submission has been initiated. With respect to the content of the submission serialization, the XForms processor must behave as if the submission serialization is completely formed prior to initiating the submission.

4.1.5 Replacing Text with a Submission Response

In XForms 1.1, the replace attribute of submission supports the additional value of text. If this setting is made, and the submission response conforms to an XML mediatype (as defined by the content type specifiers in [RFC 3023]) or a text media type (as defined by a content type specifier of text/*), then the response data is encoded as text and replaces the content of the replacement target node. See 4.1.6 The target Attribute on Element submission for further information about the replacement target node. If the content type of the submission response is not an XML mediatype or text mediatype as defined above, then the submission ends after dispatching the event xforms-submit-error with an error-type of resource-error.

4.1.6 The target Attribute on Element submission

The submission element must allow a new optional attribute named target of type string. The attribute value is interpreted as an XPath expression returning a node-set, the first node of which is used as the replacement target node for the submission response.

The default replacement target node is the document element node of the instance identified by the instance attribute, which is equal to the default instance of the model if not specified. The evaluation context for this attribute is the in-scope evaluation context for the submission element, except the context node is modified to be the document element of the instance identified by the instance attribute if it is specified.

This attribute is evaluated only once a successful submission response has been received and if the replace attribute value is instance or text. If the evaluation of the target attribute produces an empty nodeset or a nodeset in which the first node is not an element node, then submission processing ends after dispatching the event xforms-submit-error with an error-type of target-error.

When the replace attribute contains the value text, then the replacement target node is used as described in 4.1.5 Replacing Text with a Submission Response. When the replace attribute contains the value instance, then the XML obtained from the submission response is used to replace the target node. The XML in the response may have comment and processing instruction nodes before and after the document element. These nodes are discarded if the replacement target node is not the document element of an instance. Otherwise, those processing instructions and comments replace any processing instructions and comments that previously appeared outside of the document element of the instance being replaced.

4.1.7 The delete submission method

Element submission must allow the value delete for attribute method and provide delete submission behavior as defined in [RFC 2616].

4.3.1 The verb Attribute

The submission element must allow a new optional attribute named verb of type string. The default value is determined based on the URI scheme and the method attribute using the rules in 4.7 Submission Options. For example, under the http and https schemes, the methods post and urlencoded-post correspond to the verb POST. If given, the verb attribute overrides the default verb used in submission.

4.3.2 The verb Element

The submission element can optionally a child element named verb, which must appear immediately after the optional resource element. This element provides the submission verb, overriding the setting obtained from the verb attribute (or its default).

Common Attributes: None

Special Attributes:

value

Optional attribute containing an XPath expression to evaluate using the in-scope evaluation context. To obtain the verb, the result of the expression is processed as if by call to the XPath string function.

The verb to be used by the submission can be specified with either the value attribute or the string content of the verb element. If both are specified, then the value attribute takes precedence. If the submission does not have a verb element, then the submission verb is obtained from the verb attribute (or its default).

4.4.1 The name Element

When the name element appears as a child of element header, it is used to specify the name of a header to be added to the preamble of a submission. The name element may be used more than once if the containing header element specifies a nodeset attribute.

Common Attributes: None

Special Attributes:

value

Optional attribute containing an XPath expression to evaluate using the in-scope evaluation context. To obtain the header name, the result of the expression is processed as if by call to the XPath string function.

The header name may be given by the string content of the name element, or by the result of the value attribute. If both are given, the result from the value attribute takes precedence. If the resulting header name is the empty string, then the header is considered to be void, and it is not added to the submission preamble.

4.4.2 The value Element

When the value element appears as a child of element header, it is used to specify the value component of a header to be added to the preamble of a submission. The value element may be used more than once if the containing header element specifies a nodeset attribute.

Common Attributes: None

Special Attributes:

value

Optional attribute containing an XPath expression to evaluate using the in-scope evaluation context. To obtain the header value, the result of the expression is processed as if by call to the XPath string function.

The header value may be given by the string content of the value element, or by the result of the value attribute. If both are given, the result from the value attribute takes precedence.

4.5.1 The xforms-submit-serialize Event

Dispatched at the beginning of submission serialization (see 4.6.1 The xforms-submit Event).

Target: submission

Bubbles: Yes

Cancelable: No

Context Info:

Default Action: If the event context submission-body property string is empty, then no operation is performed so that the submission will use the normal serialization data (see 4.6.1 The xforms-submit Event). Otherwise, if the event context submission-body property string is non-empty, then the serialization data for the submission is set to be the content of the submission-body string.

4.6.1 The xforms-submit Event

Under no circumstances may more than a single concurrent submit process be under way for a particular XForms submission. From the start of the default action of xforms-submit, until its termination (immediately before dispatching xforms-submit-done or xforms-submit-error), the default action for subsequent xforms-submit events is to dispatch xforms-submit-error with context information containing an error-type of submission-in-progress.

Otherwise, default action for this event results in the following steps:

1. The data model is updated. Specifically, if the deferred update rebuild flag is set for the model containing this submission, then the rebuild operation is performed without dispatching an event to invoke the operation. Then, if the deferred update recalculate flag is set for the model containing this submission, then the recalculate operation is performed without dispatching an event to invoke the operation.

2. A node from the instance data is selected, based on attributes on the submission element. if the attributes of submission select an empty nodeset, a non-relevant node or a non-element node, then submission processing is stopped after dispatching event xforms-submit-error with context information containing an error-type of no-data. Otherwise, the indicated node and all nodes for which it is an ancestor are considered for the remainder of the submit process. if the attribute relevant is true, whether by default or declaration, then any node which is considered not relevant as defined in 6.1.4 The relevant Property is removed.

3. If the attribute validate is true,whether by default or declaration, then all selected instance data nodes are checked for validity according to the definition in Section 4.3.5 (no notification events are marked for dispatching due to this operation). Any selected instance data node that is required but empty or found to be invalid stops submission processing after dispatching event xforms-submit-error with context information containing an error-type of validation-error.

4. The headers are determined using the header element(s) in the submission and the mediatype attribute or its default.

5. The verb is determined using the verb element, verb attribute, or the method attribute.

6. The submission URL is determined using the resource element, resource attribute, or the action attribute.

7. If the serialize attribute is false, then the submission serialization is the empty string. Otherwise, the submission serialization is determined as follows. The event xforms-submit-serialize is dispatched. If the submission-body property of the event is changed from the initial value of empty string, then the content of the submission-body property string is used as the submission serialization. Otherwise, the submission serialization consists of a serialization of the selected instance data according to the rules stated at 4.7 Submission Options.

8. The submission is performed based on the headers, verb, URL, and submission serialization . The exact rules of submission are based on the protocol scheme and the method as defined in 4.7 Submission Options.

If the mode of the submission is asynchronous, then default processing for this event ends after the above steps, and submission processing is resumed once the response from the submission is returned. If the mode of the submission is synchronous, then the XForms processor suspends user interaction with all form controls of the document and action processing is blocked within in the default processing for this event until the response from the submission is returned.

The response returned from the submission is applied as follows:

• For a success response including a body, when the value of the replace attribute on element submission is "all", the event xforms-submit-done is dispatched with appropriate context information, and submit processing concludes with entire containing document being replaced with the returned body.

• For a success response including a body of an XML media type (as defined by the content type specifiers in [RFC 3023]), when the value of the replace attribute on element submission is "instance", the response is parsed as XML. If the parse fails, then submission processing concludes after dispatching xforms-submit-error with appropriate context information, including an error-type of parse-error. However, if the XML parse succeeds, then instance data replacement is performed according to the rules in 4.1.6 The target Attribute on Element submission. This operation may fail if the target attribute is specified and does not produce an element node result. In this case, submission ends after dispatching event xforms-submit-error with appropriate context information, including an error-type of target-error. Otherwise, the instance data replacement succeeds. Once the XML instance data has been successfully replaced, the rebuild, recalculate, revalidate and refresh operations are performed on the model, without dispatching events to invoke those four operations. This sequence of operations is associated with special deferred update behavior. Submission processing then concludes after dispatching xforms-submit-done with appropriate context information.

• For a success response including a body of a non-XML media type (i.e. with a content type not matching any of the specifiers in [RFC 3023]), when the value of the replace attribute on element submission is "instance", nothing in the document is replaced and submission processing concludes after dispatching xforms-submit-error with appropriate context information, including an error-type of resource-error.

• For a success response including a body of an XML media type (as defined by the content type specifiers in [RFC 3023]) or a text media type (as defined by a content type of text/*), when the value of the replace attribute on element submission is "text", the response is encoded as text. Then, the content replacement is performed according to the rules specified in 4.1.5 Replacing Text with a Submission Response and 4.1.6 The target Attribute on Element submission. If the evaluation of an expressed target attribute failed, then the submission processing concludes after dispatching xforms-submit-error with appropriate context information, including an error-type of target-error. Otherwise, if the replaced content contained one or more element nodes, then the rebuild operation is invoked without dispatching an event for the operation. Then, the recalculate, revalidate and refresh operations are performed on the model, without dispatching events to invoke those operations. This sequence of operations is associated with special deferred update behavior. Finally, submission processing then concludes after dispatching xforms-submit-done with appropriate context information.

• For a success response including a body that is both a non-XML media type (i.e. with a content type not matching any of the specifiers in [RFC 3023]) and a non-text type (i.e. with a content type not matching text/*), when the value of the replace attribute on element submission is "text", nothing in the document is replaced and submission processing concludes after dispatching xforms-submit-error with appropriate context information, including an error-type of resource-error.

• For a success response including a body, when the value of the replace attribute on element submission is "none", submission processing concludes after dispatching xforms-submit-done with appropriate context information.

• For a success response not including a body, submission processing concludes after dispatching xforms-submit-done with appropriate context information.

• Behaviors of other possible values for attribute replace are not defined in this specification.

• For an error response nothing in the document is replaced, and submission processing concludes after dispatching xforms-submit-error with appropriate context information, including an error-type of resource-error.

4.9.1 Representation of SOAP Envelope

The single-node binding of the submission element refers to the XML data to be submitted. In the case of a SOAP submission, the instance data includes the SOAP envelope and related SOAP tags.

4.9.2 Indicating a SOAP submission

For a SOAP submission, the mediatype attribute of the submission must be set to the MIME type of application/soap+xml. The form author may append charset and action MIME parameters.

4.9.3 SOAP HTTP Binding

The method attribute of the submission must be set to get or post in order to access the SOAP HTTP binding.

If method="get", then the SOAP response message exchange pattern is used. The HTTP headers must contain the Accept parameter with a value conforming to the following properties:

• must begin with application/soap+xml

• If the submission mediatype contains a charset MIME parameter, then it is appended to the application/soap+xml MIME type

• No other MIME parameters from the mediatype are copied to the application/soap+xml MIME type

• The q MIME parameter must not be specified in the application/soap+xml MIME type so that the default quality of 1 is used.

If method="post", then the SOAP request-response message exchange pattern is used. For SOAP 1.2, the current submission behavior of using the mediatype attribute value as the value of the Content-type parameter in the HTTP headers is sufficient. If the instance data being submitted has as its root element node a SOAP envelope in the SOAP 1.1 namespace (http://schemas.xmlsoap.org/soap/envelope/), then:

• the Content-type HTTP header is change to text/xml

• the charset MIME parameter is appended if it was specified in the mediatype

• if the action MIME parameter appears in the mediatype then a SOAPAction HTTP header is added and given a value equal to the content of the action MIME parameter

4.9.4 Handling the SOAP Response

The XForms processor must handle client authorization and redirection.

SOAP faults (400 and 500 level errors) are handled in the same manner as underlying HTTP errors, which is to say that an xforms-submit-error event is dispatched.

On successful completion, the results are consumed according to the XForms submission process, culminating in an xforms-submit-done event. The form author may capture this event and copy data from the target instance that receives the returned SOAP envelope to other instances that are designed to carry only data.

5.1.1 The xforms-output-error Event

Dispatched by the processor immediately after the first failure of an output to render or update the rendition of content.

Target: output

Bubbles: Yes

Cancelable: No

Context Info: None.

Default Action: None; notification event only.

Since the output element can be the target of the xforms-output-error, the content model for the output is opened further to include XForms actions.