bicalendar.xml

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

<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="api.xsl"?>
<class name="BiCalendar" extends="BiComponent">
	<description>This class represents a calendar control</description>
	<arguments>
		<argument name="oDate" optional="true">
			<description>Optional javascript date object used to determine
 						the month that should be displayed when the calendar
                         is created.</description>
			<type>Date</type>
		</argument>
	</arguments>
	<staticMethods>
		<method name="isSameDay">
			<description>This returns true if two dates represent the same day</description>
			<arguments>
				<argument name="d1">
					<description>The first date to compare</description>
					<type>Date</type>
				</argument>
				<argument name="d2">
					<description>The second date to compare</description>
					<type>Date</type>
				</argument>
			</arguments>
			<returns>
				<type>Boolean</type>
			</returns>
		</method>
		<method name="isSameMonth">
			<description>This returns true if two dates represent the same month</description>
			<arguments>
				<argument name="d1">
					<description>The first date to compare</description>
					<type>Date</type>
				</argument>
				<argument name="d2">
					<description>The second date to compare</description>
					<type>Date</type>
				</argument>
			</arguments>
			<returns>
				<type>Boolean</type>
			</returns>
		</method>
	</staticMethods>
	<staticFields>
	</staticFields>
	<methods>
		<method name="previousYear">
			<description>Goes to the previous year</description>
			<arguments>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="previousMonth">
			<description>Goes to the previous month</description>
			<arguments>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="nextYear">
			<description>Goes to the next year</description>
			<arguments>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="nextMonth">
			<description>Goes to the next month</description>
			<arguments>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="goToYear">
			<description>Goes to the given year</description>
			<arguments>
				<argument name="nFullYear">
					<description>The year to go to</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="goToMonth">
			<description>Goes to the given month. Note that months are numbered from 0 to 11 in Javascript.</description>
			<arguments>
				<argument name="nMonth">
					<description>The index of the month to go to</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="goToToday">
			<description>Goes to today and selects that day</description>
			<arguments>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="updateDateLabel">
			<description>This is called when the date label should be updated. Override this to
 add custom drawing of the label</description>
			<arguments>
				<argument name="oDate">
					<description>The date object the label represents</description>
					<type>Date</type>
				</argument>
				<argument name="oLabel">
					<description>The label to update</description>
					<type>
						<link class="BiLabel">BiLabel</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
	</methods>
	<properties>
		<property name="showYearButtons" get="true" set="true">
			<description>Whether to show the buttons that allow you to go to next or previous year
 in the caption</description>
			<type>Boolean</type>
		</property>
		<property name="showMonthButtons" get="true" set="true">
			<description>Whether to show the buttons that allow you to go to next or previous month
 in the caption</description>
			<type>Boolean</type>
		</property>
		<property name="showCaption" get="true" set="true">
			<description>Whether to show the caption or not</description>
			<type>Boolean</type>
		</property>
		<property name="currentDate" get="true" set="true">
			<description>The date describing the currently shown month. To get the selected date(s)
 use selectedDate(s)</description>
			<type>Date</type>
		</property>
		<property name="dateFormatSymbols" get="true" set="true">
			<description>The object providing the date picker with the symbols needed to display
 localized strings</description>
			<type>
				<link class="BiDateFormatSymbols">BiDateFormatSymbols</link>
			</type>
		</property>
		<property name="captionText" get="true">
			<description>The text to show in the caption</description>
			<type>String</type>
		</property>
		<property name="selectedDate" get="true" set="true">
			<description>The selected date.</description>
			<type>Date</type>
		</property>
		<property name="selectedDates" get="true" set="true">
			<description>These are the selected dates. In case multiple selection is used then use
 this instead of <link>selectedDate</link>
			</description>
			<type>Date[]</type>
		</property>
		<property name="selectionModel" get="true">
			<description>This is the selection model used for the calendar</description>
			<type>
				<link class="BiCalendarSelectionModel">BiCalendarSelectionModel</link>
			</type>
		</property>
	</properties>
	<events>
		<event name="change">
			<description>This event is fired when the selection changes</description>
			<type>
				<link class="BiEvent">BiEvent</link>
			</type>
		</event>
		<event name="action">
			<description>This event is fired when the user clicks on a day</description>
			<type>
				<link class="BiEvent">BiEvent</link>
			</type>
		</event>
	</events>
	<remarks>
	</remarks>
</class>