1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7 <meta http-equiv="content-type" content="text/html; charset=undefined" />
8 <meta name="generator" content="JsDoc Toolkit" />
11 <title>JsDoc Reference - Roo.DatePicker</title>
14 <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />
15 <link rel="stylesheet" type="text/css" href="../default.css" />
18 <script type="text/javascript" src="../page.js">
25 <body onload="RooDocsPage.onload();">
28 <div class="body-wrap">
30 <!-- ============================== links to methods. ================================= -->
32 <div class="top-tools">
34 <a class="inner-link" href="#Roo.DatePicker-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo.DatePicker-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo.DatePicker-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo.DatePicker-configs"><img src="resources/s.gif" class="item-icon icon-config">Config Options</a>
38 <a class="bookmark" href="NEED_TO_CREATE_DIRECT_LINK_HREF"><img src="resources/s.gif" class="item-icon icon-fav">Direct Link</a>
43 <!-- ============================== inheritance Block. ================================= -->
45 <div class="inheritance res-block">
46 <pre class="res-block-inner"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
47 <img src="../../images/default/s.gif" height="1" width="20"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.DatePicker
52 <!-- ============================== class title / details ============================ -->
55 <h1 class="classTitle">
60 <table cellspacing="0" class="class-summary-table">
62 <tr><td class="label">Package:</td><td class="hd-info">Roo</td></tr>
64 <tr><td class="label">Defined In:</td><td class="hd-info">
66 <a href="./src/Roo_DatePicker.js.html">Roo/DatePicker.js</a>.
69 <tr><td class="label">Class:</td><td class="hd-info">DatePicker</td></tr>
74 <tr><td class="label">Extends:</td><td class="hd-info">
75 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
83 <!-- ============================== class summary ========================== -->
84 <div class="description">
85 Simple date picker class.
89 <!-- ============================== Class comment block... ========================== -->
91 <div class="comments">
92 <b>Class Comments / Notes</B> =>
93 <u onclick="parent.CommentDialog.showCommentId = 'Roo.DatePicker';">[Add Your comment/notes about this class]</u>
95 <iframe frameborder="0" id="comments-Roo" style="border: none;width:100%;"
96 src="/blog.php/GtkDjsComments/Roo.DatePicker.html"></iframe>
101 <!-- ============================== config options ========================== -->
106 <div class="hr"></div>
107 <a id="Roo.DatePicker-configs"></a>
113 <table cellspacing="0" class="member-table">
114 <caption>Config Options (Usually are also Properties)</caption>
118 <th class="sig-header" colspan="2">Options</th>
120 <th class="msource-header">Defined By</th>
127 <tr class="config-row expandable config-row-alt0 notInherited">
128 <td class="micon"><a class="exi" href="#expand"> </a></td>
131 <a id="Roo.DatePicker-cfg-cancelText" name=".cancelText"></a>
132 <div class="fixedFont">
133 <b class="itemname">cancelText</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
139 <div class="short">The text to display on the cancel button</div>
143 <div class="long">The text to display on the cancel button</div>
157 <tr class="config-row expandable config-row-alt1 notInherited">
158 <td class="micon"><a class="exi" href="#expand"> </a></td>
161 <a id="Roo.DatePicker-cfg-constrainToViewport" name=".constrainToViewport"></a>
162 <div class="fixedFont">
163 <b class="itemname">constrainToViewport</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
169 <div class="short">True to constrain the date picker to the viewport (defaults to true)</div>
173 <div class="long">True to constrain the date picker to the viewport (defaults to true)</div>
187 <tr class="config-row expandable config-row-alt0 notInherited">
188 <td class="micon"><a class="exi" href="#expand"> </a></td>
191 <a id="Roo.DatePicker-cfg-dayNames" name=".dayNames"></a>
192 <div class="fixedFont">
193 <b class="itemname">dayNames</b> : <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
199 <div class="short">An array of textual day names which can be overriden for localization support (defaults to Date.dayNames)</div>
203 <div class="long">An array of textual day names which can be overriden for localization support (defaults to Date.dayNames)</div>
217 <tr class="config-row expandable config-row-alt1 notInherited">
218 <td class="micon"><a class="exi" href="#expand"> </a></td>
221 <a id="Roo.DatePicker-cfg-disabledDatesRE" name=".disabledDatesRE"></a>
222 <div class="fixedFont">
223 <b class="itemname">disabledDatesRE</b> : RegExp
229 <div class="short">JavaScript regular expression used to disable a pattern of dates (defaults to null)</div>
233 <div class="long">JavaScript regular expression used to disable a pattern of dates (defaults to null)</div>
247 <tr class="config-row expandable config-row-alt0 notInherited">
248 <td class="micon"><a class="exi" href="#expand"> </a></td>
251 <a id="Roo.DatePicker-cfg-disabledDatesText" name=".disabledDatesText"></a>
252 <div class="fixedFont">
253 <b class="itemname">disabledDatesText</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
259 <div class="short">The tooltip text to display when the date falls on a disabled date (defaults to "")</div>
263 <div class="long">The tooltip text to display when the date falls on a disabled date (defaults to "")</div>
277 <tr class="config-row expandable config-row-alt1 notInherited">
278 <td class="micon"><a class="exi" href="#expand"> </a></td>
281 <a id="Roo.DatePicker-cfg-disabledDays" name=".disabledDays"></a>
282 <div class="fixedFont">
283 <b class="itemname">disabledDays</b> : <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
289 <div class="short">An array of days to disable, 0-based.</div>
293 <div class="long">An array of days to disable, 0-based. For example, [0, 6] disables Sunday and Saturday (defaults to null).</div>
307 <tr class="config-row expandable config-row-alt0 notInherited">
308 <td class="micon"><a class="exi" href="#expand"> </a></td>
311 <a id="Roo.DatePicker-cfg-disabledDaysText" name=".disabledDaysText"></a>
312 <div class="fixedFont">
313 <b class="itemname">disabledDaysText</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
319 <div class="short">The tooltip to display when the date falls on a disabled day (defaults to "")</div>
323 <div class="long">The tooltip to display when the date falls on a disabled day (defaults to "")</div>
337 <tr class="config-row expandable config-row-alt1 notInherited">
338 <td class="micon"><a class="exi" href="#expand"> </a></td>
341 <a id="Roo.DatePicker-cfg-format" name=".format"></a>
342 <div class="fixedFont">
343 <b class="itemname">format</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
349 <div class="short">The default date format string which can be overriden for localization support.</div>
353 <div class="long">The default date format string which can be overriden for localization support. The format must be<br/>valid according to {<b>link</b> Date<b>parseDate</b>} (defaults to 'm/d/y').</div>
367 <tr class="config-row expandable config-row-alt0 notInherited">
368 <td class="micon"><a class="exi" href="#expand"> </a></td>
371 <a id="Roo.DatePicker-cfg-maxDate" name=".maxDate"></a>
372 <div class="fixedFont">
373 <b class="itemname">maxDate</b> : <a href="./Date.html#constructor" roo:cls="Date.html#constructor">Date</a>
379 <div class="short">Maximum allowable date (JavaScript date object, defaults to null)</div>
383 <div class="long">Maximum allowable date (JavaScript date object, defaults to null)</div>
397 <tr class="config-row expandable config-row-alt1 notInherited">
398 <td class="micon"><a class="exi" href="#expand"> </a></td>
401 <a id="Roo.DatePicker-cfg-maxText" name=".maxText"></a>
402 <div class="fixedFont">
403 <b class="itemname">maxText</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
409 <div class="short">The error text to display if the maxDate validation fails (defaults to "This date is after the maximum date")</div>
413 <div class="long">The error text to display if the maxDate validation fails (defaults to "This date is after the maximum date")</div>
427 <tr class="config-row expandable config-row-alt0 notInherited">
428 <td class="micon"><a class="exi" href="#expand"> </a></td>
431 <a id="Roo.DatePicker-cfg-minDate" name=".minDate"></a>
432 <div class="fixedFont">
433 <b class="itemname">minDate</b> : <a href="./Date.html#constructor" roo:cls="Date.html#constructor">Date</a>
439 <div class="short">Minimum allowable date (JavaScript date object, defaults to null)</div>
443 <div class="long">Minimum allowable date (JavaScript date object, defaults to null)</div>
457 <tr class="config-row expandable config-row-alt1 notInherited">
458 <td class="micon"><a class="exi" href="#expand"> </a></td>
461 <a id="Roo.DatePicker-cfg-minText" name=".minText"></a>
462 <div class="fixedFont">
463 <b class="itemname">minText</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
469 <div class="short">The error text to display if the minDate validation fails (defaults to "This date is before the minimum date")</div>
473 <div class="long">The error text to display if the minDate validation fails (defaults to "This date is before the minimum date")</div>
487 <tr class="config-row expandable config-row-alt0 notInherited">
488 <td class="micon"><a class="exi" href="#expand"> </a></td>
491 <a id="Roo.DatePicker-cfg-monthNames" name=".monthNames"></a>
492 <div class="fixedFont">
493 <b class="itemname">monthNames</b> : <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
499 <div class="short">An array of textual month names which can be overriden for localization support (defaults to Date.monthNames)</div>
503 <div class="long">An array of textual month names which can be overriden for localization support (defaults to Date.monthNames)</div>
517 <tr class="config-row expandable config-row-alt1 notInherited">
518 <td class="micon"><a class="exi" href="#expand"> </a></td>
521 <a id="Roo.DatePicker-cfg-monthYearText" name=".monthYearText"></a>
522 <div class="fixedFont">
523 <b class="itemname">monthYearText</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
529 <div class="short">The header month selector tooltip (defaults to 'Choose a month (Control+Up/Down to move years)')</div>
533 <div class="long">The header month selector tooltip (defaults to 'Choose a month (Control+Up/Down to move years)')</div>
547 <tr class="config-row expandable config-row-alt0 notInherited">
548 <td class="micon"><a class="exi" href="#expand"> </a></td>
551 <a id="Roo.DatePicker-cfg-nextText" name=".nextText"></a>
552 <div class="fixedFont">
553 <b class="itemname">nextText</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
559 <div class="short">The next month navigation button tooltip (defaults to 'Next Month (Control+Right)')</div>
563 <div class="long">The next month navigation button tooltip (defaults to 'Next Month (Control+Right)')</div>
577 <tr class="config-row expandable config-row-alt1 notInherited">
578 <td class="micon"><a class="exi" href="#expand"> </a></td>
581 <a id="Roo.DatePicker-cfg-okText" name=".okText"></a>
582 <div class="fixedFont">
583 <b class="itemname">okText</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
589 <div class="short">The text to display on the ok button</div>
593 <div class="long">The text to display on the ok button</div>
607 <tr class="config-row expandable config-row-alt0 notInherited">
608 <td class="micon"><a class="exi" href="#expand"> </a></td>
611 <a id="Roo.DatePicker-cfg-prevText" name=".prevText"></a>
612 <div class="fixedFont">
613 <b class="itemname">prevText</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
619 <div class="short">The previous month navigation button tooltip (defaults to 'Previous Month (Control+Left)')</div>
623 <div class="long">The previous month navigation button tooltip (defaults to 'Previous Month (Control+Left)')</div>
637 <tr class="config-row expandable config-row-alt1 notInherited">
638 <td class="micon"><a class="exi" href="#expand"> </a></td>
641 <a id="Roo.DatePicker-cfg-showClear" name=".showClear"></a>
642 <div class="fixedFont">
643 <b class="itemname">showClear</b> : Bool
649 <div class="short">Show a clear button (usefull for date form elements that can be blank.</div>
653 <div class="long">Show a clear button (usefull for date form elements that can be blank.)</div>
667 <tr class="config-row expandable config-row-alt0 notInherited">
668 <td class="micon"><a class="exi" href="#expand"> </a></td>
671 <a id="Roo.DatePicker-cfg-startDay" name=".startDay"></a>
672 <div class="fixedFont">
673 <b class="itemname">startDay</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
679 <div class="short">Day index at which the week should begin, 0-based (defaults to 0, which is Sunday)</div>
683 <div class="long">Day index at which the week should begin, 0-based (defaults to 0, which is Sunday)</div>
697 <tr class="config-row expandable config-row-alt1 notInherited">
698 <td class="micon"><a class="exi" href="#expand"> </a></td>
701 <a id="Roo.DatePicker-cfg-todayText" name=".todayText"></a>
702 <div class="fixedFont">
703 <b class="itemname">todayText</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
709 <div class="short">The text to display on the button that selects the current date (defaults to "Today")</div>
713 <div class="long">The text to display on the button that selects the current date (defaults to "Today")</div>
727 <tr class="config-row expandable config-row-alt0 notInherited">
728 <td class="micon"><a class="exi" href="#expand"> </a></td>
731 <a id="Roo.DatePicker-cfg-todayTip" name=".todayTip"></a>
732 <div class="fixedFont">
733 <b class="itemname">todayTip</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
739 <div class="short">The tooltip to display for the button that selects the current date (defaults to "{current date} (Spacebar)")</div>
743 <div class="long">The tooltip to display for the button that selects the current date (defaults to "{current date} (Spacebar)")</div>
767 <!-- ============================== public properties ==================== -->
771 <a id="Roo.DatePicker-props"></a>
777 <table cellspacing="0" class="member-table">
778 <caption class="Empty">Public Properties - Has None</caption>
784 <!-- ============================== methods summary / details ======================== -->
787 <a id="Roo.DatePicker-methods"></a>
788 <!-- constructor?? -->
795 <!-- then dynamics first -->
802 <table cellspacing="0" class="member-table">
803 <caption>Public Methods</caption>
805 <th class="sig-header" colspan="2">Method</th>
806 <th class="msource-header">Defined By</th>
816 <tr class="method-row config-row-alt0 expandable notInherited">
817 <td class="micon"><a class="exi" href="#expand"> </a></td>
821 <a id="Roo-method-DatePicker" name=".DatePicker"></a>
822 <div class="fixedFont">
823 <span class="attributes">new <B>Roo.</B></span><b class="itemname">DatePicker</b>
825 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
833 <div class="short">Create a new Roo.DatePicker</div>
840 Create a new Roo.DatePicker
843 <dl class="detailList">
844 <dt class="heading">Parameters:</dt>
847 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>config</b>
850 <dd>The config object</dd>
874 <tr class="method-row config-row-alt1 expandable notInherited">
875 <td class="micon"><a class="exi" href="#expand"> </a></td>
879 <a id="Roo.DatePicker-method-getValue" name=".getValue"></a>
880 <div class="fixedFont">
881 <span class="attributes"></span><b class="itemname">getValue</b>
889 <a href="./Date.html#constructor" roo:cls="Date.html#constructor">Date</a>
898 <div class="short">Gets the current selected value of the date field</div>
904 Gets the current selected value of the date field
915 <dl class="detailList">
916 <dt class="heading">Returns:</dt>
918 <dd><span class="fixedFont"><a href="./Date.html#constructor" roo:cls="Date.html#constructor">Date</a></span> The selected date</dd>
940 <tr class="method-row config-row-alt0 expandable notInherited">
941 <td class="micon"><a class="exi" href="#expand"> </a></td>
945 <a id="Roo.DatePicker-method-setValue" name=".setValue"></a>
946 <div class="fixedFont">
947 <span class="attributes"></span><b class="itemname">setValue</b>
949 (<a href="./Date.html#constructor" roo:cls="Date.html#constructor">Date</a> <B><i>value</i></B>)
956 <div class="short">Sets the value of the date field</div>
962 Sets the value of the date field
969 <dl class="detailList">
970 <dt class="heading">Parameters:</dt>
973 <span class="fixedFont"><a href="./Date.html#constructor" roo:cls="Date.html#constructor">Date</a></span> <b>value</b>
976 <dd>The date to set</dd>
1005 <!-- ============================== events summary / details ======================== -->
1008 <a id="Roo.DatePicker-events"></a>
1017 <table cellspacing="0" class="member-table">
1018 <caption>Events</caption>
1021 <th class="sig-header" colspan="2">Event</th>
1022 <th class="msource-header">Defined By</th>
1031 <tr class="method-row expandable config-row-alt0 notInherited">
1032 <td class="micon"><a class="exi" href="#expand"> </a></td>
1035 <a id="Roo.DatePicker-event-*select"></a>
1037 <div class="fixedFont">
1038 <b class="itemname">select</b> (DatePicker <B><i>this</i></B>, <a href="./Date.html#constructor" roo:cls="Date.html#constructor">Date</a> <B><i>date</i></B>)
1044 <div class="short">Fires when a date is selected
1050 Fires when a date is selected
1056 <dl class="detailList">
1057 <dt class="heading">Parameters:</dt>
1060 <span class="fixedFont">DatePicker</span> <b>this</b>
1066 <span class="fixedFont"><a href="./Date.html#constructor" roo:cls="Date.html#constructor">Date</a></span> <b>date</b>
1069 <dd>The selected date</dd>
1087 <td class="msource">
1099 <!-- ============================== footer ================================= -->
1100 <div class="fineprint" style="clear:both">
1102 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Fri Jul 16 2010 16:11:47 GMT+0800 (HKT)
1104 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>