6049 lines
302 KiB
HTML
6049 lines
302 KiB
HTML
<!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">
|
|
</head>
|
|
|
|
<body id="yahoo-com">
|
|
<div id="doc3" class="yui-t2">
|
|
|
|
<div id="hd">
|
|
<h1>Yahoo! UI Library</h1>
|
|
<h3>Calendar <span class="subtitle">2.2.2</span></h3>
|
|
<p>
|
|
<a href="./index.html">Yahoo! UI Library</a>
|
|
> <a href="./module_calendar.html">calendar</a>
|
|
> YAHOO.widget.Calendar
|
|
|
|
</p>
|
|
</div>
|
|
|
|
<div id="bd">
|
|
<div id="yui-main">
|
|
<div class="yui-b">
|
|
|
|
|
|
<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="cal1Container"></div>
|
|
</xmp>
|
|
Note that the table can be replaced with any kind of element.
|
|
</p>
|
|
</div>
|
|
|
|
<div class="section constructor details">
|
|
<h3><a name="constructor_detail">Constructor</a></h3>
|
|
<div class="content">
|
|
<div class="detail">
|
|
<strong>YAHOO.widget.Calendar</strong>
|
|
<code>
|
|
(
|
|
|
|
|
|
|
|
id
|
|
|
|
,
|
|
containerId
|
|
|
|
,
|
|
config
|
|
)
|
|
</code>
|
|
<div class="description">
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>id
|
|
<String>
|
|
</code>
|
|
The id of the table element that will represent the calendar widget
|
|
</dd>
|
|
<dd>
|
|
<code>containerId
|
|
<String>
|
|
</code>
|
|
The id of the container div element that will wrap the calendar table
|
|
</dd>
|
|
<dd>
|
|
<code>config
|
|
<Object>
|
|
</code>
|
|
The configuration object containing the Calendar's arguments
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="section field details">
|
|
<h3><a name="field_detail">Properties</a></h3>
|
|
<div class="content">
|
|
<h4><a name="_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 />
|
|
<h4><a name="_selectedDates">_selectedDates</a>
|
|
<code>- private Array</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
The private list of initially selected dates.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
<h4><a name="browser">browser</a>
|
|
<code>- String</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Returns a string representing the current browser.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
<h4><a name="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 />
|
|
<h4><a name="cells">cells</a>
|
|
<code>- HTMLTableCellElement[]</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
The collection of calendar table cells
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
<h4><a name="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 />
|
|
<h4><a name="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 />
|
|
<h4><a name="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 />
|
|
<h4><a name="id">id</a>
|
|
<code>- String</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
The id that uniquely identifies this calendar. This id should match the id of the placeholder element on the page.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
<h4><a name="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 />
|
|
<h4><a name="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 />
|
|
<h4><a name="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 />
|
|
<h4><a name="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 />
|
|
<h4><a name="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 />
|
|
<h4><a name="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 />
|
|
<h4><a name="Style.CSS_BODY">Style.CSS_BODY</a>
|
|
<code>- object</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
<h4><a name="Style.CSS_CALENDAR">Style.CSS_CALENDAR</a>
|
|
<code>- object</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
<h4><a name="Style.CSS_CELL">Style.CSS_CELL</a>
|
|
<code>- object</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
<h4><a name="Style.CSS_CELL_BOTTOM">Style.CSS_CELL_BOTTOM</a>
|
|
<code>- object</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
<h4><a name="Style.CSS_CELL_HIGHLIGHT1">Style.CSS_CELL_HIGHLIGHT1</a>
|
|
<code>- object</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
<h4><a name="Style.CSS_CELL_HIGHLIGHT2">Style.CSS_CELL_HIGHLIGHT2</a>
|
|
<code>- object</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
<h4><a name="Style.CSS_CELL_HIGHLIGHT3">Style.CSS_CELL_HIGHLIGHT3</a>
|
|
<code>- object</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
<h4><a name="Style.CSS_CELL_HIGHLIGHT4">Style.CSS_CELL_HIGHLIGHT4</a>
|
|
<code>- object</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
<h4><a name="Style.CSS_CELL_HOVER">Style.CSS_CELL_HOVER</a>
|
|
<code>- object</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
<h4><a name="Style.CSS_CELL_LEFT">Style.CSS_CELL_LEFT</a>
|
|
<code>- object</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
<h4><a name="Style.CSS_CELL_OOB">Style.CSS_CELL_OOB</a>
|
|
<code>- object</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
<h4><a name="Style.CSS_CELL_OOM">Style.CSS_CELL_OOM</a>
|
|
<code>- object</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
<h4><a name="Style.CSS_CELL_RESTRICTED">Style.CSS_CELL_RESTRICTED</a>
|
|
<code>- object</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
<h4><a name="Style.CSS_CELL_RIGHT">Style.CSS_CELL_RIGHT</a>
|
|
<code>- object</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
<h4><a name="Style.CSS_CELL_SELECTABLE">Style.CSS_CELL_SELECTABLE</a>
|
|
<code>- object</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
<h4><a name="Style.CSS_CELL_SELECTED">Style.CSS_CELL_SELECTED</a>
|
|
<code>- object</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
<h4><a name="Style.CSS_CELL_SELECTOR">Style.CSS_CELL_SELECTOR</a>
|
|
<code>- object</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
<h4><a name="Style.CSS_CELL_TODAY">Style.CSS_CELL_TODAY</a>
|
|
<code>- object</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
<h4><a name="Style.CSS_CELL_TOP">Style.CSS_CELL_TOP</a>
|
|
<code>- object</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
<h4><a name="Style.CSS_CLOSE">Style.CSS_CLOSE</a>
|
|
<code>- object</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
<h4><a name="Style.CSS_CONTAINER">Style.CSS_CONTAINER</a>
|
|
<code>- object</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
<h4><a name="Style.CSS_FOOTER">Style.CSS_FOOTER</a>
|
|
<code>- object</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
<h4><a name="Style.CSS_HEADER">Style.CSS_HEADER</a>
|
|
<code>- object</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
<h4><a name="Style.CSS_HEADER_TEXT">Style.CSS_HEADER_TEXT</a>
|
|
<code>- object</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
<h4><a name="Style.CSS_NAV_LEFT">Style.CSS_NAV_LEFT</a>
|
|
<code>- object</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
<h4><a name="Style.CSS_NAV_RIGHT">Style.CSS_NAV_RIGHT</a>
|
|
<code>- object</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
<h4><a name="Style.CSS_ROW_FOOTER">Style.CSS_ROW_FOOTER</a>
|
|
<code>- object</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
<h4><a name="Style.CSS_ROW_HEADER">Style.CSS_ROW_HEADER</a>
|
|
<code>- object</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
<h4><a name="Style.CSS_SINGLE">Style.CSS_SINGLE</a>
|
|
<code>- object</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
<h4><a name="Style.CSS_WEEKDAY_CELL">Style.CSS_WEEKDAY_CELL</a>
|
|
<code>- object</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
<h4><a name="Style.CSS_WEEKDAY_ROW">Style.CSS_WEEKDAY_ROW</a>
|
|
<code>- object</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
<h4><a name="today">today</a>
|
|
<code>- Date</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
A Date object representing today's date.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
<h4><a name="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 />
|
|
<h4><a name="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 />
|
|
<h4><a name="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 />
|
|
<h4><a name="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 />
|
|
<h4><a name="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 />
|
|
<h4><a name="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 />
|
|
<h4><a name="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 />
|
|
<h4><a name="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 />
|
|
<h4><a name="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 />
|
|
<h4><a name="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 />
|
|
<h4><a name="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 />
|
|
<h4><a name="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 />
|
|
<h4><a name="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 />
|
|
<h4><a name="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 />
|
|
<h4><a name="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 class="section method details">
|
|
<h3><a name="methodDetails">Methods</a></h3>
|
|
<div class="content">
|
|
<h4>
|
|
<a name="_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 <String></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 <Array></code>
|
|
An array of dates used to construct the renderer. The format varies based
|
|
on the renderer type
|
|
</dd>
|
|
<dd>
|
|
<code>fnRender <Function></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 />
|
|
<h4>
|
|
<a name="_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 <Number[]></code>
|
|
The first date field array to compare
|
|
</dd>
|
|
<dd>
|
|
<code>array2 <Number[]></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 />
|
|
<h4>
|
|
<a name="_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 <Number[]></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 />
|
|
<h4>
|
|
<a name="_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 <String></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 />
|
|
<h4>
|
|
<a name="_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 <String></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 />
|
|
<h4>
|
|
<a name="_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 <Date|String></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 />
|
|
<h4>
|
|
<a name="_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 <Number[]></code>
|
|
Date field array representing the first date in the range
|
|
</dd>
|
|
<dd>
|
|
<code>endDate <Number[]></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 />
|
|
<h4>
|
|
<a name="_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 <Number[]></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 />
|
|
<h4>
|
|
<a name="_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 <String/Date/Date[]></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 />
|
|
<h4>
|
|
<a name="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 <Number></code>
|
|
The month (1-12) to associate with this renderer
|
|
</dd>
|
|
<dd>
|
|
<code>fnRender <Function></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 />
|
|
<h4>
|
|
<a name="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 <Number></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 />
|
|
<h4>
|
|
<a name="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 <String></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 <Function></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 />
|
|
<h4>
|
|
<a name="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 <Number></code>
|
|
The weekday (0-6) to associate with this renderer
|
|
</dd>
|
|
<dd>
|
|
<code>fnRender <Function></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 />
|
|
<h4>
|
|
<a name="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 <Number></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 />
|
|
<h4>
|
|
<a name="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 />
|
|
<h4>
|
|
<a name="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 <Date></code>
|
|
The current working date
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
String
|
|
</code></dt>
|
|
<dd>The formatted day label</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
<h4>
|
|
<a name="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 />
|
|
<h4>
|
|
<a name="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 <Array></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 />
|
|
<h4>
|
|
<a name="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 />
|
|
<h4>
|
|
<a name="clearAllBodyCellStyles">clearAllBodyCellStyles</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>clearAllBodyCellStyles</strong>
|
|
(
|
|
|
|
|
|
The
|
|
|
|
|
|
)
|
|
</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>The <style></code>
|
|
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 />
|
|
<h4>
|
|
<a name="clearElement">clearElement</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>clearElement</strong>
|
|
(
|
|
|
|
|
|
The
|
|
|
|
|
|
)
|
|
</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>The <HTMLTableCellElement></code>
|
|
cell to clear
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
<h4>
|
|
<a name="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 />
|
|
<h4>
|
|
<a name="configIframe">configIframe</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>configIframe</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Renders the built-in IFRAME shim for the IE6 and below
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
<h4>
|
|
<a name="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 />
|
|
<h4>
|
|
<a name="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 />
|
|
<h4>
|
|
<a name="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 />
|
|
<h4>
|
|
<a name="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 />
|
|
<h4>
|
|
<a name="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 />
|
|
<h4>
|
|
<a name="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 />
|
|
<h4>
|
|
<a name="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 />
|
|
<h4>
|
|
<a name="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 />
|
|
<h4>
|
|
<a name="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.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>date <String/Date/Date[]></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 />
|
|
<h4>
|
|
<a name="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 />
|
|
<h4>
|
|
<a name="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.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>cellIndex <Number></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 />
|
|
<h4>
|
|
<a name="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 <DOMEvent></code>
|
|
The event
|
|
</dd>
|
|
<dd>
|
|
<code>cal <Calendar></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 />
|
|
<h4>
|
|
<a name="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 <DOMEvent></code>
|
|
The event
|
|
</dd>
|
|
<dd>
|
|
<code>cal <Calendar></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 />
|
|
<h4>
|
|
<a name="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 <DOMEvent></code>
|
|
The event
|
|
</dd>
|
|
<dd>
|
|
<code>cal <Calendar></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 />
|
|
<h4>
|
|
<a name="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 <String></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 />
|
|
<h4>
|
|
<a name="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 <String></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 />
|
|
<h4>
|
|
<a name="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 />
|
|
<h4>
|
|
<a name="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 />
|
|
<h4>
|
|
<a name="init">init</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>init</strong>
|
|
(
|
|
|
|
|
|
id
|
|
|
|
|
|
,
|
|
containerId
|
|
|
|
|
|
,
|
|
config
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Initializes the Calendar widget.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>id <String></code>
|
|
The id of the table element that will represent the calendar widget
|
|
</dd>
|
|
<dd>
|
|
<code>containerId <String></code>
|
|
The id of the container div element that will wrap the calendar table
|
|
</dd>
|
|
<dd>
|
|
<code>config <Object></code>
|
|
The configuration object containing the Calendar's arguments
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
<h4>
|
|
<a name="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 />
|
|
<h4>
|
|
<a name="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 />
|
|
<h4>
|
|
<a name="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 <Date></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 />
|
|
<h4>
|
|
<a name="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 />
|
|
<h4>
|
|
<a name="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 />
|
|
<h4>
|
|
<a name="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 />
|
|
<h4>
|
|
<a name="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 />
|
|
<h4>
|
|
<a name="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 />
|
|
<h4>
|
|
<a name="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 />
|
|
<h4>
|
|
<a name="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 <Array></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 />
|
|
<h4>
|
|
<a name="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 />
|
|
<h4>
|
|
<a name="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 />
|
|
<h4>
|
|
<a name="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 <Array></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 />
|
|
<h4>
|
|
<a name="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 />
|
|
<h4>
|
|
<a name="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 />
|
|
<h4>
|
|
<a name="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 />
|
|
<h4>
|
|
<a name="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 />
|
|
<h4>
|
|
<a name="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 <Date></code>
|
|
The current working Date being used for the render process
|
|
</dd>
|
|
<dd>
|
|
<code>html <Array></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 />
|
|
<h4>
|
|
<a name="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 <Date></code>
|
|
The current working Date object being used to generate the calendar
|
|
</dd>
|
|
<dd>
|
|
<code>cell <HTMLTableCellElement></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 />
|
|
<h4>
|
|
<a name="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 <Date></code>
|
|
The current working Date object being used to generate the calendar
|
|
</dd>
|
|
<dd>
|
|
<code>cell <HTMLTableCellElement></code>
|
|
The current working cell in the calendar
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
<h4>
|
|
<a name="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 <Date></code>
|
|
The current working Date object being used to generate the calendar
|
|
</dd>
|
|
<dd>
|
|
<code>cell <HTMLTableCellElement></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 />
|
|
<h4>
|
|
<a name="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 <Date></code>
|
|
The current working Date object being used to generate the calendar
|
|
</dd>
|
|
<dd>
|
|
<code>cell <HTMLTableCellElement></code>
|
|
The current working cell in the calendar
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
<h4>
|
|
<a name="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 <Date></code>
|
|
The current working Date object being used to generate the calendar
|
|
</dd>
|
|
<dd>
|
|
<code>cell <HTMLTableCellElement></code>
|
|
The current working cell in the calendar
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
<h4>
|
|
<a name="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 <Date></code>
|
|
The current working Date object being used to generate the calendar
|
|
</dd>
|
|
<dd>
|
|
<code>cell <HTMLTableCellElement></code>
|
|
The current working cell in the calendar
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
<h4>
|
|
<a name="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 <Date></code>
|
|
The current working Date object being used to generate the calendar
|
|
</dd>
|
|
<dd>
|
|
<code>cell <HTMLTableCellElement></code>
|
|
The current working cell in the calendar
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
<h4>
|
|
<a name="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 <Date></code>
|
|
The current working Date object being used to generate the calendar
|
|
</dd>
|
|
<dd>
|
|
<code>cell <HTMLTableCellElement></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 />
|
|
<h4>
|
|
<a name="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 <Date></code>
|
|
The current working Date object being used to generate the calendar
|
|
</dd>
|
|
<dd>
|
|
<code>cell <HTMLTableCellElement></code>
|
|
The current working cell in the calendar
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
<h4>
|
|
<a name="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 <Array></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 />
|
|
<h4>
|
|
<a name="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 <Array></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 />
|
|
<h4>
|
|
<a name="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 <Date></code>
|
|
The current working Date object being used to generate the calendar
|
|
</dd>
|
|
<dd>
|
|
<code>cell <HTMLTableCellElement></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 />
|
|
<h4>
|
|
<a name="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 <Number></code>
|
|
The week number of the current row
|
|
</dd>
|
|
<dd>
|
|
<code>cell <Array></code>
|
|
The current working HTML array
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
<h4>
|
|
<a name="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 <Number></code>
|
|
The week number of the current row
|
|
</dd>
|
|
<dd>
|
|
<code>cell <Array></code>
|
|
The current working HTML array
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
<h4>
|
|
<a name="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 />
|
|
<h4>
|
|
<a name="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 />
|
|
<h4>
|
|
<a name="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.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>date <String/Date/Date[]></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 />
|
|
<h4>
|
|
<a name="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.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>cellIndex <Number></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 />
|
|
<h4>
|
|
<a name="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 <Number></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 />
|
|
<h4>
|
|
<a name="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 <Number></code>
|
|
The numeric 4-digit year
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
<h4>
|
|
<a name="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 />
|
|
<h4>
|
|
<a name="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 <Date></code>
|
|
The current working Date object being used to generate the calendar
|
|
</dd>
|
|
<dd>
|
|
<code>cell <HTMLTableCellElement></code>
|
|
The current working cell in the calendar
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
<h4>
|
|
<a name="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 <Number></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 />
|
|
<h4>
|
|
<a name="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 <Number></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 />
|
|
<h4>
|
|
<a name="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 />
|
|
<h4>
|
|
<a name="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 class="section method details">
|
|
<h3><a name="methodDetails">Events</a></h3>
|
|
<div class="content">
|
|
<h4>
|
|
<a name="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 />
|
|
<h4>
|
|
<a name="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 />
|
|
<h4>
|
|
<a name="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 />
|
|
<h4>
|
|
<a name="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 />
|
|
<h4>
|
|
<a name="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 />
|
|
<h4>
|
|
<a name="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 <Array></code>
|
|
of Date field arrays in the format [YYYY, MM, DD].
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
<h4>
|
|
<a name="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 />
|
|
<h4>
|
|
<a name="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 />
|
|
<h4>
|
|
<a name="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 <Array></code>
|
|
of Date field arrays in the format [YYYY, MM, DD].
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
<div class="section field details">
|
|
<h3><a name="field_detail">Configuration Attributes</a></h3>
|
|
<div class="content">
|
|
<h4><a name="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 />
|
|
<h4><a name="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 />
|
|
<h4><a name="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 />
|
|
<h4><a name="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 />
|
|
<h4><a name="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 />
|
|
<h4><a name="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.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default">
|
|
Default Value: true
|
|
</div>
|
|
|
|
<hr />
|
|
<h4><a name="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 />
|
|
<h4><a name="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 />
|
|
<h4><a name="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 />
|
|
<h4><a name="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 />
|
|
<h4><a name="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 />
|
|
<h4><a name="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 />
|
|
<h4><a name="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 />
|
|
<h4><a name="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 />
|
|
<h4><a name="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 />
|
|
<h4><a name="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 />
|
|
<h4><a name="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 />
|
|
<h4><a name="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 />
|
|
<h4><a name="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 />
|
|
<h4><a name="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 />
|
|
<h4><a name="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 />
|
|
<h4><a name="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 />
|
|
<h4><a name="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 />
|
|
<h4><a name="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 />
|
|
<h4><a name="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 />
|
|
<h4><a name="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 />
|
|
<h4><a name="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 />
|
|
<h4><a name="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).
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default">
|
|
Default Value: 0
|
|
</div>
|
|
|
|
<hr />
|
|
<h4><a name="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 />
|
|
<h4><a name="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 />
|
|
<h4><a name="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 />
|
|
<h4><a name="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 />
|
|
<h4><a name="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 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_connection.html">connection</a></li>
|
|
|
|
<li class=""><a href="module_container.html">container</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_element.html">element</a></li>
|
|
|
|
<li class=""><a href="module_event.html">event</a></li>
|
|
|
|
<li class=""><a href="module_history.html">history</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_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_yahoo.html">yahoo</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.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="DateMath.js.html">DateMath.js</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="module">
|
|
<h4>Properties</h4>
|
|
<ul class="content">
|
|
<li><a href="#_renderStack">_renderStack</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#_selectedDates">_selectedDates</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#browser">browser</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#cellDates">cellDates</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#cells">cells</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#cfg">cfg</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#Config">Config</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#domEventMap">domEventMap</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#id">id</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#index">index</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#Locale">Locale</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#oDomContainer">oDomContainer</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#Options">Options</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#parent">parent</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#renderStack">renderStack</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#Style.CSS_BODY">Style.CSS_BODY</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#Style.CSS_CALENDAR">Style.CSS_CALENDAR</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#Style.CSS_CELL">Style.CSS_CELL</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#Style.CSS_CELL_BOTTOM">Style.CSS_CELL_BOTTOM</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#Style.CSS_CELL_HIGHLIGHT1">Style.CSS_CELL_HIGHLIGHT1</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#Style.CSS_CELL_HIGHLIGHT2">Style.CSS_CELL_HIGHLIGHT2</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#Style.CSS_CELL_HIGHLIGHT3">Style.CSS_CELL_HIGHLIGHT3</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#Style.CSS_CELL_HIGHLIGHT4">Style.CSS_CELL_HIGHLIGHT4</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#Style.CSS_CELL_HOVER">Style.CSS_CELL_HOVER</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#Style.CSS_CELL_LEFT">Style.CSS_CELL_LEFT</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#Style.CSS_CELL_OOB">Style.CSS_CELL_OOB</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#Style.CSS_CELL_OOM">Style.CSS_CELL_OOM</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#Style.CSS_CELL_RESTRICTED">Style.CSS_CELL_RESTRICTED</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#Style.CSS_CELL_RIGHT">Style.CSS_CELL_RIGHT</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#Style.CSS_CELL_SELECTABLE">Style.CSS_CELL_SELECTABLE</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#Style.CSS_CELL_SELECTED">Style.CSS_CELL_SELECTED</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#Style.CSS_CELL_SELECTOR">Style.CSS_CELL_SELECTOR</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#Style.CSS_CELL_TODAY">Style.CSS_CELL_TODAY</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#Style.CSS_CELL_TOP">Style.CSS_CELL_TOP</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#Style.CSS_CLOSE">Style.CSS_CLOSE</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#Style.CSS_CONTAINER">Style.CSS_CONTAINER</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#Style.CSS_FOOTER">Style.CSS_FOOTER</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#Style.CSS_HEADER">Style.CSS_HEADER</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#Style.CSS_HEADER_TEXT">Style.CSS_HEADER_TEXT</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#Style.CSS_NAV_LEFT">Style.CSS_NAV_LEFT</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#Style.CSS_NAV_RIGHT">Style.CSS_NAV_RIGHT</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#Style.CSS_ROW_FOOTER">Style.CSS_ROW_FOOTER</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#Style.CSS_ROW_HEADER">Style.CSS_ROW_HEADER</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#Style.CSS_SINGLE">Style.CSS_SINGLE</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#Style.CSS_WEEKDAY_CELL">Style.CSS_WEEKDAY_CELL</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#Style.CSS_WEEKDAY_ROW">Style.CSS_WEEKDAY_ROW</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#today">today</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#YAHOO.widget.Calendar._DEFAULT_CONFIG">YAHOO.widget.Calendar._DEFAULT_CONFIG</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#YAHOO.widget.Calendar._EVENT_TYPES">YAHOO.widget.Calendar._EVENT_TYPES</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#YAHOO.widget.Calendar._STYLES">YAHOO.widget.Calendar._STYLES</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#YAHOO.widget.Calendar.DATE">YAHOO.widget.Calendar.DATE</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#YAHOO.widget.Calendar.DISPLAY_DAYS">YAHOO.widget.Calendar.DISPLAY_DAYS</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#YAHOO.widget.Calendar.IMG_ROOT">YAHOO.widget.Calendar.IMG_ROOT</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#YAHOO.widget.Calendar.LONG">YAHOO.widget.Calendar.LONG</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#YAHOO.widget.Calendar.MEDIUM">YAHOO.widget.Calendar.MEDIUM</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#YAHOO.widget.Calendar.MONTH">YAHOO.widget.Calendar.MONTH</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#YAHOO.widget.Calendar.MONTH_DAY">YAHOO.widget.Calendar.MONTH_DAY</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#YAHOO.widget.Calendar.ONE_CHAR">YAHOO.widget.Calendar.ONE_CHAR</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#YAHOO.widget.Calendar.RANGE">YAHOO.widget.Calendar.RANGE</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#YAHOO.widget.Calendar.SHORT">YAHOO.widget.Calendar.SHORT</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#YAHOO.widget.Calendar.STOP_RENDER">YAHOO.widget.Calendar.STOP_RENDER</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#YAHOO.widget.Calendar.WEEKDAY">YAHOO.widget.Calendar.WEEKDAY</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="module">
|
|
<h4>Methods</h4>
|
|
<ul class="content">
|
|
<li><!--<code>void</code>-->
|
|
<a href="#_addRenderer">_addRenderer</a>
|
|
</li>
|
|
<li><!--<code>Boolean</code>-->
|
|
<a href="#_fieldArraysAreEqual">_fieldArraysAreEqual</a>
|
|
</li>
|
|
<li><!--<code>Number</code>-->
|
|
<a href="#_indexOfSelectedFieldArray">_indexOfSelectedFieldArray</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#_parseDate">_parseDate</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#_parseDates">_parseDates</a>
|
|
</li>
|
|
<li><!--<code>Date</code>-->
|
|
<a href="#_parsePageDate">_parsePageDate</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#_parseRange">_parseRange</a>
|
|
</li>
|
|
<li><!--<code>Date</code>-->
|
|
<a href="#_toDate">_toDate</a>
|
|
</li>
|
|
<li><!--<code>Array[](Number[])</code>-->
|
|
<a href="#_toFieldArray">_toFieldArray</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#addMonthRenderer">addMonthRenderer</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#addMonths">addMonths</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#addRenderer">addRenderer</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#addWeekdayRenderer">addWeekdayRenderer</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#addYears">addYears</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#applyListeners">applyListeners</a>
|
|
</li>
|
|
<li><!--<code>String</code>-->
|
|
<a href="#buildDayLabel">buildDayLabel</a>
|
|
</li>
|
|
<li><!--<code>String</code>-->
|
|
<a href="#buildMonthLabel">buildMonthLabel</a>
|
|
</li>
|
|
<li><!--<code>Array</code>-->
|
|
<a href="#buildWeekdays">buildWeekdays</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#clear">clear</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#clearAllBodyCellStyles">clearAllBodyCellStyles</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#clearElement">clearElement</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#configClose">configClose</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#configIframe">configIframe</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#configLocale">configLocale</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#configLocaleValues">configLocaleValues</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#configMaxDate">configMaxDate</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#configMinDate">configMinDate</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#configOptions">configOptions</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#configPageDate">configPageDate</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#configSelected">configSelected</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#configTitle">configTitle</a>
|
|
</li>
|
|
<li><!--<code>Date[]</code>-->
|
|
<a href="#deselect">deselect</a>
|
|
</li>
|
|
<li><!--<code>Date[]</code>-->
|
|
<a href="#deselectAll">deselectAll</a>
|
|
</li>
|
|
<li><!--<code>Date[]</code>-->
|
|
<a href="#deselectCell">deselectCell</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#doCellMouseOut">doCellMouseOut</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#doCellMouseOver">doCellMouseOver</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#doSelectCell">doSelectCell</a>
|
|
</li>
|
|
<li><!--<code>Date</code>-->
|
|
<a href="#getDateByCellId">getDateByCellId</a>
|
|
</li>
|
|
<li><!--<code>Array</code>-->
|
|
<a href="#getDateFieldsByCellId">getDateFieldsByCellId</a>
|
|
</li>
|
|
<li><!--<code>Date[]</code>-->
|
|
<a href="#getSelectedDates">getSelectedDates</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#hide">hide</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#init">init</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#initEvents">initEvents</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#initStyles">initStyles</a>
|
|
</li>
|
|
<li><!--<code>Boolean</code>-->
|
|
<a href="#isDateOOM">isDateOOM</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#nextMonth">nextMonth</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#nextYear">nextYear</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#onBeforeDeselect">onBeforeDeselect</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#onBeforeSelect">onBeforeSelect</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#onChangePage">onChangePage</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#onClear">onClear</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#onDeselect">onDeselect</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#onRender">onRender</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#onReset">onReset</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#onSelect">onSelect</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#previousMonth">previousMonth</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#previousYear">previousYear</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#refreshLocale">refreshLocale</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#render">render</a>
|
|
</li>
|
|
<li><!--<code>Array</code>-->
|
|
<a href="#renderBody">renderBody</a>
|
|
</li>
|
|
<li><!--<code>String</code>-->
|
|
<a href="#renderBodyCellRestricted">renderBodyCellRestricted</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#renderCellDefault">renderCellDefault</a>
|
|
</li>
|
|
<li><!--<code>String</code>-->
|
|
<a href="#renderCellNotThisMonth">renderCellNotThisMonth</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#renderCellStyleHighlight1">renderCellStyleHighlight1</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#renderCellStyleHighlight2">renderCellStyleHighlight2</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#renderCellStyleHighlight3">renderCellStyleHighlight3</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#renderCellStyleHighlight4">renderCellStyleHighlight4</a>
|
|
</li>
|
|
<li><!--<code>String</code>-->
|
|
<a href="#renderCellStyleSelected">renderCellStyleSelected</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#renderCellStyleToday">renderCellStyleToday</a>
|
|
</li>
|
|
<li><!--<code>Array</code>-->
|
|
<a href="#renderFooter">renderFooter</a>
|
|
</li>
|
|
<li><!--<code>Array</code>-->
|
|
<a href="#renderHeader">renderHeader</a>
|
|
</li>
|
|
<li><!--<code>String</code>-->
|
|
<a href="#renderOutOfBoundsDate">renderOutOfBoundsDate</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#renderRowFooter">renderRowFooter</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#renderRowHeader">renderRowHeader</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#reset">reset</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#resetRenderers">resetRenderers</a>
|
|
</li>
|
|
<li><!--<code>Date[]</code>-->
|
|
<a href="#select">select</a>
|
|
</li>
|
|
<li><!--<code>Date[]</code>-->
|
|
<a href="#selectCell">selectCell</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#setMonth">setMonth</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#setYear">setYear</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#show">show</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#styleCellDefault">styleCellDefault</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#subtractMonths">subtractMonths</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#subtractYears">subtractYears</a>
|
|
</li>
|
|
<li><!--<code>String</code>-->
|
|
<a href="#toString">toString</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#validate">validate</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="module">
|
|
<h4>Events</h4>
|
|
<ul class="content">
|
|
<li>
|
|
<a href="#beforeDeselectEvent">beforeDeselectEvent</a>
|
|
</li>
|
|
<li>
|
|
<a href="#beforeRenderEvent">beforeRenderEvent</a>
|
|
</li>
|
|
<li>
|
|
<a href="#beforeSelectEvent">beforeSelectEvent</a>
|
|
</li>
|
|
<li>
|
|
<a href="#changePageEvent">changePageEvent</a>
|
|
</li>
|
|
<li>
|
|
<a href="#clearEvent">clearEvent</a>
|
|
</li>
|
|
<li>
|
|
<a href="#deselectEvent">deselectEvent</a>
|
|
</li>
|
|
<li>
|
|
<a href="#renderEvent">renderEvent</a>
|
|
</li>
|
|
<li>
|
|
<a href="#resetEvent">resetEvent</a>
|
|
</li>
|
|
<li>
|
|
<a href="#selectEvent">selectEvent</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="module">
|
|
<h4>Configuration Attributes</h4>
|
|
<ul class="content">
|
|
<li>
|
|
<a href="#close">close</a>
|
|
</li>
|
|
<li>
|
|
<a href="#DATE_DELIMITER">DATE_DELIMITER</a>
|
|
</li>
|
|
<li>
|
|
<a href="#DATE_FIELD_DELIMITER">DATE_FIELD_DELIMITER</a>
|
|
</li>
|
|
<li>
|
|
<a href="#DATE_RANGE_DELIMITER">DATE_RANGE_DELIMITER</a>
|
|
</li>
|
|
<li>
|
|
<a href="#HIDE_BLANK_WEEKS">HIDE_BLANK_WEEKS</a>
|
|
</li>
|
|
<li>
|
|
<a href="#iframe">iframe</a>
|
|
</li>
|
|
<li>
|
|
<a href="#LOCALE_MONTHS">LOCALE_MONTHS</a>
|
|
</li>
|
|
<li>
|
|
<a href="#LOCALE_WEEKDAYS">LOCALE_WEEKDAYS</a>
|
|
</li>
|
|
<li>
|
|
<a href="#maxdate">maxdate</a>
|
|
</li>
|
|
<li>
|
|
<a href="#MD_DAY_POSITION">MD_DAY_POSITION</a>
|
|
</li>
|
|
<li>
|
|
<a href="#MD_MONTH_POSITION">MD_MONTH_POSITION</a>
|
|
</li>
|
|
<li>
|
|
<a href="#MDY_DAY_POSITION">MDY_DAY_POSITION</a>
|
|
</li>
|
|
<li>
|
|
<a href="#MDY_MONTH_POSITION">MDY_MONTH_POSITION</a>
|
|
</li>
|
|
<li>
|
|
<a href="#MDY_YEAR_POSITION">MDY_YEAR_POSITION</a>
|
|
</li>
|
|
<li>
|
|
<a href="#mindate">mindate</a>
|
|
</li>
|
|
<li>
|
|
<a href="#MONTHS_LONG">MONTHS_LONG</a>
|
|
</li>
|
|
<li>
|
|
<a href="#MONTHS_SHORT">MONTHS_SHORT</a>
|
|
</li>
|
|
<li>
|
|
<a href="#MULTI_SELECT">MULTI_SELECT</a>
|
|
</li>
|
|
<li>
|
|
<a href="#MY_MONTH_POSITION">MY_MONTH_POSITION</a>
|
|
</li>
|
|
<li>
|
|
<a href="#MY_YEAR_POSITION">MY_YEAR_POSITION</a>
|
|
</li>
|
|
<li>
|
|
<a href="#NAV_ARROW_LEFT">NAV_ARROW_LEFT</a>
|
|
</li>
|
|
<li>
|
|
<a href="#NAV_ARROW_RIGHT">NAV_ARROW_RIGHT</a>
|
|
</li>
|
|
<li>
|
|
<a href="#pagedate">pagedate</a>
|
|
</li>
|
|
<li>
|
|
<a href="#selected">selected</a>
|
|
</li>
|
|
<li>
|
|
<a href="#SHOW_WEEK_FOOTER">SHOW_WEEK_FOOTER</a>
|
|
</li>
|
|
<li>
|
|
<a href="#SHOW_WEEK_HEADER">SHOW_WEEK_HEADER</a>
|
|
</li>
|
|
<li>
|
|
<a href="#SHOW_WEEKDAYS">SHOW_WEEKDAYS</a>
|
|
</li>
|
|
<li>
|
|
<a href="#START_WEEKDAY">START_WEEKDAY</a>
|
|
</li>
|
|
<li>
|
|
<a href="#title">title</a>
|
|
</li>
|
|
<li>
|
|
<a href="#WEEKDAYS_1CHAR">WEEKDAYS_1CHAR</a>
|
|
</li>
|
|
<li>
|
|
<a href="#WEEKDAYS_LONG">WEEKDAYS_LONG</a>
|
|
</li>
|
|
<li>
|
|
<a href="#WEEKDAYS_MEDIUM">WEEKDAYS_MEDIUM</a>
|
|
</li>
|
|
<li>
|
|
<a href="#WEEKDAYS_SHORT">WEEKDAYS_SHORT</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div id="ft">
|
|
<hr />
|
|
Copyright © 2007 Yahoo! Inc. All rights reserved.
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|