docs/output/Ext.tree.TreeNodeUI.html

   1         <div class="body-wrap">
   2         <div class="top-tools">
   3             <a class="inner-link" href="#Ext.tree.TreeNodeUI-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
   4             <a class="inner-link" href="#Ext.tree.TreeNodeUI-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
   5             <a class="inner-link" href="#Ext.tree.TreeNodeUI-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
   6                         <a class="bookmark" href="../docs/?class=Ext.tree.TreeNodeUI"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>
   7         </div>
   8                 <h1>Class Ext.tree.TreeNodeUI</h1>
   9         <table cellspacing="0">
  10             <tr><td class="label">Package:</td><td class="hd-info">Ext.tree</td></tr>
  11             <tr><td class="label">Defined In:</td><td class="hd-info"><a href="../src/TreeNodeUI.js" target="_blank">TreeNodeUI.js</a></td></tr>
  12             <tr><td class="label">Class:</td><td class="hd-info">TreeNodeUI</td></tr>
  13                                     <tr><td class="label">Extends:</td><td class="hd-info">Object</td></tr>
  14                     </table>
  15         <div class="description">
  16             *
  17 This class provides the default UI implementation for Ext TreeNodes.
  18 The TreeNode UI implementation is separate from the
  19 tree implementation, and allows customizing of the appearance of
  20 tree nodes.<br>
  21 <p>
  22 If you are customizing the Tree's user interface, you
  23 may need to extend this class, but you should never need to instantiate this class.<br>
  24 <p>
  25 This class provides access to the user interface components of an Ext TreeNode, through
  26 <a ext:cls="Ext.tree.TreeNode" ext:member="getUI" href="output/Ext.tree.TreeNode.html#getUI">Ext.tree.TreeNode.getUI</a>        </div>
  27
  28         <div class="hr"></div>
  29                 <a id="Ext.tree.TreeNodeUI-props"></a>
  30         <h2>Public Properties</h2>
  31         <div class="no-members">This class has no public properties.</div>        <a id="Ext.tree.TreeNodeUI-methods"></a>
  32         <h2>Public Methods</h2>
  33                 <table cellspacing="0" class="member-table">
  34             <tr>
  35                 <th class="sig-header" colspan="2">Method</th>
  36                 <th class="msource-header">Defined By</th>
  37             </tr>
  38                 <tr class="method-row expandable">\r
  39         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
  40         <td class="sig">\r
  41         <a id="Ext.tree.TreeNodeUI-addClass"></a>\r
  42             <b>addClass</b>(&nbsp;<code>String/Array className</code>&nbsp;) : void            <div class="mdesc">\r
  43                         <div class="short">Adds one or more CSS classes to the node's UI element.
  44 Duplicate classes are automatically filtered out.</div>\r
  45             <div class="long">\r
  46                 Adds one or more CSS classes to the node's UI element.
  47 Duplicate classes are automatically filtered out.    <div class="mdetail-params">\r
  48         <strong>Parameters:</strong>\r
  49         <ul><li><code>className</code> : String/Array<div class="sub-desc">The CSS class to add, or an array of classes</div></li>        </ul>\r
  50         <strong>Returns:</strong>\r
  51         <ul>\r
  52             <li><code>void</code></li>\r
  53         </ul>\r
  54     </div>\r
  55                 </div>\r
  56                         </div>\r
  57         </td>\r
  58         <td class="msource">TreeNodeUI</td>\r
  59     </tr>\r
  60         <tr class="method-row alt expandable">\r
  61         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
  62         <td class="sig">\r
  63         <a id="Ext.tree.TreeNodeUI-getAnchor"></a>\r
  64             <b>getAnchor</b>() : HtmlElement            <div class="mdesc">\r
  65                         <div class="short">Returns the &lt;a> element that provides focus for the node's UI.</div>\r
  66             <div class="long">\r
  67                 Returns the &lt;a> element that provides focus for the node's UI.    <div class="mdetail-params">\r
  68         <strong>Parameters:</strong>\r
  69         <ul><li>None.</li>        </ul>\r
  70         <strong>Returns:</strong>\r
  71         <ul>\r
  72             <li><code>HtmlElement</code><div class="sub-desc">The DOM anchor element.</div></li>\r
  73         </ul>\r
  74     </div>\r
  75                 </div>\r
  76                         </div>\r
  77         </td>\r
  78         <td class="msource">TreeNodeUI</td>\r
  79     </tr>\r
  80         <tr class="method-row expandable">\r
  81         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
  82         <td class="sig">\r
  83         <a id="Ext.tree.TreeNodeUI-getIconEl"></a>\r
  84             <b>getIconEl</b>() : HtmlElement            <div class="mdesc">\r
  85                         <div class="short">Returns the icon &lt;img> element.</div>\r
  86             <div class="long">\r
  87                 Returns the icon &lt;img> element.    <div class="mdetail-params">\r
  88         <strong>Parameters:</strong>\r
  89         <ul><li>None.</li>        </ul>\r
  90         <strong>Returns:</strong>\r
  91         <ul>\r
  92             <li><code>HtmlElement</code><div class="sub-desc">The DOM image element.</div></li>\r
  93         </ul>\r
  94     </div>\r
  95                 </div>\r
  96                         </div>\r
  97         </td>\r
  98         <td class="msource">TreeNodeUI</td>\r
  99     </tr>\r
 100         <tr class="method-row alt expandable">\r
 101         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 102         <td class="sig">\r
 103         <a id="Ext.tree.TreeNodeUI-getTextEl"></a>\r
 104             <b>getTextEl</b>() : HtmlNode            <div class="mdesc">\r
 105                         <div class="short">Returns the text node.</div>\r
 106             <div class="long">\r
 107                 Returns the text node.    <div class="mdetail-params">\r
 108         <strong>Parameters:</strong>\r
 109         <ul><li>None.</li>        </ul>\r
 110         <strong>Returns:</strong>\r
 111         <ul>\r
 112             <li><code>HtmlNode</code><div class="sub-desc">The DOM text node.</div></li>\r
 113         </ul>\r
 114     </div>\r
 115                 </div>\r
 116                         </div>\r
 117         </td>\r
 118         <td class="msource">TreeNodeUI</td>\r
 119     </tr>\r
 120         <tr class="method-row expandable">\r
 121         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 122         <td class="sig">\r
 123         <a id="Ext.tree.TreeNodeUI-hide"></a>\r
 124             <b>hide</b>() : void            <div class="mdesc">\r
 125                         <div class="short">Hides this node.</div>\r
 126             <div class="long">\r
 127                 Hides this node.    <div class="mdetail-params">\r
 128         <strong>Parameters:</strong>\r
 129         <ul><li>None.</li>        </ul>\r
 130         <strong>Returns:</strong>\r
 131         <ul>\r
 132             <li><code>void</code></li>\r
 133         </ul>\r
 134     </div>\r
 135                 </div>\r
 136                         </div>\r
 137         </td>\r
 138         <td class="msource">TreeNodeUI</td>\r
 139     </tr>\r
 140         <tr class="method-row alt expandable">\r
 141         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 142         <td class="sig">\r
 143         <a id="Ext.tree.TreeNodeUI-isChecked"></a>\r
 144             <b>isChecked</b>() : Boolean            <div class="mdesc">\r
 145                         <div class="short">Returns the checked status of the node. If the node was rendered with no
 146 checkbox, it returns false.</div>\r
 147             <div class="long">\r
 148                 Returns the checked status of the node. If the node was rendered with no
 149 checkbox, it returns false.    <div class="mdetail-params">\r
 150         <strong>Parameters:</strong>\r
 151         <ul><li>None.</li>        </ul>\r
 152         <strong>Returns:</strong>\r
 153         <ul>\r
 154             <li><code>Boolean</code><div class="sub-desc">The checked flag.</div></li>\r
 155         </ul>\r
 156     </div>\r
 157                 </div>\r
 158                         </div>\r
 159         </td>\r
 160         <td class="msource">TreeNodeUI</td>\r
 161     </tr>\r
 162         <tr class="method-row expandable">\r
 163         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 164         <td class="sig">\r
 165         <a id="Ext.tree.TreeNodeUI-removeClass"></a>\r
 166             <b>removeClass</b>(&nbsp;<code>String/Array className</code>&nbsp;) : void            <div class="mdesc">\r
 167                         <div class="short">Removes one or more CSS classes from the node's UI element.</div>\r
 168             <div class="long">\r
 169                 Removes one or more CSS classes from the node's UI element.    <div class="mdetail-params">\r
 170         <strong>Parameters:</strong>\r
 171         <ul><li><code>className</code> : String/Array<div class="sub-desc">The CSS class to remove, or an array of classes</div></li>        </ul>\r
 172         <strong>Returns:</strong>\r
 173         <ul>\r
 174             <li><code>void</code></li>\r
 175         </ul>\r
 176     </div>\r
 177                 </div>\r
 178                         </div>\r
 179         </td>\r
 180         <td class="msource">TreeNodeUI</td>\r
 181     </tr>\r
 182         <tr class="method-row alt expandable">\r
 183         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 184         <td class="sig">\r
 185         <a id="Ext.tree.TreeNodeUI-show"></a>\r
 186             <b>show</b>() : void            <div class="mdesc">\r
 187                         <div class="short">Shows this node.</div>\r
 188             <div class="long">\r
 189                 Shows this node.    <div class="mdetail-params">\r
 190         <strong>Parameters:</strong>\r
 191         <ul><li>None.</li>        </ul>\r
 192         <strong>Returns:</strong>\r
 193         <ul>\r
 194             <li><code>void</code></li>\r
 195         </ul>\r
 196     </div>\r
 197                 </div>\r
 198                         </div>\r
 199         </td>\r
 200         <td class="msource">TreeNodeUI</td>\r
 201     </tr>\r
 202         <tr class="method-row expandable">\r
 203         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 204         <td class="sig">\r
 205         <a id="Ext.tree.TreeNodeUI-toggleCheck"></a>\r
 206             <b>toggleCheck</b>(&nbsp;<code>Boolean (optional)</code>&nbsp;) : void            <div class="mdesc">\r
 207                         <div class="short">Sets the checked status of the tree node to the passed value, or, if no value was passed,
 208 toggles the checked status....</div>\r
 209             <div class="long">\r
 210                 Sets the checked status of the tree node to the passed value, or, if no value was passed,
 211 toggles the checked status. If the node was rendered with no checkbox, this has no effect.    <div class="mdetail-params">\r
 212         <strong>Parameters:</strong>\r
 213         <ul><li><code>(optional)</code> : Boolean<div class="sub-desc">The new checked status.</div></li>        </ul>\r
 214         <strong>Returns:</strong>\r
 215         <ul>\r
 216             <li><code>void</code></li>\r
 217         </ul>\r
 218     </div>\r
 219                 </div>\r
 220                         </div>\r
 221         </td>\r
 222         <td class="msource">TreeNodeUI</td>\r
 223     </tr>\r
 224             </table>
 225                 <a id="Ext.tree.TreeNodeUI-events"></a>
 226         <h2>Public Events</h2>
 227         <div class="no-members">This class has no public events.</div>
 228         </div>