1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7 <meta http-equiv="content-type" content="text/html; charset=undefined" />
8 <meta name="generator" content="JsDoc Toolkit" />
11 <title>JsDoc Reference - Roo.grid.PropertyGrid</title>
14 <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />
15 <link rel="stylesheet" type="text/css" href="../default.css" />
18 <script type="text/javascript" src="../page.js">
25 <body onload="RooDocsPage.onload();">
28 <div class="body-wrap">
30 <!-- ============================== links to methods. ================================= -->
32 <div class="top-tools">
34 <a class="inner-link" href="#Roo.grid.PropertyGrid-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo.grid.PropertyGrid-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo.grid.PropertyGrid-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo.grid.PropertyGrid-configs"><img src="resources/s.gif" class="item-icon icon-config">Config Options</a>
38 <a class="bookmark" href="NEED_TO_CREATE_DIRECT_LINK_HREF"><img src="resources/s.gif" class="item-icon icon-fav">Direct Link</a>
43 <!-- ============================== inheritance Block. ================================= -->
45 <div class="inheritance res-block">
46 <pre class="res-block-inner"><a href="./Roo.grid.EditorGrid.html#constructor" roo:cls="Roo.grid.EditorGrid.html#constructor">Roo.grid.EditorGrid</a>
47 <img src="../../images/default/s.gif" height="1" width="20"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.grid.PropertyGrid
52 <!-- ============================== class title / details ============================ -->
55 <h1 class="classTitle">
57 Class Roo.grid.PropertyGrid
60 <table cellspacing="0" class="class-summary-table">
62 <tr><td class="label">Package:</td><td class="hd-info">Roo.grid</td></tr>
64 <tr><td class="label">Defined In:</td><td class="hd-info">
66 <a href="./src/Roo_grid_PropertyGrid.js.html">Roo/grid/PropertyGrid.js</a>.
69 <tr><td class="label">Class:</td><td class="hd-info">PropertyGrid</td></tr>
74 <tr><td class="label">Extends:</td><td class="hd-info">
75 <a href="./Roo.grid.EditorGrid.html#constructor" roo:cls="Roo.grid.EditorGrid.html#constructor">Roo.grid.EditorGrid</a>
83 <!-- ============================== class summary ========================== -->
84 <div class="description">
85 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>
89 <!-- ============================== Class comment block... ========================== -->
91 <div class="comments">
92 <b>Class Comments / Notes</B> =>
93 <u onclick="parent.CommentDialog.showCommentId = 'Roo.grid.PropertyGrid';">[Add Your comment/notes about this class]</u>
95 <iframe frameborder="0" id="comments-Roo.grid" style="border: none;width:100%;"
96 src="/blog.php/GtkDjsComments/Roo.grid.PropertyGrid.html"></iframe>
101 <!-- ============================== config options ========================== -->
106 <div class="hr"></div>
107 <a id="Roo.grid.PropertyGrid-configs"></a>
113 <table cellspacing="0" class="member-table">
114 <caption>Config Options (Usually are also Properties)</caption>
118 <th class="sig-header" colspan="2">Options</th>
120 <th class="msource-header">Defined By</th>
127 <tr class="config-row expandable config-row-alt0 notInherited">
128 <td class="micon"><a class="exi" href="#expand"> </a></td>
131 <a id="Roo.grid.PropertyGrid-cfg-customEditors" name=".customEditors"></a>
132 <div class="fixedFont">
133 <b class="itemname">customEditors</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
139 <div class="short">map of colnames=> custom editors.</div>
143 <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>
151 Roo.grid.PropertyGrid
157 <tr class="config-row expandable config-row-alt1 notInherited">
158 <td class="micon"><a class="exi" href="#expand"> </a></td>
161 <a id="Roo.grid.PropertyGrid-cfg-propertyNames" name=".propertyNames"></a>
162 <div class="fixedFont">
163 <b class="itemname">propertyNames</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
169 <div class="short">map of property Names to their displayed value</div>
173 <div class="long">map of property Names to their displayed value</div>
181 Roo.grid.PropertyGrid
197 <!-- ============================== public properties ==================== -->
201 <a id="Roo.grid.PropertyGrid-props"></a>
207 <table cellspacing="0" class="member-table">
208 <caption class="Empty">Public Properties - Has None</caption>
214 <!-- ============================== methods summary / details ======================== -->
217 <a id="Roo.grid.PropertyGrid-methods"></a>
218 <!-- constructor?? -->
225 <!-- then dynamics first -->
232 <table cellspacing="0" class="member-table">
233 <caption>Public Methods</caption>
235 <th class="sig-header" colspan="2">Method</th>
236 <th class="msource-header">Defined By</th>
246 <tr class="method-row config-row-alt0 expandable notInherited">
247 <td class="micon"><a class="exi" href="#expand"> </a></td>
251 <a id="Roo.grid-method-PropertyGrid" name=".PropertyGrid"></a>
252 <div class="fixedFont">
253 <span class="attributes">new <B>Roo.grid.</B></span><b class="itemname">PropertyGrid</b>
255 (<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>)
263 <div class="short">Create a new Roo.grid.PropertyGrid</div>
270 Create a new Roo.grid.PropertyGrid
273 <dl class="detailList">
274 <dt class="heading">Parameters:</dt>
277 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element</span> <b>container</b>
280 <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>
283 <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>
286 <dd>A config object that sets properties on this grid.</dd>
310 <tr class="method-row config-row-alt1 expandable notInherited">
311 <td class="micon"><a class="exi" href="#expand"> </a></td>
315 <a id="Roo.grid.PropertyGrid-method-getSource" name=".getSource"></a>
316 <div class="fixedFont">
317 <span class="attributes"></span><b class="itemname">getSource</b>
325 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
334 <div class="short">Gets all the data from the grid.</div>
340 Gets all the data from the grid.
351 <dl class="detailList">
352 <dt class="heading">Returns:</dt>
354 <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>
370 Roo.grid.PropertyGrid
376 <tr class="method-row config-row-alt0 expandable notInherited">
377 <td class="micon"><a class="exi" href="#expand"> </a></td>
381 <a id="Roo.grid.PropertyGrid-method-setSource" name=".setSource"></a>
382 <div class="fixedFont">
383 <span class="attributes"></span><b class="itemname">setSource</b>
385 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>data</i></B>)
392 <div class="short">Sets the data for the Grid<br/>accepts a Key => Value object of all the elements avaiable.</div>
398 Sets the data for the Grid<br/>accepts a Key => Value object of all the elements avaiable.
405 <dl class="detailList">
406 <dt class="heading">Parameters:</dt>
409 <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>
412 <dd>to appear in grid.</dd>
432 Roo.grid.PropertyGrid
441 <!-- ============================== events summary / details ======================== -->
444 <a id="Roo.grid.PropertyGrid-events"></a>
453 <table cellspacing="0" class="member-table">
454 <caption>Events</caption>
457 <th class="sig-header" colspan="2">Event</th>
458 <th class="msource-header">Defined By</th>
467 <tr class="method-row expandable config-row-alt0 notInherited">
468 <td class="micon"><a class="exi" href="#expand"> </a></td>
471 <a id="Roo.grid.PropertyGrid-event-*beforepropertychange"></a>
473 <div class="fixedFont">
474 <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>)
480 <div class="short">Fires before a property changes (return false to stop?)
486 Fires before a property changes (return false to stop?)
492 <dl class="detailList">
493 <dt class="heading">Parameters:</dt>
496 <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>
499 <dd>property grid? (check could be store)</dd>
502 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>id</b>
508 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>newval</b>
514 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>oldval</b>
536 Roo.grid.PropertyGrid
540 <tr class="method-row expandable config-row-alt1 notInherited">
541 <td class="micon"><a class="exi" href="#expand"> </a></td>
544 <a id="Roo.grid.PropertyGrid-event-*propertychange"></a>
546 <div class="fixedFont">
547 <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>)
553 <div class="short">Fires after a property changes
559 Fires after a property changes
565 <dl class="detailList">
566 <dt class="heading">Parameters:</dt>
569 <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>
572 <dd>property grid? (check could be store)</dd>
575 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>id</b>
581 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>newval</b>
587 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>oldval</b>
609 Roo.grid.PropertyGrid
620 <!-- ============================== footer ================================= -->
621 <div class="fineprint" style="clear:both">
623 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Fri Jul 16 2010 16:37:11 GMT+0800 (HKT)
625 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>