oqapi/webgui
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
webgui/www/extras/yui/docs/calendar/YAHOO.widget.Calendar.html
JT Smith 4f68a0933c added YUI and YUI-ext 
fixed the resizable text area with IE problem
fixed the ad space with IE problem
merged the 7.2.0 and 7.1.4 change logs
2006-11-07 23:15:57 +00:00

451 lines
16 KiB
HTML
Raw Blame History

<html>
<head>
<title>API: Calendar YAHOO.widget.Calendar.html (YUI Library)</title>
<link href="stylesheet.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="header">
<h1>Yahoo! UI Library</h1>
<h3><a href="./index.html">Yahoo! UI Library: Calendar</a></h3>
<div class="breadcrumbs">
<a href="./index.html">Yahoo! UI Library: Calendar</a>
&gt;
<strong>YAHOO.widget.Calendar</strong>
</div>
</div>
<div id="body">
<div class="nav">
<div class="module resources">
<ul class="content">
<li><a href="overview-tree.html">Tree View</a></li>
<li><a href="index-all.html">Element Index</a></li>
</ul>
</div>
<div class="module">
<h4><a href="./allclasses-noframe.html">Classes</a></h4>
<ul class="content">
<li>
<a href="YAHOO.widget.html">
YAHOO.widget</a>
</li>
<li>
<a href="YAHOO.widget.Calendar.html">
YAHOO.widget.Calendar</a>
</li>
<li>
<a href="YAHOO.widget.Calendar2up.html">
YAHOO.widget.Calendar2up</a>
</li>
<li>
<a href="YAHOO.widget.Calendar2up_Cal.html">
YAHOO.widget.Calendar2up_Cal</a>
</li>
<li>
<a href="YAHOO.widget.Calendar_Core.html">
YAHOO.widget.Calendar_Core</a>
</li>
<li>
<a href="YAHOO.widget.CalendarGroup.html">
YAHOO.widget.CalendarGroup</a>
</li>
<li>
<a href="YAHOO.widget.DateMath.html">
YAHOO.widget.DateMath</a>
</li>
</ul>
</div>
<div class="module">
<h4><a href="./overview-summary.html">Files</a></h4>
<ul class="content">
<li>
<a href="overview-summary-Calendar.js.html">
Calendar.js</a>
</li>
<li>
<a href="overview-summary-Calendar2up.js.html">
Calendar2up.js</a>
</li>
<li>
<a href="overview-summary-Calendar_Core.js.html">
Calendar_Core.js</a>
</li>
<li>
<a href="overview-summary-CalendarGroup.js.html">
CalendarGroup.js</a>
</li>
<li>
<a href="overview-summary-DateMath.js.html">
DateMath.js</a>
</li>
</ul>
</div>
</div>
<div id="pri">
<div class="main">
<h2>Class YAHOO.widget.Calendar</h2>
<pre>Object
|
+--<a href='YAHOO.widget.Calendar_Core.html'>YAHOO.widget.Calendar_Core</a>
|
+--<b>YAHOO.widget.Calendar</b>
</pre>
<hr />
<!-- Class definition -->
<div class="class-def">
<div class="class-name">
<span class="class-attribs">
</span>
<span class="class-type">class</span>
<b>YAHOO.widget.Calendar</b>
</div>
<div class="class-extends">
<dd>extends <a href='YAHOO.widget.Calendar_Core.html'>YAHOO.widget.Calendar_Core</a></dd>
</div>
</div>
<div class="meta">
</div>
<!-- ======== QUICK LINKS ======== -->
<div class="quick-links">
<strong>Quick Links:</strong>&nbsp;
<a href="#constructor_summary">Constructor Summary</a>
|
<a href="#methodSummary">Method Summary</a> |
<a href="#methodDetails">Method Details</a>
</div>
<!-- ======== END QUICK LINKS ======== -->
<!-- ======== NESTED CLASS SUMMARY ======== -->
<!-- ======== END NESTED CLASS SUMMARY ======== -->
<!-- =========== FIELD SUMMARY =========== -->
<div class="section field inheritance">
<h3>Fields inherited from class <a href="YAHOO.widget.Calendar_Core.html">YAHOO.widget.Calendar_Core</a> <span class="top">[<a href="#top">top</a>]</span></h3>
<div class="content">
<code><a href="YAHOO.widget.Calendar_Core.html#Config">Config</a>, <a href="YAHOO.widget.Calendar_Core.html#parent">parent</a>, <a href="YAHOO.widget.Calendar_Core.html#cells">cells</a>, <a href="YAHOO.widget.Calendar_Core.html#weekHeaderCells">weekHeaderCells</a>, <a href="YAHOO.widget.Calendar_Core.html#weekFooterCells">weekFooterCells</a>, <a href="YAHOO.widget.Calendar_Core.html#cellDates">cellDates</a>, <a href="YAHOO.widget.Calendar_Core.html#id">id</a>, <a href="YAHOO.widget.Calendar_Core.html#oDomContainer">oDomContainer</a>, <a href="YAHOO.widget.Calendar_Core.html#today">today</a>, <a href="YAHOO.widget.Calendar_Core.html#renderStack">renderStack</a>, <a href="YAHOO.widget.Calendar_Core.html#pageDate">pageDate</a>, <a href="YAHOO.widget.Calendar_Core.html#minDate">minDate</a>, <a href="YAHOO.widget.Calendar_Core.html#maxDate">maxDate</a>, <a href="YAHOO.widget.Calendar_Core.html#selectedDates">selectedDates</a>, <a href="YAHOO.widget.Calendar_Core.html#shellRendered">shellRendered</a>, <a href="YAHOO.widget.Calendar_Core.html#table">table</a>, <a href="YAHOO.widget.Calendar_Core.html#headerCell">headerCell</a></code>
</div>
</div>
<!-- =========== END FIELD SUMMARY =========== -->
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<div class="section contructor summaries">
<h3><a name="constructor_summary">Constructor Summary</a> <span class="top">[<a href="#top">top</a>]</span></h3>
<div class="content">
<code class="spec">
<a href="YAHOO.widget.Calendar.html#YAHOO.widget.Calendar()">YAHOO.widget.Calendar</a>
</code>
<div class="description">
Calendar is the default implementation of the YAHOO.widget.Calendar_Core base class.&nbsp;
</div>
</div>
</div>
<!-- ======== END CONSTRUCTOR SUMMARY ======== -->
<!-- ========== METHOD SUMMARY =========== -->
<div class="section method summaries">
<h3><a name="methodSummary">Method Summary</a> <span class="top">[<a href="#top">top</a>]</span></h3>
<div class="content">
<table border="1" cellpadding="3" cellspacing="0">
<tr>
<td class="flags">void</td>
<td class="spec">
<code>
<a href="#buildShell">buildShell</a>
()
</code>
<div class="description">
Builds the calendar table shell that will be filled in with dates and formatting.&nbsp;
</div>
</td>
</tr>
<tr>
<td class="flags">void</td>
<td class="spec">
<code>
<a href="#renderHeader">renderHeader</a>
()
</code>
<div class="description">
Appends the header contents into the widget header.&nbsp;
</div>
</td>
</tr>
<tr>
<td class="flags">void</td>
<td class="spec">
<code>
<a href="#renderShell">renderShell</a>
()
</code>
<div class="description">
Outputs the calendar shell to the DOM, inserting it into the placeholder element.&nbsp;
</div>
</td>
</tr>
</table>
</div>
</div>
<div class="section method inheritance">
<h3>Methods inherited from class <a href="YAHOO.widget.Calendar_Core.html">YAHOO.widget.Calendar_Core</a></h3>
<div class="content">
<code><a href="YAHOO.widget.Calendar_Core.html#init">init</a>, <a href="YAHOO.widget.Calendar_Core.html#wireDefaultEvents">wireDefaultEvents</a>, <a href="YAHOO.widget.Calendar_Core.html#wireCustomEvents">wireCustomEvents</a>, <a href="YAHOO.widget.Calendar_Core.html#setupConfig">setupConfig</a>, <a href="YAHOO.widget.Calendar_Core.html#customConfig">customConfig</a>, <a href="YAHOO.widget.Calendar_Core.html#buildMonthLabel">buildMonthLabel</a>, <a href="YAHOO.widget.Calendar_Core.html#buildDayLabel">buildDayLabel</a>, <a href="YAHOO.widget.Calendar_Core.html#buildShellHeader">buildShellHeader</a>, <a href="YAHOO.widget.Calendar_Core.html#buildShellBody">buildShellBody</a>, <a href="YAHOO.widget.Calendar_Core.html#buildShellFooter">buildShellFooter</a>, <a href="YAHOO.widget.Calendar_Core.html#render">render</a>, <a href="YAHOO.widget.Calendar_Core.html#renderBody">renderBody</a>, <a href="YAHOO.widget.Calendar_Core.html#renderFooter">renderFooter</a>, <a href="YAHOO.widget.Calendar_Core.html#renderOutOfBoundsDate">renderOutOfBoundsDate</a>, <a href="YAHOO.widget.Calendar_Core.html#renderRowHeader">renderRowHeader</a>, <a href="YAHOO.widget.Calendar_Core.html#renderRowFooter">renderRowFooter</a>, <a href="YAHOO.widget.Calendar_Core.html#renderCellDefault">renderCellDefault</a>, <a href="YAHOO.widget.Calendar_Core.html#renderCellStyleHighlight1">renderCellStyleHighlight1</a>, <a href="YAHOO.widget.Calendar_Core.html#renderCellStyleHighlight2">renderCellStyleHighlight2</a>, <a href="YAHOO.widget.Calendar_Core.html#renderCellStyleHighlight3">renderCellStyleHighlight3</a>, <a href="YAHOO.widget.Calendar_Core.html#renderCellStyleHighlight4">renderCellStyleHighlight4</a>, <a href="YAHOO.widget.Calendar_Core.html#renderCellStyleToday">renderCellStyleToday</a>, <a href="YAHOO.widget.Calendar_Core.html#renderCellStyleSelected">renderCellStyleSelected</a>, <a href="YAHOO.widget.Calendar_Core.html#renderCellNotThisMonth">renderCellNotThisMonth</a>, <a href="YAHOO.widget.Calendar_Core.html#renderBodyCellRestricted">renderBodyCellRestricted</a>, <a href="YAHOO.widget.Calendar_Core.html#addMonths">addMonths</a>, <a href="YAHOO.widget.Calendar_Core.html#subtractMonths">subtractMonths</a>, <a href="YAHOO.widget.Calendar_Core.html#addYears">addYears</a>, <a href="YAHOO.widget.Calendar_Core.html#subtractYears">subtractYears</a>, <a href="YAHOO.widget.Calendar_Core.html#nextMonth">nextMonth</a>, <a href="YAHOO.widget.Calendar_Core.html#previousMonth">previousMonth</a>, <a href="YAHOO.widget.Calendar_Core.html#nextYear">nextYear</a>, <a href="YAHOO.widget.Calendar_Core.html#previousYear">previousYear</a>, <a href="YAHOO.widget.Calendar_Core.html#reset">reset</a>, <a href="YAHOO.widget.Calendar_Core.html#clear">clear</a>, <a href="YAHOO.widget.Calendar_Core.html#select">select</a>, <a href="YAHOO.widget.Calendar_Core.html#selectCell">selectCell</a>, <a href="YAHOO.widget.Calendar_Core.html#deselect">deselect</a>, <a href="YAHOO.widget.Calendar_Core.html#deselectCell">deselectCell</a>, <a href="YAHOO.widget.Calendar_Core.html#deselectAll">deselectAll</a>, <a href="YAHOO.widget.Calendar_Core.html#isDateOOM">isDateOOM</a>, <a href="YAHOO.widget.Calendar_Core.html#onBeforeSelect">onBeforeSelect</a>, <a href="YAHOO.widget.Calendar_Core.html#onSelect">onSelect</a>, <a href="YAHOO.widget.Calendar_Core.html#onBeforeDeselect">onBeforeDeselect</a>, <a href="YAHOO.widget.Calendar_Core.html#onDeselect">onDeselect</a>, <a href="YAHOO.widget.Calendar_Core.html#onChangePage">onChangePage</a>, <a href="YAHOO.widget.Calendar_Core.html#onRender">onRender</a>, <a href="YAHOO.widget.Calendar_Core.html#onReset">onReset</a>, <a href="YAHOO.widget.Calendar_Core.html#onClear">onClear</a>, <a href="YAHOO.widget.Calendar_Core.html#validate">validate</a>, <a href="YAHOO.widget.Calendar_Core.html#resetRenderers">resetRenderers</a>, <a href="YAHOO.widget.Calendar_Core.html#clearElement">clearElement</a>, <a href="YAHOO.widget.Calendar_Core.html#addRenderer">addRenderer</a>, <a href="YAHOO.widget.Calendar_Core.html#addMonthRenderer">addMonthRenderer</a>, <a href="YAHOO.widget.Calendar_Core.html#addWeekdayRenderer">addWeekdayRenderer</a>, <a href="YAHOO.widget.Calendar_Core.html#clearAllBodyCellStyles">clearAllBodyCellStyles</a>, <a href="YAHOO.widget.Calendar_Core.html#setMonth">setMonth</a>, <a href="YAHOO.widget.Calendar_Core.html#setYear">setYear</a>, <a href="YAHOO.widget.Calendar_Core.html#getSelectedDates">getSelectedDates</a>, <a href="YAHOO.widget.Calendar_Core.html#toString">toString</a></code>
</div>
</div>
<!-- ========== END METHOD SUMMARY =========== -->
<!-- ============ FIELD DETAIL START =========== -->
<!-- ============ FIELD DETAIL END =========== -->
<!-- ========= CONSTRUCTOR DETAIL START ======== -->
<div class="section constructor details">
<h3><a name="constructor_detail">Constructor Detail</a> <span class="top">[<a href="#top">top</a>]</span></h3>
<div class="content">
<h4><a name="YAHOO.widget.Calendar()">YAHOO.widget.Calendar</a></h4>
<div class="detail">
<code>
<strong>YAHOO.widget.Calendar</strong>
()
</code>
<div class="description">
Calendar is the default implementation of the YAHOO.widget.Calendar_Core base class.
This class is the UED-approved version of the calendar selector widget. For all documentation
on the implemented methods listed here, see the documentation for YAHOO.widget.Calendar_Core.
<dl>
<dt>Parameters:</dt>
<dd>
<code>id</code> -
The id of the table element that will represent the calendar widget
</dd>
<dd>
<code>containerId</code> -
The id of the container element that will contain the calendar table
</dd>
<dd>
<code>monthyear</code> -
The month/year string used to set the current calendar page
</dd>
<dd>
<code>selected</code> -
A string of date values formatted using the date parser. The built-in default date format is MM/DD/YYYY. Ranges are defined using MM/DD/YYYY-MM/DD/YYYY. Month/day combinations are defined using MM/DD. Any combination of these can be combined by delimiting the string with commas. Example: "12/24/2005,12/25,1/18/2006-1/21/2006"
</dd>
</dl>
HASH(0x1e21cf4)
</div>
</div>
</div>
</div>
<!-- ========= CONSTRUCTOR DETAIL END ======== -->
<!-- ============ METHOD DETAIL START ========== -->
<div class="section method details">
<h3><a name="methodDetails">Method Detail</a> <span class="top">[<a href="#top">top</a>]</span></h3>
<div class="content">
<h4><a name="buildShell">buildShell</a></h4>
<div class="detail">
<code>
void
<strong>buildShell</strong>
()
</code>
<div class="description">
Builds the calendar table shell that will be filled in with dates and formatting.
This method calls buildShellHeader, buildShellBody, and buildShellFooter (in that order)
to construct the pieces of the calendar table. The construction of the shell should
only happen one time when the calendar is initialized.
HASH(0x1cf8db4)
</div>
</div>
<hr />
<h4><a name="renderHeader">renderHeader</a></h4>
<div class="detail">
<code>
void
<strong>renderHeader</strong>
()
</code>
<div class="description">
Appends the header contents into the widget header.
HASH(0x1d2ac6c)
</div>
</div>
<hr />
<h4><a name="renderShell">renderShell</a></h4>
<div class="detail">
<code>
void
<strong>renderShell</strong>
()
</code>
<div class="description">
Outputs the calendar shell to the DOM, inserting it into the placeholder element.
HASH(0x1d2add4)
</div>
</div>
<hr />
</div>
</div>
<!-- ============ METHOD DETAIL END ========== -->
</div>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<div id="footer">
<hr />
Copyright &copy; 2006 Yahoo! Inc. All rights reserved.
<br /><br />
Documentation generated by <a href="http://jsdoc.sourceforge.net/">
JSDoc</a>
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink