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

   1 <div class="body-wrap" xmlns:ext="http://www.extjs.com"><div class="top-tools"><a class="inner-link" href="#Ext.calendar.WeekView-props"><img src="resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>&#13;<a class="inner-link" href="#Ext.calendar.WeekView-methods"><img src="resources/images/default/s.gif" class="item-icon icon-method">Methods</a>&#13;<a class="inner-link" href="#Ext.calendar.WeekView-events"><img src="resources/images/default/s.gif" class="item-icon icon-event">Events</a>&#13;<a class="inner-link" href="#Ext.calendar.WeekView-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.WeekView"><img src="resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>&#13;</div><div class="inheritance res-block"><pre class="res-block-inner"><a href="output/Ext.calendar.DayView.html" ext:member="" ext:cls="Ext.calendar.DayView">DayView</a>
   2   <img src="resources/elbow-end.gif">WeekView</pre></div><h1>Class <a href="source/WeekView.html#cls-Ext.calendar.WeekView">Ext.calendar.WeekView</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/WeekView.html#cls-Ext.calendar.WeekView">WeekView.js</a></td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/WeekView.html#cls-Ext.calendar.WeekView">WeekView</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info"><a href="output/Ext.calendar.DayView.html" ext:cls="Ext.calendar.DayView" ext:member="">DayView</a></td></tr></table><div class="description"><p>Displays a calendar view by week. This class does not usually need ot be used directly as you can
   3 use a <a href="output/Ext.calendar.CalendarPanel.html" ext:cls="Ext.calendar.CalendarPanel">CalendarPanel</a> to manage multiple calendar views at once including
   4 the week view.</p></div><div class="hr"></div><a id="Ext.calendar.WeekView-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.WeekView-dayCount"></a><b><a href="source/WeekView.html#cfg-Ext.calendar.WeekView-dayCount">dayCount</a></b> : Number<div class="mdesc">The number of days to display in the view (defaults to 7)</div></td><td class="msource">WeekView</td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.calendar.DayView-ddCreateEventText"></a><b><a href="source/DayView.html#cfg-Ext.calendar.DayView-ddCreateEventText">ddCreateEventText</a></b> : String<div class="mdesc"><div class="short">The text to display inside the drag proxy while dragging over the calendar to create a new event (defaults to
   5 'Creat...</div><div class="long">The text to display inside the drag proxy while dragging over the calendar to create a new event (defaults to
   6 'Create event for {0}' where {0} is a date range supplied by the view)</div></div></td><td class="msource"><a href="output/Ext.calendar.DayView.html#ddCreateEventText" ext:member="#ddCreateEventText" ext:cls="Ext.calendar.DayView">DayView</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.calendar.DayView-ddMoveEventText"></a><b><a href="source/DayView.html#cfg-Ext.calendar.DayView-ddMoveEventText">ddMoveEventText</a></b> : String<div class="mdesc"><div class="short">The text to display inside the drag proxy while dragging an event to reposition it (defaults to
   7 'Move event to {0}' ...</div><div class="long">The text to display inside the drag proxy while dragging an event to reposition it (defaults to
   8 'Move event to {0}' where {0} is the updated event start date/time supplied by the view)</div></div></td><td class="msource"><a href="output/Ext.calendar.DayView.html#ddMoveEventText" ext:member="#ddMoveEventText" ext:cls="Ext.calendar.DayView">DayView</a></td></tr><tr class="config-row  inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.calendar.DayView-showTime"></a><b><a href="source/DayView.html#cfg-Ext.calendar.DayView-showTime">showTime</a></b> : Boolean<div class="mdesc">True to display the current time in today's box in the calendar, false to not display it (defautls to true)</div></td><td class="msource"><a href="output/Ext.calendar.DayView.html#showTime" ext:member="#showTime" ext:cls="Ext.calendar.DayView">DayView</a></td></tr><tr class="config-row  inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.calendar.DayView-showTodayText"></a><b><a href="source/DayView.html#cfg-Ext.calendar.DayView-showTodayText">showTodayText</a></b> : Boolean<div class="mdesc">True to display the <a href="output/Ext.calendar.DayView.html#Ext.calendar.DayView-todayText" ext:member="todayText" ext:cls="Ext.calendar.DayView">todayText</a> string in today's box in the calendar, false to not display it (defautls to true)</div></td><td class="msource"><a href="output/Ext.calendar.DayView.html#showTodayText" ext:member="#showTodayText" ext:cls="Ext.calendar.DayView">DayView</a></td></tr><tr class="config-row  inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.calendar.DayView-todayText"></a><b><a href="source/DayView.html#cfg-Ext.calendar.DayView-todayText">todayText</a></b> : String<div class="mdesc">The text to display in the current day's box in the calendar when <a href="output/Ext.calendar.DayView.html#Ext.calendar.DayView-showTodayText" ext:member="showTodayText" ext:cls="Ext.calendar.DayView">showTodayText</a> is true (defaults to 'Today')</div></td><td class="msource"><a href="output/Ext.calendar.DayView.html#todayText" ext:member="#todayText" ext:cls="Ext.calendar.DayView">DayView</a></td></tr></tbody></table><a id="Ext.calendar.WeekView-props"></a><h2>Public Properties</h2><div class="no-members">This class has no public properties.</div><a id="Ext.calendar.WeekView-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.WeekView-WeekView"></a><b><a href="source/WeekView.html#cls-Ext.calendar.WeekView">WeekView</a></b>(&nbsp;<code>Object&nbsp;config</code>&nbsp;)
   9     <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">WeekView</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.calendar.DayView-getStartDate"></a><b><a href="source/DayView.html#method-Ext.calendar.DayView-getStartDate">getStartDate</a></b>()
  10     :
  11                                         Date<div class="mdesc"><div class="short">Returns the start date of the view, as set by setStartDate. Note that this may not
  12 be the first date displayed in th...</div><div class="long">Returns the start date of the view, as set by <a href="output/Ext.calendar.DayView.html#Ext.calendar.DayView-setStartDate" ext:member="setStartDate" ext:cls="Ext.calendar.DayView">setStartDate</a>. Note that this may not
  13 be the first date displayed in the rendered calendar -- to get the start and end dates displayed
  14 to the user use <a href="output/Ext.calendar.DayView.html#Ext.calendar.DayView-getViewBounds" ext:member="getViewBounds" ext:cls="Ext.calendar.DayView">getViewBounds</a>.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Date</code><div class="sub-desc">The start date</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.calendar.DayView.html#getStartDate" ext:member="#getStartDate" ext:cls="Ext.calendar.DayView">DayView</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.calendar.DayView-isToday"></a><b><a href="source/DayView.html#method-Ext.calendar.DayView-isToday">isToday</a></b>()
  15     :
  16                                         Boolean<div class="mdesc"><div class="short">Returns true if the view is currently displaying today's date, else false.</div><div class="long">Returns true if the view is currently displaying today's date, else false.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc">True or false</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.calendar.DayView.html#isToday" ext:member="#isToday" ext:cls="Ext.calendar.DayView">DayView</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.calendar.DayView-moveDays"></a><b><a href="source/DayView.html#method-Ext.calendar.DayView-moveDays">moveDays</a></b>(&nbsp;<code>Number&nbsp;value</code>&nbsp;)
  17     :
  18                                         void<div class="mdesc"><div class="short">Shifts the view by the passed number of days relative to the currently set date</div><div class="long">Shifts the view by the passed number of days relative to the currently set date<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>value</code> : Number<div class="sub-desc">The number of days (positive or negative) by which to shift the view</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.calendar.DayView.html#moveDays" ext:member="#moveDays" ext:cls="Ext.calendar.DayView">DayView</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.calendar.DayView-moveNext"></a><b><a href="source/DayView.html#method-Ext.calendar.DayView-moveNext">moveNext</a></b>()
  19     :
  20                                         void<div class="mdesc"><div class="short">Updates the view to the next consecutive date(s)</div><div class="long">Updates the view to the next consecutive date(s)<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.calendar.DayView.html#moveNext" ext:member="#moveNext" ext:cls="Ext.calendar.DayView">DayView</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.calendar.DayView-movePrev"></a><b><a href="source/DayView.html#method-Ext.calendar.DayView-movePrev">movePrev</a></b>()
  21     :
  22                                         void<div class="mdesc"><div class="short">Updates the view to the previous consecutive date(s)</div><div class="long">Updates the view to the previous consecutive date(s)<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.calendar.DayView.html#movePrev" ext:member="#movePrev" ext:cls="Ext.calendar.DayView">DayView</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.calendar.DayView-moveTo"></a><b><a href="source/DayView.html#method-Ext.calendar.DayView-moveTo">moveTo</a></b>(&nbsp;<code>Date&nbsp;dt</code>&nbsp;)
  23     :
  24                                         void<div class="mdesc"><div class="short">Updates the view to contain the passed date</div><div class="long">Updates the view to contain the passed date<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>dt</code> : Date<div class="sub-desc">The date to display</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.calendar.DayView.html#moveTo" ext:member="#moveTo" ext:cls="Ext.calendar.DayView">DayView</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.calendar.DayView-moveToday"></a><b><a href="source/DayView.html#method-Ext.calendar.DayView-moveToday">moveToday</a></b>()
  25     :
  26                                         void<div class="mdesc"><div class="short">Updates the view to show today</div><div class="long">Updates the view to show today<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.calendar.DayView.html#moveToday" ext:member="#moveToday" ext:cls="Ext.calendar.DayView">DayView</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.calendar.DayView-setStartDate"></a><b><a href="source/DayView.html#method-Ext.calendar.DayView-setStartDate">setStartDate</a></b>(&nbsp;<code>Date&nbsp;dt</code>&nbsp;)
  27     :
  28                                         void<div class="mdesc"><div class="short">Sets the start date used to calculate the view boundaries to display. The displayed view will be the
  29 earliest and la...</div><div class="long">Sets the start date used to calculate the view boundaries to display. The displayed view will be the
  30 earliest and latest dates that match the view requirements and contain the date passed to this function.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>dt</code> : Date<div class="sub-desc">The date used to calculate the new view boundaries</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.calendar.DayView.html#setStartDate" ext:member="#setStartDate" ext:cls="Ext.calendar.DayView">DayView</a></td></tr></tbody></table><a id="Ext.calendar.WeekView-events"></a><h2>Public Events</h2><div class="no-members">This class has no public events.</div></div>