oqapi/webgui
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
webgui/www/extras/yui/docs/YAHOO.widget.Calendar.html
JT Smith ff7d72becc upgrade to yui 2.5.1
2008-03-25 16:13:25 +00:00

7468 lines
374 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<title>API: calendar YAHOO.widget.Calendar (YUI Library)</title>
<link rel="stylesheet" type="text/css" href="assets/api.css">
<script type="text/javascript" src="assets/api-js"></script>
<script type="text/javascript" src="assets/ac-js"></script>
</head>
<body id="yahoo-com">
<div id="doc3" class="yui-t2">
<div id="hd">
<a href="http://developer.yahoo.com/yui/"><h1>Yahoo! UI Library</h1></a>
<h3>Calendar&nbsp; <span class="subtitle">2.5.1</span></h3>
<p>
<a href="./index.html">Yahoo! UI Library</a>
&gt; <a href="./module_calendar.html">calendar</a>
&gt; YAHOO.widget.Calendar
</p>
</div>
<div id="bd">
<div id="yui-main">
<div class="yui-b">
<form name="yui-classopts-form">
<span id="classopts"><input type="checkbox" name="showprivate" id="showprivate" /> Show Private</span>
<span id="classopts"><input type="checkbox" name="showprotected" id="showprotected" /> Show Protected</span>
</form>
<h2>
Class <b>YAHOO.widget.Calendar</b>
<span class="extends">
</span>
<span class="extends">
</span>
</code>
</h2>
<!-- class tree goes here -->
<dl class="subclasses">
<dt>Known Subclasses:</dd>
<dd>
<a href="YAHOO.widget.Calendar_Core.html">YAHOO.widget.Calendar_Core</a>
</dd>
</dl>
<div class="summary description">
Calendar is the base class for the Calendar widget. In its most basic
implementation, it has the ability to render a calendar widget on the page
that can be manipulated to select a single date, move back and forth between
months and years.
<p>To construct the placeholder for the calendar widget, the code is as
follows:
<xmp>
<div id="calContainer"></div>
</xmp>
</p>
<p>
<strong>NOTE: As of 2.4.0, the constructor's ID argument is optional.</strong>
The Calendar can be constructed by simply providing a container ID string,
or a reference to a container DIV HTMLElement (the element needs to exist
in the document).
E.g.:
<xmp>
var c = new YAHOO.widget.Calendar("calContainer", configOptions);
</xmp>
or:
<xmp>
var containerDiv = YAHOO.util.Dom.get("calContainer");
var c = new YAHOO.widget.Calendar(containerDiv, configOptions);
</xmp>
</p>
<p>
If not provided, the ID will be generated from the container DIV ID by adding an "_t" suffix.
For example if an ID is not provided, and the container's ID is "calContainer", the Calendar's ID will be set to "calContainer_t".
</p>
</div>
<div class="section constructor details">
<h3 id="constructor">Constructor</h3>
<div class="content">
<div class="detail">
<strong>YAHOO.widget.Calendar</strong>
<code>
(
id
,
container
,
config
)
</code>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>id
&lt;String&gt;
</code>
optional The id of the table element that will represent the Calendar widget. As of 2.4.0, this argument is optional.
</dd>
<dd>
<code>container
&lt;String | HTMLElement&gt;
</code>
The id of the container div element that will wrap the Calendar table, or a reference to a DIV element which exists in the document.
</dd>
<dd>
<code>config
&lt;Object&gt;
</code>
optional The configuration object containing the initial configuration values for the Calendar.
</dd>
</dl>
</div>
</div>
</div>
</div>
<div class="section field details">
<h3 id="properties">Properties</h3>
<div class="content">
<div class="private">
<h4><a name="property__renderStack">_renderStack</a>
<code>- private Array</code>
</h4>
<div class="detail">
<div class="description">
A copy of the initial render functions created before rendering.
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property__selectedDates">_selectedDates</a>
<code>- private Array</code>
</h4>
<div class="detail">
<div class="description">
The private list of initially selected dates.
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_browser">browser</a>
<code>- String</code>
</h4>
<div class="detail">
<div class="description">
Returns a string representing the current browser.
</div>
</div>
<div class="deprecated">
<strong>Deprecated:</strong> As of 2.3.0, environment information is available in YAHOO.env.ua
</div>
<hr />
</div>
<div class="">
<h4><a name="property_cellDates">cellDates</a>
<code>- Array[](Number[])</code>
</h4>
<div class="detail">
<div class="description">
The collection of calendar cell dates that is parallel to the cells collection. The array contains dates field arrays in the format of [YYYY, M, D].
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_cells">cells</a>
<code>- HTMLTableCellElement[]</code>
</h4>
<div class="detail">
<div class="description">
The collection of calendar table cells
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_cfg">cfg</a>
<code>- YAHOO.util.Config</code>
</h4>
<div class="detail">
<div class="description">
The Config object used to hold the configuration variables for the Calendar
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property_Config">Config</a>
<code>- private Object</code>
</h4>
<div class="detail">
<div class="description">
The configuration object used to set up the calendars various locale and style options.
</div>
</div>
<div class="deprecated">
<strong>Deprecated:</strong> Configuration properties should be set by calling Calendar.cfg.setProperty.
</div>
<hr />
</div>
<div class="">
<h4><a name="property_containerId">containerId</a>
<code>- String</code>
</h4>
<div class="detail">
<div class="description">
The unique id associated with the Calendar's container
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_domEventMap">domEventMap</a>
<code>- Object</code>
</h4>
<div class="detail">
<div class="description">
A map of DOM event handlers to attach to cells associated with specific CSS class names
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_id">id</a>
<code>- String</code>
</h4>
<div class="detail">
<div class="description">
The id that uniquely identifies this Calendar.
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_index">index</a>
<code>- Number</code>
</h4>
<div class="detail">
<div class="description">
The index of this item in the parent group
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_Locale">Locale</a>
<code>- Object</code>
</h4>
<div class="detail">
<div class="description">
The local object which contains the Calendar's locale settings
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_oDomContainer">oDomContainer</a>
<code>- HTMLElement</code>
</h4>
<div class="detail">
<div class="description">
The DOM element reference that points to this calendar's container element. The calendar will be inserted into this element when the shell is rendered.
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_oNavigator">oNavigator</a>
<code>- CalendarNavigator</code>
</h4>
<div class="detail">
<div class="description">
A reference to the CalendarNavigator instance created for this Calendar.
Will be null if the "navigator" configuration property has not been set
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_Options">Options</a>
<code>- Object</code>
</h4>
<div class="detail">
<div class="description">
The local object which contains the Calendar's options
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_parent">parent</a>
<code>- CalendarGroup</code>
</h4>
<div class="detail">
<div class="description">
The parent CalendarGroup, only to be set explicitly by the parent group
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_renderStack">renderStack</a>
<code>- Array[]</code>
</h4>
<div class="detail">
<div class="description">
The list of render functions, along with required parameters, used to render cells.
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_Style.CSS_BODY">Style.CSS_BODY</a>
<code>- object</code>
</h4>
<div class="detail">
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_Style.CSS_CALENDAR">Style.CSS_CALENDAR</a>
<code>- object</code>
</h4>
<div class="detail">
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_Style.CSS_CELL">Style.CSS_CELL</a>
<code>- object</code>
</h4>
<div class="detail">
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_Style.CSS_CELL_BOTTOM">Style.CSS_CELL_BOTTOM</a>
<code>- object</code>
</h4>
<div class="detail">
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_Style.CSS_CELL_HIGHLIGHT1">Style.CSS_CELL_HIGHLIGHT1</a>
<code>- object</code>
</h4>
<div class="detail">
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_Style.CSS_CELL_HIGHLIGHT2">Style.CSS_CELL_HIGHLIGHT2</a>
<code>- object</code>
</h4>
<div class="detail">
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_Style.CSS_CELL_HIGHLIGHT3">Style.CSS_CELL_HIGHLIGHT3</a>
<code>- object</code>
</h4>
<div class="detail">
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_Style.CSS_CELL_HIGHLIGHT4">Style.CSS_CELL_HIGHLIGHT4</a>
<code>- object</code>
</h4>
<div class="detail">
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_Style.CSS_CELL_HOVER">Style.CSS_CELL_HOVER</a>
<code>- object</code>
</h4>
<div class="detail">
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_Style.CSS_CELL_LEFT">Style.CSS_CELL_LEFT</a>
<code>- object</code>
</h4>
<div class="detail">
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_Style.CSS_CELL_OOB">Style.CSS_CELL_OOB</a>
<code>- object</code>
</h4>
<div class="detail">
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_Style.CSS_CELL_OOM">Style.CSS_CELL_OOM</a>
<code>- object</code>
</h4>
<div class="detail">
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_Style.CSS_CELL_RESTRICTED">Style.CSS_CELL_RESTRICTED</a>
<code>- object</code>
</h4>
<div class="detail">
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_Style.CSS_CELL_RIGHT">Style.CSS_CELL_RIGHT</a>
<code>- object</code>
</h4>
<div class="detail">
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_Style.CSS_CELL_SELECTABLE">Style.CSS_CELL_SELECTABLE</a>
<code>- object</code>
</h4>
<div class="detail">
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_Style.CSS_CELL_SELECTED">Style.CSS_CELL_SELECTED</a>
<code>- object</code>
</h4>
<div class="detail">
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_Style.CSS_CELL_SELECTOR">Style.CSS_CELL_SELECTOR</a>
<code>- object</code>
</h4>
<div class="detail">
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_Style.CSS_CELL_TODAY">Style.CSS_CELL_TODAY</a>
<code>- object</code>
</h4>
<div class="detail">
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_Style.CSS_CELL_TOP">Style.CSS_CELL_TOP</a>
<code>- object</code>
</h4>
<div class="detail">
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_Style.CSS_CLOSE">Style.CSS_CLOSE</a>
<code>- object</code>
</h4>
<div class="detail">
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_Style.CSS_CONTAINER">Style.CSS_CONTAINER</a>
<code>- object</code>
</h4>
<div class="detail">
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_Style.CSS_FOOTER">Style.CSS_FOOTER</a>
<code>- object</code>
</h4>
<div class="detail">
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_Style.CSS_HEADER">Style.CSS_HEADER</a>
<code>- object</code>
</h4>
<div class="detail">
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_Style.CSS_HEADER_TEXT">Style.CSS_HEADER_TEXT</a>
<code>- object</code>
</h4>
<div class="detail">
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_Style.CSS_NAV">Style.CSS_NAV</a>
<code>- object</code>
</h4>
<div class="detail">
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_Style.CSS_NAV_LEFT">Style.CSS_NAV_LEFT</a>
<code>- object</code>
</h4>
<div class="detail">
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_Style.CSS_NAV_RIGHT">Style.CSS_NAV_RIGHT</a>
<code>- object</code>
</h4>
<div class="detail">
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_Style.CSS_ROW_FOOTER">Style.CSS_ROW_FOOTER</a>
<code>- object</code>
</h4>
<div class="detail">
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_Style.CSS_ROW_HEADER">Style.CSS_ROW_HEADER</a>
<code>- object</code>
</h4>
<div class="detail">
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_Style.CSS_SINGLE">Style.CSS_SINGLE</a>
<code>- object</code>
</h4>
<div class="detail">
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_Style.CSS_WEEKDAY_CELL">Style.CSS_WEEKDAY_CELL</a>
<code>- object</code>
</h4>
<div class="detail">
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_Style.CSS_WEEKDAY_ROW">Style.CSS_WEEKDAY_ROW</a>
<code>- object</code>
</h4>
<div class="detail">
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_today">today</a>
<code>- Date</code>
</h4>
<div class="detail">
<div class="description">
A Date object representing today's date.
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property_YAHOO.widget.Calendar._DEFAULT_CONFIG">YAHOO.widget.Calendar._DEFAULT_CONFIG</a>
<code>- private static final Object</code>
</h4>
<div class="detail">
<div class="description">
The set of default Config property keys and values for the Calendar
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property_YAHOO.widget.Calendar._EVENT_TYPES">YAHOO.widget.Calendar._EVENT_TYPES</a>
<code>- private static final Object</code>
</h4>
<div class="detail">
<div class="description">
The set of Custom Event types supported by the Calendar
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property_YAHOO.widget.Calendar._STYLES">YAHOO.widget.Calendar._STYLES</a>
<code>- private static final Object</code>
</h4>
<div class="detail">
<div class="description">
The set of default style constants for the Calendar
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_YAHOO.widget.Calendar.DATE">YAHOO.widget.Calendar.DATE</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Type constant used for renderers to represent an individual date (M/D/Y)
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_YAHOO.widget.Calendar.DISPLAY_DAYS">YAHOO.widget.Calendar.DISPLAY_DAYS</a>
<code>- static final Number</code>
</h4>
<div class="detail">
<div class="description">
Constant that represents the total number of date cells that are displayed in a given month
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_YAHOO.widget.Calendar.IMG_ROOT">YAHOO.widget.Calendar.IMG_ROOT</a>
<code>- static String</code>
</h4>
<div class="detail">
<div class="description">
The path to be used for images loaded for the Calendar
</div>
</div>
<div class="deprecated">
<strong>Deprecated:</strong> You can now customize images by overriding the calclose, calnavleft and calnavright default CSS classes for the close icon, left arrow and right arrow respectively
</div>
<hr />
</div>
<div class="">
<h4><a name="property_YAHOO.widget.Calendar.LONG">YAHOO.widget.Calendar.LONG</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Constant used to represent long date field string formats (e.g. Monday or February)
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_YAHOO.widget.Calendar.MEDIUM">YAHOO.widget.Calendar.MEDIUM</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Constant used to represent medium date field string formats (e.g. Mon)
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_YAHOO.widget.Calendar.MONTH">YAHOO.widget.Calendar.MONTH</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Type constant used for renderers to represent a month across any year
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_YAHOO.widget.Calendar.MONTH_DAY">YAHOO.widget.Calendar.MONTH_DAY</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Type constant used for renderers to represent an individual date across any year (M/D)
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_YAHOO.widget.Calendar.ONE_CHAR">YAHOO.widget.Calendar.ONE_CHAR</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Constant used to represent single character date field string formats (e.g. M, T, W)
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_YAHOO.widget.Calendar.RANGE">YAHOO.widget.Calendar.RANGE</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Type constant used for renderers to represent a range of individual dates (M/D/Y-M/D/Y)
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_YAHOO.widget.Calendar.SHORT">YAHOO.widget.Calendar.SHORT</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Constant used to represent short date field string formats (e.g. Tu or Feb)
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_YAHOO.widget.Calendar.STOP_RENDER">YAHOO.widget.Calendar.STOP_RENDER</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Constant used for halting the execution of the remainder of the render stack
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_YAHOO.widget.Calendar.WEEKDAY">YAHOO.widget.Calendar.WEEKDAY</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Type constant used for renderers to represent a weekday
</div>
</div>
<hr />
</div>
</div>
</div>
<div class="section method details">
<h3 id="methods">Methods</h3>
<div class="content">
<div class="private">
<h4>
<a name="method__addRenderer">_addRenderer</a></h4>
<div class="detail">
<code>
private
void
<strong>_addRenderer</strong>
(
type
,
aDates
,
fnRender
)
</code>
<div class="description">
The private method used for adding cell renderers to the local render stack.
This method is called by other methods that set the renderer type prior to the method call.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>type &lt;String&gt;</code>
The type string that indicates the type of date renderer being added.
Values are YAHOO.widget.Calendar.DATE, YAHOO.widget.Calendar.MONTH_DAY, YAHOO.widget.Calendar.WEEKDAY,
YAHOO.widget.Calendar.RANGE, YAHOO.widget.Calendar.MONTH
</dd>
<dd>
<code>aDates &lt;Array&gt;</code>
An array of dates used to construct the renderer. The format varies based
on the renderer type
</dd>
<dd>
<code>fnRender &lt;Function&gt;</code>
The function executed to render cells that match the render rules for this renderer.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__fieldArraysAreEqual">_fieldArraysAreEqual</a></h4>
<div class="detail">
<code>
private
Boolean
<strong>_fieldArraysAreEqual</strong>
(
array1
,
array2
)
</code>
<div class="description">
Converts a date field array [yyyy,mm,dd] to a JavaScript Date object.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>array1 &lt;Number[]&gt;</code>
The first date field array to compare
</dd>
<dd>
<code>array2 &lt;Number[]&gt;</code>
The first date field array to compare
</dd>
</dl>
<dl>
<dt>Returns:
<code>
Boolean
</code></dt>
<dd>The boolean that represents the equality of the two arrays</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__indexOfSelectedFieldArray">_indexOfSelectedFieldArray</a></h4>
<div class="detail">
<code>
private
Number
<strong>_indexOfSelectedFieldArray</strong>
(
find
)
</code>
<div class="description">
Gets the index of a date field array [yyyy,mm,dd] in the current list of selected dates.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>find &lt;Number[]&gt;</code>
The date field array to search for
</dd>
</dl>
<dl>
<dt>Returns:
<code>
Number
</code></dt>
<dd>The index of the date field array within the collection of selected dates.
-1 will be returned if the date is not found.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="protected">
<h4>
<a name="method__parseArgs">_parseArgs</a></h4>
<div class="detail">
<code>
protected
Object
<strong>_parseArgs</strong>
(
Function
)
</code>
<div class="description">
Protected helper used to parse Calendar constructor/init arguments.
As of 2.4.0, Calendar supports a simpler constructor
signature. This method reconciles arguments
received in the pre 2.4.0 and 2.4.0 formats.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>Function &lt;Array&gt;</code>
"arguments" array
</dd>
</dl>
<dl>
<dt>Returns:
<code>
Object
</code></dt>
<dd>Object with id, container, config properties containing
the reconciled argument values.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__parseDate">_parseDate</a></h4>
<div class="detail">
<code>
private
void
<strong>_parseDate</strong>
(
sDate
)
</code>
<div class="description">
Converts a date string to a date field array
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>sDate &lt;String&gt;</code>
Date string. Valid formats are mm/dd and mm/dd/yyyy.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd>A date field array representing the string passed to the method</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__parseDates">_parseDates</a></h4>
<div class="detail">
<code>
private
void
<strong>_parseDates</strong>
(
sDates
)
</code>
<div class="description">
Converts a multi or single-date string to an array of date field arrays
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>sDates &lt;String&gt;</code>
Date string with one or more comma-delimited dates. Valid formats are mm/dd, mm/dd/yyyy, mm/dd/yyyy-mm/dd/yyyy
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd>An array of date field arrays</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__parsePageDate">_parsePageDate</a></h4>
<div class="detail">
<code>
private
Date
<strong>_parsePageDate</strong>
(
date
)
</code>
<div class="description">
Parses a pagedate configuration property value. The value can either be specified as a string of form "mm/yyyy" or a Date object
and is parsed into a Date object normalized to the first day of the month. If no value is passed in, the month and year from today's date are used to create the Date object
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>date &lt;Date|String&gt;</code>
Pagedate value which needs to be parsed
</dd>
</dl>
<dl>
<dt>Returns:
<code>
Date
</code></dt>
<dd>The Date object representing the pagedate</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__parseRange">_parseRange</a></h4>
<div class="detail">
<code>
private
void
<strong>_parseRange</strong>
(
startDate
,
endDate
)
</code>
<div class="description">
Converts a date range to the full list of included dates
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>startDate &lt;Number[]&gt;</code>
Date field array representing the first date in the range
</dd>
<dd>
<code>endDate &lt;Number[]&gt;</code>
Date field array representing the last date in the range
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd>An array of date field arrays</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__toDate">_toDate</a></h4>
<div class="detail">
<code>
private
Date
<strong>_toDate</strong>
(
dateFieldArray
)
</code>
<div class="description">
Converts a date field array [yyyy,mm,dd] to a JavaScript Date object.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>dateFieldArray &lt;Number[]&gt;</code>
The date field array to convert to a JavaScript Date.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
Date
</code></dt>
<dd>JavaScript Date object representing the date field array</dd>
</dl>
<div class="deprecated">
<strong>Deprecated</strong> Made public, toDate
</div>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__toFieldArray">_toFieldArray</a></h4>
<div class="detail">
<code>
private
Array[](Number[])
<strong>_toFieldArray</strong>
(
date
)
</code>
<div class="description">
Converts a date (either a JavaScript Date object, or a date string) to the internal data structure
used to represent dates: [[yyyy,mm,dd],[yyyy,mm,dd]].
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>date &lt;String/Date/Date[]&gt;</code>
The date string of dates to deselect in the current calendar. Valid formats are
individual date(s) (12/24/2005,12/26/2005) or date range(s) (12/24/2005-1/1/2006).
Multiple comma-delimited dates can also be passed to this method (12/24/2005,12/11/2005-12/13/2005).
This method can also take a JavaScript Date object or an array of Date objects.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
Array[](Number[])
</code></dt>
<dd>Array of date field arrays</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_addMonthRenderer">addMonthRenderer</a></h4>
<div class="detail">
<code>
void
<strong>addMonthRenderer</strong>
(
month
,
fnRender
)
</code>
<div class="description">
Adds a month to the render stack. The function reference passed to this method will be executed
when a date cell matches the month passed to this method.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>month &lt;Number&gt;</code>
The month (1-12) to associate with this renderer
</dd>
<dd>
<code>fnRender &lt;Function&gt;</code>
The function executed to render cells that match the render rules for this renderer.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_addMonths">addMonths</a></h4>
<div class="detail">
<code>
void
<strong>addMonths</strong>
(
count
)
</code>
<div class="description">
Adds the designated number of months to the current calendar month, and sets the current
calendar page date to the new month.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>count &lt;Number&gt;</code>
The number of months to add to the current calendar
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_addRenderer">addRenderer</a></h4>
<div class="detail">
<code>
void
<strong>addRenderer</strong>
(
sDates
,
fnRender
)
</code>
<div class="description">
Adds a renderer to the render stack. The function reference passed to this method will be executed
when a date cell matches the conditions specified in the date string for this renderer.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>sDates &lt;String&gt;</code>
A date string to associate with the specified renderer. Valid formats
include date (12/24/2005), month/day (12/24), and range (12/1/2004-1/1/2005)
</dd>
<dd>
<code>fnRender &lt;Function&gt;</code>
The function executed to render cells that match the render rules for this renderer.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_addWeekdayRenderer">addWeekdayRenderer</a></h4>
<div class="detail">
<code>
void
<strong>addWeekdayRenderer</strong>
(
weekday
,
fnRender
)
</code>
<div class="description">
Adds a weekday to the render stack. The function reference passed to this method will be executed
when a date cell matches the weekday passed to this method.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>weekday &lt;Number&gt;</code>
The weekday (Sunday = 1, Monday = 2 ... Saturday = 7) to associate with this renderer
</dd>
<dd>
<code>fnRender &lt;Function&gt;</code>
The function executed to render cells that match the render rules for this renderer.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_addYears">addYears</a></h4>
<div class="detail">
<code>
void
<strong>addYears</strong>
(
count
)
</code>
<div class="description">
Adds the designated number of years to the current calendar, and sets the current
calendar page date to the new month.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>count &lt;Number&gt;</code>
The number of years to add to the current calendar
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_applyListeners">applyListeners</a></h4>
<div class="detail">
<code>
void
<strong>applyListeners</strong>
(
)
</code>
<div class="description">
Applies the Calendar's DOM listeners to applicable elements.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_buildDayLabel">buildDayLabel</a></h4>
<div class="detail">
<code>
String
<strong>buildDayLabel</strong>
(
workingDate
)
</code>
<div class="description">
Builds the date digit that will be displayed in calendar cells
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>workingDate &lt;Date&gt;</code>
The current working date
</dd>
</dl>
<dl>
<dt>Returns:
<code>
String
</code></dt>
<dd>The formatted day label</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_buildMonthLabel">buildMonthLabel</a></h4>
<div class="detail">
<code>
String
<strong>buildMonthLabel</strong>
(
)
</code>
<div class="description">
Builds the date label that will be displayed in the calendar header or
footer, depending on configuration.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
String
</code></dt>
<dd>The formatted calendar month label</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_buildWeekdays">buildWeekdays</a></h4>
<div class="detail">
<code>
Array
<strong>buildWeekdays</strong>
(
html
)
</code>
<div class="description">
Renders the Calendar's weekday headers.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>html &lt;Array&gt;</code>
The current working HTML array
</dd>
</dl>
<dl>
<dt>Returns:
<code>
Array
</code></dt>
<dd>The current working HTML array</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_clear">clear</a></h4>
<div class="detail">
<code>
void
<strong>clear</strong>
(
)
</code>
<div class="description">
Clears the selected dates in the current calendar widget and sets the calendar
to the current month and year.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_clearAllBodyCellStyles">clearAllBodyCellStyles</a></h4>
<div class="detail">
<code>
void
<strong>clearAllBodyCellStyles</strong>
(
style
)
</code>
<div class="description">
Removes all styles from all body cells in the current calendar table.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>style &lt;style&gt;</code>
The CSS class name to remove from all calendar body cells
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_clearElement">clearElement</a></h4>
<div class="detail">
<code>
void
<strong>clearElement</strong>
(
cell
)
</code>
<div class="description">
Clears the inner HTML, CSS class and style information from the specified cell.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>cell &lt;HTMLTableCellElement&gt;</code>
The cell to clear
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_configClose">configClose</a></h4>
<div class="detail">
<code>
void
<strong>configClose</strong>
(
)
</code>
<div class="description">
Default handler for the "close" property
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_configIframe">configIframe</a></h4>
<div class="detail">
<code>
void
<strong>configIframe</strong>
(
)
</code>
<div class="description">
Default Config listener for the iframe property. If the iframe config property is set to true,
renders the built-in IFRAME shim if the container is relatively or absolutely positioned.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_configLocale">configLocale</a></h4>
<div class="detail">
<code>
void
<strong>configLocale</strong>
(
)
</code>
<div class="description">
The default handler for all configuration locale properties
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_configLocaleValues">configLocaleValues</a></h4>
<div class="detail">
<code>
void
<strong>configLocaleValues</strong>
(
)
</code>
<div class="description">
The default handler for all configuration locale field length properties
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_configMaxDate">configMaxDate</a></h4>
<div class="detail">
<code>
void
<strong>configMaxDate</strong>
(
)
</code>
<div class="description">
The default handler for the "maxdate" property
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_configMinDate">configMinDate</a></h4>
<div class="detail">
<code>
void
<strong>configMinDate</strong>
(
)
</code>
<div class="description">
The default handler for the "mindate" property
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_configNavigator">configNavigator</a></h4>
<div class="detail">
<code>
void
<strong>configNavigator</strong>
(
)
</code>
<div class="description">
The default handler for the "navigator" property
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_configOptions">configOptions</a></h4>
<div class="detail">
<code>
void
<strong>configOptions</strong>
(
)
</code>
<div class="description">
The default handler for all configuration options properties
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_configPageDate">configPageDate</a></h4>
<div class="detail">
<code>
void
<strong>configPageDate</strong>
(
)
</code>
<div class="description">
The default handler for the "pagedate" property
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_configSelected">configSelected</a></h4>
<div class="detail">
<code>
void
<strong>configSelected</strong>
(
)
</code>
<div class="description">
The default handler for the "selected" property
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_configTitle">configTitle</a></h4>
<div class="detail">
<code>
void
<strong>configTitle</strong>
(
)
</code>
<div class="description">
Default handler for the "title" property
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_createCloseButton">createCloseButton</a></h4>
<div class="detail">
<code>
void
<strong>createCloseButton</strong>
(
)
</code>
<div class="description">
Creates the close button HTML element and adds it to Calendar container DIV
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd>The close HTML element created</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_createTitleBar">createTitleBar</a></h4>
<div class="detail">
<code>
void
<strong>createTitleBar</strong>
(
strTitle
)
</code>
<div class="description">
Creates the title bar element and adds it to Calendar container DIV
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>strTitle &lt;String&gt;</code>
The title to display in the title bar
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd>The title bar element</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_deselect">deselect</a></h4>
<div class="detail">
<code>
Date[]
<strong>deselect</strong>
(
date
)
</code>
<div class="description">
Deselects a date or a collection of dates on the current calendar. This method, by default,
does not call the render method explicitly. Once deselection has completed, render must be
called for the changes to be reflected visually.
The method will not attempt to deselect any dates which are OOB (out of bounds, and hence not selectable)
and the array of deselected dates passed to the deselectEvent will not contain any OOB dates.
If all dates are OOB, beforeDeselect and deselect events will not be fired.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>date &lt;String/Date/Date[]&gt;</code>
The date string of dates to deselect in the current calendar. Valid formats are
individual date(s) (12/24/2005,12/26/2005) or date range(s) (12/24/2005-1/1/2006).
Multiple comma-delimited dates can also be passed to this method (12/24/2005,12/11/2005-12/13/2005).
This method can also take a JavaScript Date object or an array of Date objects.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
Date[]
</code></dt>
<dd>Array of JavaScript Date objects representing all individual dates that are currently selected.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_deselectAll">deselectAll</a></h4>
<div class="detail">
<code>
Date[]
<strong>deselectAll</strong>
(
)
</code>
<div class="description">
Deselects all dates on the current calendar.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
Date[]
</code></dt>
<dd>Array of JavaScript Date objects representing all individual dates that are currently selected.
Assuming that this function executes properly, the return value should be an empty array.
However, the empty array is returned for the sake of being able to check the selection status
of the calendar.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_deselectCell">deselectCell</a></h4>
<div class="detail">
<code>
Date[]
<strong>deselectCell</strong>
(
cellIndex
)
</code>
<div class="description">
Deselects a date on the current calendar by referencing the index of the cell that should be deselected.
This method is used to easily deselect a single cell (usually with a mouse click) without having to do
a full render. The selected style is removed from the cell directly.
If the cell is not marked with the CSS_CELL_SELECTABLE class (as is the case by default for out of month
or out of bounds cells), the method will not attempt to deselect it and in such a case, beforeDeselect and
deselect events will not be fired.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>cellIndex &lt;Number&gt;</code>
The index of the cell to deselect in the current calendar.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
Date[]
</code></dt>
<dd>Array of JavaScript Date objects representing all individual dates that are currently selected.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_doCellMouseOut">doCellMouseOut</a></h4>
<div class="detail">
<code>
void
<strong>doCellMouseOut</strong>
(
e
,
cal
)
</code>
<div class="description">
The event that is executed when the user moves the mouse out of a cell
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>e &lt;DOMEvent&gt;</code>
The event
</dd>
<dd>
<code>cal &lt;Calendar&gt;</code>
A reference to the calendar passed by the Event utility
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_doCellMouseOver">doCellMouseOver</a></h4>
<div class="detail">
<code>
void
<strong>doCellMouseOver</strong>
(
e
,
cal
)
</code>
<div class="description">
The event that is executed when the user hovers over a cell
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>e &lt;DOMEvent&gt;</code>
The event
</dd>
<dd>
<code>cal &lt;Calendar&gt;</code>
A reference to the calendar passed by the Event utility
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_doSelectCell">doSelectCell</a></h4>
<div class="detail">
<code>
void
<strong>doSelectCell</strong>
(
e
,
cal
)
</code>
<div class="description">
The default event function that is attached to a date link within a calendar cell
when the calendar is rendered.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>e &lt;DOMEvent&gt;</code>
The event
</dd>
<dd>
<code>cal &lt;Calendar&gt;</code>
A reference to the calendar passed by the Event utility
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getCellIndex">getCellIndex</a></h4>
<div class="detail">
<code>
Number
<strong>getCellIndex</strong>
(
date
)
</code>
<div class="description">
Find the Calendar's cell index for a given date.
If the date is not found, the method returns -1.
<p>
The returned index can be used to lookup the cell HTMLElement
using the Calendar's cells array or passed to selectCell to select
cells by index.
</p>
See <a href="#cells">cells</a>, <a href="#selectCell">selectCell</a>.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>date &lt;Date&gt;</code>
JavaScript Date object, for which to find a cell index.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
Number
</code></dt>
<dd>The index of the date in Calendars cellDates/cells arrays, or -1 if the date
is not on the curently rendered Calendar page.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getDateByCellId">getDateByCellId</a></h4>
<div class="detail">
<code>
Date
<strong>getDateByCellId</strong>
(
id
)
</code>
<div class="description">
Retrieves the Date object for the specified Calendar cell
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>id &lt;String&gt;</code>
The id of the cell
</dd>
</dl>
<dl>
<dt>Returns:
<code>
Date
</code></dt>
<dd>The Date object for the specified Calendar cell</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getDateFieldsByCellId">getDateFieldsByCellId</a></h4>
<div class="detail">
<code>
Array
<strong>getDateFieldsByCellId</strong>
(
id
)
</code>
<div class="description">
Retrieves the Date object for the specified Calendar cell
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>id &lt;String&gt;</code>
The id of the cell
</dd>
</dl>
<dl>
<dt>Returns:
<code>
Array
</code></dt>
<dd>The array of Date fields for the specified Calendar cell</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getSelectedDates">getSelectedDates</a></h4>
<div class="detail">
<code>
Date[]
<strong>getSelectedDates</strong>
(
)
</code>
<div class="description">
Gets the list of currently selected dates from the calendar.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
Date[]
</code></dt>
<dd>An array of currently selected JavaScript Date objects.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_hide">hide</a></h4>
<div class="detail">
<code>
void
<strong>hide</strong>
(
)
</code>
<div class="description">
Hides the Calendar's outer container from view.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_init">init</a></h4>
<div class="detail">
<code>
void
<strong>init</strong>
(
id
,
container
,
config
)
</code>
<div class="description">
Initializes the Calendar widget.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>id &lt;String&gt;</code>
optional The id of the table element that will represent the Calendar widget. As of 2.4.0, this argument is optional.
</dd>
<dd>
<code>container &lt;String | HTMLElement&gt;</code>
The id of the container div element that will wrap the Calendar table, or a reference to a DIV element which exists in the document.
</dd>
<dd>
<code>config &lt;Object&gt;</code>
optional The configuration object containing the initial configuration values for the Calendar.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_initEvents">initEvents</a></h4>
<div class="detail">
<code>
void
<strong>initEvents</strong>
(
)
</code>
<div class="description">
Initializes Calendar's built-in CustomEvents
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_initStyles">initStyles</a></h4>
<div class="detail">
<code>
void
<strong>initStyles</strong>
(
)
</code>
<div class="description">
Defines the style constants for the Calendar
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_isDateOOB">isDateOOB</a></h4>
<div class="detail">
<code>
Boolean
<strong>isDateOOB</strong>
(
date
)
</code>
<div class="description">
Determines whether a given date is OOB (out of bounds - less than the mindate or more than the maxdate).
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>date &lt;Date&gt;</code>
The JavaScript Date object for which to check the OOB status
</dd>
</dl>
<dl>
<dt>Returns:
<code>
Boolean
</code></dt>
<dd>true if the date is OOB</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_isDateOOM">isDateOOM</a></h4>
<div class="detail">
<code>
Boolean
<strong>isDateOOM</strong>
(
date
)
</code>
<div class="description">
Determines whether a given date is OOM (out of month).
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>date &lt;Date&gt;</code>
The JavaScript Date object for which to check the OOM status
</dd>
</dl>
<dl>
<dt>Returns:
<code>
Boolean
</code></dt>
<dd>true if the date is OOM</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_nextMonth">nextMonth</a></h4>
<div class="detail">
<code>
void
<strong>nextMonth</strong>
(
)
</code>
<div class="description">
Navigates to the next month page in the calendar widget.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_nextYear">nextYear</a></h4>
<div class="detail">
<code>
void
<strong>nextYear</strong>
(
)
</code>
<div class="description">
Navigates to the next year in the currently selected month in the calendar widget.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_onBeforeDeselect">onBeforeDeselect</a></h4>
<div class="detail">
<code>
void
<strong>onBeforeDeselect</strong>
(
)
</code>
<div class="description">
Event executed before a date is deselected in the calendar widget.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
<div class="deprecated">
<strong>Deprecated</strong> Event handlers for this event should be susbcribed to beforeDeselectEvent.
</div>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_onBeforeSelect">onBeforeSelect</a></h4>
<div class="detail">
<code>
void
<strong>onBeforeSelect</strong>
(
)
</code>
<div class="description">
Event executed before a date is selected in the calendar widget.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
<div class="deprecated">
<strong>Deprecated</strong> Event handlers for this event should be susbcribed to beforeSelectEvent.
</div>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_onChangePage">onChangePage</a></h4>
<div class="detail">
<code>
void
<strong>onChangePage</strong>
(
)
</code>
<div class="description">
Event executed when the user navigates to a different calendar page.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
<div class="deprecated">
<strong>Deprecated</strong> Event handlers for this event should be susbcribed to changePageEvent.
</div>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_onClear">onClear</a></h4>
<div class="detail">
<code>
void
<strong>onClear</strong>
(
)
</code>
<div class="description">
Event executed when the calendar widget is completely cleared to the current month with no selections.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
<div class="deprecated">
<strong>Deprecated</strong> Event handlers for this event should be susbcribed to clearEvent.
</div>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_onDeselect">onDeselect</a></h4>
<div class="detail">
<code>
void
<strong>onDeselect</strong>
(
selected
)
</code>
<div class="description">
Event executed when a date is deselected in the calendar widget.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>selected &lt;Array&gt;</code>
An array of date field arrays representing which date or dates were deselected. Example: [ [2006,8,6],[2006,8,7],[2006,8,8] ]
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
<div class="deprecated">
<strong>Deprecated</strong> Event handlers for this event should be susbcribed to deselectEvent.
</div>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_onRender">onRender</a></h4>
<div class="detail">
<code>
void
<strong>onRender</strong>
(
)
</code>
<div class="description">
Event executed when the calendar widget is rendered.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
<div class="deprecated">
<strong>Deprecated</strong> Event handlers for this event should be susbcribed to renderEvent.
</div>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_onReset">onReset</a></h4>
<div class="detail">
<code>
void
<strong>onReset</strong>
(
)
</code>
<div class="description">
Event executed when the calendar widget is reset to its original state.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
<div class="deprecated">
<strong>Deprecated</strong> Event handlers for this event should be susbcribed to resetEvemt.
</div>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_onSelect">onSelect</a></h4>
<div class="detail">
<code>
void
<strong>onSelect</strong>
(
selected
)
</code>
<div class="description">
Event executed when a date is selected in the calendar widget.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>selected &lt;Array&gt;</code>
An array of date field arrays representing which date or dates were selected. Example: [ [2006,8,6],[2006,8,7],[2006,8,8] ]
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
<div class="deprecated">
<strong>Deprecated</strong> Event handlers for this event should be susbcribed to selectEvent.
</div>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_previousMonth">previousMonth</a></h4>
<div class="detail">
<code>
void
<strong>previousMonth</strong>
(
)
</code>
<div class="description">
Navigates to the previous month page in the calendar widget.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_previousYear">previousYear</a></h4>
<div class="detail">
<code>
void
<strong>previousYear</strong>
(
)
</code>
<div class="description">
Navigates to the previous year in the currently selected month in the calendar widget.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method_refreshLocale">refreshLocale</a></h4>
<div class="detail">
<code>
private
void
<strong>refreshLocale</strong>
(
)
</code>
<div class="description">
Refreshes the locale values used to build the Calendar.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_removeCloseButton">removeCloseButton</a></h4>
<div class="detail">
<code>
void
<strong>removeCloseButton</strong>
(
)
</code>
<div class="description">
Removes the close button HTML element from the DOM
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_removeRenderers">removeRenderers</a></h4>
<div class="detail">
<code>
void
<strong>removeRenderers</strong>
(
)
</code>
<div class="description">
Removes all custom renderers added to the Calendar through the addRenderer, addMonthRenderer and
addWeekdayRenderer methods. Calendar's render method needs to be called after removing renderers
to re-render the Calendar without custom renderers applied.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_removeTitleBar">removeTitleBar</a></h4>
<div class="detail">
<code>
void
<strong>removeTitleBar</strong>
(
)
</code>
<div class="description">
Removes the title bar element from the DOM
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_render">render</a></h4>
<div class="detail">
<code>
void
<strong>render</strong>
(
)
</code>
<div class="description">
Renders the calendar after it has been configured. The render() method has a specific call chain that will execute
when the method is called: renderHeader, renderBody, renderFooter.
Refer to the documentation for those methods for information on
individual render tasks.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_renderBody">renderBody</a></h4>
<div class="detail">
<code>
Array
<strong>renderBody</strong>
(
workingDate
,
html
)
</code>
<div class="description">
Renders the calendar body.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>workingDate &lt;Date&gt;</code>
The current working Date being used for the render process
</dd>
<dd>
<code>html &lt;Array&gt;</code>
The current working HTML array
</dd>
</dl>
<dl>
<dt>Returns:
<code>
Array
</code></dt>
<dd>The current working HTML array</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_renderBodyCellRestricted">renderBodyCellRestricted</a></h4>
<div class="detail">
<code>
String
<strong>renderBodyCellRestricted</strong>
(
workingDate
,
cell
)
</code>
<div class="description">
Renders the current calendar cell as a non-selectable "black-out" date using the default
restricted style.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>workingDate &lt;Date&gt;</code>
The current working Date object being used to generate the calendar
</dd>
<dd>
<code>cell &lt;HTMLTableCellElement&gt;</code>
The current working cell in the calendar
</dd>
</dl>
<dl>
<dt>Returns:
<code>
String
</code></dt>
<dd>YAHOO.widget.Calendar.STOP_RENDER if rendering should stop with this style, null or nothing if rendering
should not be terminated</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_renderCellDefault">renderCellDefault</a></h4>
<div class="detail">
<code>
void
<strong>renderCellDefault</strong>
(
workingDate
,
cell
)
</code>
<div class="description">
Renders a single standard calendar cell in the calendar widget table.
All logic for determining how a standard default cell will be rendered is
encapsulated in this method, and must be accounted for when extending the
widget class.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>workingDate &lt;Date&gt;</code>
The current working Date object being used to generate the calendar
</dd>
<dd>
<code>cell &lt;HTMLTableCellElement&gt;</code>
The current working cell in the calendar
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_renderCellNotThisMonth">renderCellNotThisMonth</a></h4>
<div class="detail">
<code>
String
<strong>renderCellNotThisMonth</strong>
(
workingDate
,
cell
)
</code>
<div class="description">
Applies the default style used for rendering dates that are not a part of the current
month (preceding or trailing the cells for the current month)
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>workingDate &lt;Date&gt;</code>
The current working Date object being used to generate the calendar
</dd>
<dd>
<code>cell &lt;HTMLTableCellElement&gt;</code>
The current working cell in the calendar
</dd>
</dl>
<dl>
<dt>Returns:
<code>
String
</code></dt>
<dd>YAHOO.widget.Calendar.STOP_RENDER if rendering should stop with this style, null or nothing if rendering
should not be terminated</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_renderCellStyleHighlight1">renderCellStyleHighlight1</a></h4>
<div class="detail">
<code>
void
<strong>renderCellStyleHighlight1</strong>
(
workingDate
,
cell
)
</code>
<div class="description">
Renders a single standard calendar cell using the CSS hightlight1 style
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>workingDate &lt;Date&gt;</code>
The current working Date object being used to generate the calendar
</dd>
<dd>
<code>cell &lt;HTMLTableCellElement&gt;</code>
The current working cell in the calendar
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_renderCellStyleHighlight2">renderCellStyleHighlight2</a></h4>
<div class="detail">
<code>
void
<strong>renderCellStyleHighlight2</strong>
(
workingDate
,
cell
)
</code>
<div class="description">
Renders a single standard calendar cell using the CSS hightlight2 style
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>workingDate &lt;Date&gt;</code>
The current working Date object being used to generate the calendar
</dd>
<dd>
<code>cell &lt;HTMLTableCellElement&gt;</code>
The current working cell in the calendar
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_renderCellStyleHighlight3">renderCellStyleHighlight3</a></h4>
<div class="detail">
<code>
void
<strong>renderCellStyleHighlight3</strong>
(
workingDate
,
cell
)
</code>
<div class="description">
Renders a single standard calendar cell using the CSS hightlight3 style
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>workingDate &lt;Date&gt;</code>
The current working Date object being used to generate the calendar
</dd>
<dd>
<code>cell &lt;HTMLTableCellElement&gt;</code>
The current working cell in the calendar
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_renderCellStyleHighlight4">renderCellStyleHighlight4</a></h4>
<div class="detail">
<code>
void
<strong>renderCellStyleHighlight4</strong>
(
workingDate
,
cell
)
</code>
<div class="description">
Renders a single standard calendar cell using the CSS hightlight4 style
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>workingDate &lt;Date&gt;</code>
The current working Date object being used to generate the calendar
</dd>
<dd>
<code>cell &lt;HTMLTableCellElement&gt;</code>
The current working cell in the calendar
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_renderCellStyleSelected">renderCellStyleSelected</a></h4>
<div class="detail">
<code>
String
<strong>renderCellStyleSelected</strong>
(
workingDate
,
cell
)
</code>
<div class="description">
Applies the default style used for rendering selected dates to the current calendar cell
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>workingDate &lt;Date&gt;</code>
The current working Date object being used to generate the calendar
</dd>
<dd>
<code>cell &lt;HTMLTableCellElement&gt;</code>
The current working cell in the calendar
</dd>
</dl>
<dl>
<dt>Returns:
<code>
String
</code></dt>
<dd>YAHOO.widget.Calendar.STOP_RENDER if rendering should stop with this style, null or nothing if rendering
should not be terminated</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_renderCellStyleToday">renderCellStyleToday</a></h4>
<div class="detail">
<code>
void
<strong>renderCellStyleToday</strong>
(
workingDate
,
cell
)
</code>
<div class="description">
Applies the default style used for rendering today's date to the current calendar cell
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>workingDate &lt;Date&gt;</code>
The current working Date object being used to generate the calendar
</dd>
<dd>
<code>cell &lt;HTMLTableCellElement&gt;</code>
The current working cell in the calendar
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_renderFooter">renderFooter</a></h4>
<div class="detail">
<code>
Array
<strong>renderFooter</strong>
(
html
)
</code>
<div class="description">
Renders the calendar footer. In the default implementation, there is
no footer.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>html &lt;Array&gt;</code>
The current working HTML array
</dd>
</dl>
<dl>
<dt>Returns:
<code>
Array
</code></dt>
<dd>The current working HTML array</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_renderHeader">renderHeader</a></h4>
<div class="detail">
<code>
Array
<strong>renderHeader</strong>
(
html
)
</code>
<div class="description">
Renders the calendar header.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>html &lt;Array&gt;</code>
The current working HTML array
</dd>
</dl>
<dl>
<dt>Returns:
<code>
Array
</code></dt>
<dd>The current working HTML array</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_renderOutOfBoundsDate">renderOutOfBoundsDate</a></h4>
<div class="detail">
<code>
String
<strong>renderOutOfBoundsDate</strong>
(
workingDate
,
cell
)
</code>
<div class="description">
Renders a cell that falls before the minimum date or after the maximum date.
widget class.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>workingDate &lt;Date&gt;</code>
The current working Date object being used to generate the calendar
</dd>
<dd>
<code>cell &lt;HTMLTableCellElement&gt;</code>
The current working cell in the calendar
</dd>
</dl>
<dl>
<dt>Returns:
<code>
String
</code></dt>
<dd>YAHOO.widget.Calendar.STOP_RENDER if rendering should stop with this style, null or nothing if rendering
should not be terminated</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_renderRowFooter">renderRowFooter</a></h4>
<div class="detail">
<code>
void
<strong>renderRowFooter</strong>
(
weekNum
,
cell
)
</code>
<div class="description">
Renders the row footer for a week.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>weekNum &lt;Number&gt;</code>
The week number of the current row
</dd>
<dd>
<code>cell &lt;Array&gt;</code>
The current working HTML array
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_renderRowHeader">renderRowHeader</a></h4>
<div class="detail">
<code>
void
<strong>renderRowHeader</strong>
(
weekNum
,
cell
)
</code>
<div class="description">
Renders the row header for a week.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>weekNum &lt;Number&gt;</code>
The week number of the current row
</dd>
<dd>
<code>cell &lt;Array&gt;</code>
The current working HTML array
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_reset">reset</a></h4>
<div class="detail">
<code>
void
<strong>reset</strong>
(
)
</code>
<div class="description">
Resets the calendar widget to the originally selected month and year, and
sets the calendar to the initial selection(s).
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_resetRenderers">resetRenderers</a></h4>
<div class="detail">
<code>
void
<strong>resetRenderers</strong>
(
)
</code>
<div class="description">
Resets the render stack of the current calendar to its original pre-render value.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_select">select</a></h4>
<div class="detail">
<code>
Date[]
<strong>select</strong>
(
date
)
</code>
<div class="description">
Selects a date or a collection of dates on the current calendar. This method, by default,
does not call the render method explicitly. Once selection has completed, render must be
called for the changes to be reflected visually.
Any dates which are OOB (out of bounds, not selectable) will not be selected and the array of
selected dates passed to the selectEvent will not contain OOB dates.
If all dates are OOB, the no state change will occur; beforeSelect and select events will not be fired.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>date &lt;String/Date/Date[]&gt;</code>
The date string of dates to select in the current calendar. Valid formats are
individual date(s) (12/24/2005,12/26/2005) or date range(s) (12/24/2005-1/1/2006).
Multiple comma-delimited dates can also be passed to this method (12/24/2005,12/11/2005-12/13/2005).
This method can also take a JavaScript Date object or an array of Date objects.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
Date[]
</code></dt>
<dd>Array of JavaScript Date objects representing all individual dates that are currently selected.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_selectCell">selectCell</a></h4>
<div class="detail">
<code>
Date[]
<strong>selectCell</strong>
(
cellIndex
)
</code>
<div class="description">
Selects a date on the current calendar by referencing the index of the cell that should be selected.
This method is used to easily select a single cell (usually with a mouse click) without having to do
a full render. The selected style is applied to the cell directly.
If the cell is not marked with the CSS_CELL_SELECTABLE class (as is the case by default for out of month
or out of bounds cells), it will not be selected and in such a case beforeSelect and select events will not be fired.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>cellIndex &lt;Number&gt;</code>
The index of the cell to select in the current calendar.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
Date[]
</code></dt>
<dd>Array of JavaScript Date objects representing all individual dates that are currently selected.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_setMonth">setMonth</a></h4>
<div class="detail">
<code>
void
<strong>setMonth</strong>
(
month
)
</code>
<div class="description">
Sets the calendar's month explicitly
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>month &lt;Number&gt;</code>
The numeric month, from 0 (January) to 11 (December)
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_setYear">setYear</a></h4>
<div class="detail">
<code>
void
<strong>setYear</strong>
(
year
)
</code>
<div class="description">
Sets the calendar's year explicitly.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>year &lt;Number&gt;</code>
The numeric 4-digit year
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_show">show</a></h4>
<div class="detail">
<code>
void
<strong>show</strong>
(
)
</code>
<div class="description">
Shows the Calendar's outer container.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_styleCellDefault">styleCellDefault</a></h4>
<div class="detail">
<code>
void
<strong>styleCellDefault</strong>
(
workingDate
,
cell
)
</code>
<div class="description">
Styles a selectable cell.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>workingDate &lt;Date&gt;</code>
The current working Date object being used to generate the calendar
</dd>
<dd>
<code>cell &lt;HTMLTableCellElement&gt;</code>
The current working cell in the calendar
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_subtractMonths">subtractMonths</a></h4>
<div class="detail">
<code>
void
<strong>subtractMonths</strong>
(
count
)
</code>
<div class="description">
Subtracts the designated number of months from the current calendar month, and sets the current
calendar page date to the new month.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>count &lt;Number&gt;</code>
The number of months to subtract from the current calendar
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_subtractYears">subtractYears</a></h4>
<div class="detail">
<code>
void
<strong>subtractYears</strong>
(
count
)
</code>
<div class="description">
Subtcats the designated number of years from the current calendar, and sets the current
calendar page date to the new month.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>count &lt;Number&gt;</code>
The number of years to subtract from the current calendar
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_toDate">toDate</a></h4>
<div class="detail">
<code>
Date
<strong>toDate</strong>
(
dateFieldArray
)
</code>
<div class="description">
Converts a date field array [yyyy,mm,dd] to a JavaScript Date object. The date field array
is the format in which dates are as provided as arguments to selectEvent and deselectEvent listeners.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>dateFieldArray &lt;Number[]&gt;</code>
The date field array to convert to a JavaScript Date.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
Date
</code></dt>
<dd>JavaScript Date object representing the date field array.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_toString">toString</a></h4>
<div class="detail">
<code>
String
<strong>toString</strong>
(
)
</code>
<div class="description">
Returns a string representation of the object.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
String
</code></dt>
<dd>A string representation of the Calendar object.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_validate">validate</a></h4>
<div class="detail">
<code>
void
<strong>validate</strong>
(
)
</code>
<div class="description">
Validates the calendar widget. This method has no default implementation
and must be extended by subclassing the widget.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd>Should return true if the widget validates, and false if
it doesn't.</dd>
</dl>
</div>
</div>
<hr />
</div>
</div>
</div>
<div class="section method details">
<h3 id="events">Events</h3>
<div class="content">
<div class="">
<h4>
<a name="event_beforeDeselectEvent">beforeDeselectEvent</a></h4>
<div class="detail">
<code>
<strong>beforeDeselectEvent</strong>
(
)
</code>
<div class="description">
Fired before a selection is made
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_beforeHideEvent">beforeHideEvent</a></h4>
<div class="detail">
<code>
<strong>beforeHideEvent</strong>
(
)
</code>
<div class="description">
Fired just before the Calendar is to be hidden
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_beforeHideNavEvent">beforeHideNavEvent</a></h4>
<div class="detail">
<code>
<strong>beforeHideNavEvent</strong>
(
)
</code>
<div class="description">
Fired just before the CalendarNavigator is to be hidden
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_beforeRenderEvent">beforeRenderEvent</a></h4>
<div class="detail">
<code>
<strong>beforeRenderEvent</strong>
(
)
</code>
<div class="description">
Fired before the Calendar is rendered
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_beforeRenderNavEvent">beforeRenderNavEvent</a></h4>
<div class="detail">
<code>
<strong>beforeRenderNavEvent</strong>
(
)
</code>
<div class="description">
Fired just before the CalendarNavigator is to be rendered
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_beforeSelectEvent">beforeSelectEvent</a></h4>
<div class="detail">
<code>
<strong>beforeSelectEvent</strong>
(
)
</code>
<div class="description">
Fired before a selection is made
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_beforeShowEvent">beforeShowEvent</a></h4>
<div class="detail">
<code>
<strong>beforeShowEvent</strong>
(
)
</code>
<div class="description">
Fired just before the Calendar is to be shown
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_beforeShowNavEvent">beforeShowNavEvent</a></h4>
<div class="detail">
<code>
<strong>beforeShowNavEvent</strong>
(
)
</code>
<div class="description">
Fired just before the CalendarNavigator is to be shown
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_changePageEvent">changePageEvent</a></h4>
<div class="detail">
<code>
<strong>changePageEvent</strong>
(
)
</code>
<div class="description">
Fired when the Calendar page is changed
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_clearEvent">clearEvent</a></h4>
<div class="detail">
<code>
<strong>clearEvent</strong>
(
)
</code>
<div class="description">
Fired when the Calendar is cleared
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_deselectEvent">deselectEvent</a></h4>
<div class="detail">
<code>
<strong>deselectEvent</strong>
(
Array
)
</code>
<div class="description">
Fired when a selection is made
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>Array &lt;Array&gt;</code>
of Date field arrays in the format [YYYY, MM, DD].
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_hideEvent">hideEvent</a></h4>
<div class="detail">
<code>
<strong>hideEvent</strong>
(
)
</code>
<div class="description">
Fired after the Calendar is hidden
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_hideNavEvent">hideNavEvent</a></h4>
<div class="detail">
<code>
<strong>hideNavEvent</strong>
(
)
</code>
<div class="description">
Fired after the CalendarNavigator is hidden
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_renderEvent">renderEvent</a></h4>
<div class="detail">
<code>
<strong>renderEvent</strong>
(
)
</code>
<div class="description">
Fired when the Calendar is rendered
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_renderNavEvent">renderNavEvent</a></h4>
<div class="detail">
<code>
<strong>renderNavEvent</strong>
(
)
</code>
<div class="description">
Fired after the CalendarNavigator is rendered
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_resetEvent">resetEvent</a></h4>
<div class="detail">
<code>
<strong>resetEvent</strong>
(
)
</code>
<div class="description">
Fired when the Calendar is reset
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_selectEvent">selectEvent</a></h4>
<div class="detail">
<code>
<strong>selectEvent</strong>
(
Array
)
</code>
<div class="description">
Fired when a selection is made
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>Array &lt;Array&gt;</code>
of Date field arrays in the format [YYYY, MM, DD].
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_showEvent">showEvent</a></h4>
<div class="detail">
<code>
<strong>showEvent</strong>
(
)
</code>
<div class="description">
Fired after the Calendar is shown
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_showNavEvent">showNavEvent</a></h4>
<div class="detail">
<code>
<strong>showNavEvent</strong>
(
)
</code>
<div class="description">
Fired after the CalendarNavigator is shown
</div>
<div class="description">
</div>
</div>
<hr />
</div>
</div>
</div>
<div class="section field details">
<h3 id="configattributes">Configuration Attributes</h3>
<div class="content">
<div class="">
<h4><a name="config_close">close</a>
<code>- Boolean</code>
</h4>
<div class="detail">
<div class="description">
Whether or not a close button should be displayed for this Calendar
</div>
</div>
<div class="default">
Default Value: false
</div>
<hr />
</div>
<div class="">
<h4><a name="config_DATE_DELIMITER">DATE_DELIMITER</a>
<code>- String</code>
</h4>
<div class="detail">
<div class="description">
The value used to delimit individual dates in a date string passed to various Calendar functions.
</div>
</div>
<div class="default">
Default Value: ","
</div>
<hr />
</div>
<div class="">
<h4><a name="config_DATE_FIELD_DELIMITER">DATE_FIELD_DELIMITER</a>
<code>- String</code>
</h4>
<div class="detail">
<div class="description">
The value used to delimit date fields in a date string passed to various Calendar functions.
</div>
</div>
<div class="default">
Default Value: "/"
</div>
<hr />
</div>
<div class="">
<h4><a name="config_DATE_RANGE_DELIMITER">DATE_RANGE_DELIMITER</a>
<code>- String</code>
</h4>
<div class="detail">
<div class="description">
The value used to delimit date ranges in a date string passed to various Calendar functions.
</div>
</div>
<div class="default">
Default Value: "-"
</div>
<hr />
</div>
<div class="">
<h4><a name="config_HIDE_BLANK_WEEKS">HIDE_BLANK_WEEKS</a>
<code>- Boolean</code>
</h4>
<div class="detail">
<div class="description">
True if the Calendar should suppress weeks that are not a part of the current month. False by default.
</div>
</div>
<div class="default">
Default Value: false
</div>
<hr />
</div>
<div class="">
<h4><a name="config_iframe">iframe</a>
<code>- Boolean</code>
</h4>
<div class="detail">
<div class="description">
Whether or not an iframe shim should be placed under the Calendar to prevent select boxes from bleeding through in Internet Explorer 6 and below.
This property is enabled by default for IE6 and below. It is disabled by default for other browsers for performance reasons, but can be
enabled if required.
</div>
</div>
<div class="default">
Default Value: true for IE6 and below, false for all other browsers
</div>
<hr />
</div>
<div class="">
<h4><a name="config_LOCALE_MONTHS">LOCALE_MONTHS</a>
<code>- String</code>
</h4>
<div class="detail">
<div class="description">
The setting that determines which length of month labels should be used. Possible values are "short" and "long".
</div>
</div>
<div class="default">
Default Value: "long"
</div>
<hr />
</div>
<div class="">
<h4><a name="config_LOCALE_WEEKDAYS">LOCALE_WEEKDAYS</a>
<code>- String</code>
</h4>
<div class="detail">
<div class="description">
The setting that determines which length of weekday labels should be used. Possible values are "1char", "short", "medium", and "long".
</div>
</div>
<div class="default">
Default Value: "short"
</div>
<hr />
</div>
<div class="">
<h4><a name="config_maxdate">maxdate</a>
<code>- String</code>
</h4>
<div class="detail">
<div class="description">
The maximum selectable date in the current Calendar (mm/dd/yyyy)
</div>
</div>
<div class="default">
Default Value: null
</div>
<hr />
</div>
<div class="">
<h4><a name="config_MD_DAY_POSITION">MD_DAY_POSITION</a>
<code>- Number</code>
</h4>
<div class="detail">
<div class="description">
The position of the day in a month/year date string
</div>
</div>
<div class="default">
Default Value: 2
</div>
<hr />
</div>
<div class="">
<h4><a name="config_MD_MONTH_POSITION">MD_MONTH_POSITION</a>
<code>- Number</code>
</h4>
<div class="detail">
<div class="description">
The position of the month in a month/day date string
</div>
</div>
<div class="default">
Default Value: 1
</div>
<hr />
</div>
<div class="">
<h4><a name="config_MDY_DAY_POSITION">MDY_DAY_POSITION</a>
<code>- Number</code>
</h4>
<div class="detail">
<div class="description">
The position of the day in a month/day/year date string
</div>
</div>
<div class="default">
Default Value: 2
</div>
<hr />
</div>
<div class="">
<h4><a name="config_MDY_MONTH_POSITION">MDY_MONTH_POSITION</a>
<code>- Number</code>
</h4>
<div class="detail">
<div class="description">
The position of the month in a month/day/year date string
</div>
</div>
<div class="default">
Default Value: 1
</div>
<hr />
</div>
<div class="">
<h4><a name="config_MDY_YEAR_POSITION">MDY_YEAR_POSITION</a>
<code>- Number</code>
</h4>
<div class="detail">
<div class="description">
The position of the year in a month/day/year date string
</div>
</div>
<div class="default">
Default Value: 3
</div>
<hr />
</div>
<div class="">
<h4><a name="config_mindate">mindate</a>
<code>- String</code>
</h4>
<div class="detail">
<div class="description">
The minimum selectable date in the current Calendar (mm/dd/yyyy)
</div>
</div>
<div class="default">
Default Value: null
</div>
<hr />
</div>
<div class="">
<h4><a name="config_MONTHS_LONG">MONTHS_LONG</a>
<code>- String[]</code>
</h4>
<div class="detail">
<div class="description">
The long month labels for the current locale.
</div>
</div>
<div class="default">
Default Value: ["January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December"
</div>
<hr />
</div>
<div class="">
<h4><a name="config_MONTHS_SHORT">MONTHS_SHORT</a>
<code>- String[]</code>
</h4>
<div class="detail">
<div class="description">
The short month labels for the current locale.
</div>
</div>
<div class="default">
Default Value: ["Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"]
</div>
<hr />
</div>
<div class="">
<h4><a name="config_MULTI_SELECT">MULTI_SELECT</a>
<code>- Boolean</code>
</h4>
<div class="detail">
<div class="description">
True if the Calendar should allow multiple selections. False by default.
</div>
</div>
<div class="default">
Default Value: false
</div>
<hr />
</div>
<div class="">
<h4><a name="config_MY_LABEL_MONTH_POSITION">MY_LABEL_MONTH_POSITION</a>
<code>- Number</code>
</h4>
<div class="detail">
<div class="description">
The position of the month in the month year label string used as the Calendar header
</div>
</div>
<div class="default">
Default Value: 1
</div>
<hr />
</div>
<div class="">
<h4><a name="config_MY_LABEL_MONTH_SUFFIX">MY_LABEL_MONTH_SUFFIX</a>
<code>- String</code>
</h4>
<div class="detail">
<div class="description">
The suffix used after the month when rendering the Calendar header
</div>
</div>
<div class="default">
Default Value: " "
</div>
<hr />
</div>
<div class="">
<h4><a name="config_MY_LABEL_YEAR_POSITION">MY_LABEL_YEAR_POSITION</a>
<code>- Number</code>
</h4>
<div class="detail">
<div class="description">
The position of the year in the month year label string used as the Calendar header
</div>
</div>
<div class="default">
Default Value: 2
</div>
<hr />
</div>
<div class="">
<h4><a name="config_MY_LABEL_YEAR_SUFFIX">MY_LABEL_YEAR_SUFFIX</a>
<code>- String</code>
</h4>
<div class="detail">
<div class="description">
The suffix used after the year when rendering the Calendar header
</div>
</div>
<div class="default">
Default Value: ""
</div>
<hr />
</div>
<div class="">
<h4><a name="config_MY_MONTH_POSITION">MY_MONTH_POSITION</a>
<code>- Number</code>
</h4>
<div class="detail">
<div class="description">
The position of the month in a month/year date string
</div>
</div>
<div class="default">
Default Value: 1
</div>
<hr />
</div>
<div class="">
<h4><a name="config_MY_YEAR_POSITION">MY_YEAR_POSITION</a>
<code>- Number</code>
</h4>
<div class="detail">
<div class="description">
The position of the year in a month/year date string
</div>
</div>
<div class="default">
Default Value: 2
</div>
<hr />
</div>
<div class="">
<h4><a name="config_NAV_ARROW_LEFT">NAV_ARROW_LEFT</a>
<code>- String</code>
</h4>
<div class="detail">
<div class="description">
The image that should be used for the left navigation arrow.
</div>
</div>
<div class="deprecated">
<strong>Deprecated</strong> You can customize the image by overriding the default CSS class for the left arrow - "calnavleft"
</div>
<div class="default">
Default Value: null
</div>
<hr />
</div>
<div class="">
<h4><a name="config_NAV_ARROW_RIGHT">NAV_ARROW_RIGHT</a>
<code>- String</code>
</h4>
<div class="detail">
<div class="description">
The image that should be used for the right navigation arrow.
</div>
</div>
<div class="deprecated">
<strong>Deprecated</strong> You can customize the image by overriding the default CSS class for the right arrow - "calnavright"
</div>
<div class="default">
Default Value: null
</div>
<hr />
</div>
<div class="">
<h4><a name="config_navigator">navigator</a>
<code>- {Object|Boolean}</code>
</h4>
<div class="detail">
<div class="description">
Configuration for the Month/Year CalendarNavigator UI which allows the user to jump directly to a
specific Month/Year without having to scroll sequentially through months.
<p>
Setting this property to null (default value) or false, will disable the CalendarNavigator UI.
</p>
<p>
Setting this property to true will enable the CalendarNavigatior UI with the default CalendarNavigator configuration values.
</p>
<p>
This property can also be set to an object literal containing configuration properties for the CalendarNavigator UI.
The configuration object expects the the following case-sensitive properties, with the "strings" property being a nested object.
Any properties which are not provided will use the default values (defined in the CalendarNavigator class).
</p>
<dl>
<dt>strings</dt>
<dd><em>Object</em> : An object with the properties shown below, defining the string labels to use in the Navigator's UI
<dl>
<dt>month</dt><dd><em>String</em> : The string to use for the month label. Defaults to "Month".</dd>
<dt>year</dt><dd><em>String</em> : The string to use for the year label. Defaults to "Year".</dd>
<dt>submit</dt><dd><em>String</em> : The string to use for the submit button label. Defaults to "Okay".</dd>
<dt>cancel</dt><dd><em>String</em> : The string to use for the cancel button label. Defaults to "Cancel".</dd>
<dt>invalidYear</dt><dd><em>String</em> : The string to use for invalid year values. Defaults to "Year needs to be a number".</dd>
</dl>
</dd>
<dt>monthFormat</dt><dd><em>String</em> : The month format to use. Either YAHOO.widget.Calendar.LONG, or YAHOO.widget.Calendar.SHORT. Defaults to YAHOO.widget.Calendar.LONG</dd>
<dt>initialFocus</dt><dd><em>String</em> : Either "year" or "month" specifying which input control should get initial focus. Defaults to "year"</dd>
</dl>
<p>E.g.</p>
<pre>
var navConfig = {
strings: {
month:"Calendar Month",
year:"Calendar Year",
submit: "Submit",
cancel: "Cancel",
invalidYear: "Please enter a valid year"
},
monthFormat: YAHOO.widget.Calendar.SHORT,
initialFocus: "month"
}
</pre>
</div>
</div>
<div class="default">
Default Value: null
</div>
<hr />
</div>
<div class="">
<h4><a name="config_pagedate">pagedate</a>
<code>- String</code>
</h4>
<div class="detail">
<div class="description">
The month/year representing the current visible Calendar date (mm/yyyy)
</div>
</div>
<div class="default">
Default Value: today's date
</div>
<hr />
</div>
<div class="">
<h4><a name="config_selected">selected</a>
<code>- String</code>
</h4>
<div class="detail">
<div class="description">
The date or range of dates representing the current Calendar selection
</div>
</div>
<div class="default">
Default Value: []
</div>
<hr />
</div>
<div class="">
<h4><a name="config_SHOW_WEEK_FOOTER">SHOW_WEEK_FOOTER</a>
<code>- Boolean</code>
</h4>
<div class="detail">
<div class="description">
True if the Calendar should show week row footers. False by default.
</div>
</div>
<div class="default">
Default Value: false
</div>
<hr />
</div>
<div class="">
<h4><a name="config_SHOW_WEEK_HEADER">SHOW_WEEK_HEADER</a>
<code>- Boolean</code>
</h4>
<div class="detail">
<div class="description">
True if the Calendar should show week row headers. False by default.
</div>
</div>
<div class="default">
Default Value: false
</div>
<hr />
</div>
<div class="">
<h4><a name="config_SHOW_WEEKDAYS">SHOW_WEEKDAYS</a>
<code>- Boolean</code>
</h4>
<div class="detail">
<div class="description">
True if the Calendar should show weekday labels. True by default.
</div>
</div>
<div class="default">
Default Value: true
</div>
<hr />
</div>
<div class="">
<h4><a name="config_START_WEEKDAY">START_WEEKDAY</a>
<code>- number</code>
</h4>
<div class="detail">
<div class="description">
The weekday the week begins on. Default is 0 (Sunday = 0, Monday = 1 ... Saturday = 6).
</div>
</div>
<div class="default">
Default Value: 0
</div>
<hr />
</div>
<div class="">
<h4><a name="config_title">title</a>
<code>- String</code>
</h4>
<div class="detail">
<div class="description">
The title to display above the Calendar's month header
</div>
</div>
<div class="default">
Default Value: ""
</div>
<hr />
</div>
<div class="">
<h4><a name="config_WEEKDAYS_1CHAR">WEEKDAYS_1CHAR</a>
<code>- String[]</code>
</h4>
<div class="detail">
<div class="description">
The 1-character weekday labels for the current locale.
</div>
</div>
<div class="default">
Default Value: ["S", "M", "T", "W", "T", "F", "S"]
</div>
<hr />
</div>
<div class="">
<h4><a name="config_WEEKDAYS_LONG">WEEKDAYS_LONG</a>
<code>- String[]</code>
</h4>
<div class="detail">
<div class="description">
The long weekday labels for the current locale.
</div>
</div>
<div class="default">
Default Value: ["Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday"]
</div>
<hr />
</div>
<div class="">
<h4><a name="config_WEEKDAYS_MEDIUM">WEEKDAYS_MEDIUM</a>
<code>- String[]</code>
</h4>
<div class="detail">
<div class="description">
The medium weekday labels for the current locale.
</div>
</div>
<div class="default">
Default Value: ["Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat"]
</div>
<hr />
</div>
<div class="">
<h4><a name="config_WEEKDAYS_SHORT">WEEKDAYS_SHORT</a>
<code>- String[]</code>
</h4>
<div class="detail">
<div class="description">
The short weekday labels for the current locale.
</div>
</div>
<div class="default">
Default Value: ["Su", "Mo", "Tu", "We", "Th", "Fr", "Sa"]
</div>
<hr />
</div>
</div>
</div>
</div>
</div>
<div class="yui-b">
<div class="nav">
<div class="module">
<h4>Modules</h4>
<ul class="content">
<li class=""><a href="module_animation.html">animation</a></li>
<li class=""><a href="module_autocomplete.html">autocomplete</a></li>
<li class=""><a href="module_button.html">button</a></li>
<li class="selected"><a href="module_calendar.html">calendar</a></li>
<li class=""><a href="module_charts.html">charts</a></li>
<li class=""><a href="module_colorpicker.html">colorpicker</a></li>
<li class=""><a href="module_connection.html">connection</a></li>
<li class=""><a href="module_container.html">container</a></li>
<li class=""><a href="module_cookie.html">cookie</a></li>
<li class=""><a href="module_datasource.html">datasource</a></li>
<li class=""><a href="module_datatable.html">datatable</a></li>
<li class=""><a href="module_dom.html">dom</a></li>
<li class=""><a href="module_dragdrop.html">dragdrop</a></li>
<li class=""><a href="module_editor.html">editor</a></li>
<li class=""><a href="module_element.html">element</a></li>
<li class=""><a href="module_event.html">event</a></li>
<li class=""><a href="module_get.html">get</a></li>
<li class=""><a href="module_history.html">history</a></li>
<li class=""><a href="module_imagecropper.html">imagecropper</a></li>
<li class=""><a href="module_imageloader.html">imageloader</a></li>
<li class=""><a href="module_json.html">json</a></li>
<li class=""><a href="module_layout.html">layout</a></li>
<li class=""><a href="module_logger.html">logger</a></li>
<li class=""><a href="module_menu.html">menu</a></li>
<li class=""><a href="module_profiler.html">profiler</a></li>
<li class=""><a href="module_profilerviewer.html">profilerviewer</a></li>
<li class=""><a href="module_resize.html">resize</a></li>
<li class=""><a href="module_selector.html">selector</a></li>
<li class=""><a href="module_slider.html">slider</a></li>
<li class=""><a href="module_tabview.html">tabview</a></li>
<li class=""><a href="module_treeview.html">treeview</a></li>
<li class=""><a href="module_uploader.html">uploader</a></li>
<li class=""><a href="module_yahoo.html">yahoo</a></li>
<li class=""><a href="module_yuiloader.html">yuiloader</a></li>
<li class=""><a href="module_yuitest.html">yuitest</a></li>
</ul>
</div>
<div class="module">
<h4>Classes</h4>
<ul class="content">
<li class="selected"><a href="YAHOO.widget.Calendar.html">YAHOO.widget.Calendar</a></li>
<li class=""><a href="YAHOO.widget.Calendar2up.html">YAHOO.widget.Calendar2up</a></li>
<li class=""><a href="YAHOO.widget.Calendar_Core.html">YAHOO.widget.Calendar_Core</a></li>
<li class=""><a href="YAHOO.widget.CalendarGroup.html">YAHOO.widget.CalendarGroup</a></li>
<li class=""><a href="YAHOO.widget.CalendarNavigator.html">YAHOO.widget.CalendarNavigator</a></li>
<li class=""><a href="YAHOO.widget.DateMath.html">YAHOO.widget.DateMath</a></li>
</ul>
</div>
<div class="module">
<h4>Files</h4>
<ul class="content">
<li class=""><a href="Calendar.js.html">Calendar.js</a></li>
<li class=""><a href="CalendarGroup.js.html">CalendarGroup.js</a></li>
<li class=""><a href="CalendarNavigator.js.html">CalendarNavigator.js</a></li>
<li class=""><a href="DateMath.js.html">DateMath.js</a></li>
</ul>
</div>
<div class="module">
<h4>Properties</h4>
<ul class="content">
<li class="private"><a href="#property__renderStack">_renderStack</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class="private"><a href="#property__selectedDates">_selectedDates</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_browser">browser</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_cellDates">cellDates</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_cells">cells</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_cfg">cfg</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class="private"><a href="#property_Config">Config</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_containerId">containerId</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_domEventMap">domEventMap</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_id">id</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_index">index</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_Locale">Locale</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_oDomContainer">oDomContainer</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_oNavigator">oNavigator</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_Options">Options</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_parent">parent</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_renderStack">renderStack</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_Style.CSS_BODY">Style.CSS_BODY</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_Style.CSS_CALENDAR">Style.CSS_CALENDAR</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_Style.CSS_CELL">Style.CSS_CELL</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_Style.CSS_CELL_BOTTOM">Style.CSS_CELL_BOTTOM</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_Style.CSS_CELL_HIGHLIGHT1">Style.CSS_CELL_HIGHLIGHT1</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_Style.CSS_CELL_HIGHLIGHT2">Style.CSS_CELL_HIGHLIGHT2</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_Style.CSS_CELL_HIGHLIGHT3">Style.CSS_CELL_HIGHLIGHT3</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_Style.CSS_CELL_HIGHLIGHT4">Style.CSS_CELL_HIGHLIGHT4</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_Style.CSS_CELL_HOVER">Style.CSS_CELL_HOVER</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_Style.CSS_CELL_LEFT">Style.CSS_CELL_LEFT</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_Style.CSS_CELL_OOB">Style.CSS_CELL_OOB</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_Style.CSS_CELL_OOM">Style.CSS_CELL_OOM</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_Style.CSS_CELL_RESTRICTED">Style.CSS_CELL_RESTRICTED</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_Style.CSS_CELL_RIGHT">Style.CSS_CELL_RIGHT</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_Style.CSS_CELL_SELECTABLE">Style.CSS_CELL_SELECTABLE</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_Style.CSS_CELL_SELECTED">Style.CSS_CELL_SELECTED</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_Style.CSS_CELL_SELECTOR">Style.CSS_CELL_SELECTOR</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_Style.CSS_CELL_TODAY">Style.CSS_CELL_TODAY</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_Style.CSS_CELL_TOP">Style.CSS_CELL_TOP</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_Style.CSS_CLOSE">Style.CSS_CLOSE</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_Style.CSS_CONTAINER">Style.CSS_CONTAINER</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_Style.CSS_FOOTER">Style.CSS_FOOTER</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_Style.CSS_HEADER">Style.CSS_HEADER</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_Style.CSS_HEADER_TEXT">Style.CSS_HEADER_TEXT</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_Style.CSS_NAV">Style.CSS_NAV</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_Style.CSS_NAV_LEFT">Style.CSS_NAV_LEFT</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_Style.CSS_NAV_RIGHT">Style.CSS_NAV_RIGHT</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_Style.CSS_ROW_FOOTER">Style.CSS_ROW_FOOTER</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_Style.CSS_ROW_HEADER">Style.CSS_ROW_HEADER</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_Style.CSS_SINGLE">Style.CSS_SINGLE</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_Style.CSS_WEEKDAY_CELL">Style.CSS_WEEKDAY_CELL</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_Style.CSS_WEEKDAY_ROW">Style.CSS_WEEKDAY_ROW</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_today">today</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class="private"><a href="#property_YAHOO.widget.Calendar._DEFAULT_CONFIG">YAHOO.widget.Calendar._DEFAULT_CONFIG</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class="private"><a href="#property_YAHOO.widget.Calendar._EVENT_TYPES">YAHOO.widget.Calendar._EVENT_TYPES</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class="private"><a href="#property_YAHOO.widget.Calendar._STYLES">YAHOO.widget.Calendar._STYLES</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_YAHOO.widget.Calendar.DATE">YAHOO.widget.Calendar.DATE</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_YAHOO.widget.Calendar.DISPLAY_DAYS">YAHOO.widget.Calendar.DISPLAY_DAYS</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_YAHOO.widget.Calendar.IMG_ROOT">YAHOO.widget.Calendar.IMG_ROOT</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_YAHOO.widget.Calendar.LONG">YAHOO.widget.Calendar.LONG</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_YAHOO.widget.Calendar.MEDIUM">YAHOO.widget.Calendar.MEDIUM</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_YAHOO.widget.Calendar.MONTH">YAHOO.widget.Calendar.MONTH</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_YAHOO.widget.Calendar.MONTH_DAY">YAHOO.widget.Calendar.MONTH_DAY</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_YAHOO.widget.Calendar.ONE_CHAR">YAHOO.widget.Calendar.ONE_CHAR</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_YAHOO.widget.Calendar.RANGE">YAHOO.widget.Calendar.RANGE</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_YAHOO.widget.Calendar.SHORT">YAHOO.widget.Calendar.SHORT</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_YAHOO.widget.Calendar.STOP_RENDER">YAHOO.widget.Calendar.STOP_RENDER</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_YAHOO.widget.Calendar.WEEKDAY">YAHOO.widget.Calendar.WEEKDAY</a>
<!--<code>&lt;String&gt;</code>-->
</li>
</ul>
</div>
<div class="module">
<h4>Methods</h4>
<ul class="content">
<li class="private"><!--<code>void</code>-->
<a href="#method__addRenderer">_addRenderer</a>
</li>
<li class="private"><!--<code>Boolean</code>-->
<a href="#method__fieldArraysAreEqual">_fieldArraysAreEqual</a>
</li>
<li class="private"><!--<code>Number</code>-->
<a href="#method__indexOfSelectedFieldArray">_indexOfSelectedFieldArray</a>
</li>
<li class="protected"><!--<code>Object</code>-->
<a href="#method__parseArgs">_parseArgs</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__parseDate">_parseDate</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__parseDates">_parseDates</a>
</li>
<li class="private"><!--<code>Date</code>-->
<a href="#method__parsePageDate">_parsePageDate</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__parseRange">_parseRange</a>
</li>
<li class="private"><!--<code>Date</code>-->
<a href="#method__toDate">_toDate</a>
</li>
<li class="private"><!--<code>Array[](Number[])</code>-->
<a href="#method__toFieldArray">_toFieldArray</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_addMonthRenderer">addMonthRenderer</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_addMonths">addMonths</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_addRenderer">addRenderer</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_addWeekdayRenderer">addWeekdayRenderer</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_addYears">addYears</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_applyListeners">applyListeners</a>
</li>
<li class=""><!--<code>String</code>-->
<a href="#method_buildDayLabel">buildDayLabel</a>
</li>
<li class=""><!--<code>String</code>-->
<a href="#method_buildMonthLabel">buildMonthLabel</a>
</li>
<li class=""><!--<code>Array</code>-->
<a href="#method_buildWeekdays">buildWeekdays</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_clear">clear</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_clearAllBodyCellStyles">clearAllBodyCellStyles</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_clearElement">clearElement</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_configClose">configClose</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_configIframe">configIframe</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_configLocale">configLocale</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_configLocaleValues">configLocaleValues</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_configMaxDate">configMaxDate</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_configMinDate">configMinDate</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_configNavigator">configNavigator</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_configOptions">configOptions</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_configPageDate">configPageDate</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_configSelected">configSelected</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_configTitle">configTitle</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_createCloseButton">createCloseButton</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_createTitleBar">createTitleBar</a>
</li>
<li class=""><!--<code>Date[]</code>-->
<a href="#method_deselect">deselect</a>
</li>
<li class=""><!--<code>Date[]</code>-->
<a href="#method_deselectAll">deselectAll</a>
</li>
<li class=""><!--<code>Date[]</code>-->
<a href="#method_deselectCell">deselectCell</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_doCellMouseOut">doCellMouseOut</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_doCellMouseOver">doCellMouseOver</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_doSelectCell">doSelectCell</a>
</li>
<li class=""><!--<code>Number</code>-->
<a href="#method_getCellIndex">getCellIndex</a>
</li>
<li class=""><!--<code>Date</code>-->
<a href="#method_getDateByCellId">getDateByCellId</a>
</li>
<li class=""><!--<code>Array</code>-->
<a href="#method_getDateFieldsByCellId">getDateFieldsByCellId</a>
</li>
<li class=""><!--<code>Date[]</code>-->
<a href="#method_getSelectedDates">getSelectedDates</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_hide">hide</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_init">init</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_initEvents">initEvents</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_initStyles">initStyles</a>
</li>
<li class=""><!--<code>Boolean</code>-->
<a href="#method_isDateOOB">isDateOOB</a>
</li>
<li class=""><!--<code>Boolean</code>-->
<a href="#method_isDateOOM">isDateOOM</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_nextMonth">nextMonth</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_nextYear">nextYear</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_onBeforeDeselect">onBeforeDeselect</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_onBeforeSelect">onBeforeSelect</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_onChangePage">onChangePage</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_onClear">onClear</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_onDeselect">onDeselect</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_onRender">onRender</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_onReset">onReset</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_onSelect">onSelect</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_previousMonth">previousMonth</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_previousYear">previousYear</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method_refreshLocale">refreshLocale</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_removeCloseButton">removeCloseButton</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_removeRenderers">removeRenderers</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_removeTitleBar">removeTitleBar</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_render">render</a>
</li>
<li class=""><!--<code>Array</code>-->
<a href="#method_renderBody">renderBody</a>
</li>
<li class=""><!--<code>String</code>-->
<a href="#method_renderBodyCellRestricted">renderBodyCellRestricted</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_renderCellDefault">renderCellDefault</a>
</li>
<li class=""><!--<code>String</code>-->
<a href="#method_renderCellNotThisMonth">renderCellNotThisMonth</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_renderCellStyleHighlight1">renderCellStyleHighlight1</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_renderCellStyleHighlight2">renderCellStyleHighlight2</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_renderCellStyleHighlight3">renderCellStyleHighlight3</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_renderCellStyleHighlight4">renderCellStyleHighlight4</a>
</li>
<li class=""><!--<code>String</code>-->
<a href="#method_renderCellStyleSelected">renderCellStyleSelected</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_renderCellStyleToday">renderCellStyleToday</a>
</li>
<li class=""><!--<code>Array</code>-->
<a href="#method_renderFooter">renderFooter</a>
</li>
<li class=""><!--<code>Array</code>-->
<a href="#method_renderHeader">renderHeader</a>
</li>
<li class=""><!--<code>String</code>-->
<a href="#method_renderOutOfBoundsDate">renderOutOfBoundsDate</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_renderRowFooter">renderRowFooter</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_renderRowHeader">renderRowHeader</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_reset">reset</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_resetRenderers">resetRenderers</a>
</li>
<li class=""><!--<code>Date[]</code>-->
<a href="#method_select">select</a>
</li>
<li class=""><!--<code>Date[]</code>-->
<a href="#method_selectCell">selectCell</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_setMonth">setMonth</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_setYear">setYear</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_show">show</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_styleCellDefault">styleCellDefault</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_subtractMonths">subtractMonths</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_subtractYears">subtractYears</a>
</li>
<li class=""><!--<code>Date</code>-->
<a href="#method_toDate">toDate</a>
</li>
<li class=""><!--<code>String</code>-->
<a href="#method_toString">toString</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_validate">validate</a>
</li>
</ul>
</div>
<div class="module">
<h4>Events</h4>
<ul class="content">
<li class="">
<a href="#event_beforeDeselectEvent">beforeDeselectEvent</a>
</li>
<li class="">
<a href="#event_beforeHideEvent">beforeHideEvent</a>
</li>
<li class="">
<a href="#event_beforeHideNavEvent">beforeHideNavEvent</a>
</li>
<li class="">
<a href="#event_beforeRenderEvent">beforeRenderEvent</a>
</li>
<li class="">
<a href="#event_beforeRenderNavEvent">beforeRenderNavEvent</a>
</li>
<li class="">
<a href="#event_beforeSelectEvent">beforeSelectEvent</a>
</li>
<li class="">
<a href="#event_beforeShowEvent">beforeShowEvent</a>
</li>
<li class="">
<a href="#event_beforeShowNavEvent">beforeShowNavEvent</a>
</li>
<li class="">
<a href="#event_changePageEvent">changePageEvent</a>
</li>
<li class="">
<a href="#event_clearEvent">clearEvent</a>
</li>
<li class="">
<a href="#event_deselectEvent">deselectEvent</a>
</li>
<li class="">
<a href="#event_hideEvent">hideEvent</a>
</li>
<li class="">
<a href="#event_hideNavEvent">hideNavEvent</a>
</li>
<li class="">
<a href="#event_renderEvent">renderEvent</a>
</li>
<li class="">
<a href="#event_renderNavEvent">renderNavEvent</a>
</li>
<li class="">
<a href="#event_resetEvent">resetEvent</a>
</li>
<li class="">
<a href="#event_selectEvent">selectEvent</a>
</li>
<li class="">
<a href="#event_showEvent">showEvent</a>
</li>
<li class="">
<a href="#event_showNavEvent">showNavEvent</a>
</li>
</ul>
</div>
<div class="module">
<h4>Configuration Attributes</h4>
<ul class="content">
<li class="">
<a href="#config_close">close</a>
</li>
<li class="">
<a href="#config_DATE_DELIMITER">DATE_DELIMITER</a>
</li>
<li class="">
<a href="#config_DATE_FIELD_DELIMITER">DATE_FIELD_DELIMITER</a>
</li>
<li class="">
<a href="#config_DATE_RANGE_DELIMITER">DATE_RANGE_DELIMITER</a>
</li>
<li class="">
<a href="#config_HIDE_BLANK_WEEKS">HIDE_BLANK_WEEKS</a>
</li>
<li class="">
<a href="#config_iframe">iframe</a>
</li>
<li class="">
<a href="#config_LOCALE_MONTHS">LOCALE_MONTHS</a>
</li>
<li class="">
<a href="#config_LOCALE_WEEKDAYS">LOCALE_WEEKDAYS</a>
</li>
<li class="">
<a href="#config_maxdate">maxdate</a>
</li>
<li class="">
<a href="#config_MD_DAY_POSITION">MD_DAY_POSITION</a>
</li>
<li class="">
<a href="#config_MD_MONTH_POSITION">MD_MONTH_POSITION</a>
</li>
<li class="">
<a href="#config_MDY_DAY_POSITION">MDY_DAY_POSITION</a>
</li>
<li class="">
<a href="#config_MDY_MONTH_POSITION">MDY_MONTH_POSITION</a>
</li>
<li class="">
<a href="#config_MDY_YEAR_POSITION">MDY_YEAR_POSITION</a>
</li>
<li class="">
<a href="#config_mindate">mindate</a>
</li>
<li class="">
<a href="#config_MONTHS_LONG">MONTHS_LONG</a>
</li>
<li class="">
<a href="#config_MONTHS_SHORT">MONTHS_SHORT</a>
</li>
<li class="">
<a href="#config_MULTI_SELECT">MULTI_SELECT</a>
</li>
<li class="">
<a href="#config_MY_LABEL_MONTH_POSITION">MY_LABEL_MONTH_POSITION</a>
</li>
<li class="">
<a href="#config_MY_LABEL_MONTH_SUFFIX">MY_LABEL_MONTH_SUFFIX</a>
</li>
<li class="">
<a href="#config_MY_LABEL_YEAR_POSITION">MY_LABEL_YEAR_POSITION</a>
</li>
<li class="">
<a href="#config_MY_LABEL_YEAR_SUFFIX">MY_LABEL_YEAR_SUFFIX</a>
</li>
<li class="">
<a href="#config_MY_MONTH_POSITION">MY_MONTH_POSITION</a>
</li>
<li class="">
<a href="#config_MY_YEAR_POSITION">MY_YEAR_POSITION</a>
</li>
<li class="">
<a href="#config_NAV_ARROW_LEFT">NAV_ARROW_LEFT</a>
</li>
<li class="">
<a href="#config_NAV_ARROW_RIGHT">NAV_ARROW_RIGHT</a>
</li>
<li class="">
<a href="#config_navigator">navigator</a>
</li>
<li class="">
<a href="#config_pagedate">pagedate</a>
</li>
<li class="">
<a href="#config_selected">selected</a>
</li>
<li class="">
<a href="#config_SHOW_WEEK_FOOTER">SHOW_WEEK_FOOTER</a>
</li>
<li class="">
<a href="#config_SHOW_WEEK_HEADER">SHOW_WEEK_HEADER</a>
</li>
<li class="">
<a href="#config_SHOW_WEEKDAYS">SHOW_WEEKDAYS</a>
</li>
<li class="">
<a href="#config_START_WEEKDAY">START_WEEKDAY</a>
</li>
<li class="">
<a href="#config_title">title</a>
</li>
<li class="">
<a href="#config_WEEKDAYS_1CHAR">WEEKDAYS_1CHAR</a>
</li>
<li class="">
<a href="#config_WEEKDAYS_LONG">WEEKDAYS_LONG</a>
</li>
<li class="">
<a href="#config_WEEKDAYS_MEDIUM">WEEKDAYS_MEDIUM</a>
</li>
<li class="">
<a href="#config_WEEKDAYS_SHORT">WEEKDAYS_SHORT</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div id="ft">
<hr />
Copyright &copy; 2007 Yahoo! Inc. All rights reserved.
</div>
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink