svn commit: r470569 - /incubator/xap/trunk/WebContent/XapConfig.js

[bb...@apache.org]

Author: bbuffone
Date: Thu Nov  2 14:26:45 2006
New Revision: 470569

URL: http://svn.apache.org/viewvc?view=rev&rev=470569
Log:
New Configuration file format for XAP.

Added:
    incubator/xap/trunk/WebContent/XapConfig.js

Added: incubator/xap/trunk/WebContent/XapConfig.js
URL: http://svn.apache.org/viewvc/incubator/xap/trunk/WebContent/XapConfig.js?view=auto&rev=470569
==============================================================================
--- incubator/xap/trunk/WebContent/XapConfig.js (added)
+++ incubator/xap/trunk/WebContent/XapConfig.js Thu Nov  2 14:26:45 2006
@@ -0,0 +1,87 @@
+/**
+ * This is the default Xap configuration file that will be used to specified 
+ * different runtime settings of the Xap application. Xap application provide
+ * for paramenter overriding in the following way.
+ *
+ * The default values for an application come from this file. When an application is loaded
+ * the developer can specify a configuration object to the Xap.createApplication method.
+ * any value in that object will override these parameters (Array parameters will NOT be merged).
+ * If the developer has specified page scaning then the Xap attributes on the HTML element
+ * will then override the values supplied to the Xap.createApplication. Each HTML element that is
+ * found is treated as a seperate XAP application.
+ *
+ * Parameter Override workflow:
+ * 1) This configuration file.
+ * 2a) The config object specified to the Xap.createApplication method.
+ * 2b) Any xap parameters embeded in a html element found during page scanning.
+ *
+ * For more information on using the JSON format go to www.json.org.
+ */
+{
+    /**
+     * This is the default name for the application.  Users can access this
+     * application by using the Xap.applications["myApplicationName"]
+     *
+     * Accepted Values: can be null, undefined, or any String.
+     */
+	applicationName: "xapApplication",
+	/**
+	 * This is the default starting page for the application.  When the application is 
+	 * started it will load this page to create the applications user interface.
+     *
+     * Accepted Values: can be null, undefined, or any url the is an acceptable Xal document.
+	 */
+	startPage: "index.xal",
+	/**
+	 * This is the default context for the application. When resources are loaded either by
+	 * using the request service or as a event handler.
+     *
+     * Accepted Values: The root of the application as compared to the start web page.
+	 */
+	context: "../../",
+	/**
+	 * This is the default toolkit type.
+     *
+     * Accepted Values: any defined toolkit.
+	 */
+	toolkitType: "dojo",
+	/**
+	 * This is the default list of plugin classes that will be loaded.  Place any class that needs
+	 * to be loaded into during initialization.
+     *
+     * Accepted Values: can be null, undefined, or any Array of class names.
+	 */
+    pluginClasses: [
+        "xap.mco.McoNamespaceHandler",
+        "xap.xml.xmodify.XmodifyNamespaceHandler",
+        "xap.macro.MacroNamespaceHandler",
+        "xap.xml.XalNamespaceHandler",
+        "xap.data.DataNamespaceHandler"
+        ],
+	/**
+	 * This is the default list of plugin classes that will be loaded.  Place any class that needs
+	 * to be loaded into during initialization. Plugin classes need to implement the "pluginLoaded"
+	 * method.
+     *
+     * Accepted Values: can be null, undefined, or any Array of class names.
+	 */
+    pluginFiles: [
+        "src/xap/taghandling/plugin.xml"
+        ],
+	/**
+	 * This is the default id of the html element that will host the Xap application.
+	 * If the element is null or undefined then the root is assumed to be the body.
+     *
+     * Accepted Values: can be null, undefined, or id of the element that will be the 
+     *                  root of the application.
+	 */
+    element: null,
+	/**
+	 * The loggingEnabled value determines whether or not logging is turned on in the Xap client.
+	 * if logging is enabled then a new window will open that has the log produced by the Xap client
+	 * during runtime.  It is not recommended to close the logging window during execution.
+     *
+     * Accepted Values: can be null, undefined, or true / false.
+	 */
+	logging: true
+}
\ No newline at end of file