bitextfield.xml

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

<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="api.xsl"?>
<class name="BiTextField" extends="BiComponent">
	<description>This class is used to display a single line plain text input</description>
	<arguments>
		<argument name="sText" optional="true" default="&quot;&quot;">
			<description>The text to show in the text field </description>
			<type>String</type>
		</argument>
	</arguments>
	<staticMethods>
		<method name="createRegExpValidator">
			<description>This method takes a regular expression object and returns
 a function that can then be used for the <link>validator</link>
 property.</description>
			<arguments>
				<argument name="oRegExp">
					<description>The regular expression that will be tested against the
 								text of the text field.</description>
					<type>RegExp</type>
				</argument>
			</arguments>
			<returns>
				<type>Function</type>
			</returns>
		</method>
	</staticMethods>
	<staticFields>
	</staticFields>
	<methods>
		<method name="selectAll">
			<description>Selects all text in the text field</description>
			<arguments>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="setPadding">
			<description>Sets the padding on more than one side. This method can ba called with 1, 2
  or 4 arguments. In case of 1 argument it sets the padding on all sides. If 2
  arguments are used then the padding on the left/right and top/bottom are set
  to the same. And if called with 4 all 4 sides can have different padding,<br>
				</br>
				<br>
				</br>
  setPadding(nPadding) - Sets the padding on all sides to nPadding<br>
				</br>
  setPadding(nLeftRight, nTopBottom) - Sets the padding on the left and right to nLeftRight and the padding on the top and bottom to nTopBottom<br>
				</br>
  setPadding(nLeft, nRight, nTop, nBottom) - Sets the padding on all sides to nLeft, nRight, nTop and nBottom respectively.<br>
				</br>
			</description>
			<arguments>
				<argument name="nLeft">
					<description>Left padding</description>
					<type>Number</type>
				</argument>
				<argument name="nRight" optional="true">
					<description>Right padding </description>
					<type>Number</type>
				</argument>
				<argument name="nTop" optional="true">
					<description>Top padding </description>
					<type>Number</type>
				</argument>
				<argument name="nBottom" optional="true">
					<description>Bottom padding </description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
	</methods>
	<properties>
		<property name="text" get="true" set="true">
			<description>The text on the text field</description>
			<type>String</type>
		</property>
		<property name="font" get="true" set="true">
			<description>This is used to describe how to paint the text in the text field.</description>
			<type>
				<link class="BiFont">BiFont</link>
			</type>
		</property>
		<property name="align" get="true" set="true">
			<description>The text alignment. Valid values are:<br>
				</br>
				<br>
				</br>
				<code>left</code>
				<br>
				</br>
				<code>right</code>
				<br>
				</br>
				<code>center</code>
			</description>
			<type>String</type>
		</property>
		<property name="maxLength" get="true" set="true">
			<description>The maximum number of characters that the user can enter into the text field</description>
			<type>Number</type>
		</property>
		<property name="readOnly" get="true" set="true">
			<description>Whether the user can enter text in the text field</description>
			<type>Boolean</type>
		</property>
		<property name="validator" get="true" set="true">
			<description>This property is a function that is used to validate the text of
 the text field. The function should take a string and return
 <code>true</code> if the text is valid.</description>
			<type>Function</type>
		</property>
		<property name="invalidMessage" get="true" set="true">
			<description>This property can be used to give information about why the value
 might be invalid.</description>
			<type>String</type>
		</property>
		<property name="isValid" get="true">
			<description>Uses the validator to determine whether the text inside
 the component is valid.</description>
			<type>Boolean</type>
		</property>
		<property name="selectionStart" get="true" set="true">
			<description>The starting point of the selection in the text field. If not selected this
 returns -1.</description>
			<type>Number</type>
		</property>
		<property name="selectionLength" get="true" set="true">
			<description>The length (number of chracters) of the currently selected text in the text field</description>
			<type>Number</type>
		</property>
		<property name="selectionText" get="true" set="true">
			<description>The currently selected text in the text field</description>
			<type>String</type>
		</property>
		<property name="allowTab" get="true" set="true">
			<description>Whether pressing the tab key should insert a tab character or move the focus from
 the text field</description>
			<type>Boolean</type>
		</property>
		<property name="paddingLeft" get="true" set="true">
			<description>The left padding (in pixels)</description>
			<type>Number</type>
		</property>
		<property name="paddingRight" get="true" set="true">
			<description>The right padding (in pixels)</description>
			<type>Number</type>
		</property>
		<property name="paddingTop" get="true" set="true">
			<description>The top padding (in pixels)</description>
			<type>Number</type>
		</property>
		<property name="paddingBottom" get="true" set="true">
			<description>The bottom padding (in pixels)</description>
			<type>Number</type>
		</property>
	</properties>
	<events>
		<event name="action">
			<description>This event is fired when the enter key is pressed</description>
			<type>
				<link class="BiEvent">BiEvent</link>
			</type>
		</event>
		<event name="textchanged">
			<description>This event is fired when the text has changed.
 									This happens when the user in some way changes
                                  the text inside the text field. This event
                                  is fired continiously as the user types.</description>
			<type>
				<link class="BiEvent">BiEvent</link>
			</type>
		</event>
		<event name="change">
			<description>This event is fired when the text field is blurred
 								and the text has changed since the text field got
                              focus.</description>
			<type>
				<link class="BiEvent">BiEvent</link>
			</type>
		</event>
	</events>
	<remarks>To change the font of the component you have to use
 			<link field="font">setFont()</link>. Changing the
          font object without calling <link field="font">setFont()</link>
          will not update the component.<br>
		</br>
		<br>
		</br>
          If the text field has a <link class="BiComponent" field="command">command</link>
          the command will be <link class="BiCommand" field="execute">executed</link>
          when the user presses the enter key.</remarks>
</class>