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.View</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.View-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo.View-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo.View-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo.View-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.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
47 <img src="../../images/default/s.gif" height="1" width="20"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.View
52 <!-- ============================== class title / details ============================ -->
55 <h1 class="classTitle">
60 <table cellspacing="0" class="class-summary-table">
62 <tr><td class="label">Package:</td><td class="hd-info">Roo</td></tr>
64 <tr><td class="label">Defined In:</td><td class="hd-info">
66 <a href="./src/Roo_View.js.html">Roo/View.js</a>.
69 <tr><td class="label">Class:</td><td class="hd-info">View</td></tr>
72 <tr><td class="label">Subclasses:</td><td class="hd-info">
73 <a href="./Roo.JsonView.html#constructor" roo:cls="Roo.JsonView.html#constructor">Roo.JsonView</a>
81 <tr><td class="label">Extends:</td><td class="hd-info">
82 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
90 <!-- ============================== class summary ========================== -->
91 <div class="description">
92 Create a "View" for an element based on a data model or UpdateManager and the supplied DomHelper template. <br/>This class also supports single and multi selection modes. <br><br/>Create a data model bound view:<br/> <pre><code><br/> var store = new Roo.data.Store(...);<br/><br/> var view = new Roo.View({<br/> el : "my-element",<br/> template : '<div id="{0}">{2} - {1}</div>', // auto create template<br/> <br/> singleSelect: true,<br/> selectedClass: "ydataview-selected",<br/> store: store<br/> });<br/><br/> // listen for node click?<br/> view.on("click", function(vw, index, node, e){<br/> alert('Node "' + node.id + '" at index: ' + index + " was clicked.");<br/> });<br/><br/> // load XML data<br/> dataModel.load("foobar.xml");<br/> </code></pre><br/> For an example of creating a JSON/UpdateManager view, see {<b>link</b> Roo.JsonView}.<br/><br><br><br/><b>Note: The root of your template must be a single node. Table/row implementations may work but are not supported due to<br/>IE"s limited insertion support with tables and Opera"s faulty event bubbling.</b><br/><br/>Note: old style constructor is still suported (container, template, config)
96 <!-- ============================== Class comment block... ========================== -->
98 <div class="comments">
99 <b>Class Comments / Notes</B> =>
100 <u onclick="parent.CommentDialog.showCommentId = 'Roo.View';">[Add Your comment/notes about this class]</u>
102 <iframe frameborder="0" id="comments-Roo" style="border: none;width:100%;"
103 src="/blog.php/GtkDjsComments/Roo.View.html"></iframe>
108 <!-- ============================== config options ========================== -->
113 <div class="hr"></div>
114 <a id="Roo.View-configs"></a>
120 <table cellspacing="0" class="member-table">
121 <caption>Config Options (Usually are also Properties)</caption>
125 <th class="sig-header" colspan="2">Options</th>
127 <th class="msource-header">Defined By</th>
134 <tr class="config-row expandable config-row-alt0 notInherited">
135 <td class="micon"><a class="exi" href="#expand"> </a></td>
138 <a id="Roo.View-cfg-el" name=".el"></a>
139 <div class="fixedFont">
140 <b class="itemname">el</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|<a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
146 <div class="short">The container element.</div>
150 <div class="long">The container element.</div>
164 <tr class="config-row expandable config-row-alt1 notInherited">
165 <td class="micon"><a class="exi" href="#expand"> </a></td>
168 <a id="Roo.View-cfg-emptyText" name=".emptyText"></a>
169 <div class="fixedFont">
170 <b class="itemname">emptyText</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
176 <div class="short">The empty text to show when nothing is loaded.</div>
180 <div class="long">The empty text to show when nothing is loaded.</div>
194 <tr class="config-row expandable config-row-alt0">
195 <td class="micon"><a class="exi" href="#expand"> </a></td>
198 <a id="Roo.util.Observable-cfg-listeners" name=".listeners"></a>
199 <div class="fixedFont">
200 <b class="itemname">listeners</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
206 <div class="short">list of events and functions to call for this object, <br/>For example :<br/><pre><code><br/> listeners : { <br/> 'click' : function(e) {<br/> .</div>
210 <div class="long">list of events and functions to call for this object, <br/>For example :<br/><pre><code><br/> listeners : { <br/> 'click' : function(e) {<br/> ..... <br/> } ,<br/> .... <br/> } <br/> </code></pre></div>
218 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
224 <tr class="config-row expandable config-row-alt1 notInherited">
225 <td class="micon"><a class="exi" href="#expand"> </a></td>
228 <a id="Roo.View-cfg-selectedClass" name=".selectedClass"></a>
229 <div class="fixedFont">
230 <b class="itemname">selectedClass</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
236 <div class="short">The css class to add to selected nodes</div>
240 <div class="long">The css class to add to selected nodes</div>
254 <tr class="config-row expandable config-row-alt0 notInherited">
255 <td class="micon"><a class="exi" href="#expand"> </a></td>
258 <a id="Roo.View-cfg-store" name=".store"></a>
259 <div class="fixedFont">
260 <b class="itemname">store</b> : <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
266 <div class="short">Data store to load data from.</div>
270 <div class="long">Data store to load data from.</div>
284 <tr class="config-row expandable config-row-alt1 notInherited">
285 <td class="micon"><a class="exi" href="#expand"> </a></td>
288 <a id="Roo.View-cfg-tpl" name=".tpl"></a>
289 <div class="fixedFont">
290 <b class="itemname">tpl</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|<a href="./Roo.Template.html#constructor" roo:cls="Roo.Template.html#constructor">Roo.Template</a>
296 <div class="short">The template used by this View</div>
300 <div class="long">The template used by this View</div>
324 <!-- ============================== public properties ==================== -->
328 <a id="Roo.View-props"></a>
334 <table cellspacing="0" class="member-table">
335 <caption class="Empty">Public Properties - Has None</caption>
341 <!-- ============================== methods summary / details ======================== -->
344 <a id="Roo.View-methods"></a>
345 <!-- constructor?? -->
352 <!-- then dynamics first -->
359 <table cellspacing="0" class="member-table">
360 <caption>Public Methods</caption>
362 <th class="sig-header" colspan="2">Method</th>
363 <th class="msource-header">Defined By</th>
373 <tr class="method-row config-row-alt0 expandable notInherited">
374 <td class="micon"><a class="exi" href="#expand"> </a></td>
378 <a id="Roo-method-View" name=".View"></a>
379 <div class="fixedFont">
380 <span class="attributes">new <B>Roo.</B></span><b class="itemname">View</b>
382 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
390 <div class="short">Create a new Roo.View</div>
397 Create a new Roo.View
400 <dl class="detailList">
401 <dt class="heading">Parameters:</dt>
404 <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>
407 <dd>The config object</dd>
431 <tr class="method-row config-row-alt1 expandable">
432 <td class="micon"><a class="exi" href="#expand"> </a></td>
436 <a id="Roo.util.Observable-method-addEvents" name=".addEvents"></a>
437 <div class="fixedFont">
438 <span class="attributes"></span><b class="itemname">addEvents</b>
440 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
447 <div class="short">Used to define events on this Observable</div>
453 Used to define events on this Observable
460 <dl class="detailList">
461 <dt class="heading">Parameters:</dt>
464 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>object</b>
467 <dd>The object with the events defined</dd>
487 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
493 <tr class="method-row config-row-alt0 expandable">
494 <td class="micon"><a class="exi" href="#expand"> </a></td>
498 <a id="Roo.util.Observable-method-addListener" name=".addListener"></a>
499 <div class="fixedFont">
500 <span class="attributes"></span><b class="itemname">addListener</b>
502 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
509 <div class="short">Appends an event handler to this component</div>
515 Appends an event handler to this component
522 <dl class="detailList">
523 <dt class="heading">Parameters:</dt>
526 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
529 <dd>The type of event to listen for</dd>
532 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
535 <dd>The method the event invokes</dd>
538 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>scope</b>
541 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
544 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>options</b>
547 <dd>(optional) An object containing handler configuration<br/>properties. This may contain any of the following properties:<ul><br/><li>scope {Object} The scope in which to execute the handler function. The handler function's "this" context.</li><br/><li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li><br/><li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li><br/><li>buffer {Number} Causes the handler to be scheduled to run in an {<b>link</b> Roo.util.DelayedTask} delayed<br/>by the specified number of milliseconds. If the event fires again within that time, the original<br/>handler is <em>not</em> invoked, but the new handler is scheduled in its place.</li><br/></ul><br><br/><p><br/><b>Combining Options</b><br><br/>Using the options argument, it is possible to combine different types of listeners:<br><br/><br><br/>A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)<br/> <pre><code><br/> el.on('click', this.onClick, this, {<br/> single: true,<br/> delay: 100,<br/> forumId: 4<br/> });<br/> </code></pre><br/><p><br/><b>Attaching multiple handlers in 1 call</b><br><br/>The method also allows for a single argument to be passed which is a config object containing properties<br/>which specify multiple handlers.<br/><pre><code><br/> el.on({<br/> 'click': {<br/> fn: this.onClick,<br/> scope: this,<br/> delay: 100<br/> }, <br/> 'mouseover': {<br/> fn: this.onMouseOver,<br/> scope: this<br/> },<br/> 'mouseout': {<br/> fn: this.onMouseOut,<br/> scope: this<br/> }<br/> });<br/> </code></pre><br/><p><br/>Or a shorthand syntax which passes the same scope object to all handlers:<br/> <pre><code><br/> el.on({<br/> 'click': this.onClick,<br/> 'mouseover': this.onMouseOver,<br/> 'mouseout': this.onMouseOut,<br/> scope: this<br/> });<br/> </code></pre></dd>
567 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
573 <tr class="method-row config-row-alt1 expandable notInherited">
574 <td class="micon"><a class="exi" href="#expand"> </a></td>
578 <a id="Roo.View-method-clearSelections" name=".clearSelections"></a>
579 <div class="fixedFont">
580 <span class="attributes"></span><b class="itemname">clearSelections</b>
582 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>suppressEvent</i></B>)
589 <div class="short">Clear all selections</div>
602 <dl class="detailList">
603 <dt class="heading">Parameters:</dt>
606 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>suppressEvent</b>
609 <dd>(optional) true to skip firing of the selectionchange event</dd>
635 <tr class="method-row config-row-alt0 expandable notInherited">
636 <td class="micon"><a class="exi" href="#expand"> </a></td>
640 <a id="Roo.View-method-findItemFromChild" name=".findItemFromChild"></a>
641 <div class="fixedFont">
642 <span class="attributes"></span><b class="itemname">findItemFromChild</b>
644 (<a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a> <B><i>node</i></B>)
650 <a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>
659 <div class="short">Returns the template node the passed child belongs to or null if it doesn't belong to one.</div>
665 Returns the template node the passed child belongs to or null if it doesn't belong to one.
672 <dl class="detailList">
673 <dt class="heading">Parameters:</dt>
676 <span class="fixedFont"><a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a></span> <b>node</b>
687 <dl class="detailList">
688 <dt class="heading">Returns:</dt>
690 <dd><span class="fixedFont"><a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a></span> The template node</dd>
712 <tr class="method-row config-row-alt1 expandable">
713 <td class="micon"><a class="exi" href="#expand"> </a></td>
717 <a id="Roo.util.Observable-method-fireEvent" name=".fireEvent"></a>
718 <div class="fixedFont">
719 <span class="attributes"></span><b class="itemname">fireEvent</b>
721 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object...</a> <B><i>args</i></B>)
727 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
736 <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
742 Fires the specified event with the passed parameters (minus the event name).
749 <dl class="detailList">
750 <dt class="heading">Parameters:</dt>
753 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
759 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object...</a></span> <b>args</b>
762 <dd>Variable number of parameters are passed to handlers</dd>
770 <dl class="detailList">
771 <dt class="heading">Returns:</dt>
773 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> returns false if any of the handlers return false otherwise it returns true</dd>
789 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
795 <tr class="method-row config-row-alt0 expandable notInherited">
796 <td class="micon"><a class="exi" href="#expand"> </a></td>
800 <a id="Roo.View-method-getEl" name=".getEl"></a>
801 <div class="fixedFont">
802 <span class="attributes"></span><b class="itemname">getEl</b>
810 <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
819 <div class="short">Returns the element this view is bound to.</div>
825 Returns the element this view is bound to.
836 <dl class="detailList">
837 <dt class="heading">Returns:</dt>
839 <dd><span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> </dd>
861 <tr class="method-row config-row-alt1 expandable notInherited">
862 <td class="micon"><a class="exi" href="#expand"> </a></td>
866 <a id="Roo.View-method-getNode" name=".getNode"></a>
867 <div class="fixedFont">
868 <span class="attributes"></span><b class="itemname">getNode</b>
870 (<a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>/String/Number <B><i>nodeInfo</i></B>)
876 <a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>
885 <div class="short">Gets a template node.</div>
891 Gets a template node.
898 <dl class="detailList">
899 <dt class="heading">Parameters:</dt>
902 <span class="fixedFont"><a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>/String/Number</span> <b>nodeInfo</b>
905 <dd>An HTMLElement template node, index of a template node or the id of a template node</dd>
913 <dl class="detailList">
914 <dt class="heading">Returns:</dt>
916 <dd><span class="fixedFont"><a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a></span> The node or null if it wasn't found</dd>
938 <tr class="method-row config-row-alt0 expandable notInherited">
939 <td class="micon"><a class="exi" href="#expand"> </a></td>
943 <a id="Roo.View-method-getNodes" name=".getNodes"></a>
944 <div class="fixedFont">
945 <span class="attributes"></span><b class="itemname">getNodes</b>
947 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>startIndex</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>endIndex</i></B>)
953 <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
962 <div class="short">Gets a range template nodes.</div>
968 Gets a range template nodes.
975 <dl class="detailList">
976 <dt class="heading">Parameters:</dt>
979 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>startIndex</b>
985 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>endIndex</b>
996 <dl class="detailList">
997 <dt class="heading">Returns:</dt>
999 <dd><span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a></span> An array of nodes</dd>
1013 <td class="msource">
1021 <tr class="method-row config-row-alt1 expandable notInherited">
1022 <td class="micon"><a class="exi" href="#expand"> </a></td>
1026 <a id="Roo.View-method-getSelectedIndexes" name=".getSelectedIndexes"></a>
1027 <div class="fixedFont">
1028 <span class="attributes"></span><b class="itemname">getSelectedIndexes</b>
1036 <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
1045 <div class="short">Get the indexes of the selected nodes.</div>
1051 Get the indexes of the selected nodes.
1062 <dl class="detailList">
1063 <dt class="heading">Returns:</dt>
1065 <dd><span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a></span> </dd>
1079 <td class="msource">
1087 <tr class="method-row config-row-alt0 expandable notInherited">
1088 <td class="micon"><a class="exi" href="#expand"> </a></td>
1092 <a id="Roo.View-method-getSelectedNodes" name=".getSelectedNodes"></a>
1093 <div class="fixedFont">
1094 <span class="attributes"></span><b class="itemname">getSelectedNodes</b>
1102 <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
1111 <div class="short">Get the currently selected nodes.</div>
1117 Get the currently selected nodes.
1128 <dl class="detailList">
1129 <dt class="heading">Returns:</dt>
1131 <dd><span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a></span> An array of HTMLElements</dd>
1145 <td class="msource">
1153 <tr class="method-row config-row-alt1 expandable notInherited">
1154 <td class="micon"><a class="exi" href="#expand"> </a></td>
1158 <a id="Roo.View-method-getSelectionCount" name=".getSelectionCount"></a>
1159 <div class="fixedFont">
1160 <span class="attributes"></span><b class="itemname">getSelectionCount</b>
1168 <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
1177 <div class="short">Get the number of selected nodes.</div>
1183 Get the number of selected nodes.
1194 <dl class="detailList">
1195 <dt class="heading">Returns:</dt>
1197 <dd><span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> </dd>
1211 <td class="msource">
1219 <tr class="method-row config-row-alt0 expandable">
1220 <td class="micon"><a class="exi" href="#expand"> </a></td>
1224 <a id="Roo.util.Observable-method-hasListener" name=".hasListener"></a>
1225 <div class="fixedFont">
1226 <span class="attributes"></span><b class="itemname">hasListener</b>
1228 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
1234 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1243 <div class="short">Checks to see if this object has any listeners for a specified event</div>
1249 Checks to see if this object has any listeners for a specified event
1256 <dl class="detailList">
1257 <dt class="heading">Parameters:</dt>
1260 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1263 <dd>The name of the event to check for</dd>
1271 <dl class="detailList">
1272 <dt class="heading">Returns:</dt>
1274 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> True if the event is being listened for, else false</dd>
1288 <td class="msource">
1290 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1296 <tr class="method-row config-row-alt1 expandable notInherited">
1297 <td class="micon"><a class="exi" href="#expand"> </a></td>
1301 <a id="Roo.View-method-indexOf" name=".indexOf"></a>
1302 <div class="fixedFont">
1303 <span class="attributes"></span><b class="itemname">indexOf</b>
1305 (<a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>/String/Number <B><i>nodeInfo</i></B>)
1311 <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
1320 <div class="short">Finds the index of the passed node</div>
1326 Finds the index of the passed node
1333 <dl class="detailList">
1334 <dt class="heading">Parameters:</dt>
1337 <span class="fixedFont"><a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>/String/Number</span> <b>nodeInfo</b>
1340 <dd>An HTMLElement template node, index of a template node or the id of a template node</dd>
1348 <dl class="detailList">
1349 <dt class="heading">Returns:</dt>
1351 <dd><span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> The index of the node or -1</dd>
1365 <td class="msource">
1373 <tr class="method-row config-row-alt0 expandable notInherited">
1374 <td class="micon"><a class="exi" href="#expand"> </a></td>
1378 <a id="Roo.View-method-isSelected" name=".isSelected"></a>
1379 <div class="fixedFont">
1380 <span class="attributes"></span><b class="itemname">isSelected</b>
1382 (<a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>/Number <B><i>node</i></B>)
1388 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1397 <div class="short">Returns true if the passed node is selected</div>
1403 Returns true if the passed node is selected
1410 <dl class="detailList">
1411 <dt class="heading">Parameters:</dt>
1414 <span class="fixedFont"><a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>/Number</span> <b>node</b>
1417 <dd>The node or node index</dd>
1425 <dl class="detailList">
1426 <dt class="heading">Returns:</dt>
1428 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> </dd>
1442 <td class="msource">
1450 <tr class="method-row config-row-alt1 expandable">
1451 <td class="micon"><a class="exi" href="#expand"> </a></td>
1455 <a id="Roo.util.Observable-method-on" name=".on"></a>
1456 <div class="fixedFont">
1457 <span class="attributes"></span><b class="itemname">on</b>
1459 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
1466 <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
1472 Appends an event handler to this element (shorthand for addListener)
1479 <dl class="detailList">
1480 <dt class="heading">Parameters:</dt>
1483 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1486 <dd>The type of event to listen for</dd>
1489 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1492 <dd>The method the event invokes</dd>
1495 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>scope</b>
1498 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
1501 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>options</b>
1522 <td class="msource">
1524 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1530 <tr class="method-row config-row-alt0 expandable notInherited">
1531 <td class="micon"><a class="exi" href="#expand"> </a></td>
1535 <a id="Roo.View-method-prepareData" name=".prepareData"></a>
1536 <div class="fixedFont">
1537 <span class="attributes"></span><b class="itemname">prepareData</b>
1539 (<a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>/Object <B><i>data</i></B>)
1546 <div class="short">Function to override to reformat the data that is sent to<br/>the template for each node.</div>
1552 Function to override to reformat the data that is sent to<br/>the template for each node.
1559 <dl class="detailList">
1560 <dt class="heading">Parameters:</dt>
1563 <span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>/Object</span> <b>data</b>
1566 <dd>The raw data (array of colData for a data model bound view or<br/>a JSON object for an UpdateManager bound view).</dd>
1584 <td class="msource">
1592 <tr class="method-row config-row-alt1 expandable">
1593 <td class="micon"><a class="exi" href="#expand"> </a></td>
1597 <a id="Roo.util.Observable-method-purgeListeners" name=".purgeListeners"></a>
1598 <div class="fixedFont">
1599 <span class="attributes"></span><b class="itemname">purgeListeners</b>
1608 <div class="short">Removes all listeners for this object</div>
1614 Removes all listeners for this object
1635 <td class="msource">
1637 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1643 <tr class="method-row config-row-alt0 expandable notInherited">
1644 <td class="micon"><a class="exi" href="#expand"> </a></td>
1648 <a id="Roo.View-method-refresh" name=".refresh"></a>
1649 <div class="fixedFont">
1650 <span class="attributes"></span><b class="itemname">refresh</b>
1659 <div class="short">Refreshes the view.</div>
1686 <td class="msource">
1694 <tr class="method-row config-row-alt1 expandable notInherited">
1695 <td class="micon"><a class="exi" href="#expand"> </a></td>
1699 <a id="Roo.View-method-refreshNode" name=".refreshNode"></a>
1700 <div class="fixedFont">
1701 <span class="attributes"></span><b class="itemname">refreshNode</b>
1703 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>index</i></B>)
1710 <div class="short">Refresh an individual node.</div>
1716 Refresh an individual node.
1723 <dl class="detailList">
1724 <dt class="heading">Parameters:</dt>
1727 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>index</b>
1748 <td class="msource">
1756 <tr class="method-row config-row-alt0 expandable">
1757 <td class="micon"><a class="exi" href="#expand"> </a></td>
1761 <a id="Roo.util.Observable-method-removeListener" name=".removeListener"></a>
1762 <div class="fixedFont">
1763 <span class="attributes"></span><b class="itemname">removeListener</b>
1765 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>)
1772 <div class="short">Removes a listener</div>
1785 <dl class="detailList">
1786 <dt class="heading">Parameters:</dt>
1789 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1792 <dd>The type of event to listen for</dd>
1795 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1798 <dd>The handler to remove</dd>
1801 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>scope</b>
1804 <dd>(optional) The scope (this object) for the handler</dd>
1822 <td class="msource">
1824 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1830 <tr class="method-row config-row-alt1 expandable notInherited">
1831 <td class="micon"><a class="exi" href="#expand"> </a></td>
1835 <a id="Roo.View-method-select" name=".select"></a>
1836 <div class="fixedFont">
1837 <span class="attributes"></span><b class="itemname">select</b>
1839 (<a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>/HTMLElement/String/Number <B><i>nodeInfo</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>keepExisting</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>suppressEvent</i></B>)
1846 <div class="short">Selects nodes.</div>
1859 <dl class="detailList">
1860 <dt class="heading">Parameters:</dt>
1863 <span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>/HTMLElement/String/Number</span> <b>nodeInfo</b>
1866 <dd>An HTMLElement template node, index of a template node, id of a template node or an array of any of those to select</dd>
1869 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>keepExisting</b>
1872 <dd>(optional) true to keep existing selections</dd>
1875 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>suppressEvent</b>
1878 <dd>(optional) true to skip firing of the selectionchange vent</dd>
1896 <td class="msource">
1904 <tr class="method-row config-row-alt0 expandable notInherited">
1905 <td class="micon"><a class="exi" href="#expand"> </a></td>
1909 <a id="Roo.View-method-setStore" name=".setStore"></a>
1910 <div class="fixedFont">
1911 <span class="attributes"></span><b class="itemname">setStore</b>
1913 (Store <B><i>store</i></B>)
1920 <div class="short">Changes the data store this view uses and refresh the view.</div>
1926 Changes the data store this view uses and refresh the view.
1933 <dl class="detailList">
1934 <dt class="heading">Parameters:</dt>
1937 <span class="fixedFont">Store</span> <b>store</b>
1958 <td class="msource">
1966 <tr class="method-row config-row-alt1 expandable">
1967 <td class="micon"><a class="exi" href="#expand"> </a></td>
1971 <a id="Roo.util.Observable-method-un" name=".un"></a>
1972 <div class="fixedFont">
1973 <span class="attributes"></span><b class="itemname">un</b>
1975 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>)
1982 <div class="short">Removes a listener (shorthand for removeListener)</div>
1988 Removes a listener (shorthand for removeListener)
1995 <dl class="detailList">
1996 <dt class="heading">Parameters:</dt>
1999 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
2002 <dd>The type of event to listen for</dd>
2005 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
2008 <dd>The handler to remove</dd>
2011 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>scope</b>
2014 <dd>(optional) The scope (this object) for the handler</dd>
2032 <td class="msource">
2034 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2043 <!-- ============================== events summary / details ======================== -->
2046 <a id="Roo.View-events"></a>
2055 <table cellspacing="0" class="member-table">
2056 <caption>Events</caption>
2059 <th class="sig-header" colspan="2">Event</th>
2060 <th class="msource-header">Defined By</th>
2069 <tr class="method-row expandable config-row-alt0 notInherited">
2070 <td class="micon"><a class="exi" href="#expand"> </a></td>
2073 <a id="Roo.View-event-*beforeclick"></a>
2075 <div class="fixedFont">
2076 <b class="itemname">beforeclick</b> (<a href="./Roo.View.html#constructor" roo:cls="Roo.View.html#constructor">Roo.View</a> <B><i>this</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>index</i></B>, <a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a> <B><i>node</i></B>, <a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a> <B><i>e</i></B>)
2082 <div class="short">Fires before a click is processed.
2088 Fires before a click is processed. Returns false to cancel the default action.
2094 <dl class="detailList">
2095 <dt class="heading">Parameters:</dt>
2098 <span class="fixedFont"><a href="./Roo.View.html#constructor" roo:cls="Roo.View.html#constructor">Roo.View</a></span> <b>this</b>
2104 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>index</b>
2107 <dd>The index of the target node</dd>
2110 <span class="fixedFont"><a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a></span> <b>node</b>
2113 <dd>The target node</dd>
2116 <span class="fixedFont"><a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a></span> <b>e</b>
2119 <dd>The raw event object</dd>
2137 <td class="msource">
2142 <tr class="method-row expandable config-row-alt1 notInherited">
2143 <td class="micon"><a class="exi" href="#expand"> </a></td>
2146 <a id="Roo.View-event-*beforeselect"></a>
2148 <div class="fixedFont">
2149 <b class="itemname">beforeselect</b> (<a href="./Roo.View.html#constructor" roo:cls="Roo.View.html#constructor">Roo.View</a> <B><i>this</i></B>, <a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a> <B><i>node</i></B>, <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a> <B><i>selections</i></B>)
2155 <div class="short">Fires before a selection is made.
2161 Fires before a selection is made. If any handlers return false, the selection is cancelled.
2167 <dl class="detailList">
2168 <dt class="heading">Parameters:</dt>
2171 <span class="fixedFont"><a href="./Roo.View.html#constructor" roo:cls="Roo.View.html#constructor">Roo.View</a></span> <b>this</b>
2177 <span class="fixedFont"><a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a></span> <b>node</b>
2180 <dd>The node to be selected</dd>
2183 <span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a></span> <b>selections</b>
2186 <dd>Array of currently selected nodes</dd>
2204 <td class="msource">
2209 <tr class="method-row expandable config-row-alt0 notInherited">
2210 <td class="micon"><a class="exi" href="#expand"> </a></td>
2213 <a id="Roo.View-event-*click"></a>
2215 <div class="fixedFont">
2216 <b class="itemname">click</b> (<a href="./Roo.View.html#constructor" roo:cls="Roo.View.html#constructor">Roo.View</a> <B><i>this</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>index</i></B>, <a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a> <B><i>node</i></B>, <a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a> <B><i>e</i></B>)
2222 <div class="short">Fires when a template node is clicked.
2228 Fires when a template node is clicked.
2234 <dl class="detailList">
2235 <dt class="heading">Parameters:</dt>
2238 <span class="fixedFont"><a href="./Roo.View.html#constructor" roo:cls="Roo.View.html#constructor">Roo.View</a></span> <b>this</b>
2244 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>index</b>
2247 <dd>The index of the target node</dd>
2250 <span class="fixedFont"><a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a></span> <b>node</b>
2253 <dd>The target node</dd>
2256 <span class="fixedFont"><a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a></span> <b>e</b>
2259 <dd>The raw event object</dd>
2277 <td class="msource">
2282 <tr class="method-row expandable config-row-alt1 notInherited">
2283 <td class="micon"><a class="exi" href="#expand"> </a></td>
2286 <a id="Roo.View-event-*contextmenu"></a>
2288 <div class="fixedFont">
2289 <b class="itemname">contextmenu</b> (<a href="./Roo.View.html#constructor" roo:cls="Roo.View.html#constructor">Roo.View</a> <B><i>this</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>index</i></B>, <a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a> <B><i>node</i></B>, <a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a> <B><i>e</i></B>)
2295 <div class="short">Fires when a template node is right clicked.
2301 Fires when a template node is right clicked.
2307 <dl class="detailList">
2308 <dt class="heading">Parameters:</dt>
2311 <span class="fixedFont"><a href="./Roo.View.html#constructor" roo:cls="Roo.View.html#constructor">Roo.View</a></span> <b>this</b>
2317 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>index</b>
2320 <dd>The index of the target node</dd>
2323 <span class="fixedFont"><a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a></span> <b>node</b>
2326 <dd>The target node</dd>
2329 <span class="fixedFont"><a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a></span> <b>e</b>
2332 <dd>The raw event object</dd>
2350 <td class="msource">
2355 <tr class="method-row expandable config-row-alt0 notInherited">
2356 <td class="micon"><a class="exi" href="#expand"> </a></td>
2359 <a id="Roo.View-event-*dblclick"></a>
2361 <div class="fixedFont">
2362 <b class="itemname">dblclick</b> (<a href="./Roo.View.html#constructor" roo:cls="Roo.View.html#constructor">Roo.View</a> <B><i>this</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>index</i></B>, <a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a> <B><i>node</i></B>, <a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a> <B><i>e</i></B>)
2368 <div class="short">Fires when a template node is double clicked.
2374 Fires when a template node is double clicked.
2380 <dl class="detailList">
2381 <dt class="heading">Parameters:</dt>
2384 <span class="fixedFont"><a href="./Roo.View.html#constructor" roo:cls="Roo.View.html#constructor">Roo.View</a></span> <b>this</b>
2390 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>index</b>
2393 <dd>The index of the target node</dd>
2396 <span class="fixedFont"><a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a></span> <b>node</b>
2399 <dd>The target node</dd>
2402 <span class="fixedFont"><a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a></span> <b>e</b>
2405 <dd>The raw event object</dd>
2423 <td class="msource">
2428 <tr class="method-row expandable config-row-alt1 notInherited">
2429 <td class="micon"><a class="exi" href="#expand"> </a></td>
2432 <a id="Roo.View-event-*selectionchange"></a>
2434 <div class="fixedFont">
2435 <b class="itemname">selectionchange</b> (<a href="./Roo.View.html#constructor" roo:cls="Roo.View.html#constructor">Roo.View</a> <B><i>this</i></B>, <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a> <B><i>selections</i></B>)
2441 <div class="short">Fires when the selected nodes change.
2447 Fires when the selected nodes change.
2453 <dl class="detailList">
2454 <dt class="heading">Parameters:</dt>
2457 <span class="fixedFont"><a href="./Roo.View.html#constructor" roo:cls="Roo.View.html#constructor">Roo.View</a></span> <b>this</b>
2463 <span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a></span> <b>selections</b>
2466 <dd>Array of the selected nodes</dd>
2484 <td class="msource">
2496 <!-- ============================== footer ================================= -->
2497 <div class="fineprint" style="clear:both">
2499 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Tue Jul 27 2010 11:05:07 GMT+0800 (HKT)
2501 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>