incubator-xap-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From bbuff...@apache.org
Subject svn commit: r474002 - /incubator/xap/trunk/src/xap/Xap.js
Date Sun, 12 Nov 2006 17:36:04 GMT
Author: bbuffone
Date: Sun Nov 12 09:36:03 2006
New Revision: 474002

URL: http://svn.apache.org/viewvc?view=rev&rev=474002
Log:
updated documentation.

Modified:
    incubator/xap/trunk/src/xap/Xap.js

Modified: incubator/xap/trunk/src/xap/Xap.js
URL: http://svn.apache.org/viewvc/incubator/xap/trunk/src/xap/Xap.js?view=diff&rev=474002&r1=474001&r2=474002
==============================================================================
--- incubator/xap/trunk/src/xap/Xap.js (original)
+++ incubator/xap/trunk/src/xap/Xap.js Sun Nov 12 09:36:03 2006
@@ -17,6 +17,12 @@
  
 /**
  * @class 
+ * Xap is the main interface to the Xap Ajax Markup Engine.  Use this class to 
+ * create the Xap application(s) with-in an HTML page.<br><br>
+ * Use the creatApplication and createEmbeddedApplication methods. Xap is designed to 
+ * be used in different mode.  If applications require only the ability to update the 
+ * HTML UI; then use Xap with out any Xap components.  For applications that require a full
+ * Rich desktop style application then the complete framework can be used.
  */
 
 /** 
@@ -70,6 +76,19 @@
  * 	<li>applicationName</li>
  * 	<li>configFilePath</li>
  * </ul>
+ * <br><br>
+ *<pre>
+ *&lt;script language="JavaScript" type="text/javascript"&gt;
+ *var myAppArray = null;
+ *function launch() {	    
+ *   myAppArray = Xap.createEmbeddedApplications();	
+ *   myAppArray["myEmbbeddedApp"].getSession();
+ *}	
+ *&lt;/script&gt;
+ *&lt;/head&gt;
+ *&lt;body onload="launch();"&gt;
+ *&lt;div startPage="index.xal" applicationName="myEmbbeddedApp"&gt; 
+ *</pre>
  * @return window.xapApplications array object that contains all the applications created
  * by scanniing the HTML document.
  * @type Array



Mime
View raw message