You are viewing a plain text version of this content. The canonical link for it is here.
Posted to xap-commits@incubator.apache.org by bb...@apache.org on 2007/06/25 03:05:26 UTC
svn commit: r550329 [2/13] - in /incubator/xap/site: docs/ docs/xmodify/
docs/xmodify/content/ docs/xmodify/css/ docs/xmodify/doc/
docs/xmodify/doc/complexTypes/ docs/xmodify/doc/complexTypes/html/
docs/xmodify/doc/complexTypes/xml/ docs/xmodify/doc/ov...
Added: incubator/xap/site/docs/xmodify/doc/complexTypes/html/clone-element-type.html
URL: http://svn.apache.org/viewvc/incubator/xap/site/docs/xmodify/doc/complexTypes/html/clone-element-type.html?view=auto&rev=550329
==============================================================================
--- incubator/xap/site/docs/xmodify/doc/complexTypes/html/clone-element-type.html (added)
+++ incubator/xap/site/docs/xmodify/doc/complexTypes/html/clone-element-type.html Sun Jun 24 20:05:18 2007
@@ -0,0 +1,205 @@
+<html xmlns:event="http://www.w3.org/2001/XMLSchema" xmlns:meta="http://www.w3.org/2001/XMLSchema" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
+<head>
+<META http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+<link rel="stylesheet" type="text/css" href="../../../css/stylesheet.css">
+</head>
+<body>
+<script src="../../../js/myJS.js" language="javascript" type="text/javascript"></script>
+<h2>
+<span class="smal">"http://openxal.org/core/xmodify"</span>
+<br>clone</h2>
+<div>
+<h4 class="Group">
+<img src="../../../images/minus.gif" id="complexOverviewMinus" onClick="
+ javascript:toggleDiv(this,'complexOverviewDivID');">Overview</h4>
+</div>
+<div id="complexOverviewDivID" style="display:block;visibility:visible"> <clone [attributes]/></div>
+<div>
+<h4 class="Group">
+<img src="../../../images/minus.gif" id="complexDocMinus" onClick="javascript:toggleDiv(this,'complexDocDivID');">Documentation</h4>
+</div>
+<div id="complexDocDivID" style="display:block;visibility:visible">
+<br>The clone command clones each of the results returned by the XPath query and
+returns the set of cloned elements. Here is a sample clone command: <br><br>
+<pre>
+ <xm:modifications version="1.0" xmlns:xm="http://openxal.org/core/xmodify" document="mydocument">
+ <xm:clone select="/ui/rootPane/freePane[1]/button[1]"/>
+ </xm:modifications>
+</pre>
+The above command will clone the first child button of the first child freePane of the
+rootPane element in the document "mydocument".
+The clone command is not useful as a top level command since the result will just
+be discarded. It should be used as an argument to other commands that take arguments.
+<h4>Here is a XAL example:</h4><br>
+<pre>
+ <xm:modifications version="1.0" xmlns:xm="http://openxal.org/core/xmodify" document="mydocument">
+ <xm:append select="/ui/rootPane">
+ <xm:clone select="/ui/rootPane/freePane[1]"/>
+ </xm:append>
+ </xm:modifications>
+</pre>
+The above command will clone the first child freePane of the rootPane element
+in document "mydocument" and then append it to the same rootPane element.<br><br>
+
+<b>Important:</b> if the XPath of the enclosing command (in the above example it's the append)
+returns more than 1 result, you have to make sure that the cloned element
+(freePane[1]) does not have any developer specified id attributes (since they are always copied
+into the clone). Otherwise there will be id conflicts and the command will fail
+when trying to append to the second result returned by the XPath query.<br><br>
+
+The XPath query must return the following set: ( Element )*.
+If any of the results of the XPath query is not an Element, an UpdateException is thrown
+and the execution of the <xm:modifications/> block is halted.<br><br>
+
+<h4>HTML Example:</h4>
+<br><br>
+<script language="JavaScript" type="text/javascript" src="../../../../../javascript/jquery/jquery-latest.js"></script>
+<script language="JavaScript" type="text/javascript" src="../../../../../javascript/xmodify/xmodify-jquery.js"></script>
+
+Change the value of the input field and click the clone button.
+<br><br>
+
+<div style="border:1px solid #aaa;margin:10px;padding:10px;" id="replace-contents">
+ <div><b>Please login!</b></div><br>
+ <div><input id="username" type="text" value="janesmith"></div><br>
+ <div id="inputContainer">
+ </div>
+ <input style="width:150px" type="button" value="Clone the Input" onclick="$.xmodify({url:'../../../operations/clone.xml'});"/>
+</div>
+<br>
+<p><b>clone.xml</b></p>
+<p>This file uses the clone xModify instruction create a copy of the input field.
+</p>
+<pre>
+<xal xmlns:xm="http://openxal.org/core/xmodify">
+ <xm:modifications document="html">
+ <xm:append select="#inputContainer">
+ <xm:clone select="#username"/>
+ </xm:append>
+ </xm:modifications>
+</xal>
+</pre>
+
+</div>
+<div>
+<h4 class="Group">
+<img src="../../../images/minus.gif" id="complexAttributesMinus" onClick="javascript:toggleDiv(this,'complexAttributesDivID');">Attribute Summary</h4>
+</div>
+<div id="complexAttributesDivID" style="display:block;visibility:visible">
+<table>
+<tr>
+<td class="TableCellHeader NameCell">Attribute Name</td><td class="TableCellHeader">Type</td><td class="TableCellHeader">Description</td>
+</tr>
+<tr class="TableRowColor" valign="top" bgcolor="white">
+<td class="TableGroupCell" valign="top" colspan="3">Basic<br>
+</td>
+</tr>
+<tr class="TableRowColor" valign="top" bgcolor="white">
+<td class="TableRightCell NameCell" valign="top"><a href="#deep">deep</a></td><td valign="top" align="left" class="TableLeftCell Types">boolean</td><td class="TableLeftCell">
+Specifies whether to perform a deep or shallow clone.</td>
+</tr>
+<tr class="TableRowColor" valign="top" bgcolor="white">
+<td class="TableRightCell NameCell" valign="top"><a href="#select">select</a></td><td valign="top" align="left" class="TableLeftCell"><a href="../../simpleTypes/html/select-attribute-type.html">select</a></td><td class="TableLeftCell">
+The value of this attribute is any valid XPath query which returns a result
+set (usually a set of elements or attributes) on which the enclosing xModify
+command then operates on.</td>
+</tr>
+</table>
+</div>
+<div>
+<h4 class="Group">
+<img src="../../../images/minus.gif" id="complexAttributeDetailMinus" onClick="javascript:toggleDiv(this,'complexAttributeDetailDivID');">Attribute Details</h4>
+</div>
+<div id="complexAttributeDetailDivID" style="display:block;visibility:visible">
+<h3>
+<img align="top" src="../../../images/base.gif"><a name="deep">deep</a>
+</h3>
+<table class="TableDetail">
+<tr>
+<td valign="top" class="TableRightCell NameCell">About</td><td class="TableRightCell">
+Specifies whether to perform a deep or shallow clone. If deep=true, the element
+and all of its children are cloned. If deep=false, only the top element is cloned
+but none of its children.
+</td>
+</tr>
+<tr>
+<td valign="top" class="TableRightCell">Type</td><td class="TableRightCell">
+<p>
+<span class="Types">boolean</span>
+</p>
+</td>
+</tr>
+<tr>
+<td valign="top" class="TableRightCell">Values</td><td class="TableRightCell"><span class="Types">boolean</span></td>
+</tr>
+<tr>
+<td valign="top" class="TableRightCell">Usage</td><td class="TableRightCell">optional</td>
+</tr>
+</table>
+<h3>
+<img align="top" src="../../../images/base.gif"><a name="select">select</a>
+</h3>
+<table class="TableDetail">
+<tr>
+<td valign="top" class="TableRightCell NameCell">About</td><td class="TableRightCell">
+The value of this attribute is any valid XPath query which returns a result
+set (usually a set of elements or attributes) on which the enclosing xModify
+command then operates on. <p>
+Shown below is a valid xModify command set containing just 1 command: remove-element.<br><br>
+
+<pre>
+ <xm:modifications version="1.0" xmlns:xm="http://openxal.org/core/xmodify"
+ document="mydocument">
+ <xm:remove-element select="/ui/rootPane/freePane[1]/button"/>
+ </xm:modifications>
+</pre>
+<br>
+The 'select' attribute of this command contains the following XPath query:
+"/ui/rootPane/freePane[1]/button". This query selects all buttons in the document "mydocument"
+that are children of the first child freePane of the rootPane element. All of these buttons
+are then removed from the document by the remove-element command.
+
+<br><br>
+When selecting elements in the HTML document be sure to capitalize the element names. This is
+a result of the way the are store in the browser. The following example will append a row to the table
+with an id of "myTable". Notice on the XPath statement also contains the TBODY which is
+standard on all tables.
+<br>
+<pre>
+ <xm:modifications version="1.0" xmlns:xm="http://openxal.org/core/xmodify"
+ document="html">
+ <xm:append select="TABLE[@id='myTable']/TBODY">
+ <![CDATA[ <tr><td>New Person</td></tr>
+ ]]>
+ </xm:append><br>
+ </xm:modifications><br>
+</pre>
+
+</td>
+</tr>
+<tr>
+<td valign="top" class="TableRightCell">Type</td><td class="TableRightCell">
+<p>
+<span class="Types"><a href="../../simpleTypes/html/select-attribute-type.html">select-attribute-type</a></span>
+</p>
+</td>
+</tr>
+<tr>
+<td valign="top" class="TableRightCell">Values</td><td class="TableRightCell"><span class="Types"></span></td>
+</tr>
+<tr>
+<td valign="top" class="TableRightCell">Usage</td><td class="TableRightCell">optional</td>
+</tr>
+</table>
+</div>
+<table class="FooterTable">
+<tr>
+<td align="left" width="50%" class="TableRowColor">Version: Based on Platform 4.5.7.1862</td><td align="right" class="TableRowColor"><span class="updateDate">last update: 2007-06-22</span></td>
+</tr>
+</table>
+<script src="http://www.google-analytics.com/urchin.js" language="javascript" type="text/javascript"></script><script>
+ uacct = "UA-2110702-1";
+ urchinTracker();
+ </script>
+</body>
+</html>
Added: incubator/xap/site/docs/xmodify/doc/complexTypes/html/create-document-element-type.html
URL: http://svn.apache.org/viewvc/incubator/xap/site/docs/xmodify/doc/complexTypes/html/create-document-element-type.html?view=auto&rev=550329
==============================================================================
--- incubator/xap/site/docs/xmodify/doc/complexTypes/html/create-document-element-type.html (added)
+++ incubator/xap/site/docs/xmodify/doc/complexTypes/html/create-document-element-type.html Sun Jun 24 20:05:18 2007
@@ -0,0 +1,69 @@
+<html xmlns:event="http://www.w3.org/2001/XMLSchema" xmlns:meta="http://www.w3.org/2001/XMLSchema" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
+<head>
+<META http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+<link rel="stylesheet" type="text/css" href="../../../css/stylesheet.css">
+</head>
+<body>
+<script src="../../../js/myJS.js" language="javascript" type="text/javascript"></script>
+<h2>
+<span class="smal">"http://openxal.org/core/xmodify"</span>
+<br>create-document</h2>
+<div>
+<h4 class="Group">
+<img src="../../../images/minus.gif" id="complexOverviewMinus" onClick="
+ javascript:toggleDiv(this,'complexOverviewDivID');">Overview</h4>
+</div>
+<div id="complexOverviewDivID" style="display:block;visibility:visible"> <create-document [attributes]> <br> ( <span class="AnyElement">
+ Any element from any namespace
+ </span>? )? <br></create-document> </div>
+<div>
+<h4 class="Group">
+<img src="../../../images/minus.gif" id="complexDocMinus" onClick="javascript:toggleDiv(this,'complexDocDivID');">Documentation</h4>
+</div>
+<div id="complexDocDivID" style="display:block;visibility:visible">
+The create-document command allows you to create documents and have them registered
+with the DocumentRegistry on the client side. This element supports no attributes and
+must be the first element under the <xm:modifications> element.
+
+<br><br>
+
+The create-document command supports a single child, however this child may have as many
+descendants as you like.
+
+<br><br>
+
+A sample create-document command element (using a deferred data retrieval) looks like: <br><br>
+
+<xm:modifications version="1.0" xmlns:xm="http://openxal.org/core/xmodify" document="myNewDocument"><br>
+ <xm:create-document><br>
+ <xi:include xmlns:xi="http://openxal.org/core/xinclude" href="/myFile.xml"/><br>
+ </xm:create-document><br>
+</xm:modifications><br><br>
+
+Another sample create-document command element with inline content looks like: <br><br>
+
+<xm:modifications version="1.0" xmlns:xm="http://openxal.org/core/xmodify" document="EmotionalStatesDocument"><br>
+ <xm:create-document><br>
+ <emotional-states><br>
+ <happy/><br>
+
+ <sad/><br>
+ </emotional-states><br>
+ </xm:create-document><br>
+</xm:modifications><br><br>
+
+If the above samples were executed, the documents would be registered with the client
+side DocumentRegistry as locally available documents.
+
+</div>
+<table class="FooterTable">
+<tr>
+<td align="left" width="50%" class="TableRowColor">Version: Based on Platform 4.5.7.1862</td><td align="right" class="TableRowColor"><span class="updateDate">last update: 2007-06-22</span></td>
+</tr>
+</table>
+<script src="http://www.google-analytics.com/urchin.js" language="javascript" type="text/javascript"></script><script>
+ uacct = "UA-2110702-1";
+ urchinTracker();
+ </script>
+</body>
+</html>
Added: incubator/xap/site/docs/xmodify/doc/complexTypes/html/embed-xal-element-type.html
URL: http://svn.apache.org/viewvc/incubator/xap/site/docs/xmodify/doc/complexTypes/html/embed-xal-element-type.html?view=auto&rev=550329
==============================================================================
--- incubator/xap/site/docs/xmodify/doc/complexTypes/html/embed-xal-element-type.html (added)
+++ incubator/xap/site/docs/xmodify/doc/complexTypes/html/embed-xal-element-type.html Sun Jun 24 20:05:18 2007
@@ -0,0 +1,208 @@
+<html xmlns:event="http://www.w3.org/2001/XMLSchema" xmlns:meta="http://www.w3.org/2001/XMLSchema" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
+<head>
+<META http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+<link rel="stylesheet" type="text/css" href="../../../css/stylesheet.css">
+</head>
+<body>
+<script src="../../../js/myJS.js" language="javascript" type="text/javascript"></script>
+<h2>
+<span class="smal">"http://openxal.org/core/xmodify"</span>
+<br>embed-xal</h2>
+<div>
+<h4 class="Group">
+<img src="../../../images/minus.gif" id="complexOverviewMinus" onClick="
+ javascript:toggleDiv(this,'complexOverviewDivID');">Overview</h4>
+</div>
+<div id="complexOverviewDivID" style="display:block;visibility:visible"> <embed-xal [attributes]/></div>
+<div>
+<h4 class="Group">
+<img src="../../../images/minus.gif" id="complexDocMinus" onClick="javascript:toggleDiv(this,'complexDocDivID');">Documentation</h4>
+</div>
+<div id="complexDocDivID" style="display:block;visibility:visible">
+Use the embed-xal operation to change the elements selected via the
+"select" attribute into a XAL host. This operations is typically used
+When developers are using HTML as the layout mechanism for their application
+and want to place the XAL widgets with in a specific locations. The other reason
+to use embed XAL is that you are trying to enhance the an existing site with XAL widgets.
+<br><br>
+For Example:
+<br><br>
+You want to layout an application as follows:<br><br>
+
+<p align="center">
+<img src="../../../images/embed-xal.gif">
+</p>
+<br>
+
+<b>HTML File</b><br>
+<pre>
+<html><body>
+ <table>
+ <tr>
+ <td rowspan="2">
+ <div id="treeView"></div>
+ </td>
+ <td>
+ <div id="detailsView"></div>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <div id="tableView"></div>
+ </td>
+ </tr>
+ </table>
+</body></html>
+</pre>
+
+<b>xModify File</b><br>
+<pre>
+ <xal xmlns:xm="http://openxal.org/core/xmodify">
+ <xm:modifications document="html">
+ <xm:embed-xal select="id('treeView')">
+ <tree>
+ <row>
+ <cell text="US"/>
+ <row>
+ <cell text="Marketing"/>
+ </row>
+ </row>
+ <row>
+ <cell text="UK"/>
+ <row>
+ <cell text="Marketing"/>
+ </row>
+ </row>
+ <row>
+ <cell text="FR"/>
+ <row>
+ <cell text="Marketing"/>
+ </row>
+ </row>
+ <row>
+ <cell text="JP"/>
+ <row>
+ <cell text="Marketing"/>
+ </row>
+ </row>
+ </tree>
+ </xm:embed-xal>
+ <xm:embed-xal select="id('detailsView')">
+ <verticalBoxPane>
+ <textField text="bob"/>
+ <button text="Change" onCommand="mco:myClientCode.onCommand()"/>
+ </verticalBoxPane>
+ </xm:embed-xal>
+ <xm:embed-xal select="id('tableView')">
+ <table>
+ <column>
+ <header text="Event ID"/>
+ </column>
+ <column>
+ <header text="Event Details">
+ </column>
+ <row>
+ <cell text="1"/>
+ <cell text="Denial of Service attack detected on 192.168.0.1"/>
+ </row>
+ </table>
+ </xm:embed-xal>
+ </xm:modifications>
+</xal>
+</pre>
+
+
+</div>
+<div>
+<h4 class="Group">
+<img src="../../../images/minus.gif" id="complexAttributesMinus" onClick="javascript:toggleDiv(this,'complexAttributesDivID');">Attribute Summary</h4>
+</div>
+<div id="complexAttributesDivID" style="display:block;visibility:visible">
+<table>
+<tr>
+<td class="TableCellHeader NameCell">Attribute Name</td><td class="TableCellHeader">Type</td><td class="TableCellHeader">Description</td>
+</tr>
+<tr class="TableRowColor" valign="top" bgcolor="white">
+<td class="TableGroupCell" valign="top" colspan="3">Basic<br>
+</td>
+</tr>
+<tr class="TableRowColor" valign="top" bgcolor="white">
+<td class="TableRightCell NameCell" valign="top"><a href="#select">select</a></td><td valign="top" align="left" class="TableLeftCell"><a href="../../simpleTypes/html/select-attribute-type.html">select</a></td><td class="TableLeftCell">
+The value of this attribute is any valid XPath query which returns a result
+set (usually a set of elements or attributes) on which the enclosing xModify
+command then operates on.</td>
+</tr>
+</table>
+</div>
+<div>
+<h4 class="Group">
+<img src="../../../images/minus.gif" id="complexAttributeDetailMinus" onClick="javascript:toggleDiv(this,'complexAttributeDetailDivID');">Attribute Details</h4>
+</div>
+<div id="complexAttributeDetailDivID" style="display:block;visibility:visible">
+<h3>
+<img align="top" src="../../../images/base.gif"><a name="select">select</a>
+</h3>
+<table class="TableDetail">
+<tr>
+<td valign="top" class="TableRightCell NameCell">About</td><td class="TableRightCell">
+The value of this attribute is any valid XPath query which returns a result
+set (usually a set of elements or attributes) on which the enclosing xModify
+command then operates on. <p>
+Shown below is a valid xModify command set containing just 1 command: remove-element.<br><br>
+
+<pre>
+ <xm:modifications version="1.0" xmlns:xm="http://openxal.org/core/xmodify"
+ document="mydocument">
+ <xm:remove-element select="/ui/rootPane/freePane[1]/button"/>
+ </xm:modifications>
+</pre>
+<br>
+The 'select' attribute of this command contains the following XPath query:
+"/ui/rootPane/freePane[1]/button". This query selects all buttons in the document "mydocument"
+that are children of the first child freePane of the rootPane element. All of these buttons
+are then removed from the document by the remove-element command.
+
+<br><br>
+When selecting elements in the HTML document be sure to capitalize the element names. This is
+a result of the way the are store in the browser. The following example will append a row to the table
+with an id of "myTable". Notice on the XPath statement also contains the TBODY which is
+standard on all tables.
+<br>
+<pre>
+ <xm:modifications version="1.0" xmlns:xm="http://openxal.org/core/xmodify"
+ document="html">
+ <xm:append select="TABLE[@id='myTable']/TBODY">
+ <![CDATA[ <tr><td>New Person</td></tr>
+ ]]>
+ </xm:append><br>
+ </xm:modifications><br>
+</pre>
+
+</td>
+</tr>
+<tr>
+<td valign="top" class="TableRightCell">Type</td><td class="TableRightCell">
+<p>
+<span class="Types"><a href="../../simpleTypes/html/select-attribute-type.html">select-attribute-type</a></span>
+</p>
+</td>
+</tr>
+<tr>
+<td valign="top" class="TableRightCell">Values</td><td class="TableRightCell"><span class="Types"></span></td>
+</tr>
+<tr>
+<td valign="top" class="TableRightCell">Usage</td><td class="TableRightCell">optional</td>
+</tr>
+</table>
+</div>
+<table class="FooterTable">
+<tr>
+<td align="left" width="50%" class="TableRowColor">Version: Based on Platform 4.5.7.1862</td><td align="right" class="TableRowColor"><span class="updateDate">last update: 2007-06-22</span></td>
+</tr>
+</table>
+<script src="http://www.google-analytics.com/urchin.js" language="javascript" type="text/javascript"></script><script>
+ uacct = "UA-2110702-1";
+ urchinTracker();
+ </script>
+</body>
+</html>
Added: incubator/xap/site/docs/xmodify/doc/complexTypes/html/insert-after-element-type.html
URL: http://svn.apache.org/viewvc/incubator/xap/site/docs/xmodify/doc/complexTypes/html/insert-after-element-type.html?view=auto&rev=550329
==============================================================================
--- incubator/xap/site/docs/xmodify/doc/complexTypes/html/insert-after-element-type.html (added)
+++ incubator/xap/site/docs/xmodify/doc/complexTypes/html/insert-after-element-type.html Sun Jun 24 20:05:18 2007
@@ -0,0 +1,192 @@
+<html xmlns:event="http://www.w3.org/2001/XMLSchema" xmlns:meta="http://www.w3.org/2001/XMLSchema" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
+<head>
+<META http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+<link rel="stylesheet" type="text/css" href="../../../css/stylesheet.css">
+</head>
+<body>
+<script src="../../../js/myJS.js" language="javascript" type="text/javascript"></script>
+<h2>
+<span class="smal">"http://openxal.org/core/xmodify"</span>
+<br>insert-after</h2>
+<div>
+<h4 class="Group">
+<img src="../../../images/minus.gif" id="complexOverviewMinus" onClick="
+ javascript:toggleDiv(this,'complexOverviewDivID');">Overview</h4>
+</div>
+<div id="complexOverviewDivID" style="display:block;visibility:visible"> <insert-after [attributes]> <br> ( <span class="AnyElement">
+ Any element from any namespace
+ </span>* )? <br></insert-after> </div>
+<div>
+<h4 class="Group">
+<img src="../../../images/minus.gif" id="complexDocMinus" onClick="javascript:toggleDiv(this,'complexDocDivID');">Documentation</h4>
+</div>
+<div id="complexDocDivID" style="display:block;visibility:visible">
+The insert-after command inserts its arguments (specified as children of
+the command element) after each of the results returned by the XPath
+query of the command. <br><br>
+
+The XPath query must select the following set: ( Element | Text )*.
+If some result of the XPath query is not one of the two types, an UpdateException is thrown
+and the execution of the <xm:modifications/> block is halted. An UpdateException
+will also be thrown if the XPath query selects the root Element of the document.<br><br>
+
+The following logic applies to the arguments of the insert-after command based
+on the type of each argument:
+
+<ul>
+<li>value-of directive element: the value of the bound variable will get
+inserted (not the directive element itself)
+<li>clone directive element is executed and the cloned elements (which is the result of
+ executing the command) will get inserted.
+<li>any other xModify directive element will get inserted as is.
+<li>element in any other namespace will be inserted as is. If the XPath query
+ returns more than 1 result, the element is cloned before the insertion to prevent
+ id conflicts (the clone is deep).
+<li>string argument is inserted as is.
+</ul>
+<br>
+<h4>Here is a XAL example:</h4><br>
+<pre>
+ <xm:modifications version="1.0" xmlns:xm="http://openxal.org/core/xmodify" document="mydocument">
+ <xm:insert-after select="id('somepanel')">
+ <freePane id="mypanel"/>
+ </xm:insert-after>
+ </xm:modifications>
+</pre>
+The above command will insert the new freePane (id="mypanel") after the
+freePane whose id="somepanel". ("after" means the new freePane will appear after
+the selected freePane in the list of children of the selected freePane's parent element).
+
+<h4>HTML Example:</h4><br>
+
+In the sample below pressing the "Add row to table" will create a new row in the table before the
+the Jane Smith row.
+
+<script language="JavaScript" type="text/javascript" src="../../../../../javascript/jquery/jquery-latest.js"></script>
+<script language="JavaScript" type="text/javascript" src="../../../../../javascript/xmodify/xmodify-jquery.js"></script>
+
+<p>
+<table style="width:310px" id="mytable">
+ <tr style="background-color:#aaa"><th width="150px" align="left">Employee ID</th><th width="150px" align="left">Full Name</th></tr>
+ <tr id="insertAfterMe"><td>3456g</td><td>Jane Smith</td></tr>
+ <tr><td>9833o</td><td>Larry Doyle</td></tr>
+<table>
+<input style="width:150px" type="button" value="Add row to table" onclick="$.xmodify({url:'../../../operations/insert-after.xml'});"/>
+<input style="width:150px" type="button" value="Reset table" onclick="$.xmodify({url:'../../../operations/resettable2.xml'});"/>
+</p>
+<br>
+
+<p><b>insert-after.xml</b></p>
+<p>This file uses the insert-after xModify instruction to add a new row to the html table.
+The select attribute of the append tag denotes the location of the element that the contents
+be inserted before. Typically you will use a <![CDATA[ ]]> block to cut down on parse
+and traversal time.</p>
+<pre><xal xmlns:xm="http://openxal.org/core/xmodify">
+ <xm:modifications document="html">
+ <xm:insert-after select="#insertAfterMe">
+ <![CDATA[
+ <tr>
+ <td>12390i</td>
+ <td>Larry Franklin</td>
+ </tr>
+ ]]>
+ </xm:insert-after>
+
+ </xm:modifications>
+</xal>
+</pre>
+
+</div>
+<div>
+<h4 class="Group">
+<img src="../../../images/minus.gif" id="complexAttributesMinus" onClick="javascript:toggleDiv(this,'complexAttributesDivID');">Attribute Summary</h4>
+</div>
+<div id="complexAttributesDivID" style="display:block;visibility:visible">
+<table>
+<tr>
+<td class="TableCellHeader NameCell">Attribute Name</td><td class="TableCellHeader">Type</td><td class="TableCellHeader">Description</td>
+</tr>
+<tr class="TableRowColor" valign="top" bgcolor="white">
+<td class="TableGroupCell" valign="top" colspan="3">Basic<br>
+</td>
+</tr>
+<tr class="TableRowColor" valign="top" bgcolor="white">
+<td class="TableRightCell NameCell" valign="top"><a href="#select">select</a></td><td valign="top" align="left" class="TableLeftCell"><a href="../../simpleTypes/html/select-attribute-type.html">select</a></td><td class="TableLeftCell">
+The value of this attribute is any valid XPath query which returns a result
+set (usually a set of elements or attributes) on which the enclosing xModify
+command then operates on.</td>
+</tr>
+</table>
+</div>
+<div>
+<h4 class="Group">
+<img src="../../../images/minus.gif" id="complexAttributeDetailMinus" onClick="javascript:toggleDiv(this,'complexAttributeDetailDivID');">Attribute Details</h4>
+</div>
+<div id="complexAttributeDetailDivID" style="display:block;visibility:visible">
+<h3>
+<img align="top" src="../../../images/base.gif"><a name="select">select</a>
+</h3>
+<table class="TableDetail">
+<tr>
+<td valign="top" class="TableRightCell NameCell">About</td><td class="TableRightCell">
+The value of this attribute is any valid XPath query which returns a result
+set (usually a set of elements or attributes) on which the enclosing xModify
+command then operates on. <p>
+Shown below is a valid xModify command set containing just 1 command: remove-element.<br><br>
+
+<pre>
+ <xm:modifications version="1.0" xmlns:xm="http://openxal.org/core/xmodify"
+ document="mydocument">
+ <xm:remove-element select="/ui/rootPane/freePane[1]/button"/>
+ </xm:modifications>
+</pre>
+<br>
+The 'select' attribute of this command contains the following XPath query:
+"/ui/rootPane/freePane[1]/button". This query selects all buttons in the document "mydocument"
+that are children of the first child freePane of the rootPane element. All of these buttons
+are then removed from the document by the remove-element command.
+
+<br><br>
+When selecting elements in the HTML document be sure to capitalize the element names. This is
+a result of the way the are store in the browser. The following example will append a row to the table
+with an id of "myTable". Notice on the XPath statement also contains the TBODY which is
+standard on all tables.
+<br>
+<pre>
+ <xm:modifications version="1.0" xmlns:xm="http://openxal.org/core/xmodify"
+ document="html">
+ <xm:append select="TABLE[@id='myTable']/TBODY">
+ <![CDATA[ <tr><td>New Person</td></tr>
+ ]]>
+ </xm:append><br>
+ </xm:modifications><br>
+</pre>
+
+</td>
+</tr>
+<tr>
+<td valign="top" class="TableRightCell">Type</td><td class="TableRightCell">
+<p>
+<span class="Types"><a href="../../simpleTypes/html/select-attribute-type.html">select-attribute-type</a></span>
+</p>
+</td>
+</tr>
+<tr>
+<td valign="top" class="TableRightCell">Values</td><td class="TableRightCell"><span class="Types"></span></td>
+</tr>
+<tr>
+<td valign="top" class="TableRightCell">Usage</td><td class="TableRightCell">optional</td>
+</tr>
+</table>
+</div>
+<table class="FooterTable">
+<tr>
+<td align="left" width="50%" class="TableRowColor">Version: Based on Platform 4.5.7.1862</td><td align="right" class="TableRowColor"><span class="updateDate">last update: 2007-06-22</span></td>
+</tr>
+</table>
+<script src="http://www.google-analytics.com/urchin.js" language="javascript" type="text/javascript"></script><script>
+ uacct = "UA-2110702-1";
+ urchinTracker();
+ </script>
+</body>
+</html>
Added: incubator/xap/site/docs/xmodify/doc/complexTypes/html/insert-at-element-type.html
URL: http://svn.apache.org/viewvc/incubator/xap/site/docs/xmodify/doc/complexTypes/html/insert-at-element-type.html?view=auto&rev=550329
==============================================================================
--- incubator/xap/site/docs/xmodify/doc/complexTypes/html/insert-at-element-type.html (added)
+++ incubator/xap/site/docs/xmodify/doc/complexTypes/html/insert-at-element-type.html Sun Jun 24 20:05:18 2007
@@ -0,0 +1,233 @@
+<html xmlns:event="http://www.w3.org/2001/XMLSchema" xmlns:meta="http://www.w3.org/2001/XMLSchema" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
+<head>
+<META http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+<link rel="stylesheet" type="text/css" href="../../../css/stylesheet.css">
+</head>
+<body>
+<script src="../../../js/myJS.js" language="javascript" type="text/javascript"></script>
+<h2>
+<span class="smal">"http://openxal.org/core/xmodify"</span>
+<br>insert-at</h2>
+<div>
+<h4 class="Group">
+<img src="../../../images/minus.gif" id="complexOverviewMinus" onClick="
+ javascript:toggleDiv(this,'complexOverviewDivID');">Overview</h4>
+</div>
+<div id="complexOverviewDivID" style="display:block;visibility:visible"> <insert-at [attributes]> <br> ( <span class="AnyElement">
+ Any element from any namespace
+ </span>* )? <br></insert-at> </div>
+<div>
+<h4 class="Group">
+<img src="../../../images/minus.gif" id="complexDocMinus" onClick="javascript:toggleDiv(this,'complexDocDivID');">Documentation</h4>
+</div>
+<div id="complexDocDivID" style="display:block;visibility:visible">
+<br>The insert-at command inserts its arguments (specified as children of
+the command element) at the specified index in the children list of each of
+the results returned by the XPath query. To specify the index, the command element
+has an attribute 'index' whose value is an integer. The valid range for
+the index attribute is:( 0 - children count of the Element returned by the XPath
+query) inclusive on both ends. If the index is outside of this range an
+ArrayIndexOutOfBounds exception is thrown. If the value of the 'index' attribute
+is not an integer an UpdateException is thrown (whose cause is a
+NumberFormatException).<br><br>
+
+The XPath query must return the following set: ( Element | Document )*.
+If any of the results of the XPath query is not an Element or a Document,
+an UpdateException is thrown and the execution of the <xm:modifications/>
+block is halted. Note that if the XPath query selects the Document object,
+additional restrictions apply: the index has to be 0 and the directive element
+must have only 1 child Element (which will be set as the root Element of the
+selected Document). If these restrictions are violated, an UpdateException is
+thrown.
+<br><br>
+
+The following logic applies to the arguments of the insert-at command based
+on the type of each argument:
+
+<ul>
+<li>value-of directive element is executed and the value of the bound variable will get
+inserted (not the directive element itself)
+<li>clone directive element is executed and the cloned elements (which is the result of
+ executing the command) will get inserted.
+<li>any other xModify directive element will get inserted as is.
+<li>element in any other namespace will be inserted as is. If the XPath query
+ returns more than 1 result, the element is cloned before the insertion to prevent
+ id conflicts (the clone is deep).
+<li>string argument is inserted as is.
+</ul>
+<br>
+
+<h4>Here is a XAL example:</h4><br>
+<pre>
+ <xm:modifications version="1.0" xmlns:xm="http://openxal.org/core/xmodify" document="mydocument">
+ <xm:insert-at select="id('mywindow')" index="2">
+ <freePane id="mypanel"/>
+ </xm:insert-at>
+ </xm:modifications>
+</pre>
+The above command will insert the new freePane (id="mypanel") at index 2 in the list
+of children of the selected window element.
+
+
+<h4>HTML Example:</h4><br>
+
+In the sample below pressing the "Add row to table" will create a new row in the table before the
+the Jane Smith row.
+
+<script language="JavaScript" type="text/javascript" src="../../../../../javascript/jquery/jquery-latest.js"></script>
+<script language="JavaScript" type="text/javascript" src="../../../../../javascript/xmodify/xmodify-jquery.js"></script>
+
+<p>
+<table style="width:310px" id="mytable">
+ <tr style="background-color:#aaa"><th width="150px" align="left">Employee ID</th><th width="150px" align="left">Full Name</th></tr>
+ <tr id="insertAfterMe"><td>3456g</td><td>Jane Smith</td></tr>
+ <tr><td>9833o</td><td>Larry Doyle</td></tr>
+<table>
+<input style="width:150px" type="button" value="Add row to table" onclick="$.xmodify({url:'../../../operations/insert-at.xml'});"/>
+<input style="width:150px" type="button" value="Reset table" onclick="$.xmodify({url:'../../../operations/resettable2.xml'});"/>
+</p>
+<br>
+
+<p><b>insert-at.xml</b></p>
+<p>This file uses the insert-at xModify instruction to add a new row to the html table.
+The select attribute of the insert-at tag denotes the location of the element that the contents
+and the index attribute tells it which place to insert it.
+
+Typically you will use a <![CDATA[ ]]> block to cut down on parse
+and traversal time.</p>
+<pre><xal xmlns:xm="http://openxal.org/core/xmodify">
+ <xm:modifications document="html">
+ <xm:insert-at select="#myTable" index="1">
+ <![CDATA[
+ <tr>
+ <td>12390i</td>
+ <td>Larry Franklin</td>
+ </tr>
+ ]]>
+ </xm:insert-at>
+ </xm:modifications>
+</xal>
+</pre>
+
+
+</div>
+<div>
+<h4 class="Group">
+<img src="../../../images/minus.gif" id="complexAttributesMinus" onClick="javascript:toggleDiv(this,'complexAttributesDivID');">Attribute Summary</h4>
+</div>
+<div id="complexAttributesDivID" style="display:block;visibility:visible">
+<table>
+<tr>
+<td class="TableCellHeader NameCell">Attribute Name</td><td class="TableCellHeader">Type</td><td class="TableCellHeader">Description</td>
+</tr>
+<tr class="TableRowColor" valign="top" bgcolor="white">
+<td class="TableGroupCell" valign="top" colspan="3">Basic<br>
+</td>
+</tr>
+<tr class="TableRowColor" valign="top" bgcolor="white">
+<td class="TableRightCell NameCell" valign="top"><a href="#index">index</a></td><td valign="top" align="left" class="TableLeftCell Types">integer</td><td class="TableLeftCell"></td>
+</tr>
+<tr class="TableRowColor" valign="top" bgcolor="white">
+<td class="TableRightCell NameCell" valign="top"><a href="#select">select</a></td><td valign="top" align="left" class="TableLeftCell"><a href="../../simpleTypes/html/select-attribute-type.html">select</a></td><td class="TableLeftCell">
+The value of this attribute is any valid XPath query which returns a result
+set (usually a set of elements or attributes) on which the enclosing xModify
+command then operates on.</td>
+</tr>
+</table>
+</div>
+<div>
+<h4 class="Group">
+<img src="../../../images/minus.gif" id="complexAttributeDetailMinus" onClick="javascript:toggleDiv(this,'complexAttributeDetailDivID');">Attribute Details</h4>
+</div>
+<div id="complexAttributeDetailDivID" style="display:block;visibility:visible">
+<h3>
+<img align="top" src="../../../images/base.gif"><a name="index">index</a>
+</h3>
+<table class="TableDetail">
+<tr>
+<td valign="top" class="TableRightCell NameCell">About</td><td class="TableRightCell">
+
+
+ </td>
+</tr>
+<tr>
+<td valign="top" class="TableRightCell">Type</td><td class="TableRightCell">
+<p>
+<span class="Types">integer</span>
+</p>
+</td>
+</tr>
+<tr>
+<td valign="top" class="TableRightCell">Values</td><td class="TableRightCell"><span class="Types">integer</span></td>
+</tr>
+<tr>
+<td valign="top" class="TableRightCell">Usage</td><td class="TableRightCell">optional</td>
+</tr>
+</table>
+<h3>
+<img align="top" src="../../../images/base.gif"><a name="select">select</a>
+</h3>
+<table class="TableDetail">
+<tr>
+<td valign="top" class="TableRightCell NameCell">About</td><td class="TableRightCell">
+The value of this attribute is any valid XPath query which returns a result
+set (usually a set of elements or attributes) on which the enclosing xModify
+command then operates on. <p>
+Shown below is a valid xModify command set containing just 1 command: remove-element.<br><br>
+
+<pre>
+ <xm:modifications version="1.0" xmlns:xm="http://openxal.org/core/xmodify"
+ document="mydocument">
+ <xm:remove-element select="/ui/rootPane/freePane[1]/button"/>
+ </xm:modifications>
+</pre>
+<br>
+The 'select' attribute of this command contains the following XPath query:
+"/ui/rootPane/freePane[1]/button". This query selects all buttons in the document "mydocument"
+that are children of the first child freePane of the rootPane element. All of these buttons
+are then removed from the document by the remove-element command.
+
+<br><br>
+When selecting elements in the HTML document be sure to capitalize the element names. This is
+a result of the way the are store in the browser. The following example will append a row to the table
+with an id of "myTable". Notice on the XPath statement also contains the TBODY which is
+standard on all tables.
+<br>
+<pre>
+ <xm:modifications version="1.0" xmlns:xm="http://openxal.org/core/xmodify"
+ document="html">
+ <xm:append select="TABLE[@id='myTable']/TBODY">
+ <![CDATA[ <tr><td>New Person</td></tr>
+ ]]>
+ </xm:append><br>
+ </xm:modifications><br>
+</pre>
+
+</td>
+</tr>
+<tr>
+<td valign="top" class="TableRightCell">Type</td><td class="TableRightCell">
+<p>
+<span class="Types"><a href="../../simpleTypes/html/select-attribute-type.html">select-attribute-type</a></span>
+</p>
+</td>
+</tr>
+<tr>
+<td valign="top" class="TableRightCell">Values</td><td class="TableRightCell"><span class="Types"></span></td>
+</tr>
+<tr>
+<td valign="top" class="TableRightCell">Usage</td><td class="TableRightCell">optional</td>
+</tr>
+</table>
+</div>
+<table class="FooterTable">
+<tr>
+<td align="left" width="50%" class="TableRowColor">Version: Based on Platform 4.5.7.1862</td><td align="right" class="TableRowColor"><span class="updateDate">last update: 2007-06-22</span></td>
+</tr>
+</table>
+<script src="http://www.google-analytics.com/urchin.js" language="javascript" type="text/javascript"></script><script>
+ uacct = "UA-2110702-1";
+ urchinTracker();
+ </script>
+</body>
+</html>
Added: incubator/xap/site/docs/xmodify/doc/complexTypes/html/insert-before-element-type.html
URL: http://svn.apache.org/viewvc/incubator/xap/site/docs/xmodify/doc/complexTypes/html/insert-before-element-type.html?view=auto&rev=550329
==============================================================================
--- incubator/xap/site/docs/xmodify/doc/complexTypes/html/insert-before-element-type.html (added)
+++ incubator/xap/site/docs/xmodify/doc/complexTypes/html/insert-before-element-type.html Sun Jun 24 20:05:18 2007
@@ -0,0 +1,193 @@
+<html xmlns:event="http://www.w3.org/2001/XMLSchema" xmlns:meta="http://www.w3.org/2001/XMLSchema" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
+<head>
+<META http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+<link rel="stylesheet" type="text/css" href="../../../css/stylesheet.css">
+</head>
+<body>
+<script src="../../../js/myJS.js" language="javascript" type="text/javascript"></script>
+<h2>
+<span class="smal">"http://openxal.org/core/xmodify"</span>
+<br>insert-before</h2>
+<div>
+<h4 class="Group">
+<img src="../../../images/minus.gif" id="complexOverviewMinus" onClick="
+ javascript:toggleDiv(this,'complexOverviewDivID');">Overview</h4>
+</div>
+<div id="complexOverviewDivID" style="display:block;visibility:visible"> <insert-before [attributes]> <br> ( <span class="AnyElement">
+ Any element from any namespace
+ </span>* )? <br></insert-before> </div>
+<div>
+<h4 class="Group">
+<img src="../../../images/minus.gif" id="complexDocMinus" onClick="javascript:toggleDiv(this,'complexDocDivID');">Documentation</h4>
+</div>
+<div id="complexDocDivID" style="display:block;visibility:visible">
+<br>The insert-before command inserts its arguments (specified as children of
+the command element) before each of the results returned by the XPath
+query of the command. <br><br>
+
+The XPath query must select the following set: ( Element | Text )*.
+If some result of the XPath query is not one of the two types, an UpdateException is thrown
+and the execution of the <xm:modifications/> block is halted. An UpdateException
+will also be thrown if the XPath query selects the root Element of the document.
+<br><br>
+
+The following logic applies to the arguments of the insert-before command based
+on the type of each argument:
+
+<ul>
+<li>value-of directive element: the value of the bound variable will get
+inserted (not the directive element itself)
+<li>clone directive element: the cloned elements (which is the result of
+ executing the command) will get inserted.
+<li>any other xModify directive element will get inserted as is.
+<li>elements in any other namespace will be inserted as is. If the XPath query
+ returns more than 1 result, the element is cloned before the insertion to prevent
+ id conflicts (the clone is deep).
+<li>string argument is inserted as is.
+</ul>
+<br>
+<h4>Here is a XAL example:</h4><br>
+<pre>
+ <xm:modifications version="1.0" xmlns:xm="http://openxal.org/core/xmodify" document="mydocument">
+ <xm:insert-before select="id('somepanel')">
+ <freePane id="mypanel"/>
+ </xm:insert-before>
+ </xm:modifications>
+</pre>
+The above command will insert the new freePane (id="mypanel") before the
+freePane whose id="somepanel". ("before" means the new freePane will appear before
+the selected freePane in the list of children of the selected freePane's parent element).
+
+<br><br>
+
+<h4>HTML Example:</h4><br>
+
+In the sample below pressing the "Add row to table" will create a new row in the table before the
+the Jane Smith row.
+
+<script language="JavaScript" type="text/javascript" src="../../../../../javascript/jquery/jquery-latest.js"></script>
+<script language="JavaScript" type="text/javascript" src="../../../../../javascript/xmodify/xmodify-jquery.js"></script>
+
+<p>
+<table style="width:310px" id="mytable">
+ <tr style="background-color:#aaa"><th width="150px" align="left">Employee ID</th><th width="150px" align="left">Full Name</th></tr>
+ <tr id="insertBeforeMe"><td>3456g</td><td>Jane Smith</td></tr>
+<table>
+<input style="width:150px" type="button" value="Add row to table" onclick="$.xmodify({url:'../../../operations/insert-before.xml'});"/>
+<input style="width:150px" type="button" value="Reset table" onclick="$.xmodify({url:'../../../operations/resettable.xml'});"/>
+</p>
+<br>
+
+<p><b>insert-before.xml</b></p>
+<p>This file uses the insert-before xModify instruction to add a new row to the html table.
+The select attribute of the append tag denotes the location of the element that the contents
+be inserted before. Typically you will use a <![CDATA[ ]]> block to cut down on parse
+and traversal time.</p>
+<pre><xal xmlns:xm="http://openxal.org/core/xmodify">
+ <xm:modifications document="html">
+ <xm:insert-before select="#insertBeforeMe">
+ <![CDATA[
+ <tr>
+ <td>12390i</td>
+ <td>Larry Franklin</td>
+ </tr>
+ ]]>
+ </xm:insert-before>
+ </xm:modifications>
+</xal>
+</pre>
+
+</div>
+<div>
+<h4 class="Group">
+<img src="../../../images/minus.gif" id="complexAttributesMinus" onClick="javascript:toggleDiv(this,'complexAttributesDivID');">Attribute Summary</h4>
+</div>
+<div id="complexAttributesDivID" style="display:block;visibility:visible">
+<table>
+<tr>
+<td class="TableCellHeader NameCell">Attribute Name</td><td class="TableCellHeader">Type</td><td class="TableCellHeader">Description</td>
+</tr>
+<tr class="TableRowColor" valign="top" bgcolor="white">
+<td class="TableGroupCell" valign="top" colspan="3">Basic<br>
+</td>
+</tr>
+<tr class="TableRowColor" valign="top" bgcolor="white">
+<td class="TableRightCell NameCell" valign="top"><a href="#select">select</a></td><td valign="top" align="left" class="TableLeftCell"><a href="../../simpleTypes/html/select-attribute-type.html">select</a></td><td class="TableLeftCell">
+The value of this attribute is any valid XPath query which returns a result
+set (usually a set of elements or attributes) on which the enclosing xModify
+command then operates on.</td>
+</tr>
+</table>
+</div>
+<div>
+<h4 class="Group">
+<img src="../../../images/minus.gif" id="complexAttributeDetailMinus" onClick="javascript:toggleDiv(this,'complexAttributeDetailDivID');">Attribute Details</h4>
+</div>
+<div id="complexAttributeDetailDivID" style="display:block;visibility:visible">
+<h3>
+<img align="top" src="../../../images/base.gif"><a name="select">select</a>
+</h3>
+<table class="TableDetail">
+<tr>
+<td valign="top" class="TableRightCell NameCell">About</td><td class="TableRightCell">
+The value of this attribute is any valid XPath query which returns a result
+set (usually a set of elements or attributes) on which the enclosing xModify
+command then operates on. <p>
+Shown below is a valid xModify command set containing just 1 command: remove-element.<br><br>
+
+<pre>
+ <xm:modifications version="1.0" xmlns:xm="http://openxal.org/core/xmodify"
+ document="mydocument">
+ <xm:remove-element select="/ui/rootPane/freePane[1]/button"/>
+ </xm:modifications>
+</pre>
+<br>
+The 'select' attribute of this command contains the following XPath query:
+"/ui/rootPane/freePane[1]/button". This query selects all buttons in the document "mydocument"
+that are children of the first child freePane of the rootPane element. All of these buttons
+are then removed from the document by the remove-element command.
+
+<br><br>
+When selecting elements in the HTML document be sure to capitalize the element names. This is
+a result of the way the are store in the browser. The following example will append a row to the table
+with an id of "myTable". Notice on the XPath statement also contains the TBODY which is
+standard on all tables.
+<br>
+<pre>
+ <xm:modifications version="1.0" xmlns:xm="http://openxal.org/core/xmodify"
+ document="html">
+ <xm:append select="TABLE[@id='myTable']/TBODY">
+ <![CDATA[ <tr><td>New Person</td></tr>
+ ]]>
+ </xm:append><br>
+ </xm:modifications><br>
+</pre>
+
+</td>
+</tr>
+<tr>
+<td valign="top" class="TableRightCell">Type</td><td class="TableRightCell">
+<p>
+<span class="Types"><a href="../../simpleTypes/html/select-attribute-type.html">select-attribute-type</a></span>
+</p>
+</td>
+</tr>
+<tr>
+<td valign="top" class="TableRightCell">Values</td><td class="TableRightCell"><span class="Types"></span></td>
+</tr>
+<tr>
+<td valign="top" class="TableRightCell">Usage</td><td class="TableRightCell">optional</td>
+</tr>
+</table>
+</div>
+<table class="FooterTable">
+<tr>
+<td align="left" width="50%" class="TableRowColor">Version: Based on Platform 4.5.7.1862</td><td align="right" class="TableRowColor"><span class="updateDate">last update: 2007-06-22</span></td>
+</tr>
+</table>
+<script src="http://www.google-analytics.com/urchin.js" language="javascript" type="text/javascript"></script><script>
+ uacct = "UA-2110702-1";
+ urchinTracker();
+ </script>
+</body>
+</html>
Added: incubator/xap/site/docs/xmodify/doc/complexTypes/html/modifications-element-type.html
URL: http://svn.apache.org/viewvc/incubator/xap/site/docs/xmodify/doc/complexTypes/html/modifications-element-type.html?view=auto&rev=550329
==============================================================================
--- incubator/xap/site/docs/xmodify/doc/complexTypes/html/modifications-element-type.html (added)
+++ incubator/xap/site/docs/xmodify/doc/complexTypes/html/modifications-element-type.html Sun Jun 24 20:05:18 2007
@@ -0,0 +1,90 @@
+<html xmlns:event="http://www.w3.org/2001/XMLSchema" xmlns:meta="http://www.w3.org/2001/XMLSchema" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
+<head>
+<META http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+<link rel="stylesheet" type="text/css" href="../../../css/stylesheet.css">
+</head>
+<body>
+<script src="../../../js/myJS.js" language="javascript" type="text/javascript"></script>
+<h2>
+<span class="smal">"http://openxal.org/core/xmodify"</span>
+<br>modifications</h2>
+<div>
+<h4 class="Group">
+<img src="../../../images/minus.gif" id="complexOverviewMinus" onClick="
+ javascript:toggleDiv(this,'complexOverviewDivID');">Overview</h4>
+</div>
+<div id="complexOverviewDivID" style="display:block;visibility:visible"> <modifications [attributes]> <br> ( <a href="create-document-element-type.html">create-document</a>?, ( <a href="insert-before-element-type.html">insert-before</a> | <a href="insert-after-element-type.html">insert-after</a> | <a href="insert-at-element-type.html">insert-at</a> | <a href="append-element-type.html">append</a> | <a href="set-attribute-element-type.html">set-attribute</a> | <a href="replace-element-type.html">replace</a> | <a href="replace-children-element-type.html">replace-children</a> | <a href="remove-element-element-type.html">remove-element</a> | <a href="remove-attribute-element-type.html">remove-attribute</a> | <a href="variable-element-type.html">variable</a> | <a href="value-of-element-type.html">value-of</a> | <a href="clone-element-type.html">clone</a> | <a href="set-innerhtml-element-type.html">set-innerhtml</a> | <a href="set-style-element-type.html">set-style</a> | <a
href="embed-xal-element-type.html">embed-xal</a> )* )? <br></modifications> </div>
+<div>
+<h4 class="Group">
+<img src="../../../images/minus.gif" id="complexDocMinus" onClick="javascript:toggleDiv(this,'complexDocDivID');">Documentation</h4>
+</div>
+<div id="complexDocDivID" style="display:block;visibility:visible">
+Every set of xModify commands has to be enclosed in a single <xm:modifications/> element.
+A single file can contain multiple sets of <xm:modifications/> elements.
+The element has only 1 attribute: the name of the document on which to perform the specified updates.
+Use "xal" to affect the UI DOM. If you are using create-document directive it has to be the first
+one in the list of directives.
+
+
+</div>
+<div>
+<h4 class="Group">
+<img src="../../../images/minus.gif" id="complexAttributesMinus" onClick="javascript:toggleDiv(this,'complexAttributesDivID');">Attribute Summary</h4>
+</div>
+<div id="complexAttributesDivID" style="display:block;visibility:visible">
+<table>
+<tr>
+<td class="TableCellHeader NameCell">Attribute Name</td><td class="TableCellHeader">Type</td><td class="TableCellHeader">Description</td>
+</tr>
+<tr class="TableRowColor" valign="top" bgcolor="white">
+<td class="TableGroupCell" valign="top" colspan="3">Basic<br>
+</td>
+</tr>
+<tr class="TableRowColor" valign="top" bgcolor="white">
+<td class="TableRightCell NameCell" valign="top"><a href="#document">document</a></td><td valign="top" align="left" class="TableLeftCell"><a href="../../simpleTypes/html/document-attribute-type.html">document</a></td><td class="TableLeftCell">
+The name of the document the set of xModify commands enclosed in this <xm:modifications element
+will be executed against.</td>
+</tr>
+</table>
+</div>
+<div>
+<h4 class="Group">
+<img src="../../../images/minus.gif" id="complexAttributeDetailMinus" onClick="javascript:toggleDiv(this,'complexAttributeDetailDivID');">Attribute Details</h4>
+</div>
+<div id="complexAttributeDetailDivID" style="display:block;visibility:visible">
+<h3>
+<img align="top" src="../../../images/base.gif"><a name="document">document</a>
+</h3>
+<table class="TableDetail">
+<tr>
+<td valign="top" class="TableRightCell NameCell">About</td><td class="TableRightCell">
+The name of the document the set of xModify commands enclosed in this <xm:modifications element
+will be executed against.
+</td>
+</tr>
+<tr>
+<td valign="top" class="TableRightCell">Type</td><td class="TableRightCell">
+<p>
+<span class="Types"><a href="../../simpleTypes/html/document-attribute-type.html">document-attribute-type</a></span>
+</p>
+</td>
+</tr>
+<tr>
+<td valign="top" class="TableRightCell">Values</td><td class="TableRightCell"><span class="Types"></span></td>
+</tr>
+<tr>
+<td valign="top" class="TableRightCell">Usage</td><td class="TableRightCell">optional</td>
+</tr>
+</table>
+</div>
+<table class="FooterTable">
+<tr>
+<td align="left" width="50%" class="TableRowColor">Version: Based on Platform 4.5.7.1862</td><td align="right" class="TableRowColor"><span class="updateDate">last update: 2007-06-22</span></td>
+</tr>
+</table>
+<script src="http://www.google-analytics.com/urchin.js" language="javascript" type="text/javascript"></script><script>
+ uacct = "UA-2110702-1";
+ urchinTracker();
+ </script>
+</body>
+</html>
Added: incubator/xap/site/docs/xmodify/doc/complexTypes/html/one-element-child-directive-element-type.html
URL: http://svn.apache.org/viewvc/incubator/xap/site/docs/xmodify/doc/complexTypes/html/one-element-child-directive-element-type.html?view=auto&rev=550329
==============================================================================
--- incubator/xap/site/docs/xmodify/doc/complexTypes/html/one-element-child-directive-element-type.html (added)
+++ incubator/xap/site/docs/xmodify/doc/complexTypes/html/one-element-child-directive-element-type.html Sun Jun 24 20:05:18 2007
@@ -0,0 +1,37 @@
+<html xmlns:event="http://www.w3.org/2001/XMLSchema" xmlns:meta="http://www.w3.org/2001/XMLSchema" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
+<head>
+<META http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+<link rel="stylesheet" type="text/css" href="../../../css/stylesheet.css">
+</head>
+<body>
+<script src="../../../js/myJS.js" language="javascript" type="text/javascript"></script>
+<h2>
+<span class="smal">"http://openxal.org/core/xmodify"</span>
+<br>one-element-child-directive</h2>
+<div>
+<h4 class="Group">
+<img src="../../../images/minus.gif" id="complexOverviewMinus" onClick="
+ javascript:toggleDiv(this,'complexOverviewDivID');">Overview</h4>
+</div>
+<div id="complexOverviewDivID" style="display:block;visibility:visible"> <one-element-child-directive [attributes]> <br> ( <span class="AnyElement">
+ Any element from any namespace
+ </span>? )? <br></one-element-child-directive> </div>
+<div>
+<h4 class="Group">
+<img src="../../../images/minus.gif" id="complexDocMinus" onClick="javascript:toggleDiv(this,'complexDocDivID');">Documentation</h4>
+</div>
+<div id="complexDocDivID" style="display:block;visibility:visible">
+Elements of this type can take exactly 1 child which has to be an XML element.
+An example of a command that extends this type is create-document.
+</div>
+<table class="FooterTable">
+<tr>
+<td align="left" width="50%" class="TableRowColor">Version: Based on Platform 4.5.7.1862</td><td align="right" class="TableRowColor"><span class="updateDate">last update: 2007-06-22</span></td>
+</tr>
+</table>
+<script src="http://www.google-analytics.com/urchin.js" language="javascript" type="text/javascript"></script><script>
+ uacct = "UA-2110702-1";
+ urchinTracker();
+ </script>
+</body>
+</html>
Added: incubator/xap/site/docs/xmodify/doc/complexTypes/html/remove-attribute-element-type.html
URL: http://svn.apache.org/viewvc/incubator/xap/site/docs/xmodify/doc/complexTypes/html/remove-attribute-element-type.html?view=auto&rev=550329
==============================================================================
--- incubator/xap/site/docs/xmodify/doc/complexTypes/html/remove-attribute-element-type.html (added)
+++ incubator/xap/site/docs/xmodify/doc/complexTypes/html/remove-attribute-element-type.html Sun Jun 24 20:05:18 2007
@@ -0,0 +1,130 @@
+<html xmlns:event="http://www.w3.org/2001/XMLSchema" xmlns:meta="http://www.w3.org/2001/XMLSchema" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
+<head>
+<META http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+<link rel="stylesheet" type="text/css" href="../../../css/stylesheet.css">
+</head>
+<body>
+<script src="../../../js/myJS.js" language="javascript" type="text/javascript"></script>
+<h2>
+<span class="smal">"http://openxal.org/core/xmodify"</span>
+<br>remove-attribute</h2>
+<div>
+<h4 class="Group">
+<img src="../../../images/minus.gif" id="complexOverviewMinus" onClick="
+ javascript:toggleDiv(this,'complexOverviewDivID');">Overview</h4>
+</div>
+<div id="complexOverviewDivID" style="display:block;visibility:visible"> <remove-attribute [attributes]/></div>
+<div>
+<h4 class="Group">
+<img src="../../../images/minus.gif" id="complexDocMinus" onClick="javascript:toggleDiv(this,'complexDocDivID');">Documentation</h4>
+</div>
+<div id="complexDocDivID" style="display:block;visibility:visible">
+<br>The remove-attribute command removes the attributes returned by the XPath query of
+the command.<br><br>
+
+A sample remove-attribute command element looks like the following: <br><br>
+
+<xm:modifications version="1.0" xmlns:xm="http://openxal.org/core/xmodify" document="mydocument"><br>
+ <xm:remove-attribute select="/window/button[1]/@text"/><br>
+</xm:modifications><br><br>
+
+The above command removes the 'text' attribute from the first child button of the
+root window element in the document "mydocument".<br><br>
+
+The XPath query of the remove-attribute command must return the following set: ( Attribute )*.
+If any of the results of the XPath query is not an Attribute, an UpdateException is thrown
+and the execution of the <xm:modifications/> block is halted.<br><br>
+</div>
+<div>
+<h4 class="Group">
+<img src="../../../images/minus.gif" id="complexAttributesMinus" onClick="javascript:toggleDiv(this,'complexAttributesDivID');">Attribute Summary</h4>
+</div>
+<div id="complexAttributesDivID" style="display:block;visibility:visible">
+<table>
+<tr>
+<td class="TableCellHeader NameCell">Attribute Name</td><td class="TableCellHeader">Type</td><td class="TableCellHeader">Description</td>
+</tr>
+<tr class="TableRowColor" valign="top" bgcolor="white">
+<td class="TableGroupCell" valign="top" colspan="3">Basic<br>
+</td>
+</tr>
+<tr class="TableRowColor" valign="top" bgcolor="white">
+<td class="TableRightCell NameCell" valign="top"><a href="#select">select</a></td><td valign="top" align="left" class="TableLeftCell"><a href="../../simpleTypes/html/select-attribute-type.html">select</a></td><td class="TableLeftCell">
+The value of this attribute is any valid XPath query which returns a result
+set (usually a set of elements or attributes) on which the enclosing xModify
+command then operates on.</td>
+</tr>
+</table>
+</div>
+<div>
+<h4 class="Group">
+<img src="../../../images/minus.gif" id="complexAttributeDetailMinus" onClick="javascript:toggleDiv(this,'complexAttributeDetailDivID');">Attribute Details</h4>
+</div>
+<div id="complexAttributeDetailDivID" style="display:block;visibility:visible">
+<h3>
+<img align="top" src="../../../images/base.gif"><a name="select">select</a>
+</h3>
+<table class="TableDetail">
+<tr>
+<td valign="top" class="TableRightCell NameCell">About</td><td class="TableRightCell">
+The value of this attribute is any valid XPath query which returns a result
+set (usually a set of elements or attributes) on which the enclosing xModify
+command then operates on. <p>
+Shown below is a valid xModify command set containing just 1 command: remove-element.<br><br>
+
+<pre>
+ <xm:modifications version="1.0" xmlns:xm="http://openxal.org/core/xmodify"
+ document="mydocument">
+ <xm:remove-element select="/ui/rootPane/freePane[1]/button"/>
+ </xm:modifications>
+</pre>
+<br>
+The 'select' attribute of this command contains the following XPath query:
+"/ui/rootPane/freePane[1]/button". This query selects all buttons in the document "mydocument"
+that are children of the first child freePane of the rootPane element. All of these buttons
+are then removed from the document by the remove-element command.
+
+<br><br>
+When selecting elements in the HTML document be sure to capitalize the element names. This is
+a result of the way the are store in the browser. The following example will append a row to the table
+with an id of "myTable". Notice on the XPath statement also contains the TBODY which is
+standard on all tables.
+<br>
+<pre>
+ <xm:modifications version="1.0" xmlns:xm="http://openxal.org/core/xmodify"
+ document="html">
+ <xm:append select="TABLE[@id='myTable']/TBODY">
+ <![CDATA[ <tr><td>New Person</td></tr>
+ ]]>
+ </xm:append><br>
+ </xm:modifications><br>
+</pre>
+
+</td>
+</tr>
+<tr>
+<td valign="top" class="TableRightCell">Type</td><td class="TableRightCell">
+<p>
+<span class="Types"><a href="../../simpleTypes/html/select-attribute-type.html">select-attribute-type</a></span>
+</p>
+</td>
+</tr>
+<tr>
+<td valign="top" class="TableRightCell">Values</td><td class="TableRightCell"><span class="Types"></span></td>
+</tr>
+<tr>
+<td valign="top" class="TableRightCell">Usage</td><td class="TableRightCell">optional</td>
+</tr>
+</table>
+</div>
+<table class="FooterTable">
+<tr>
+<td align="left" width="50%" class="TableRowColor">Version: Based on Platform 4.5.7.1862</td><td align="right" class="TableRowColor"><span class="updateDate">last update: 2007-06-22</span></td>
+</tr>
+</table>
+<script src="http://www.google-analytics.com/urchin.js" language="javascript" type="text/javascript"></script><script>
+ uacct = "UA-2110702-1";
+ urchinTracker();
+ </script>
+</body>
+</html>
Added: incubator/xap/site/docs/xmodify/doc/complexTypes/html/remove-element-element-type.html
URL: http://svn.apache.org/viewvc/incubator/xap/site/docs/xmodify/doc/complexTypes/html/remove-element-element-type.html?view=auto&rev=550329
==============================================================================
--- incubator/xap/site/docs/xmodify/doc/complexTypes/html/remove-element-element-type.html (added)
+++ incubator/xap/site/docs/xmodify/doc/complexTypes/html/remove-element-element-type.html Sun Jun 24 20:05:18 2007
@@ -0,0 +1,165 @@
+<html xmlns:event="http://www.w3.org/2001/XMLSchema" xmlns:meta="http://www.w3.org/2001/XMLSchema" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
+<head>
+<META http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+<link rel="stylesheet" type="text/css" href="../../../css/stylesheet.css">
+</head>
+<body>
+<script src="../../../js/myJS.js" language="javascript" type="text/javascript"></script>
+<h2>
+<span class="smal">"http://openxal.org/core/xmodify"</span>
+<br>remove-element</h2>
+<div>
+<h4 class="Group">
+<img src="../../../images/minus.gif" id="complexOverviewMinus" onClick="
+ javascript:toggleDiv(this,'complexOverviewDivID');">Overview</h4>
+</div>
+<div id="complexOverviewDivID" style="display:block;visibility:visible"> <remove-element [attributes]/></div>
+<div>
+<h4 class="Group">
+<img src="../../../images/minus.gif" id="complexDocMinus" onClick="javascript:toggleDiv(this,'complexDocDivID');">Documentation</h4>
+</div>
+<div id="complexDocDivID" style="display:block;visibility:visible">
+<br>The remove-element command removes the elements returned by the XPath query of
+the command.<br><br>
+
+A sample remove-element command element looks like the following: <br><br>
+<pre>
+ <xm:modifications version="1.0" xmlns:xm="http://openxal.org/core/xmodify" document="mydocument"><br>
+ <xm:remove-element select="/ui/rootPane/freePane[1]/button[1]"/><br>
+ </xm:modifications><br><br>
+</pre>
+After the above command is executed, the first child button of the first child freePane
+of the rootPane element in the document "mydocument" will be removed.<br><br>
+
+The XPath query of the remove-element command must return the following set: ( Element )*.
+If any of the results of the XPath query is not an Element, an UpdateException is thrown
+and the execution of the <xm:modifications/> block is halted. If the XPath
+query selects the root Element of the Document, the root will be set to null. <br><br>
+
+<br><br>
+
+<h4>HTML Example:</h4>
+<br><br>
+<script language="JavaScript" type="text/javascript" src="../../../../../javascript/jquery/jquery-latest.js"></script>
+<script language="JavaScript" type="text/javascript" src="../../../../../javascript/xmodify/xmodify-jquery.js"></script>
+
+The buttons below can be used to clear and reset the values of the form inputs.
+<br><br>
+
+<p>
+<table style="width:310px" id="mytable">
+ <tr style="background-color:#aaa"><th width="150px" align="left">Employee ID</th><th width="150px" align="left">Full Name</th></tr>
+ <tr type="data"><td>3456g</td><td>Jane Smith</td></tr>
+ <tr type="data"><td>9876j</td><td>Larry Doyle</td></tr>
+<table>
+<input style="width:150px" type="button" value="Add row to table" onclick="$.xmodify({url:'../../../operations/adddatarow.xml'});"/>
+<input style="width:150px" type="button" value="Clear table" onclick="$.xmodify({url:'../../../operations/clear-table.xml'});"/>
+</p>
+
+<br>
+<p><b>clear-table.xml</b></p>
+<p>This file uses the remove-element xModify instruction to change the text of the input.
+The select attribute of the remove-element tag denotes the location of the elements to remove.
+</p>
+<pre>
+<xal xmlns:xm="http://openxal.org/core/xmodify">
+ <xm:modifications document="html">
+ <xm:remove-element select="TR[@type='data']"/>
+ </xm:modifications>
+</xal>
+</pre>
+
+</div>
+<div>
+<h4 class="Group">
+<img src="../../../images/minus.gif" id="complexAttributesMinus" onClick="javascript:toggleDiv(this,'complexAttributesDivID');">Attribute Summary</h4>
+</div>
+<div id="complexAttributesDivID" style="display:block;visibility:visible">
+<table>
+<tr>
+<td class="TableCellHeader NameCell">Attribute Name</td><td class="TableCellHeader">Type</td><td class="TableCellHeader">Description</td>
+</tr>
+<tr class="TableRowColor" valign="top" bgcolor="white">
+<td class="TableGroupCell" valign="top" colspan="3">Basic<br>
+</td>
+</tr>
+<tr class="TableRowColor" valign="top" bgcolor="white">
+<td class="TableRightCell NameCell" valign="top"><a href="#select">select</a></td><td valign="top" align="left" class="TableLeftCell"><a href="../../simpleTypes/html/select-attribute-type.html">select</a></td><td class="TableLeftCell">
+The value of this attribute is any valid XPath query which returns a result
+set (usually a set of elements or attributes) on which the enclosing xModify
+command then operates on.</td>
+</tr>
+</table>
+</div>
+<div>
+<h4 class="Group">
+<img src="../../../images/minus.gif" id="complexAttributeDetailMinus" onClick="javascript:toggleDiv(this,'complexAttributeDetailDivID');">Attribute Details</h4>
+</div>
+<div id="complexAttributeDetailDivID" style="display:block;visibility:visible">
+<h3>
+<img align="top" src="../../../images/base.gif"><a name="select">select</a>
+</h3>
+<table class="TableDetail">
+<tr>
+<td valign="top" class="TableRightCell NameCell">About</td><td class="TableRightCell">
+The value of this attribute is any valid XPath query which returns a result
+set (usually a set of elements or attributes) on which the enclosing xModify
+command then operates on. <p>
+Shown below is a valid xModify command set containing just 1 command: remove-element.<br><br>
+
+<pre>
+ <xm:modifications version="1.0" xmlns:xm="http://openxal.org/core/xmodify"
+ document="mydocument">
+ <xm:remove-element select="/ui/rootPane/freePane[1]/button"/>
+ </xm:modifications>
+</pre>
+<br>
+The 'select' attribute of this command contains the following XPath query:
+"/ui/rootPane/freePane[1]/button". This query selects all buttons in the document "mydocument"
+that are children of the first child freePane of the rootPane element. All of these buttons
+are then removed from the document by the remove-element command.
+
+<br><br>
+When selecting elements in the HTML document be sure to capitalize the element names. This is
+a result of the way the are store in the browser. The following example will append a row to the table
+with an id of "myTable". Notice on the XPath statement also contains the TBODY which is
+standard on all tables.
+<br>
+<pre>
+ <xm:modifications version="1.0" xmlns:xm="http://openxal.org/core/xmodify"
+ document="html">
+ <xm:append select="TABLE[@id='myTable']/TBODY">
+ <![CDATA[ <tr><td>New Person</td></tr>
+ ]]>
+ </xm:append><br>
+ </xm:modifications><br>
+</pre>
+
+</td>
+</tr>
+<tr>
+<td valign="top" class="TableRightCell">Type</td><td class="TableRightCell">
+<p>
+<span class="Types"><a href="../../simpleTypes/html/select-attribute-type.html">select-attribute-type</a></span>
+</p>
+</td>
+</tr>
+<tr>
+<td valign="top" class="TableRightCell">Values</td><td class="TableRightCell"><span class="Types"></span></td>
+</tr>
+<tr>
+<td valign="top" class="TableRightCell">Usage</td><td class="TableRightCell">optional</td>
+</tr>
+</table>
+</div>
+<table class="FooterTable">
+<tr>
+<td align="left" width="50%" class="TableRowColor">Version: Based on Platform 4.5.7.1862</td><td align="right" class="TableRowColor"><span class="updateDate">last update: 2007-06-22</span></td>
+</tr>
+</table>
+<script src="http://www.google-analytics.com/urchin.js" language="javascript" type="text/javascript"></script><script>
+ uacct = "UA-2110702-1";
+ urchinTracker();
+ </script>
+</body>
+</html>
Added: incubator/xap/site/docs/xmodify/doc/complexTypes/html/replace-children-element-type.html
URL: http://svn.apache.org/viewvc/incubator/xap/site/docs/xmodify/doc/complexTypes/html/replace-children-element-type.html?view=auto&rev=550329
==============================================================================
--- incubator/xap/site/docs/xmodify/doc/complexTypes/html/replace-children-element-type.html (added)
+++ incubator/xap/site/docs/xmodify/doc/complexTypes/html/replace-children-element-type.html Sun Jun 24 20:05:18 2007
@@ -0,0 +1,202 @@
+<html xmlns:event="http://www.w3.org/2001/XMLSchema" xmlns:meta="http://www.w3.org/2001/XMLSchema" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
+<head>
+<META http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+<link rel="stylesheet" type="text/css" href="../../../css/stylesheet.css">
+</head>
+<body>
+<script src="../../../js/myJS.js" language="javascript" type="text/javascript"></script>
+<h2>
+<span class="smal">"http://openxal.org/core/xmodify"</span>
+<br>replace-children</h2>
+<div>
+<h4 class="Group">
+<img src="../../../images/minus.gif" id="complexOverviewMinus" onClick="
+ javascript:toggleDiv(this,'complexOverviewDivID');">Overview</h4>
+</div>
+<div id="complexOverviewDivID" style="display:block;visibility:visible"> <replace-children [attributes]> <br> ( <span class="AnyElement">
+ Any element from any namespace
+ </span>* )? <br></replace-children> </div>
+<div>
+<h4 class="Group">
+<img src="../../../images/minus.gif" id="complexDocMinus" onClick="javascript:toggleDiv(this,'complexDocDivID');">Documentation</h4>
+</div>
+<div id="complexDocDivID" style="display:block;visibility:visible">
+<br>The replace-children command does the following: for each element returned
+by the XPath query, the element's children are removed; the command arguments
+are inserted in their place.
+<br><br>
+
+The XPath query must return the following set: ( Element | Document )*.
+If any of the results of the XPath query is not an Element or a Document, an
+UpdateException is thrown and the execution of the <xm:modifications/>
+block is halted. If the XPath query selects the Document object, the root
+Element will be replaced with the child of the directive Element. Note that
+only one child is expected in this case. If the directive element has more than
+one child when the XPath query selects the Document object, an xModifyException
+will be thrown.<br><br>
+
+The following logic applies to the arguments of the replace-children command based
+on the type of each argument:
+
+<ul>
+<li>value-of directive element is executed and the value of the bound variable will get
+inserted (not the directive element itself)
+<li>clone directive element is executed and the cloned elements (which is the result of
+ executing the command) will get inserted.
+<li>any other xModify directive element will get inserted as is.
+<li>element in any other namespace will be inserted as is. If the XPath query
+ returns more than 1 result, the element is cloned before the insertion to prevent
+ id conflicts (the clone is deep).
+<li>string argument is inserted as is.
+</ul>
+<br>
+
+<h4>Here is a XAL example:</h4><br>
+<pre>
+ <xm:modifications version="1.0" xmlns:xm="http://openxal.org/core/xmodify" document="mydocument">
+ <xm:replace-children select="id('mywindow')">
+ <freePane id="somePanel"/>
+ </xm:replace-children>
+ </xm:modifications>
+</pre>
+The above command will remove ALL of the children of the selected window (id="mywindow")
+and in their place will append the specified freePane (id="somePanel") so the window will
+have just 1 new child element after the command is executed.
+
+
+<br><br>
+
+<h4>HTML Example:</h4>
+<br><br>
+<script language="JavaScript" type="text/javascript" src="../../../../../javascript/jquery/jquery-latest.js"></script>
+<script language="JavaScript" type="text/javascript" src="../../../../../javascript/xmodify/xmodify-jquery.js"></script>
+
+Choose the anwser to the question and click "Submit", the results of the poll
+will be displayed.
+<br><br>
+<div style="border:1px solid #aaa;margin:10px;padding:10px;" id="replace-contents">
+ <div><b>Will the Redsox win the World Series?</b></div>
+ <div>
+ <input type="radio" name="yes">Yes<br>
+ <input type="radio" name="no">No<br>
+ <input style="width:150px" type="button" value="Submit" onclick="$.xmodify({url:'../../../operations/replace-children.xml'});"/>
+ </div>
+</div>
+<br>
+<p><b>replace-children.xml</b></p>
+<p>This file uses the replace-children xModify instruction to replace the children of the div that contains the poll.
+The select attribute of the replace tag denotes the location of the element to replace.
+Typically you will use a <![CDATA[ ]]> block to cut down on parse
+and traversal time.</p>
+<pre>
+<xal xmlns:xm="http://openxal.org/core/xmodify">
+ <xm:modifications document="html">
+ <xm:replace-children select="#replace-contents">
+ <![CDATA[
+ <div><b>Results of Poll.</b></div><br>
+ <div>
+ 100% Yes<br>
+ 0% No
+ </div>
+ </div>
+ ]]>
+ </xm:replace-children>
+ </xm:modifications>
+</xal>
+</pre>
+
+
+</div>
+<div>
+<h4 class="Group">
+<img src="../../../images/minus.gif" id="complexAttributesMinus" onClick="javascript:toggleDiv(this,'complexAttributesDivID');">Attribute Summary</h4>
+</div>
+<div id="complexAttributesDivID" style="display:block;visibility:visible">
+<table>
+<tr>
+<td class="TableCellHeader NameCell">Attribute Name</td><td class="TableCellHeader">Type</td><td class="TableCellHeader">Description</td>
+</tr>
+<tr class="TableRowColor" valign="top" bgcolor="white">
+<td class="TableGroupCell" valign="top" colspan="3">Basic<br>
+</td>
+</tr>
+<tr class="TableRowColor" valign="top" bgcolor="white">
+<td class="TableRightCell NameCell" valign="top"><a href="#select">select</a></td><td valign="top" align="left" class="TableLeftCell"><a href="../../simpleTypes/html/select-attribute-type.html">select</a></td><td class="TableLeftCell">
+The value of this attribute is any valid XPath query which returns a result
+set (usually a set of elements or attributes) on which the enclosing xModify
+command then operates on.</td>
+</tr>
+</table>
+</div>
+<div>
+<h4 class="Group">
+<img src="../../../images/minus.gif" id="complexAttributeDetailMinus" onClick="javascript:toggleDiv(this,'complexAttributeDetailDivID');">Attribute Details</h4>
+</div>
+<div id="complexAttributeDetailDivID" style="display:block;visibility:visible">
+<h3>
+<img align="top" src="../../../images/base.gif"><a name="select">select</a>
+</h3>
+<table class="TableDetail">
+<tr>
+<td valign="top" class="TableRightCell NameCell">About</td><td class="TableRightCell">
+The value of this attribute is any valid XPath query which returns a result
+set (usually a set of elements or attributes) on which the enclosing xModify
+command then operates on. <p>
+Shown below is a valid xModify command set containing just 1 command: remove-element.<br><br>
+
+<pre>
+ <xm:modifications version="1.0" xmlns:xm="http://openxal.org/core/xmodify"
+ document="mydocument">
+ <xm:remove-element select="/ui/rootPane/freePane[1]/button"/>
+ </xm:modifications>
+</pre>
+<br>
+The 'select' attribute of this command contains the following XPath query:
+"/ui/rootPane/freePane[1]/button". This query selects all buttons in the document "mydocument"
+that are children of the first child freePane of the rootPane element. All of these buttons
+are then removed from the document by the remove-element command.
+
+<br><br>
+When selecting elements in the HTML document be sure to capitalize the element names. This is
+a result of the way the are store in the browser. The following example will append a row to the table
+with an id of "myTable". Notice on the XPath statement also contains the TBODY which is
+standard on all tables.
+<br>
+<pre>
+ <xm:modifications version="1.0" xmlns:xm="http://openxal.org/core/xmodify"
+ document="html">
+ <xm:append select="TABLE[@id='myTable']/TBODY">
+ <![CDATA[ <tr><td>New Person</td></tr>
+ ]]>
+ </xm:append><br>
+ </xm:modifications><br>
+</pre>
+
+</td>
+</tr>
+<tr>
+<td valign="top" class="TableRightCell">Type</td><td class="TableRightCell">
+<p>
+<span class="Types"><a href="../../simpleTypes/html/select-attribute-type.html">select-attribute-type</a></span>
+</p>
+</td>
+</tr>
+<tr>
+<td valign="top" class="TableRightCell">Values</td><td class="TableRightCell"><span class="Types"></span></td>
+</tr>
+<tr>
+<td valign="top" class="TableRightCell">Usage</td><td class="TableRightCell">optional</td>
+</tr>
+</table>
+</div>
+<table class="FooterTable">
+<tr>
+<td align="left" width="50%" class="TableRowColor">Version: Based on Platform 4.5.7.1862</td><td align="right" class="TableRowColor"><span class="updateDate">last update: 2007-06-22</span></td>
+</tr>
+</table>
+<script src="http://www.google-analytics.com/urchin.js" language="javascript" type="text/javascript"></script><script>
+ uacct = "UA-2110702-1";
+ urchinTracker();
+ </script>
+</body>
+</html>