Subversion Repositories eFlore/Applications.cel

Compare Revisions

Ignore whitespace Rev 1 → Rev 2

/trunk/src/org/tela_botanica/public/js/ext/docs/output/Ext.util.ClickRepeater.html
New file
0,0 → 1,445
<div class="body-wrap">
<div class="top-tools">
<a class="inner-link" href="#Ext.util.ClickRepeater-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
<a class="inner-link" href="#Ext.util.ClickRepeater-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
<a class="inner-link" href="#Ext.util.ClickRepeater-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
<a class="inner-link" href="#Ext.util.ClickRepeater-configs"><img src="../resources/images/default/s.gif" class="item-icon icon-config">Config Options</a>
<a class="bookmark" href="../docs/?class=Ext.util.ClickRepeater"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>
</div>
<div class="inheritance res-block">
<pre class="res-block-inner"><a ext:cls="Ext.util.Observable" ext:member="" href="output/Ext.util.Observable.html">Observable</a>
<img src="resources/elbow-end.gif"/>ClickRepeater</pre></div>
<h1>Class Ext.util.ClickRepeater</h1>
<table cellspacing="0">
<tr><td class="label">Package:</td><td class="hd-info">Ext.util</td></tr>
<tr><td class="label">Defined In:</td><td class="hd-info"><a href="../source/util/ClickRepeater.js" target="_blank">ClickRepeater.js</a></td></tr>
<tr><td class="label">Class:</td><td class="hd-info">ClickRepeater</td></tr>
<tr><td class="label">Extends:</td><td class="hd-info"><a ext:cls="Ext.util.Observable" ext:member="" href="output/Ext.util.Observable.html">Observable</a></td></tr>
</table>
<div class="description">
A wrapper class which can be applied to any element. Fires a "click" event while the
mouse is pressed. The interval between firings may be specified in the config but
defaults to 20 milliseconds.
 
Optionally, a CSS class may be applied to the element during the time it is pressed. </div>
<div class="hr"></div>
<a id="Ext.util.ClickRepeater-configs"></a>
<h2>Config Options</h2>
<table cellspacing="0" class="member-table">
<tr>
<th class="sig-header" colspan="2">Config Options</th>
<th class="msource-header">Defined By</th>
</tr>
<tr class="config-row">
<td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
<td class="sig">
<a id="Ext.util.ClickRepeater-accelerate"></a>
<b>accelerate</b> : Boolean <div class="mdesc">
True if autorepeating should start slowly and accelerate. "interval" and "delay" are ignored. </div>
</td>
<td class="msource">ClickRepeater</td>
</tr>
<tr class="config-row alt">
<td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
<td class="sig">
<a id="Ext.util.ClickRepeater-delay"></a>
<b>delay</b> : Number <div class="mdesc">
The initial delay before the repeating event begins firing. Similar to an autorepeat key delay. </div>
</td>
<td class="msource">ClickRepeater</td>
</tr>
<tr class="config-row">
<td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
<td class="sig">
<a id="Ext.util.ClickRepeater-el"></a>
<b>el</b> : Mixed <div class="mdesc">
The element to act as a button. </div>
</td>
<td class="msource">ClickRepeater</td>
</tr>
<tr class="config-row alt">
<td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
<td class="sig">
<a id="Ext.util.ClickRepeater-interval"></a>
<b>interval</b> : Number <div class="mdesc">
The interval between firings of the "click" event. Default 20 ms. </div>
</td>
<td class="msource">ClickRepeater</td>
</tr>
<tr class="config-row inherited expandable">
<td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
<td class="sig">
<a id="Ext.util.ClickRepeater-listeners"></a>
<b>listeners</b> : Object <div class="mdesc">
<div class="short">A config object containing one or more event handlers to be added to this object during initialization. This should b...</div>
<div class="long">
A config object containing one or more event handlers to be added to this object during initialization. This should be a valid listeners config object as specified in the <a ext:cls="Ext.util.Observable" ext:member="addListener" href="output/Ext.util.Observable.html#addListener">addListener</a> example for attaching multiple handlers at once. </div>
</div>
</td>
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#listeners" href="output/Ext.util.Observable.html#listeners">Observable</a></td>
</tr>
<tr class="config-row alt">
<td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
<td class="sig">
<a id="Ext.util.ClickRepeater-pressClass"></a>
<b>pressClass</b> : String <div class="mdesc">
A CSS class name to be applied to the element while pressed. </div>
</td>
<td class="msource">ClickRepeater</td>
</tr>
<tr class="config-row">
<td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
<td class="sig">
<a id="Ext.util.ClickRepeater-preventDefault"></a>
<b>preventDefault</b> : Boolean <div class="mdesc">
True to prevent the default click event </div>
</td>
<td class="msource">ClickRepeater</td>
</tr>
<tr class="config-row alt">
<td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
<td class="sig">
<a id="Ext.util.ClickRepeater-stopDefault"></a>
<b>stopDefault</b> : Boolean <div class="mdesc">
True to stop the default click event </div>
</td>
<td class="msource">ClickRepeater</td>
</tr>
</table>
<a id="Ext.util.ClickRepeater-props"></a>
<h2>Public Properties</h2>
<div class="no-members">This class has no public properties.</div> <a id="Ext.util.ClickRepeater-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">&nbsp;</a></td>
<td class="sig">
<a id="Ext.util.ClickRepeater-ClickRepeater"></a>
<b>ClickRepeater</b>(&nbsp;<code>Mixed el</code>, <code>Object config</code>&nbsp;) <div class="mdesc">
<div class="short"></div>
<div class="long">
<div class="mdetail-params">
<strong>Parameters:</strong>
<ul><li><code>el</code> : Mixed<div class="sub-desc">The element to listen on</div></li><li><code>config</code> : Object<div class="sub-desc"></div></li> </ul>
<strong>Returns:</strong>
<ul>
<li><code></code></li>
</ul>
</div>
</div>
</div>
</td>
<td class="msource">ClickRepeater</td>
</tr>
<tr class="method-row inherited alt expandable">
<td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
<td class="sig">
<a id="Ext.util.ClickRepeater-addEvents"></a>
<b>addEvents</b>(&nbsp;<code>Object object</code>&nbsp;) : void <div class="mdesc">
<div class="short">Used to define events on this Observable</div>
<div class="long">
Used to define events on this Observable <div class="mdetail-params">
<strong>Parameters:</strong>
<ul><li><code>object</code> : Object<div class="sub-desc">The object with the events defined</div></li> </ul>
<strong>Returns:</strong>
<ul>
<li><code>void</code></li>
</ul>
</div>
</div>
</div>
</td>
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addEvents" href="output/Ext.util.Observable.html#addEvents">Observable</a></td>
</tr>
<tr class="method-row inherited expandable">
<td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
<td class="sig">
<a id="Ext.util.ClickRepeater-addListener"></a>
<b>addListener</b>(&nbsp;<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Object options</code>]</span>&nbsp;) : void <div class="mdesc">
<div class="short">Appends an event handler to this component</div>
<div class="long">
Appends an event handler to this component <div class="mdetail-params">
<strong>Parameters:</strong>
<ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The method the event invokes</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope in which to execute the handler
function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration
properties. This may contain any of the following properties:<ul>
<li><b>scope</b> : Object<p class="sub-desc">The scope in which to execute the handler function. The handler function's "this" context.</p></li>
<li><b>delay</b> : Number<p class="sub-desc">The number of milliseconds to delay the invocation of the handler after the event fires.</p></li>
<li><b>single</b> : Boolean<p class="sub-desc">True to add a handler to handle just the next firing of the event, and then remove itself.</p></li>
<li><b>buffer</b> : Number<p class="sub-desc">Causes the handler to be scheduled to run in an <a ext:cls="Ext.util.DelayedTask" href="output/Ext.util.DelayedTask.html">Ext.util.DelayedTask</a> delayed
by the specified number of milliseconds. If the event fires again within that time, the original
handler is <em>not</em> invoked, but the new handler is scheduled in its place.</p></li>
</ul><br>
<p>
<b>Combining Options</b><br>
Using the options argument, it is possible to combine different types of listeners:<br>
<br>
A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)
<pre><code>el.on(<em>'click'</em>, <b>this</b>.onClick, <b>this</b>, {
single: true,
delay: 100,
forumId: 4
});</code></pre>
<p>
<b>Attaching multiple handlers in 1 call</b><br>
The method also allows for a single argument to be passed which is a config object containing properties
which specify multiple handlers.
<p>
<pre><code>foo.on({
<em>'click'</em> : {
fn: <b>this</b>.onClick,
scope: <b>this</b>,
delay: 100
},
<em>'mouseover'</em> : {
fn: <b>this</b>.onMouseOver,
scope: <b>this</b>
},
<em>'mouseout'</em> : {
fn: <b>this</b>.onMouseOut,
scope: <b>this</b>
}
});</code></pre>
<p>
Or a shorthand syntax:<br>
<pre><code>foo.on({
<em>'click'</em> : <b>this</b>.onClick,
<em>'mouseover'</em> : <b>this</b>.onMouseOver,
<em>'mouseout'</em> : <b>this</b>.onMouseOut,
scope: <b>this</b>
});</code></pre></div></li> </ul>
<strong>Returns:</strong>
<ul>
<li><code>void</code></li>
</ul>
</div>
</div>
</div>
</td>
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addListener" href="output/Ext.util.Observable.html#addListener">Observable</a></td>
</tr>
<tr class="method-row inherited alt expandable">
<td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
<td class="sig">
<a id="Ext.util.ClickRepeater-fireEvent"></a>
<b>fireEvent</b>(&nbsp;<code>String eventName</code>, <code>Object... args</code>&nbsp;) : Boolean <div class="mdesc">
<div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
<div class="long">
Fires the specified event with the passed parameters (minus the event name). <div class="mdetail-params">
<strong>Parameters:</strong>
<ul><li><code>eventName</code> : String<div class="sub-desc"></div></li><li><code>args</code> : Object...<div class="sub-desc">Variable number of parameters are passed to handlers</div></li> </ul>
<strong>Returns:</strong>
<ul>
<li><code>Boolean</code><div class="sub-desc">returns false if any of the handlers return false otherwise it returns true</div></li>
</ul>
</div>
</div>
</div>
</td>
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#fireEvent" href="output/Ext.util.Observable.html#fireEvent">Observable</a></td>
</tr>
<tr class="method-row inherited expandable">
<td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
<td class="sig">
<a id="Ext.util.ClickRepeater-hasListener"></a>
<b>hasListener</b>(&nbsp;<code>String eventName</code>&nbsp;) : Boolean <div class="mdesc">
<div class="short">Checks to see if this object has any listeners for a specified event</div>
<div class="long">
Checks to see if this object has any listeners for a specified event <div class="mdetail-params">
<strong>Parameters:</strong>
<ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to check for</div></li> </ul>
<strong>Returns:</strong>
<ul>
<li><code>Boolean</code><div class="sub-desc">True if the event is being listened for, else false</div></li>
</ul>
</div>
</div>
</div>
</td>
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#hasListener" href="output/Ext.util.Observable.html#hasListener">Observable</a></td>
</tr>
<tr class="method-row inherited alt expandable">
<td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
<td class="sig">
<a id="Ext.util.ClickRepeater-on"></a>
<b>on</b>(&nbsp;<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Object options</code>]</span>&nbsp;) : void <div class="mdesc">
<div class="short">Appends an event handler to this element (shorthand for addListener)</div>
<div class="long">
Appends an event handler to this element (shorthand for addListener) <div class="mdetail-params">
<strong>Parameters:</strong>
<ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The method the event invokes</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope in which to execute the handler
function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional)</div></li> </ul>
<strong>Returns:</strong>
<ul>
<li><code>void</code></li>
</ul>
</div>
</div>
</div>
</td>
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#on" href="output/Ext.util.Observable.html#on">Observable</a></td>
</tr>
<tr class="method-row inherited expandable">
<td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
<td class="sig">
<a id="Ext.util.ClickRepeater-purgeListeners"></a>
<b>purgeListeners</b>() : void <div class="mdesc">
<div class="short">Removes all listeners for this object</div>
<div class="long">
Removes all listeners for this object <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"><a ext:cls="Ext.util.Observable" ext:member="#purgeListeners" href="output/Ext.util.Observable.html#purgeListeners">Observable</a></td>
</tr>
<tr class="method-row inherited alt expandable">
<td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
<td class="sig">
<a id="Ext.util.ClickRepeater-removeListener"></a>
<b>removeListener</b>(&nbsp;<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>&nbsp;) : void <div class="mdesc">
<div class="short">Removes a listener</div>
<div class="long">
Removes a listener <div class="mdetail-params">
<strong>Parameters:</strong>
<ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (this object) for the handler</div></li> </ul>
<strong>Returns:</strong>
<ul>
<li><code>void</code></li>
</ul>
</div>
</div>
</div>
</td>
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#removeListener" href="output/Ext.util.Observable.html#removeListener">Observable</a></td>
</tr>
<tr class="method-row inherited expandable">
<td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
<td class="sig">
<a id="Ext.util.ClickRepeater-resumeEvents"></a>
<b>resumeEvents</b>() : void <div class="mdesc">
<div class="short">Resume firing events. (see <a ext:cls="Ext.util.Observable" ext:member="suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">suspendEvents</a>)</div>
<div class="long">
Resume firing events. (see <a ext:cls="Ext.util.Observable" ext:member="suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">suspendEvents</a>) <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"><a ext:cls="Ext.util.Observable" ext:member="#resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">Observable</a></td>
</tr>
<tr class="method-row inherited alt expandable">
<td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
<td class="sig">
<a id="Ext.util.ClickRepeater-suspendEvents"></a>
<b>suspendEvents</b>() : void <div class="mdesc">
<div class="short">Suspend the firing of all events. (see <a ext:cls="Ext.util.Observable" ext:member="resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">resumeEvents</a>)</div>
<div class="long">
Suspend the firing of all events. (see <a ext:cls="Ext.util.Observable" ext:member="resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">resumeEvents</a>) <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"><a ext:cls="Ext.util.Observable" ext:member="#suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">Observable</a></td>
</tr>
<tr class="method-row inherited expandable">
<td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
<td class="sig">
<a id="Ext.util.ClickRepeater-un"></a>
<b>un</b>(&nbsp;<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>&nbsp;) : void <div class="mdesc">
<div class="short">Removes a listener (shorthand for removeListener)</div>
<div class="long">
Removes a listener (shorthand for removeListener) <div class="mdetail-params">
<strong>Parameters:</strong>
<ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (this object) for the handler</div></li> </ul>
<strong>Returns:</strong>
<ul>
<li><code>void</code></li>
</ul>
</div>
</div>
</div>
</td>
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#un" href="output/Ext.util.Observable.html#un">Observable</a></td>
</tr>
</table>
<a id="Ext.util.ClickRepeater-events"></a>
<h2>Public Events</h2>
<table cellspacing="0" class="member-table">
<tr>
<th class="sig-header" colspan="2">Event</th>
<th class="msource-header">Defined By</th>
</tr>
<tr class="event-row expandable">
<td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
<td class="sig">
<a id="Ext.util.ClickRepeater-click"></a>
<b>click</b> : (&nbsp;<code>Ext.util.ClickRepeater this</code>&nbsp;) <div class="mdesc">
<div class="short">Fires on a specified interval during the time the element is pressed.</div>
<div class="long">
Fires on a specified interval during the time the element is pressed. <div class="mdetail-params">
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
<ul><li><code>this</code> : Ext.util.ClickRepeater<div class="sub-desc"></div></li> </ul>
</div>
</div>
</div>
</td>
<td class="msource">ClickRepeater</td>
</tr>
<tr class="event-row alt expandable">
<td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
<td class="sig">
<a id="Ext.util.ClickRepeater-mousedown"></a>
<b>mousedown</b> : (&nbsp;<code>Ext.util.ClickRepeater this</code>&nbsp;) <div class="mdesc">
<div class="short">Fires when the mouse button is depressed.</div>
<div class="long">
Fires when the mouse button is depressed. <div class="mdetail-params">
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
<ul><li><code>this</code> : Ext.util.ClickRepeater<div class="sub-desc"></div></li> </ul>
</div>
</div>
</div>
</td>
<td class="msource">ClickRepeater</td>
</tr>
<tr class="event-row expandable">
<td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
<td class="sig">
<a id="Ext.util.ClickRepeater-mouseup"></a>
<b>mouseup</b> : (&nbsp;<code>Ext.util.ClickRepeater this</code>&nbsp;) <div class="mdesc">
<div class="short">Fires when the mouse key is released.</div>
<div class="long">
Fires when the mouse key is released. <div class="mdetail-params">
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
<ul><li><code>this</code> : Ext.util.ClickRepeater<div class="sub-desc"></div></li> </ul>
</div>
</div>
</div>
</td>
<td class="msource">ClickRepeater</td>
</tr>
</table>
</div>