examples/docs/output/Ext.calendar.DateRangeField.html

   1 <div class="body-wrap" xmlns:ext="http://www.extjs.com"><div class="top-tools"><a class="inner-link" href="#Ext.calendar.DateRangeField-props"><img src="resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>&#13;<a class="inner-link" href="#Ext.calendar.DateRangeField-methods"><img src="resources/images/default/s.gif" class="item-icon icon-method">Methods</a>&#13;<a class="inner-link" href="#Ext.calendar.DateRangeField-events"><img src="resources/images/default/s.gif" class="item-icon icon-event">Events</a>&#13;<a class="inner-link" href="#Ext.calendar.DateRangeField-configs"><img src="resources/images/default/s.gif" class="item-icon icon-config">Config Options</a>&#13;<a class="bookmark" href="../docs/?class=Ext.calendar.DateRangeField"><img src="resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>&#13;</div><h1>Class <a href="source/DateRangeField.html#cls-Ext.calendar.DateRangeField">Ext.calendar.DateRangeField</a></h1><table cellspacing="0"><tr><td class="label">Package:</td><td class="hd-info">Ext.calendar</td></tr><tr><td class="label">Defined In:</td><td class="hd-info"><a href="source/DateRangeField.html#cls-Ext.calendar.DateRangeField">DateRangeField.js</a></td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/DateRangeField.html#cls-Ext.calendar.DateRangeField">DateRangeField</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info">Object</td></tr></table><div class="description"><p>A combination field that includes start and end dates and times, as well as an optional all-day checkbox.</p></div><div class="hr"></div><a id="Ext.calendar.DateRangeField-configs"></a><h2>Config Options</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Config Options</th><th class="msource-header">Defined By</th></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.calendar.DateRangeField-toText"></a><b><a href="source/DateRangeField.html#cfg-Ext.calendar.DateRangeField-toText">toText</a></b> : String<div class="mdesc">The text to display in between the date/time fields (defaults to 'to')</div></td><td class="msource">DateRangeField</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.calendar.DateRangeField-toText"></a><b><a href="source/DateRangeField.html#cfg-Ext.calendar.DateRangeField-toText">toText</a></b> : String<div class="mdesc">The text to display as the label for the all day checkbox (defaults to 'All day')</div></td><td class="msource">DateRangeField</td></tr></tbody></table><a id="Ext.calendar.DateRangeField-props"></a><h2>Public Properties</h2><div class="no-members">This class has no public properties.</div><a id="Ext.calendar.DateRangeField-methods"></a><h2>Public Methods</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Method</th><th class="msource-header">Defined By</th></tr><tr class="method-row expandable"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.calendar.DateRangeField-DateRangeField"></a><b><a href="source/DateRangeField.html#cls-Ext.calendar.DateRangeField">DateRangeField</a></b>(&nbsp;<code>Object&nbsp;config</code>&nbsp;)
   2     <div class="mdesc"><div class="short"></div><div class="long"><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>config</code> : Object<div class="sub-desc">The config object</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">DateRangeField</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.calendar.DateRangeField-getValue"></a><b><a href="source/DateRangeField.html#method-Ext.calendar.DateRangeField-getValue">getValue</a></b>()
   3     :
   4                                         Array<div class="mdesc"><div class="short">Returns an array containing the following values in order:&lt;div class="mdetail-params"&gt;
   5 DateTime : &lt;div class="sub-des...</div><div class="long">Returns an array containing the following values in order:<div class="mdetail-params"><ul>
   6 <li><b><code>DateTime</code></b> : <div class="sub-desc">The start date/time</div></li>
   7 <li><b><code>DateTime</code></b> : <div class="sub-desc">The end date/time</div></li>
   8 <li><b><code>Boolean</code></b> : <div class="sub-desc">True if the dates are all-day, false
   9 if the time values should be used</div></li><ul></div><div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Array</code><div class="sub-desc">The array of return values</div></li></ul></div></div></div></td><td class="msource">DateRangeField</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.calendar.DateRangeField-setValue"></a><b><a href="source/DateRangeField.html#method-Ext.calendar.DateRangeField-setValue">setValue</a></b>(&nbsp;<code>Array/Date/Object&nbsp;v</code>&nbsp;)
  10     :
  11                                         void<div class="mdesc"><div class="short">Sets the values to use in the date range.</div><div class="long">Sets the values to use in the date range.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>v</code> : Array/Date/Object<div class="sub-desc">The value(s) to set into the field. Valid types are as follows:<div class="mdetail-params"><ul>
  12 <li><b><code>Array</code></b> : <div class="sub-desc">An array containing, in order, a start date, end date and all-day flag.
  13 This array should exactly match the return type as specified by <a href="output/Ext.calendar.DateRangeField.html#Ext.calendar.DateRangeField-getValue" ext:member="getValue" ext:cls="Ext.calendar.DateRangeField">getValue</a>.</div></li>
  14 <li><b><code>DateTime</code></b> : <div class="sub-desc">A single Date object, which will be used for both the start and
  15 end dates in the range.  The all-day flag will be defaulted to false.</div></li>
  16 <li><b><code>Object</code></b> : <div class="sub-desc">An object containing properties for StartDate, EndDate and IsAllDay
  17 as defined in <a href="output/Ext.calendar.EventMappings.html" ext:cls="Ext.calendar.EventMappings">Ext.calendar.EventMappings</a>.</div></li><ul></div></div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">DateRangeField</td></tr></tbody></table><a id="Ext.calendar.DateRangeField-events"></a><h2>Public Events</h2><div class="no-members">This class has no public events.</div></div>