Simple status box for the sidebar.
[elgg_plugins.git] / yui / docs / WidthResizer.html
bloba2cbd41735f16316a935c4d01dbdac2dfb9404a1
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
2 <html>
3 <head>
4 <title>API: datatable WidthResizer (YUI Library)</title>
5 <link rel="stylesheet" type="text/css" href="assets/api.css">
6 </head>
8 <body id="yahoo-com">
9 <div id="doc3" class="yui-t2">
11 <div id="hd">
12 <h1>Yahoo! UI Library</h1>
13 <h3>DataTable Widget&nbsp; <span class="subtitle">2.2.0</span></h3>
14 <p>
15 <a href="./index.html">Yahoo! UI Library</a>
16 &gt; <a href="./module_datatable.html">datatable</a>
17 &gt; WidthResizer
19 </p>
20 </div>
22 <div id="bd">
23 <div id="yui-main">
24 <div class="yui-b">
27 <h2>
32 Class <b>WidthResizer</b>
33 <span class="extends">
34 - extends <a href="YAHOO.util.DragDrop.html">YAHOO.util.DragDrop</a>
35 </span>
37 <span class="extends">
38 </span>
40 </code>
41 </h2>
42 <!-- class tree goes here -->
47 <div class="summary description">
48 WidthResizer subclasses DragDrop to support resizeable Columns.
49 </div>
51 <div class="section constructor details">
52 <h3><a name="constructor_detail">Constructor</a></h3>
53 <div class="content">
54 <div class="detail">
55 <strong>WidthResizer</strong>
56 <code>
61 colElId
64 handleElId
67 sGroup
69 </code>
70 <div class="description">
71 <dl>
72 <dt>Parameters:</dt>
73 <dd>
74 <code>colElId
75 &lt;string&gt;
76 </code>
77 ID of the Column's TH element being resized
78 </dd>
79 <dd>
80 <code>handleElId
81 &lt;string&gt;
82 </code>
83 ID of the handle element that causes the resize
84 </dd>
85 <dd>
86 <code>sGroup
87 &lt;string&gt;
88 </code>
89 Group name of related DragDrop items
90 </dd>
91 </dl>
94 </div>
95 </div>
96 </div>
97 </div>
100 <div class="section field inheritance">
101 <h4>Properties inherited from <a href="YAHOO.util.DragDrop.html">YAHOO.util.DragDrop</a>:</h4>
102 <div class="content">
103 <code>
105 <a href="YAHOO.util.DragDrop.html#__ygDragDrop">__ygDragDrop</a>,
106 <a href="YAHOO.util.DragDrop.html#_domRef">_domRef</a>,
107 <a href="YAHOO.util.DragDrop.html#available">available</a>,
108 <a href="YAHOO.util.DragDrop.html#config">config</a>,
109 <a href="YAHOO.util.DragDrop.html#constrainX">constrainX</a>,
110 <a href="YAHOO.util.DragDrop.html#constrainY">constrainY</a>,
111 <a href="YAHOO.util.DragDrop.html#dragElId">dragElId</a>,
112 <a href="YAHOO.util.DragDrop.html#groups">groups</a>,
113 <a href="YAHOO.util.DragDrop.html#handleElId">handleElId</a>,
114 <a href="YAHOO.util.DragDrop.html#hasOuterHandles">hasOuterHandles</a>,
115 <a href="YAHOO.util.DragDrop.html#id">id</a>,
116 <a href="YAHOO.util.DragDrop.html#invalidHandleClasses">invalidHandleClasses</a>,
117 <a href="YAHOO.util.DragDrop.html#invalidHandleIds">invalidHandleIds</a>,
118 <a href="YAHOO.util.DragDrop.html#invalidHandleTypes">invalidHandleTypes</a>,
119 <a href="YAHOO.util.DragDrop.html#locked">locked</a>,
120 <a href="YAHOO.util.DragDrop.html#maintainOffset">maintainOffset</a>,
121 <a href="YAHOO.util.DragDrop.html#maxX">maxX</a>,
122 <a href="YAHOO.util.DragDrop.html#maxY">maxY</a>,
123 <a href="YAHOO.util.DragDrop.html#minX">minX</a>,
124 <a href="YAHOO.util.DragDrop.html#minY">minY</a>,
125 <a href="YAHOO.util.DragDrop.html#primaryButtonOnly">primaryButtonOnly</a>,
126 <a href="YAHOO.util.DragDrop.html#startPageX">startPageX</a>,
127 <a href="YAHOO.util.DragDrop.html#startPageY">startPageY</a>,
128 <a href="YAHOO.util.DragDrop.html#xTicks">xTicks</a>,
129 <a href="YAHOO.util.DragDrop.html#yTicks">yTicks</a>
130 </code>
131 </div>
132 </div>
134 <div class="section method details">
135 <h3><a name="methodDetails">Methods</a></h3>
136 <div class="content">
137 <h4>
138 <a name="onDrag">onDrag</a></h4>
139 <div class="detail">
140 <code>
144 void
145 <strong>onDrag</strong>
153 </code>
155 <div class="description">
156 Handles drag events on the Column resizer.
157 </div>
159 <div class="description">
161 <dl>
162 <dt>Parameters:</dt>
163 <dd>
164 <code>e &lt;string&gt;</code>
165 The drag event
166 </dd>
167 </dl>
169 <dl>
170 <dt>Returns:
171 <code>
172 void
173 </code></dt>
174 <dd></dd>
175 </dl>
177 </div>
179 </div>
180 <hr />
181 <h4>
182 <a name="onMouseDown">onMouseDown</a></h4>
183 <div class="detail">
184 <code>
188 void
189 <strong>onMouseDown</strong>
197 </code>
199 <div class="description">
200 Handles mousedown events on the Column resizer.
201 </div>
203 <div class="description">
205 <dl>
206 <dt>Parameters:</dt>
207 <dd>
208 <code>e &lt;string&gt;</code>
209 The mousedown event
210 </dd>
211 </dl>
213 <dl>
214 <dt>Returns:
215 <code>
216 void
217 </code></dt>
218 <dd></dd>
219 </dl>
221 </div>
223 </div>
224 <hr />
225 <h4>
226 <a name="onMouseUp">onMouseUp</a></h4>
227 <div class="detail">
228 <code>
232 void
233 <strong>onMouseUp</strong>
241 </code>
243 <div class="description">
244 Handles mouseup events on the Column resizer.
245 </div>
247 <div class="description">
249 <dl>
250 <dt>Parameters:</dt>
251 <dd>
252 <code>e &lt;string&gt;</code>
253 The mouseup event
254 </dd>
255 </dl>
257 <dl>
258 <dt>Returns:
259 <code>
260 void
261 </code></dt>
262 <dd></dd>
263 </dl>
265 </div>
267 </div>
268 <hr />
269 </div>
270 </div>
272 <div class="section field inheritance">
273 <h4>Methods inherited from <a href="YAHOO.util.DragDrop.html">YAHOO.util.DragDrop</a>:</h4>
274 <div class="content">
275 <code>
277 <a href="YAHOO.util.DragDrop.html#addInvalidHandleClass">addInvalidHandleClass</a>,
278 <a href="YAHOO.util.DragDrop.html#addInvalidHandleId">addInvalidHandleId</a>,
279 <a href="YAHOO.util.DragDrop.html#addInvalidHandleType">addInvalidHandleType</a>,
280 <a href="YAHOO.util.DragDrop.html#addToGroup">addToGroup</a>,
281 <a href="YAHOO.util.DragDrop.html#applyConfig">applyConfig</a>,
282 <a href="YAHOO.util.DragDrop.html#b4Drag">b4Drag</a>,
283 <a href="YAHOO.util.DragDrop.html#b4DragDrop">b4DragDrop</a>,
284 <a href="YAHOO.util.DragDrop.html#b4DragOut">b4DragOut</a>,
285 <a href="YAHOO.util.DragDrop.html#b4DragOver">b4DragOver</a>,
286 <a href="YAHOO.util.DragDrop.html#b4EndDrag">b4EndDrag</a>,
287 <a href="YAHOO.util.DragDrop.html#b4MouseDown">b4MouseDown</a>,
288 <a href="YAHOO.util.DragDrop.html#b4StartDrag">b4StartDrag</a>,
289 <a href="YAHOO.util.DragDrop.html#clearConstraints">clearConstraints</a>,
290 <a href="YAHOO.util.DragDrop.html#clearTicks">clearTicks</a>,
291 <a href="YAHOO.util.DragDrop.html#endDrag">endDrag</a>,
292 <a href="YAHOO.util.DragDrop.html#getDragEl">getDragEl</a>,
293 <a href="YAHOO.util.DragDrop.html#getEl">getEl</a>,
294 <a href="YAHOO.util.DragDrop.html#getTick">getTick</a>,
295 <a href="YAHOO.util.DragDrop.html#handleMouseDown">handleMouseDown</a>,
296 <a href="YAHOO.util.DragDrop.html#handleOnAvailable">handleOnAvailable</a>,
297 <a href="YAHOO.util.DragDrop.html#init">init</a>,
298 <a href="YAHOO.util.DragDrop.html#initTarget">initTarget</a>,
299 <a href="YAHOO.util.DragDrop.html#isLocked">isLocked</a>,
300 <a href="YAHOO.util.DragDrop.html#isTarget">isTarget</a>,
301 <a href="YAHOO.util.DragDrop.html#isValidHandleChild">isValidHandleChild</a>,
302 <a href="YAHOO.util.DragDrop.html#lock">lock</a>,
303 <a href="YAHOO.util.DragDrop.html#onAvailable">onAvailable</a>,
304 <a href="YAHOO.util.DragDrop.html#onDrag">onDrag</a>,
305 <a href="YAHOO.util.DragDrop.html#onDragDrop">onDragDrop</a>,
306 <a href="YAHOO.util.DragDrop.html#onDragEnter">onDragEnter</a>,
307 <a href="YAHOO.util.DragDrop.html#onDragOut">onDragOut</a>,
308 <a href="YAHOO.util.DragDrop.html#onDragOver">onDragOver</a>,
309 <a href="YAHOO.util.DragDrop.html#onInvalidDrop">onInvalidDrop</a>,
310 <a href="YAHOO.util.DragDrop.html#onMouseDown">onMouseDown</a>,
311 <a href="YAHOO.util.DragDrop.html#onMouseUp">onMouseUp</a>,
312 <a href="YAHOO.util.DragDrop.html#padding">padding</a>,
313 <a href="YAHOO.util.DragDrop.html#removeFromGroup">removeFromGroup</a>,
314 <a href="YAHOO.util.DragDrop.html#removeInvalidHandleClass">removeInvalidHandleClass</a>,
315 <a href="YAHOO.util.DragDrop.html#removeInvalidHandleId">removeInvalidHandleId</a>,
316 <a href="YAHOO.util.DragDrop.html#removeInvalidHandleType">removeInvalidHandleType</a>,
317 <a href="YAHOO.util.DragDrop.html#resetConstraints">resetConstraints</a>,
318 <a href="YAHOO.util.DragDrop.html#setDragElId">setDragElId</a>,
319 <a href="YAHOO.util.DragDrop.html#setHandleElId">setHandleElId</a>,
320 <a href="YAHOO.util.DragDrop.html#setInitialPosition">setInitialPosition</a>,
321 <a href="YAHOO.util.DragDrop.html#setOuterHandleElId">setOuterHandleElId</a>,
322 <a href="YAHOO.util.DragDrop.html#setPadding">setPadding</a>,
323 <a href="YAHOO.util.DragDrop.html#setStartPosition">setStartPosition</a>,
324 <a href="YAHOO.util.DragDrop.html#setXConstraint">setXConstraint</a>,
325 <a href="YAHOO.util.DragDrop.html#setXTicks">setXTicks</a>,
326 <a href="YAHOO.util.DragDrop.html#setYConstraint">setYConstraint</a>,
327 <a href="YAHOO.util.DragDrop.html#setYTicks">setYTicks</a>,
328 <a href="YAHOO.util.DragDrop.html#startDrag">startDrag</a>,
329 <a href="YAHOO.util.DragDrop.html#toString">toString</a>,
330 <a href="YAHOO.util.DragDrop.html#unlock">unlock</a>,
331 <a href="YAHOO.util.DragDrop.html#unreg">unreg</a>
332 </code>
333 </div>
334 </div>
341 </div>
342 </div>
343 <div class="yui-b">
344 <div class="nav">
346 <div class="module">
347 <h4>Modules</h4>
348 <ul class="content">
350 <li class=""><a href="module_animation.html">animation</a></li>
352 <li class=""><a href="module_autocomplete.html">autocomplete</a></li>
354 <li class=""><a href="module_button.html">button</a></li>
356 <li class=""><a href="module_calendar.html">calendar</a></li>
358 <li class=""><a href="module_connection.html">connection</a></li>
360 <li class=""><a href="module_container.html">container</a></li>
362 <li class=""><a href="module_datasource.html">datasource</a></li>
364 <li class="selected"><a href="module_datatable.html">datatable</a></li>
366 <li class=""><a href="module_dom.html">dom</a></li>
368 <li class=""><a href="module_dragdrop.html">dragdrop</a></li>
370 <li class=""><a href="module_element.html">element</a></li>
372 <li class=""><a href="module_event.html">event</a></li>
374 <li class=""><a href="module_history.html">history</a></li>
376 <li class=""><a href="module_logger.html">logger</a></li>
378 <li class=""><a href="module_menu.html">menu</a></li>
380 <li class=""><a href="module_slider.html">slider</a></li>
382 <li class=""><a href="module_tabview.html">tabview</a></li>
384 <li class=""><a href="module_treeview.html">treeview</a></li>
386 <li class=""><a href="module_yahoo.html">yahoo</a></li>
387 </ul>
388 </div>
390 <div class="module">
391 <h4>Classes</h4>
392 <ul class="content">
393 <li class=""><a href="Column.html">Column</a></li>
394 <li class=""><a href="ColumnEditor.html">ColumnEditor</a></li>
395 <li class=""><a href="ColumnSet.html">ColumnSet</a></li>
396 <li class=""><a href="DataTable.html">DataTable</a></li>
397 <li class=""><a href="Record.html">Record</a></li>
398 <li class=""><a href="RecordSet.html">RecordSet</a></li>
399 <li class=""><a href="Sort.html">Sort</a></li>
400 <li class="selected"><a href="WidthResizer.html">WidthResizer</a></li>
401 </ul>
402 </div>
404 <div class="module">
405 <h4>Files</h4>
406 <ul class="content">
407 <li class=""><a href="ColumnSet.js.html">ColumnSet.js</a></li>
408 <li class=""><a href="DataTable.js.html">DataTable.js</a></li>
409 <li class=""><a href="RecordSet.js.html">RecordSet.js</a></li>
410 </ul>
411 </div>
414 <div class="module">
415 <h4>Methods</h4>
416 <ul class="content">
417 <li><!--<code>void</code>-->
418 <a href="#onDrag">onDrag</a>
419 </li>
420 <li><!--<code>void</code>-->
421 <a href="#onMouseDown">onMouseDown</a>
422 </li>
423 <li><!--<code>void</code>-->
424 <a href="#onMouseUp">onMouseUp</a>
425 </li>
426 </ul>
427 </div>
431 </div>
432 </div>
433 </div>
434 <div id="ft">
435 <hr />
436 Copyright &copy; 2007 Yahoo! Inc. All rights reserved.
437 </div>
438 </div>
439 </body>
440 </html>