Upgrade to ExtJS 3.3.0 - Released 10/06/2010
[extjs.git] / examples / docs / output / Ext.calendar.EventEditWindow.html
1 <div class="body-wrap" xmlns:ext="http://www.extjs.com"><div class="top-tools"><a class="inner-link" href="#Ext.calendar.EventEditWindow-props"><img src="resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>&#13;<a class="inner-link" href="#Ext.calendar.EventEditWindow-methods"><img src="resources/images/default/s.gif" class="item-icon icon-method">Methods</a>&#13;<a class="inner-link" href="#Ext.calendar.EventEditWindow-events"><img src="resources/images/default/s.gif" class="item-icon icon-event">Events</a>&#13;<a class="bookmark" href="../docs/?class=Ext.calendar.EventEditWindow"><img src="resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>&#13;</div><h1>Class <a href="source/EventEditWindow.html#cls-Ext.calendar.EventEditWindow">Ext.calendar.EventEditWindow</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/EventEditWindow.html#cls-Ext.calendar.EventEditWindow">EventEditWindow.js</a></td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/EventEditWindow.html#cls-Ext.calendar.EventEditWindow">EventEditWindow</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info">Object</td></tr></table><div class="description"><p>A custom window containing a basic edit form used for quick editing of events.</p>
2 <p>This window also provides custom events specific to the calendar so that other calendar components can be easily
3 notified when an event has been edited via this component.</p></div><div class="hr"></div><a id="Ext.calendar.EventEditWindow-props"></a><h2>Public Properties</h2><div class="no-members">This class has no public properties.</div><a id="Ext.calendar.EventEditWindow-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.EventEditWindow-EventEditWindow"></a><b><a href="source/EventEditWindow.html#cls-Ext.calendar.EventEditWindow">EventEditWindow</a></b>(&nbsp;<code>Object&nbsp;config</code>&nbsp;)
4     <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">EventEditWindow</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.EventEditWindow-show"></a><b><a href="source/EventEditWindow.html#method-Ext.calendar.EventEditWindow-show">show</a></b>(&nbsp;<code>Ext.data.Record/Object&nbsp;o</code>,&nbsp;<span title="Optional" class="optional">[<code>String/Element&nbsp;animateTarget</code>]</span>&nbsp;)
5     :
6                                         Ext.Window<div class="mdesc"><div class="short">Shows the window, rendering it first if necessary, or activates it and brings it to front if hidden.</div><div class="long">Shows the window, rendering it first if necessary, or activates it and brings it to front if hidden.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>o</code> : Ext.data.Record/Object<div class="sub-desc">Either a <a href="output/Ext.data.Record.html" ext:cls="Ext.data.Record">Ext.data.Record</a> if showing the form
7 for an existing event in edit mode, or a plain object containing a StartDate property (and 
8 optionally an EndDate property) for showing the form in add mode.</div></li><li><code>animateTarget</code> : String/Element<div class="sub-desc">(optional) The target element or id from which the window should
9 animate while opening (defaults to null with no animation)</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.Window</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource">EventEditWindow</td></tr></tbody></table><a id="Ext.calendar.EventEditWindow-events"></a><h2>Public Events</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Event</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.EventEditWindow-editdetails"></a><b><a href="source/EventEditWindow.html#event-Ext.calendar.EventEditWindow-editdetails">editdetails</a></b> :
10                                       (&nbsp;<code>Ext.calendar.EventEditWindow&nbsp;this</code>,&nbsp;<code>Ext.calendar.EventRecord&nbsp;rec</code>&nbsp;)
11     <div class="mdesc"><div class="short">Fires when the user selects the option in this window to continue editing in the detailed edit form
12 (by default, an i...</div><div class="long">Fires when the user selects the option in this window to continue editing in the detailed edit form
13 (by default, an instance of <a href="output/Ext.calendar.EventEditForm.html" ext:cls="Ext.calendar.EventEditForm">Ext.calendar.EventEditForm</a>. Handling code should hide this window
14 and transfer the current event record to the appropriate instance of the detailed form by showing it
15 and calling <a href="output/Ext.calendar.EventEditForm.html#Ext.calendar.EventEditForm-loadRecord" ext:member="loadRecord" ext:cls="Ext.calendar.EventEditForm">loadRecord</a>.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Ext.calendar.EventEditWindow<div class="sub-desc"></div></li><li><code>rec</code> : Ext.calendar.EventRecord<div class="sub-desc">The <a href="output/Ext.calendar.EventRecord.html" ext:cls="Ext.calendar.EventRecord">record</a> that is currently being edited</div></li></ul></div></div></div></td><td class="msource">EventEditWindow</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.EventEditWindow-eventadd"></a><b><a href="source/EventEditWindow.html#event-Ext.calendar.EventEditWindow-eventadd">eventadd</a></b> :
16                                       (&nbsp;<code>Ext.calendar.EventEditWindow&nbsp;this</code>,&nbsp;<code>Ext.calendar.EventRecord&nbsp;rec</code>&nbsp;)
17     <div class="mdesc"><div class="short">Fires after a new event is added</div><div class="long">Fires after a new event is added<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Ext.calendar.EventEditWindow<div class="sub-desc"></div></li><li><code>rec</code> : Ext.calendar.EventRecord<div class="sub-desc">The new <a href="output/Ext.calendar.EventRecord.html" ext:cls="Ext.calendar.EventRecord">record</a> that was added</div></li></ul></div></div></div></td><td class="msource">EventEditWindow</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.EventEditWindow-eventcancel"></a><b><a href="source/EventEditWindow.html#event-Ext.calendar.EventEditWindow-eventcancel">eventcancel</a></b> :
18                                       (&nbsp;<code>Ext.calendar.EventEditWindow&nbsp;this</code>,&nbsp;<code>Ext.calendar.EventRecord&nbsp;rec</code>&nbsp;)
19     <div class="mdesc"><div class="short">Fires after an event add/edit operation is canceled by the user and no store update took place</div><div class="long">Fires after an event add/edit operation is canceled by the user and no store update took place<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Ext.calendar.EventEditWindow<div class="sub-desc"></div></li><li><code>rec</code> : Ext.calendar.EventRecord<div class="sub-desc">The new <a href="output/Ext.calendar.EventRecord.html" ext:cls="Ext.calendar.EventRecord">record</a> that was canceled</div></li></ul></div></div></div></td><td class="msource">EventEditWindow</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.EventEditWindow-eventdelete"></a><b><a href="source/EventEditWindow.html#event-Ext.calendar.EventEditWindow-eventdelete">eventdelete</a></b> :
20                                       (&nbsp;<code>Ext.calendar.EventEditWindow&nbsp;this</code>,&nbsp;<code>Ext.calendar.EventRecord&nbsp;rec</code>&nbsp;)
21     <div class="mdesc"><div class="short">Fires after an event is deleted</div><div class="long">Fires after an event is deleted<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Ext.calendar.EventEditWindow<div class="sub-desc"></div></li><li><code>rec</code> : Ext.calendar.EventRecord<div class="sub-desc">The new <a href="output/Ext.calendar.EventRecord.html" ext:cls="Ext.calendar.EventRecord">record</a> that was deleted</div></li></ul></div></div></div></td><td class="msource">EventEditWindow</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.EventEditWindow-eventupdate"></a><b><a href="source/EventEditWindow.html#event-Ext.calendar.EventEditWindow-eventupdate">eventupdate</a></b> :
22                                       (&nbsp;<code>Ext.calendar.EventEditWindow&nbsp;this</code>,&nbsp;<code>Ext.calendar.EventRecord&nbsp;rec</code>&nbsp;)
23     <div class="mdesc"><div class="short">Fires after an existing event is updated</div><div class="long">Fires after an existing event is updated<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Ext.calendar.EventEditWindow<div class="sub-desc"></div></li><li><code>rec</code> : Ext.calendar.EventRecord<div class="sub-desc">The new <a href="output/Ext.calendar.EventRecord.html" ext:cls="Ext.calendar.EventRecord">record</a> that was updated</div></li></ul></div></div></div></td><td class="msource">EventEditWindow</td></tr></tbody></table></div>