biapplication.xml

来自「ajax 框价．是个好工具．javascript 矿家．可以用在任何平台．」· XML 代码 · 共 248 行

<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="api.xsl"?>
<class name="BiApplication" extends="BiEventTarget">
	<description>This is a singleton class and the instance can be found as
 the global <code>application</code> object.</description>
	<arguments>
	</arguments>
	<staticMethods>
	</staticMethods>
	<staticFields>
	</staticFields>
	<methods>
		<method name="start">
			<description>Starts the application. If any arguments are passed to this method then these
 are used, otherwise the arguments passed to the page are used.</description>
			<arguments>
				<argument name="sRootPath" optional="true">
					<description>The path to where Bindows resides. This is usually the path where bimain.html can be found.</description>
					<type>String</type>
				</argument>
				<argument name="sAdfPath" optional="true">
					<description>The path to the ADF file. If this is a relative path it is relative to the current document. If this is left
                              out then the <link>adfPath</link> is used.</description>
					<type>String</type>
				</argument>
				<argument name="oArgs" optional="true">
					<description>Any number of arguments that will be passed to the main ADF method. </description>
					<type>Object</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="getResourceById">
			<description>Returns the object created by the <link>resourceLoader</link> with the given id.</description>
			<arguments>
				<argument name="sId">
					<description>The id of the resource object</description>
					<type>String</type>
				</argument>
			</arguments>
			<returns>
				<type>Object</type>
			</returns>
		</method>
		<method name="getComponentById">
			<description>Returns the object created by the Bindows markup, in the Window part, with the given id.</description>
			<arguments>
				<argument name="sId">
					<description>The id of the object</description>
					<type>String</type>
				</argument>
			</arguments>
			<returns>
				<type>Object</type>
			</returns>
		</method>
		<method name="flushLayoutQueue">
			<description>This method is used internally to update the layout of existing components</description>
			<arguments>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="getPackage">
			<description>Returns an array containing the paths to the files in the package</description>
			<arguments>
				<argument name="sName">
					<description>The name of the package</description>
					<type>String</type>
				</argument>
			</arguments>
			<returns>
				<type>String[]</type>
			</returns>
		</method>
		<method name="addPackage">
			<description>Adds a named package to the known packages. The second argument is an
 array containing the paths to the files in the package. These paths are
 relative to the system root</description>
			<arguments>
				<argument name="sName">
					<description>The name of the package</description>
					<type>String</type>
				</argument>
				<argument name="oFiles">
					<description>An array containing the paths to the files in the package</description>
					<type>String[]</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
	</methods>
	<properties>
		<property name="version" get="true">
			<description>Returns the version of the Bindows framework.</description>
			<type>String</type>
		</property>
		<property name="path" get="true">
			<description>Returns the directory path of the Bindows root</description>
			<type>
				<link class="BiUri">BiUri</link>
			</type>
		</property>
		<property name="adfPath" get="true">
			<description>Returns the directory path of the ADF</description>
			<type>String</type>
		</property>
		<property name="progressStatus" get="true" set="true">
			<description>This is the progress status text shown while loading</description>
			<type>String</type>
		</property>
		<property name="window" get="true">
			<description>Returns the<link class="BiApplicationWindow">BiApplicationWindow</link> representing the browser window in which the
 application is running.</description>
			<type>
				<link class="BiApplicationWindow">BiApplicationWindow</link>
			</type>
		</property>
		<property name="adf" get="true">
			<description>Returns the<link class="BiAdf">BiAdf</link> instance</description>
			<type>
				<link class="BiAdf">BiAdf</link>
			</type>
		</property>
		<property name="uri" get="true">
			<description>Returns the full URI of the current page</description>
			<type>
				<link class="BiUri">BiUri</link>
			</type>
		</property>
		<property name="accessibilityMode" get="true" set="true">
			<description>This property can be used to tell whether the application should be in an
 accessibility mode. This does not really do anything and it is up to the
 components and implementations to make sure of this.</description>
			<type>Boolean</type>
		</property>
		<property name="autoNameMapping" get="true" set="true">
			<description>When this is true any XML object that has an id attribute will create a
 global reference to the object created from this XML element. This property
 is mapped to the <link class="BiAdf" field="xmlResourceParser">xmlResourceParser</link> as well as the resource
 loader used to load the resources.</description>
			<type>Boolean</type>
		</property>
		<property name="focusOnLoad" get="true" set="true">
			<description>Whether to try to focus the window when the application loads</description>
			<type>Boolean</type>
		</property>
		<property name="resourceLoader" get="true">
			<description>Returns the resource loader used to load the core script files
 as well as the resources defined in the ADF.</description>
			<type>
				<link class="BiResourceLoader">BiResourceLoader</link>
			</type>
		</property>
		<property name="themeManager" get="true">
			<description>The theme manager keeps track of exisiting themese and more</description>
			<type>
				<link class="BiThemeManager">BiThemeManager</link>
			</type>
		</property>
		<property name="theme" get="true">
			<description>Returns the currently used theme</description>
			<type>
				<link class="BiTheme">BiTheme</link>
			</type>
		</property>
		<property name="packages" get="true">
			<description>Returns an array containing the names of the known packages</description>
			<type>String[]</type>
		</property>
		<property name="defaultPackages" get="true" set="true">
			<description>The default packages to load. This needs to be set before the loading
 actually starts. To do this you can use an attribute in the Application tag
 in your ADF or set this in the HTML file hosting your application.<br>
				</br>
				<br>
				</br>
 If you just want to add a few packages then use a Package tag in your Resources
 section of the ADF.</description>
			<type>String[]</type>
		</property>
		<property name="stringBundle" get="true" set="true">
			<description>The string bundle to use for this wizard pane. If this is set to <code>null</code>
 then the static string bundle for<link class="BiWizardPane">BiWizardPane</link> is used</description>
			<type>
				<link class="BiStringBundle">BiStringBundle</link>
			</type>
		</property>
	</properties>
	<events>
		<event name="dispose">
			<description>Fires just before the application is disposed.
 										This allows you to clean up your main program
                                      before closing the application window.</description>
			<type>
				<link class="BiEvent">BiEvent</link>
			</type>
		</event>
		<event name="progressstatus">
			<description>Fires when the progress status has changed.</description>
			<type>
				<link class="BiEvent">BiEvent</link>
			</type>
		</event>
		<event name="resourcesready">
			<description>This is fired after the Bindows markup has been
 										handled but before the main method is called.</description>
			<type>
				<link class="BiEvent">BiEvent</link>
			</type>
		</event>
		<event name="load">
			<description>This is fired when everything has been loaded
 										and initialized. This is called after the main
                                      method has been called.</description>
			<type>
				<link class="BiEvent">BiEvent</link>
			</type>
		</event>
	</events>
	<remarks>The text that is shown during startup can be localized by changing the
 			<link>stringBundle</link> for the application object. The following keys
          are currently used:<br>
		</br>
		<br>
		</br>
          ApplicationIncorrectAdfArgument - The string to show when the ADF argument is incorrect<br>
		</br>
          ApplicationLoadingAdf - The string to show when the ADF file is loading<br>
		</br>
          ApplicationNoAdf - The string to show when the ADF is not specified<br>
		</br>
          ApplicationAdfLoaded - The string to show when the ADF file is loaded<br>
		</br>
          ApplicationAdfLoadError - The string to show when there was an error loading the ADF<br>
		</br>
          ApplicationAdfLoadErrorDetails - The string to use when showing the details of the ADF load error. This may contain %1 - %3 which maps to URI, HTTP status code and HTTP status text<br>
		</br>
          ApplicationLoadingResources - The string to show when loading resources. This may contain %1 and %2 which maps to the number of loaded resources and the total number of resources.<br>
		</br>
          ApplicationLoadingCompleted - The string to show when the loading is complete</remarks>
</class>