bicolorpicker.xml

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

<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="api.xsl"?>
<class name="BiColorPicker" extends="BiDialog">
	<description>This dialog allows the user to select a predefined color or define his
 own color.</description>
	<arguments>
	</arguments>
	<staticMethods>
		<method name="hslToRgb">
			<description>This takes an hsl object with h (0 - 360), s (0 - 1) and l (0 - 1) fields
 and returns an rgb object with r (0 - 255), g (0 - 255) and b (0 - 255) fields.</description>
			<arguments>
				<argument name="hsl">
					<description>An object describing the hsl triplet</description>
					<type>Object</type>
				</argument>
			</arguments>
			<returns>
				<type>Object</type>
			</returns>
		</method>
		<method name="rgbToHsl">
			<description>This takes an rgb object with r (0 - 255), g (0 - 255) and b (0 - 255) fields
 and returns an hsl object with h (0 - 360), s (0 - 1) and l (0 - 1) fields.</description>
			<arguments>
				<argument name="rgb">
					<description>An object describing the rgb triplet</description>
					<type>Object</type>
				</argument>
			</arguments>
			<returns>
				<type>Object</type>
			</returns>
		</method>
		<method name="getRgbFromRgbString">
			<description>This returns an rgb object from an rgb string (<code>"rgb(255,255,255)"</code>)</description>
			<arguments>
				<argument name="s">
					<description>An rgb string</description>
					<type>String</type>
				</argument>
			</arguments>
			<returns>
				<type>Object</type>
			</returns>
		</method>
		<method name="getRgbStringFromRgb">
			<description>This returns an rgb string (<code>"rgb(255,255,255)"</code>) from an rgb object</description>
			<arguments>
				<argument name="rgb">
					<description>An object describing the rgb triplet</description>
					<type>Object</type>
				</argument>
			</arguments>
			<returns>
				<type>String</type>
			</returns>
		</method>
	</staticMethods>
	<staticFields>
		<field name="HUE_SATURATION_IMAGE_URI">
			<description>The URI to the image to use as the hue saturarion map</description>
			<type>String</type>
		</field>
		<field name="HUE_SATURATION_HANDLE_IMAGE_URI">
			<description>The URI to the image to use as the handle for the hue saturation map</description>
			<type>String</type>
		</field>
		<field name="BRIGHTNESS_IMAGE_URI">
			<description>The URI to the image to use as the image for the brightness</description>
			<type>String</type>
		</field>
		<field name="BRIGHTNESS_HANDLE_IMAGE_URI">
			<description>The URI to the image to use as the handle for the brightness</description>
			<type>String</type>
		</field>
	</staticFields>
	<methods>
	</methods>
	<properties>
		<property name="rgbString" get="true" set="true">
			<description>The rgb string (<code>"rgb(255,255,255)"</code>) describing the selected color.</description>
			<type>String</type>
		</property>
		<property name="rgb" get="true" set="true">
			<description>The rgb triplet describing the selected color.
 The rgb triplet is an object with r (0 - 255), g (0 - 255) and b (0 - 255) fields</description>
			<type>Object</type>
		</property>
		<property name="hsl" get="true" set="true">
			<description>The hsl triplet describing the selected color.
 The hsl triplet is an object with h (0 - 360), s (0 - 1) and l (0 - 1) fields</description>
			<type>Object</type>
		</property>
		<property name="stringBundle" get="true" set="true">
			<description>The string bundle to use for this color picker. If this is set to <code>null</code>
 then the static string bundle for<link class="BiColorPicker">BiColorPicker</link> is used</description>
			<type>
				<link class="BiStringBundle">BiStringBundle</link>
			</type>
		</property>
	</properties>
	<events>
		<event name="change">
			<description>This event fires continiously when the user changes the color.
 								If you want to know when the user closes the dialog use the
                              <link class="BiDialog" field="dialogresult">dialogresult</link>
                              event inherited from the <link class="BiDialog">BiDialog</link>.</description>
			<type>
				<link class="BiEvent">BiEvent</link>
			</type>
		</event>
	</events>
	<remarks>To prevent a dialog from being disposed when it is closed you can use the
 			<link class="BiWindow" field="beforeclose">beforeclose</link> event and then
          prevent the default action. This prevents the window from being closed and
          hidden. Then you can manually hide it by setting
          <link class="BiComponent" field="visible">visible</link> to <code>false</code>.<br>
		</br>
		<br>
		</br>
          Use the <link class="BiDialog" field="dialogresult">dialogresult</link>
          event to get a notification when the user has selected a color. If the
          user canceled the dialog the <link class="BiDialog" field="dialogResult">dialogResult</link>
          property is set to null.<br>
		</br>
		<br>
		</br>
 			The text for the buttons and labels are provided by a<link class="BiStringBundle">BiStringBundle</link>
 			and the following keys are used:<br>
		</br>
		<br>
		</br>
          ColorPickerCaption - The text to use for the dialog caption<br>
		</br>
          ColorPickerOK<br>
		</br>
          ColorPickerCancel<br>
		</br>
          ColorPickerHue - The label next to the hue input<br>
		</br>
          ColorPickerSat<br>
		</br>
          ColorPickerLum<br>
		</br>
          ColorPickerRed<br>
		</br>
          ColorPickerGreen<br>
		</br>
          ColorPickerBlue<br>
		</br>
          ColorPickerSelectedColor - The label next to the selected color<br>
		</br>
	</remarks>
</class>