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.util.ClickRepeater</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.util.ClickRepeater-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo.util.ClickRepeater-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo.util.ClickRepeater-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo.util.ClickRepeater-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.util.ClickRepeater
52 <!-- ============================== class title / details ============================ -->
55 <h1 class="classTitle">
57 Class Roo.util.ClickRepeater
60 <table cellspacing="0" class="class-summary-table">
62 <tr><td class="label">Package:</td><td class="hd-info">Roo.util</td></tr>
64 <tr><td class="label">Defined In:</td><td class="hd-info">
66 <a href="./src/Roo_util_ClickRepeater.js.html">Roo/util/ClickRepeater.js</a>.
69 <tr><td class="label">Class:</td><td class="hd-info">ClickRepeater</td></tr>
74 <tr><td class="label">Extends:</td><td class="hd-info">
75 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
83 <!-- ============================== class summary ========================== -->
84 <div class="description">
85 A wrapper class which can be applied to any element. Fires a "click" event while the<br/>mouse is pressed. The interval between firings may be specified in the config but<br/>defaults to 10 milliseconds.<br/><br/>Optionally, a CSS class may be applied to the element during the time it is pressed.
89 <!-- ============================== Class comment block... ========================== -->
91 <div class="comments">
92 <b>Class Comments / Notes</B> =>
93 <u onclick="parent.CommentDialog.showCommentId = 'Roo.util.ClickRepeater';">[Add Your comment/notes about this class]</u>
95 <iframe frameborder="0" id="comments-Roo.util" style="border: none;width:100%;"
96 src="/blog.php/GtkDjsComments/Roo.util.ClickRepeater.html"></iframe>
101 <!-- ============================== config options ========================== -->
106 <div class="hr"></div>
107 <a id="Roo.util.ClickRepeater-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.util.ClickRepeater-cfg-accelerate" name=".accelerate"></a>
132 <div class="fixedFont">
133 <b class="itemname">accelerate</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
139 <div class="short">True if autorepeating should start slowly and accelerate.</div>
143 <div class="long">True if autorepeating should start slowly and accelerate.<br/> "interval" and "delay" are ignored. "immediate" is honored.</div>
151 Roo.util.ClickRepeater
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.util.ClickRepeater-cfg-delay" name=".delay"></a>
162 <div class="fixedFont">
163 <b class="itemname">delay</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
169 <div class="short">The initial delay before the repeating event begins firing.</div>
173 <div class="long">The initial delay before the repeating event begins firing.<br/>Similar to an autorepeat key delay.</div>
181 Roo.util.ClickRepeater
187 <tr class="config-row expandable config-row-alt0 notInherited">
188 <td class="micon"><a class="exi" href="#expand"> </a></td>
191 <a id="Roo.util.ClickRepeater-cfg-el" name=".el"></a>
192 <div class="fixedFont">
193 <b class="itemname">el</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element
199 <div class="short">The element to act as a button.</div>
203 <div class="long">The element to act as a button.</div>
211 Roo.util.ClickRepeater
217 <tr class="config-row expandable config-row-alt1 notInherited">
218 <td class="micon"><a class="exi" href="#expand"> </a></td>
221 <a id="Roo.util.ClickRepeater-cfg-interval" name=".interval"></a>
222 <div class="fixedFont">
223 <b class="itemname">interval</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
229 <div class="short">The interval between firings of the "click" event.</div>
233 <div class="long">The interval between firings of the "click" event. Default 10 ms.</div>
241 Roo.util.ClickRepeater
247 <tr class="config-row expandable config-row-alt0 notInherited">
248 <td class="micon"><a class="exi" href="#expand"> </a></td>
251 <a id="Roo.util.ClickRepeater-cfg-pressClass" name=".pressClass"></a>
252 <div class="fixedFont">
253 <b class="itemname">pressClass</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
259 <div class="short">A CSS class name to be applied to the element while pressed.</div>
263 <div class="long">A CSS class name to be applied to the element while pressed.</div>
271 Roo.util.ClickRepeater
277 <tr class="config-row expandable config-row-alt1 notInherited">
278 <td class="micon"><a class="exi" href="#expand"> </a></td>
281 <a id="Roo.util.ClickRepeater-cfg-preventDefault" name=".preventDefault"></a>
282 <div class="fixedFont">
283 <b class="itemname">preventDefault</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
289 <div class="short">True to prevent the default click event</div>
293 <div class="long">True to prevent the default click event</div>
301 Roo.util.ClickRepeater
307 <tr class="config-row expandable config-row-alt0 notInherited">
308 <td class="micon"><a class="exi" href="#expand"> </a></td>
311 <a id="Roo.util.ClickRepeater-cfg-stopDefault" name=".stopDefault"></a>
312 <div class="fixedFont">
313 <b class="itemname">stopDefault</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
319 <div class="short">True to stop the default click event</div>
323 <div class="long">True to stop the default click event</div>
331 Roo.util.ClickRepeater
347 <!-- ============================== public properties ==================== -->
351 <a id="Roo.util.ClickRepeater-props"></a>
357 <table cellspacing="0" class="member-table">
358 <caption class="Empty">Public Properties - Has None</caption>
364 <!-- ============================== methods summary / details ======================== -->
367 <a id="Roo.util.ClickRepeater-methods"></a>
368 <!-- constructor?? -->
375 <!-- then dynamics first -->
382 <table cellspacing="0" class="member-table">
383 <caption>Public Methods</caption>
385 <th class="sig-header" colspan="2">Method</th>
386 <th class="msource-header">Defined By</th>
396 <tr class="method-row config-row-alt0 expandable notInherited">
397 <td class="micon"><a class="exi" href="#expand"> </a></td>
401 <a id="Roo.util-method-ClickRepeater" name=".ClickRepeater"></a>
402 <div class="fixedFont">
403 <span class="attributes">new <B>Roo.util.</B></span><b class="itemname">ClickRepeater</b>
405 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element <B><i>el</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>)
413 <div class="short">Create a new Roo.util.ClickRepeater</div>
420 Create a new Roo.util.ClickRepeater
423 <dl class="detailList">
424 <dt class="heading">Parameters:</dt>
427 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span> <b>el</b>
430 <dd>The element to listen on</dd>
433 <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>
463 <!-- ============================== events summary / details ======================== -->
466 <a id="Roo.util.ClickRepeater-events"></a>
475 <table cellspacing="0" class="member-table">
476 <caption>Events</caption>
479 <th class="sig-header" colspan="2">Event</th>
480 <th class="msource-header">Defined By</th>
489 <tr class="method-row expandable config-row-alt0 notInherited">
490 <td class="micon"><a class="exi" href="#expand"> </a></td>
493 <a id="Roo.util.ClickRepeater-event-*click"></a>
495 <div class="fixedFont">
496 <b class="itemname">click</b> (<a href="./Roo.util.ClickRepeater.html#constructor" roo:cls="Roo.util.ClickRepeater.html#constructor">Roo.util.ClickRepeater</a> <B><i>this</i></B>)
502 <div class="short">Fires on a specified interval during the time the element is pressed.
508 Fires on a specified interval during the time the element is pressed.
514 <dl class="detailList">
515 <dt class="heading">Parameters:</dt>
518 <span class="fixedFont"><a href="./Roo.util.ClickRepeater.html#constructor" roo:cls="Roo.util.ClickRepeater.html#constructor">Roo.util.ClickRepeater</a></span> <b>this</b>
540 Roo.util.ClickRepeater
544 <tr class="method-row expandable config-row-alt1 notInherited">
545 <td class="micon"><a class="exi" href="#expand"> </a></td>
548 <a id="Roo.util.ClickRepeater-event-*mousedown"></a>
550 <div class="fixedFont">
551 <b class="itemname">mousedown</b> (<a href="./Roo.util.ClickRepeater.html#constructor" roo:cls="Roo.util.ClickRepeater.html#constructor">Roo.util.ClickRepeater</a> <B><i>this</i></B>)
557 <div class="short">Fires when the mouse button is depressed.
563 Fires when the mouse button is depressed.
569 <dl class="detailList">
570 <dt class="heading">Parameters:</dt>
573 <span class="fixedFont"><a href="./Roo.util.ClickRepeater.html#constructor" roo:cls="Roo.util.ClickRepeater.html#constructor">Roo.util.ClickRepeater</a></span> <b>this</b>
595 Roo.util.ClickRepeater
599 <tr class="method-row expandable config-row-alt0 notInherited">
600 <td class="micon"><a class="exi" href="#expand"> </a></td>
603 <a id="Roo.util.ClickRepeater-event-*mouseup"></a>
605 <div class="fixedFont">
606 <b class="itemname">mouseup</b> (<a href="./Roo.util.ClickRepeater.html#constructor" roo:cls="Roo.util.ClickRepeater.html#constructor">Roo.util.ClickRepeater</a> <B><i>this</i></B>)
612 <div class="short">Fires when the mouse key is released.
618 Fires when the mouse key is released.
624 <dl class="detailList">
625 <dt class="heading">Parameters:</dt>
628 <span class="fixedFont"><a href="./Roo.util.ClickRepeater.html#constructor" roo:cls="Roo.util.ClickRepeater.html#constructor">Roo.util.ClickRepeater</a></span> <b>this</b>
650 Roo.util.ClickRepeater
661 <!-- ============================== footer ================================= -->
662 <div class="fineprint" style="clear:both">
664 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Fri Jul 16 2010 16:11:58 GMT+0800 (HKT)
666 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>