docs/symbols/Roo.grid.PropertyGrid.html
authorAlan Knowles <alan@akbkhome.com>
Fri, 16 Jul 2010 07:57:04 +0000 (15:57 +0800)
committerAlan Knowles <alan@akbkhome.com>
Fri, 16 Jul 2010 07:57:04 +0000 (15:57 +0800)
docs/symbols/Roo.grid.PropertyGrid.html [new file with mode: 0644]

diff --git a/docs/symbols/Roo.grid.PropertyGrid.html b/docs/symbols/Roo.grid.PropertyGrid.html
new file mode 100644 (file)
index 0000000..8791a29
--- /dev/null
@@ -0,0 +1,628 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+
+       <head>
+               <meta http-equiv="content-type" content="text/html; charset=undefined" />
+               <meta name="generator" content="JsDoc Toolkit" />
+               
+               
+               <title>JsDoc Reference - Roo.grid.PropertyGrid</title>
+               
+               
+       <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />            
+       <link rel="stylesheet" type="text/css" href="../default.css" />
+       
+       
+       <script type="text/javascript" src="../page.js">
+       
+       </script>
+        
+               
+       </head>
+
+       <body onload="RooDocsPage.onload();">
+        
+       
+<div class="body-wrap">
+
+    <!-- ============================== links to methods. ================================= -->        
+
+    <div class="top-tools">
+    <!--
+        <a class="inner-link" href="#Roo.grid.PropertyGrid-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
+        <a class="inner-link" href="#Roo.grid.PropertyGrid-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
+        <a class="inner-link" href="#Roo.grid.PropertyGrid-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
+        <a class="inner-link" href="#Roo.grid.PropertyGrid-configs"><img src="resources/s.gif" class="item-icon icon-config">Config Options</a>
+        <a class="bookmark" href="NEED_TO_CREATE_DIRECT_LINK_HREF"><img src="resources/s.gif" class="item-icon icon-fav">Direct Link</a>
+       -->
+    </div>
+
+    
+<!-- ============================== inheritance Block. ================================= -->   
+       
+               <div class="inheritance res-block">
+                  <pre class="res-block-inner"><a href="./Roo.grid.EditorGrid.html#constructor" roo:cls="Roo.grid.EditorGrid.html#constructor">Roo.grid.EditorGrid</a>
+<img src="../../images/default/s.gif" height="1"  width="20"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.grid.PropertyGrid 
+
+                  </pre>
+               </div>
+       
+<!-- ============================== class title / details ============================ -->
+    
+    
+    <h1 class="classTitle">
+                               
+                               Class Roo.grid.PropertyGrid
+                       </h1>
+                       
+    <table cellspacing="0" class="class-summary-table">
+       
+               <tr><td class="label">Package:</td><td class="hd-info">Roo.grid</td></tr>
+       
+        <tr><td class="label">Defined In:</td><td class="hd-info">
+                       
+                                       <a href="./src/Roo_grid_PropertyGrid.js.html">Roo/grid/PropertyGrid.js</a>.
+                       
+       </td></tr>
+        <tr><td class="label">Class:</td><td class="hd-info">PropertyGrid</td></tr>
+       
+       
+       
+       
+               <tr><td class="label">Extends:</td><td class="hd-info">
+                       <a href="./Roo.grid.EditorGrid.html#constructor" roo:cls="Roo.grid.EditorGrid.html#constructor">Roo.grid.EditorGrid</a>
+       
+               </td></tr>    
+       
+       
+    </table>
+
+    
+<!-- ============================== class summary ========================== -->                       
+    <div class="description">
+       This class represents the  interface of a component based property grid control.<br/><br><br>Usage:<pre><code><br/> var grid = new Roo.grid.PropertyGrid("my-container-id", {<br/>      <br/> });<br/> // set any options<br/> grid.render();<br/></code></pre>
+    </div>
+
+       
+<!-- ============================== Class comment block... ========================== -->                                      
+
+<div class="comments">
+       <b>Class Comments / Notes</B> =>  
+       <u onclick="parent.CommentDialog.showCommentId = 'Roo.grid.PropertyGrid';">[Add Your comment/notes about this class]</u>
+       <br/>
+       <iframe frameborder="0"  id="comments-Roo.grid" style="border: none;width:100%;" 
+               src="/blog.php/GtkDjsComments/Roo.grid.PropertyGrid.html"></iframe>
+</div>
+       
+
+               
+<!-- ============================== config options ========================== -->                                              
+                
+    
+    
+               
+    <div class="hr"></div>
+    <a id="Roo.grid.PropertyGrid-configs"></a>
+               
+    
+     
+    
+       
+      <table cellspacing="0" class="member-table">   
+      <caption>Config Options (Usually are also Properties)</caption>
+    
+       
+        <tr>
+            <th class="sig-header" colspan="2">Options</th>
+           
+            <th class="msource-header">Defined By</th>
+        </tr>
+       
+       
+       
+       
+       
+               <tr class="config-row expandable config-row-alt0 notInherited">
+                  <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
+                   <td class="sig">
+
+                       <a id="Roo.grid.PropertyGrid-cfg-customEditors" name=".customEditors"></a>
+                       <div class="fixedFont">
+                               <b  class="itemname">customEditors</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
+                               
+                               
+                       </div>
+                 
+                       <div class="mdesc">
+                           <div class="short">map of colnames=> custom editors.</div> 
+                       </div>
+                       
+                       <div class="mdesc">
+                           <div class="long">map of colnames=> custom editors.<br/>the custom editor can be one of the standard ones (date|string|number|int|boolean), or a<br/>grid editor eg. Roo.grid.GridEditor(new Roo.form.TextArea({selectOnFocus:true})),<br/>false disables editing of the field.</div> 
+                       </div>
+                       
+                       
+
+                   </td>
+                   <td class="msource">
+                       
+                       Roo.grid.PropertyGrid
+                               
+                   </td>
+               </tr>
+        
+       
+               <tr class="config-row expandable config-row-alt1 notInherited">
+                  <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
+                   <td class="sig">
+
+                       <a id="Roo.grid.PropertyGrid-cfg-propertyNames" name=".propertyNames"></a>
+                       <div class="fixedFont">
+                               <b  class="itemname">propertyNames</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
+                               
+                               
+                       </div>
+                 
+                       <div class="mdesc">
+                           <div class="short">map of property Names to their displayed value</div> 
+                       </div>
+                       
+                       <div class="mdesc">
+                           <div class="long">map of property Names to their displayed value</div> 
+                       </div>
+                       
+                       
+
+                   </td>
+                   <td class="msource">
+                       
+                       Roo.grid.PropertyGrid
+                               
+                   </td>
+               </tr>
+        
+        
+    </table>
+               
+  
+  
+  
+  
+  
+  
+  
+  
+  <!-- ============================== public properties ==================== -->       
+  
+  
+  
+    <a id="Roo.grid.PropertyGrid-props"></a>      
+    
+    
+
+    
+    
+     <table cellspacing="0" class="member-table">
+      <caption class="Empty">Public Properties - Has None</caption>
+     </table>
+    
+    
+     
+    
+  <!-- ============================== methods summary / details ======================== -->
+  
+  
+  <a id="Roo.grid.PropertyGrid-methods"></a>
+       <!-- constructor?? -->
+       
+       <!-- static's first 
+       
+       
+       -->
+       
+       <!-- then dynamics first -->
+       
+  
+  
+    
+    
+    
+      <table cellspacing="0" class="member-table">
+      <caption>Public Methods</caption>
+        <tr>
+            <th class="sig-header" colspan="2">Method</th>            
+            <th class="msource-header">Defined By</th>
+
+        </tr>
+        
+       
+       
+        
+       
+        
+         
+          <tr class="method-row config-row-alt0 expandable notInherited">
+            <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
+          
+          
+            <td class="sig">
+                <a id="Roo.grid-method-PropertyGrid"   name=".PropertyGrid"></a>
+               <div class="fixedFont">
+                       <span class="attributes">new <B>Roo.grid.</B></span><b class="itemname">PropertyGrid</b>
+                               
+                                (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element <B><i>container</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>) 
+                       
+                               
+                       
+               </div>
+                <div class="mdesc">
+               
+                
+                       <div class="short">Create a new Roo.grid.PropertyGrid</div> 
+                
+                
+                    <div class="long">
+                       
+                       
+                       
+                               Create a new Roo.grid.PropertyGrid
+                       
+                       
+                               <dl class="detailList">
+                               <dt class="heading">Parameters:</dt>
+                               
+                                       <dt>
+                                               <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element</span>  <b>container</b>
+                                               
+                                       </dt>
+                                       <dd>The element into which this grid will be rendered -<br/>The container MUST have some type of size defined for the grid to fill. The container will be<br/>automatically set to position relative if it isn't already.</dd>
+                               
+                                       <dt>
+                                               <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>
+                                               
+                                       </dt>
+                                       <dd>A config object that sets properties on this grid.</dd>
+                               
+                               </dl>
+                       
+                       
+                       
+                       
+                       
+                       
+                       
+
+                   
+                   
+                    
+                    </div>                    
+                </div>
+
+            </td>
+            <td class="msource">
+               &nbsp;
+            </td>
+        </tr>
+       
+         
+          <tr class="method-row config-row-alt1 expandable notInherited">
+            <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
+          
+          
+            <td class="sig">
+                <a id="Roo.grid.PropertyGrid-method-getSource"   name=".getSource"></a>
+               <div class="fixedFont">
+                       <span class="attributes"></span><b class="itemname">getSource</b>
+                               
+                                () 
+                       
+                               
+                                        : 
+                                       
+                                               
+                                               <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
+                                       
+                                       
+                                       
+                               
+                       
+               </div>
+                <div class="mdesc">
+               
+                   <div class="short">Gets all the data from the grid.</div> 
+                
+                
+                
+                    <div class="long">
+                       
+                               Gets all the data from the grid.
+                   
+                               
+                       
+                       
+                       
+                       
+                       
+                       
+                       
+                       
+                               <dl class="detailList">
+                               <dt class="heading">Returns:</dt>
+                               
+                                       <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  data  data stored in grid</dd>
+                               
+                               </dl>
+                       
+                       
+                       
+
+                   
+                   
+                    
+                    </div>                    
+                </div>
+
+            </td>
+            <td class="msource">
+               
+                       Roo.grid.PropertyGrid
+               &nbsp;
+            </td>
+        </tr>
+       
+         
+          <tr class="method-row config-row-alt0 expandable notInherited">
+            <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
+          
+          
+            <td class="sig">
+                <a id="Roo.grid.PropertyGrid-method-setSource"   name=".setSource"></a>
+               <div class="fixedFont">
+                       <span class="attributes"></span><b class="itemname">setSource</b>
+                               
+                                (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>data</i></B>) 
+                       
+                               
+                       
+               </div>
+                <div class="mdesc">
+               
+                   <div class="short">Sets the data for the Grid<br/>accepts a Key => Value object of all the elements avaiable.</div> 
+                
+                
+                
+                    <div class="long">
+                       
+                               Sets the data for the Grid<br/>accepts a Key => Value object of all the elements avaiable.
+                   
+                               
+                       
+                       
+                       
+                       
+                               <dl class="detailList">
+                               <dt class="heading">Parameters:</dt>
+                               
+                                       <dt>
+                                               <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>data</b>
+                                               
+                                       </dt>
+                                       <dd>to appear in grid.</dd>
+                               
+                               </dl>
+                       
+                       
+                       
+                       
+                       
+                       
+                       
+
+                   
+                   
+                    
+                    </div>                    
+                </div>
+
+            </td>
+            <td class="msource">
+               
+                       Roo.grid.PropertyGrid
+               &nbsp;
+            </td>
+        </tr>
+       
+                                                      
+    </table>
+
+  
+  <!-- ============================== events summary / details ======================== -->
+  
+  
+  <a id="Roo.grid.PropertyGrid-events"></a>
+    
+  
+       
+   
+  
+    
+    
+    
+      <table cellspacing="0" class="member-table">
+               <caption>Events</caption>
+             <thead>
+               <tr>
+                   <th class="sig-header" colspan="2">Event</th>            
+                   <th class="msource-header">Defined By</th>
+
+               </tr>
+             </thead>  
+       
+       
+        
+       
+        
+          <tr class="method-row expandable config-row-alt0 notInherited">
+            <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
+           
+            <td class="sig">
+                <a id="Roo.grid.PropertyGrid-event-*beforepropertychange"></a>
+                
+              <div class="fixedFont">
+               <b class="itemname">beforepropertychange</b> (<a href="./Roo.grid.PropertyGrid.html#constructor" roo:cls="Roo.grid.PropertyGrid.html#constructor">Roo.grid.PropertyGrid</a> <B><i>grid</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>id</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>newval</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>oldval</i></B>) 
+               
+               </div>
+
+                <div class="mdesc">
+
+                   <div class="short">Fires before a property changes (return false to stop?)
+                  
+               </div> 
+                   
+                    <div class="long">
+                   
+                       Fires before a property changes (return false to stop?)
+                   
+                       
+                       
+               
+                       
+                               <dl class="detailList">
+                               <dt class="heading">Parameters:</dt>
+                               
+                                       <dt>
+                                               <span class="fixedFont"><a href="./Roo.grid.PropertyGrid.html#constructor" roo:cls="Roo.grid.PropertyGrid.html#constructor">Roo.grid.PropertyGrid</a></span> <b>grid</b>
+                                               
+                                       </dt>
+                                       <dd>property grid? (check could be store)</dd>
+                               
+                                       <dt>
+                                               <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>id</b>
+                                               
+                                       </dt>
+                                       <dd>Record Id</dd>
+                               
+                                       <dt>
+                                               <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>newval</b>
+                                               
+                                       </dt>
+                                       <dd>New Value</dd>
+                               
+                                       <dt>
+                                               <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>oldval</b>
+                                               
+                                       </dt>
+                                       <dd>Old Value</dd>
+                               
+                               </dl>
+                       
+                       
+                       
+                       
+                       
+                       
+                       
+
+                   
+                   
+                    
+                    </div>                    
+                </div>
+
+            </td>
+            <td class="msource">
+                Roo.grid.PropertyGrid
+            </td>
+        </tr>
+       
+          <tr class="method-row expandable config-row-alt1 notInherited">
+            <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
+           
+            <td class="sig">
+                <a id="Roo.grid.PropertyGrid-event-*propertychange"></a>
+                
+              <div class="fixedFont">
+               <b class="itemname">propertychange</b> (<a href="./Roo.grid.PropertyGrid.html#constructor" roo:cls="Roo.grid.PropertyGrid.html#constructor">Roo.grid.PropertyGrid</a> <B><i>grid</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>id</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>newval</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>oldval</i></B>) 
+               
+               </div>
+
+                <div class="mdesc">
+
+                   <div class="short">Fires after a property changes
+                  
+               </div> 
+                   
+                    <div class="long">
+                   
+                       Fires after a property changes
+                   
+                       
+                       
+               
+                       
+                               <dl class="detailList">
+                               <dt class="heading">Parameters:</dt>
+                               
+                                       <dt>
+                                               <span class="fixedFont"><a href="./Roo.grid.PropertyGrid.html#constructor" roo:cls="Roo.grid.PropertyGrid.html#constructor">Roo.grid.PropertyGrid</a></span> <b>grid</b>
+                                               
+                                       </dt>
+                                       <dd>property grid? (check could be store)</dd>
+                               
+                                       <dt>
+                                               <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>id</b>
+                                               
+                                       </dt>
+                                       <dd>Record Id</dd>
+                               
+                                       <dt>
+                                               <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>newval</b>
+                                               
+                                       </dt>
+                                       <dd>New Value</dd>
+                               
+                                       <dt>
+                                               <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>oldval</b>
+                                               
+                                       </dt>
+                                       <dd>Old Value</dd>
+                               
+                               </dl>
+                       
+                       
+                       
+                       
+                       
+                       
+                       
+
+                   
+                   
+                    
+                    </div>                    
+                </div>
+
+            </td>
+            <td class="msource">
+                Roo.grid.PropertyGrid
+            </td>
+        </tr>
+       
+                                                      
+    </table>
+
+  
+  
+  
+<!-- ============================== footer ================================= -->
+               <div class="fineprint" style="clear:both">
+                       
+                       Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Fri Jul 16 2010 15:55:28 GMT+0800 (HKT)
+                       Based on 
+                       <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>  
+               </div>
+       </body>
+</html>