bidateformat.xml

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

<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="api.xsl"?>
<class name="BiDateFormat" extends="BiObject">
	<description>This class is used to format and parse dates. It is based on the Java class
 <link href="http://java.sun.com/j2se/1.4.2/docs/api/java/text/SimpleDateFormat.html">SimpleDateFormat</link>.</description>
	<arguments>
		<argument name="sPattern">
			<description>A pattern describing the date format.</description>
			<type>String</type>
		</argument>
		<argument name="sLanguage" optional="true">
			<description>Optional string describing the locale</description>
			<type>String</type>
		</argument>
	</arguments>
	<staticMethods>
		<method name="getDateInstance">
			<description>Creates a new<link class="BiDateFormat">BiDateFormat</link> object that uses a date pattern.</description>
			<arguments>
				<argument name="sType">
					<description>Whether to use a short, medium or long date pattern</description>
					<type>String</type>
				</argument>
				<argument name="sLanguage" optional="true">
					<description>Optional string identifying the locale.</description>
					<type>String</type>
				</argument>
			</arguments>
			<returns>
				<type>
					<link class="BiDateFormat">BiDateFormat</link>
				</type>
			</returns>
		</method>
		<method name="getDateTimeInstance">
			<description>Creates a new<link class="BiDateFormat">BiDateFormat</link> object that uses a date time pattern.</description>
			<arguments>
				<argument name="sType">
					<description>Whether to use a short, medium or long date time pattern</description>
					<type>String</type>
				</argument>
				<argument name="sLanguage" optional="true">
					<description>Optional string identifying the locale.</description>
					<type>String</type>
				</argument>
			</arguments>
			<returns>
				<type>
					<link class="BiDateFormat">BiDateFormat</link>
				</type>
			</returns>
		</method>
		<method name="getTimeInstance">
			<description>Creates a new<link class="BiDateFormat">BiDateFormat</link> object that uses a time pattern.</description>
			<arguments>
				<argument name="sType">
					<description>Whether to use a short, medium or long time pattern</description>
					<type>String</type>
				</argument>
				<argument name="sLanguage" optional="true">
					<description>Optional string identifying the locale.</description>
					<type>String</type>
				</argument>
			</arguments>
			<returns>
				<type>
					<link class="BiDateFormat">BiDateFormat</link>
				</type>
			</returns>
		</method>
	</staticMethods>
	<staticFields>
		<field name="SHORT">
			<description>Constant for short date format pattern</description>
			<type>String</type>
		</field>
		<field name="MEDIUM">
			<description>Constant for medium date format pattern</description>
			<type>String</type>
		</field>
		<field name="LONG">
			<description>Constant for long date format pattern</description>
			<type>String</type>
		</field>
	</staticFields>
	<methods>
		<method name="format">
			<description>This takes a date object and outputs a string formatted according to
 the provided <link>pattern</link>
			</description>
			<arguments>
				<argument name="oDate">
					<description>The date to format</description>
					<type>Date</type>
				</argument>
			</arguments>
			<returns>
				<type>String</type>
			</returns>
		</method>
		<method name="parse">
			<description>This takes a string describing the date and uses the current pattern to
 parse it to javascript date object. If <link>lenient</link> is <code>true</code>
 this will also try to parse the string even if it does not match the pattern.<br>
				</br>
				<br>
				</br>
 If this fails an exception will be thrown.</description>
			<arguments>
				<argument name="sDate">
					<description>The string describing the date</description>
					<type>String</type>
				</argument>
			</arguments>
			<returns>
				<type>Date</type>
			</returns>
		</method>
	</methods>
	<properties>
		<property name="dateFormatSymbols" get="true" set="true">
			<description>The date format symbols used to define how to parse and format strings and
 dates</description>
			<type>
				<link class="BiDateFormatSymbols">BiDateFormatSymbols</link>
			</type>
		</property>
		<property name="pattern" get="true" set="true">
			<description>The pattern to use when formatting and parsing</description>
			<type>String</type>
		</property>
		<property name="localizedPattern" get="true" set="true">
			<description>The pattern using localized pattern characters</description>
			<type>String</type>
		</property>
		<property name="lenient" get="true" set="true">
			<description>When this is <code>true</code> parsing will try to parse the string even
 though it does not correctly match the given pattern. For example it will
 try to use the Javascript Date parse method.</description>
			<type>Boolean</type>
		</property>
	</properties>
	<events>
	</events>
	<remarks>Some limitations compared to the java class apply. For example
 			where Java uses a Locale class Bindows uses a string.<br>
		</br>
		<br>
		</br>
             The formatting and parsing of the timezone ('z') are limited to
             the following format: "GMT-23:59".<br>
		</br>
		<br>
		</br>
             'w' (week in year), 'W' (week in month) and 'D' (day in year) are
             not supported.</remarks>
</class>