docs/output/App.user.FormPanel.html

   1 <div class="body-wrap" xmlns:ext="http://www.extjs.com"><div class="top-tools"><a class="inner-link" href="#App.user.FormPanel-props"><img src="resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>&#13;<a class="inner-link" href="#App.user.FormPanel-methods"><img src="resources/images/default/s.gif" class="item-icon icon-method">Methods</a>&#13;<a class="inner-link" href="#App.user.FormPanel-events"><img src="resources/images/default/s.gif" class="item-icon icon-event">Events</a>&#13;<a class="inner-link" href="#App.user.FormPanel-configs"><img src="resources/images/default/s.gif" class="item-icon icon-config">Config Options</a>&#13;<a class="bookmark" href="../docs/?class=App.user.FormPanel"><img src="resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>&#13;</div><h1>Class <a href="source/UserForm.html#cls-App.user.FormPanel">App.user.FormPanel</a></h1><table cellspacing="0"><tr><td class="label">Package:</td><td class="hd-info">App.user</td></tr><tr><td class="label">Defined In:</td><td class="hd-info">UserForm.js</td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/UserForm.html#cls-App.user.FormPanel">FormPanel</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info">Object</td></tr></table><div class="description">A typical FormPanel extension</div><div class="hr"></div><a id="App.user.FormPanel-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="App.user.FormPanel-api"></a><b><a href="source/App2.html#cfg-App.user.FormPanel-api">api</a></b> : Object<div class="mdesc">remoting api.  should be defined in your own config js.</div></td><td class="msource">FormPanel</td></tr></tbody></table><a id="App.user.FormPanel-props"></a><h2>Public Properties</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Property</th><th class="msource-header">Defined By</th></tr><tr class="property-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="App.user.FormPanel-STATUS_EXCEPTION"></a><b><a href="source/App2.html#prop-App.user.FormPanel-STATUS_EXCEPTION">STATUS_EXCEPTION</a></b> : Object<div class="mdesc">response status codes.</div></td><td class="msource">FormPanel</td></tr></tbody></table><a id="App.user.FormPanel-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="App.user.FormPanel-App"></a><b><a href="source/App2.html#method-App.user.FormPanel-App">App</a></b>()
   2     :
   3                                         void<div class="mdesc"><table><tr><td class="label">Author:</td><td class="hd-info">Chris Scott</td></tr></table><div class="short">Ext.App</div><div class="long">Ext.App<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">FormPanel</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="App.user.FormPanel-ImageDragZone"></a><b><a href="source/organizer.html#method-App.user.FormPanel-ImageDragZone">ImageDragZone</a></b>()
   4     :
   5                                         void<div class="mdesc"><div class="short">Create a DragZone instance for our JsonView</div><div class="long">Create a DragZone instance for our JsonView<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">FormPanel</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="App.user.FormPanel-addMessage"></a><b><a href="source/App2.html#method-App.user.FormPanel-addMessage">addMessage</a></b>(&nbsp;<code>String&nbsp;msg</code>,&nbsp;<code>Bool&nbsp;status</code>&nbsp;)
   6     :
   7                                         void<div class="mdesc"><div class="short">adds a message to queue.</div><div class="long">adds a message to queue.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>msg</code> : String<div class="sub-desc"></div></li><li><code>status</code> : Bool<div class="sub-desc"></div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">FormPanel</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="App.user.FormPanel-buildMessageBox"></a><b><a href="source/App2.html#method-App.user.FormPanel-buildMessageBox">buildMessageBox</a></b>()
   8     :
   9                                         void<div class="mdesc"><div class="short">buildMessageBox</div><div class="long">buildMessageBox<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">FormPanel</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="App.user.FormPanel-decodeStatusIcon"></a><b><a href="source/App2.html#method-App.user.FormPanel-decodeStatusIcon">decodeStatusIcon</a></b>(&nbsp;<code>Object&nbsp;status</code>&nbsp;)
  10     :
  11                                         void<div class="mdesc"><div class="short">decodeStatusIcon</div><div class="long">decodeStatusIcon<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>status</code> : Object<div class="sub-desc"></div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">FormPanel</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="App.user.FormPanel-getAPI"></a><b><a href="source/App2.html#method-App.user.FormPanel-getAPI">getAPI</a></b>()
  12     :
  13                                         void<div class="mdesc"><div class="short">getAPI
  14 return Ext Remoting api</div><div class="long">getAPI
  15 return Ext Remoting api<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">FormPanel</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="App.user.FormPanel-getViewState"></a><b><a href="source/App2.html#method-App.user.FormPanel-getViewState">getViewState</a></b>(&nbsp;<code>Object&nbsp;cmd</code>&nbsp;)
  16     :
  17                                         void<div class="mdesc"><div class="short">getViewState, aliaz for Ext.state.Manager.get</div><div class="long">getViewState, aliaz for Ext.state.Manager.get<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>cmd</code> : Object<div class="sub-desc"></div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">FormPanel</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="App.user.FormPanel-getViews"></a><b><a href="source/App2.html#method-App.user.FormPanel-getViews">getViews</a></b>()
  18     :
  19                                         void<div class="mdesc"><div class="short">getViews
  20 return list of registered views</div><div class="long">getViews
  21 return list of registered views<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">FormPanel</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="App.user.FormPanel-initComponent"></a><b><a href="source/UserForm.html#method-App.user.FormPanel-initComponent">initComponent</a></b>()
  22     :
  23                                         void<div class="mdesc"><div class="short">initComponent</div><div class="long">initComponent<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">FormPanel</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="App.user.FormPanel-loadRecord"></a><b><a href="source/UserForm.html#method-App.user.FormPanel-loadRecord">loadRecord</a></b>(&nbsp;<code>Record&nbsp;rec</code>&nbsp;)
  24     :
  25                                         void<div class="mdesc"><div class="short">loadRecord</div><div class="long">loadRecord<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>rec</code> : Record<div class="sub-desc"></div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">FormPanel</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="App.user.FormPanel-onCreate"></a><b><a href="source/UserForm.html#method-App.user.FormPanel-onCreate">onCreate</a></b>()
  26     :
  27                                         void<div class="mdesc"><div class="short">onCreate</div><div class="long">onCreate<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">FormPanel</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="App.user.FormPanel-onReset"></a><b><a href="source/UserForm.html#method-App.user.FormPanel-onReset">onReset</a></b>()
  28     :
  29                                         void<div class="mdesc"><div class="short">onReset</div><div class="long">onReset<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">FormPanel</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="App.user.FormPanel-onUpdate"></a><b><a href="source/UserForm.html#method-App.user.FormPanel-onUpdate">onUpdate</a></b>()
  30     :
  31                                         void<div class="mdesc"><div class="short">onUpdate</div><div class="long">onUpdate<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">FormPanel</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="App.user.FormPanel-registerActions"></a><b><a href="source/App2.html#method-App.user.FormPanel-registerActions">registerActions</a></b>(&nbsp;<code>Object&nbsp;actions</code>&nbsp;)
  32     :
  33                                         void<div class="mdesc"><div class="short">registerActions
  34 registers new actions for API</div><div class="long">registerActions
  35 registers new actions for API<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>actions</code> : Object<div class="sub-desc"></div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">FormPanel</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="App.user.FormPanel-registerView"></a><b><a href="source/App2.html#method-App.user.FormPanel-registerView">registerView</a></b>(&nbsp;<code>Object&nbsp;view</code>&nbsp;)
  36     :
  37                                         void<div class="mdesc"><div class="short">registerView
  38 register an application view component.</div><div class="long">registerView
  39 register an application view component.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>view</code> : Object<div class="sub-desc"></div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">FormPanel</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="App.user.FormPanel-setAlert"></a><b><a href="source/App2.html#method-App.user.FormPanel-setAlert">setAlert</a></b>(&nbsp;<code>String&nbsp;msg</code>,&nbsp;<code>Bool&nbsp;status</code>&nbsp;)
  40     :
  41                                         void<div class="mdesc"><div class="short">setAlert
  42 show the message box.  Aliased to addMessage</div><div class="long">setAlert
  43 show the message box.  Aliased to addMessage<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>msg</code> : String<div class="sub-desc"></div></li><li><code>status</code> : Bool<div class="sub-desc"></div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">FormPanel</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="App.user.FormPanel-setViewState"></a><b><a href="source/App2.html#method-App.user.FormPanel-setViewState">setViewState</a></b>(&nbsp;<code>Object&nbsp;key</code>,&nbsp;<code>Object&nbsp;value</code>&nbsp;)
  44     :
  45                                         void<div class="mdesc"><div class="short">setViewState, alias for Ext.state.Manager.set</div><div class="long">setViewState, alias for Ext.state.Manager.set<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>key</code> : Object<div class="sub-desc"></div></li><li><code>value</code> : Object<div class="sub-desc"></div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">FormPanel</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="App.user.FormPanel-t"></a><b><a href="source/App2.html#method-App.user.FormPanel-t">t</a></b>(&nbsp;<code>String&nbsp;to</code>&nbsp;)
  46     :
  47                                         String<div class="mdesc"><div class="short">t
  48 translation function.  needs to be implemented.  simply echos supplied word back currently.</div><div class="long">t
  49 translation function.  needs to be implemented.  simply echos supplied word back currently.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>to</code> : String<div class="sub-desc">translate</div></li></ul><strong>Returns:</strong><ul><li><code>String</code><div class="sub-desc">translated.</div></li></ul></div></div></div></td><td class="msource">FormPanel</td></tr></tbody></table><a id="App.user.FormPanel-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="App.user.FormPanel-create"></a><b><a href="source/UserForm.html#event-App.user.FormPanel-create">create</a></b> :
  50                                       (&nbsp;<code>FormPanel&nbsp;this</code>,&nbsp;<code>Object&nbsp;values,</code>&nbsp;)
  51     <div class="mdesc"><div class="short">Fires when user clicks [create] button</div><div class="long">Fires when user clicks [create] button<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : FormPanel<div class="sub-desc"></div></li><li><code>values,</code> : Object<div class="sub-desc">the Form's values object</div></li></ul></div></div></div></td><td class="msource">FormPanel</td></tr></tbody></table></div>