bithememanager.xml

ajax 框价．是个好工具．javascript 矿家．可以用在任何平台．

<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="api.xsl"?>
<class name="BiThemeManager" extends="BiEventTarget">
	<description>This singleton class is used for theme support in Bindows</description>
	<arguments>
	</arguments>
	<staticMethods>
	</staticMethods>
	<staticFields>
	</staticFields>
	<methods>
		<method name="setClassAppearance">
			<description>Makes all component of this class use a certain appearance</description>
			<arguments>
				<argument name="fClass">
					<description>The constructor function for the class</description>
					<type>Function</type>
				</argument>
				<argument name="sName">
					<description>The name of the appearance to use</description>
					<type>String</type>
				</argument>
				<argument name="bManual" optional="true" default="false">
					<description>Whether the component handles the events manually </description>
					<type>Boolean</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="setAppearance">
			<description>Makes the component use a certain appearance</description>
			<arguments>
				<argument name="oComp">
					<description>The compoent to set the appearance to</description>
					<type>
						<link class="BiComponent">BiComponent</link>
					</type>
				</argument>
				<argument name="sName">
					<description>The name of the appearance to use</description>
					<type>String</type>
				</argument>
				<argument name="bManual" optional="true" default="false">
					<description>Whether the component handles the events manually </description>
					<type>Boolean</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="addAppearanceListeners">
			<description>This adds event listeners to the component so that the interactive
 appearance states are applied as needed.</description>
			<arguments>
				<argument name="oComp">
					<description>The component to add the event listeners to</description>
					<type>
						<link class="BiComponent">BiComponent</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="removeAppearanceListeners">
			<description>This removes event listeners from the component so that the interactive
 appearance states are no longer automaticallye applied.</description>
			<arguments>
				<argument name="oComp">
					<description>The component to add the event listeners to</description>
					<type>
						<link class="BiComponent">BiComponent</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="addAppearance">
			<description>This assigns the appearance to a component and adds event listeners that
 allows the look and feel to change based on the states</description>
			<arguments>
				<argument name="oComp">
					<description>The component to set the appearance on</description>
					<type>
						<link class="BiComponent">BiComponent</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="getAppearanceStates">
			<description>This returns the states that the appearance supports</description>
			<arguments>
				<argument name="sName">
					<description>The name of the appearance</description>
					<type>String</type>
				</argument>
			</arguments>
			<returns>
				<type>Number</type>
			</returns>
		</method>
		<method name="getThemeStates">
			<description>This returns a hash (Object) containing the names of the interactive appearance
 states that the component has.</description>
			<arguments>
				<argument name="oComp">
					<description>The component to get the theme states for.</description>
					<type>
						<link class="BiComponent">BiComponent</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>Object</type>
			</returns>
		</method>
		<method name="getCurrentState">
			<description>Returns the current state of the component</description>
			<arguments>
				<argument name="oComp">
					<description>The component to get the states for.</description>
					<type>
						<link class="BiComponent">BiComponent</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>Object</type>
			</returns>
		</method>
		<method name="getHasInteractiveTheme">
			<description>This returns true if the given component has any interactive appearance states</description>
			<arguments>
				<argument name="oComp">
					<description>The component to test for interactive appearance.</description>
					<type>
						<link class="BiComponent">BiComponent</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>Boolean</type>
			</returns>
		</method>
		<method name="getAppearanceTag">
			<description>This returns a string that is added to the CSS class name for the element
 representing a component.</description>
			<arguments>
				<argument name="oComp">
					<description>The component to get the appearance tag for.</description>
					<type>
						<link class="BiComponent">BiComponent</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>String</type>
			</returns>
		</method>
		<method name="applyAppearance">
			<description>Updates the appearance of the given component. This basically updates the
 CSS class name to reflect the current state.</description>
			<arguments>
				<argument name="oComp">
					<description>The component to apply the appearance to.</description>
					<type>
						<link class="BiComponent">BiComponent</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="addState">
			<description>Adds a pseudo state to the appearance for the given component. For example
 adding "active" to the component will result in taking the look of an active
 appearance the next time <link>applyAppearance</link> is called.</description>
			<arguments>
				<argument name="oComp">
					<description>The component to add the appearance state to</description>
					<type>
						<link class="BiComponent">BiComponent</link>
					</type>
				</argument>
				<argument name="sPseudo">
					<description>The pseudo state to add to the appearance</description>
					<type>String</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="removeState">
			<description>Removes a pseudo state to the appearance for the given component.</description>
			<arguments>
				<argument name="oComp">
					<description>The component to remove the appearance state from</description>
					<type>
						<link class="BiComponent">BiComponent</link>
					</type>
				</argument>
				<argument name="sPseudo">
					<description>The pseudo state to remove from the appearance</description>
					<type>String</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="setStateValue">
			<description>Adds or removes a pseudo state from the appearance for the given component.</description>
			<arguments>
				<argument name="oComp">
					<description>The component to remove the appearance state from</description>
					<type>
						<link class="BiComponent">BiComponent</link>
					</type>
				</argument>
				<argument name="sPseudo">
					<description>The pseudo state to remove from the appearance</description>
					<type>String</type>
				</argument>
				<argument name="bAdd">
					<description>Whether to add or remove the pseudo state</description>
					<type>Boolean</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="addTheme">
			<description>Adds a theme to the theme manager</description>
			<arguments>
				<argument name="oTheme">
					<description>The theme object to add</description>
					<type>
						<link class="BiTheme">BiTheme</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="removeTheme">
			<description>Removes a theme from the theme manager</description>
			<arguments>
				<argument name="oTheme">
					<description>The theme object to remove</description>
					<type>
						<link class="BiTheme">BiTheme</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="addCssRule">
			<description>Adds a CSS rule to the document</description>
			<arguments>
				<argument name="sSelector">
					<description>The selector describing which elements the rule
 								applies to</description>
					<type>String</type>
				</argument>
				<argument name="sStyle">
					<description>The CSS text describing the style of the rule.</description>
					<type>String</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="removeCssRule">
			<description>Removes all CSS rule that matches the given selector</description>
			<arguments>
				<argument name="sSelector">
					<description>The selector describing which rule to removee.</description>
					<type>String</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
	</methods>
	<properties>
		<property name="themes" get="true">
			<description>This is an array containing the added themes.</description>
			<type>
				<link class="BiTheme">BiTheme[]</link>
			</type>
		</property>
		<property name="defaultTheme" get="true" set="true">
			<description>The theme that is currently being used</description>
			<type>
				<link class="BiTheme">BiTheme</link>
			</type>
		</property>
	</properties>
	<events>
		<event name="themechanged">
			<description>This event is fired when the <link field="defaultTheme">default
 									theme</link> changes.</description>
			<type>
				<link class="BiEvent">BiEvent</link>
			</type>
		</event>
	</events>
	<remarks>
	</remarks>
</class>