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