- Replaced color picker form control with a more robust version.
This commit is contained in:
JT Smith
parent
6fe068e42d
commit
6e0470771e
1193 changed files with 342 additions and 223 deletions
268
www/extras/extjs/docs/output/Ext.KeyMap.html
vendored
Normal file
268
www/extras/extjs/docs/output/Ext.KeyMap.html
vendored
Normal file
|
|
@ -0,0 +1,268 @@
|
|||
<!doctype html public "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
||||
<html>
|
||||
<head>
|
||||
<title>Ext.KeyMap</title>
|
||||
<link rel="stylesheet" type="text/css" href="../resources/reset.css"/>
|
||||
<link rel="stylesheet" type="text/css" href="../resources/style.css" media="screen"/>
|
||||
<link rel="stylesheet" type="text/css" href="../resources/print.css" media="print">
|
||||
<!-- GC -->
|
||||
</head>
|
||||
<body>
|
||||
<div class="body-wrap">
|
||||
<div class="top-tools">
|
||||
<img src="../resources/print.gif" width="16" height="16" align="absmiddle"> <a href="Ext.KeyMap.html" target="_blank">Print Friendly</a><br/>
|
||||
|
||||
</div>
|
||||
<h1>Class Ext.KeyMap</h1>
|
||||
<table cellspacing="0">
|
||||
<tr><td class="label">Package:</td><td>Ext</td></tr>
|
||||
<tr><td class="label">Class:</td><td>KeyMap</td></tr>
|
||||
<tr><td class="label">Extends:</td><td>Object</td></tr>
|
||||
<tr><td class="label">Defined In:</td><td><a href="KeyMap.jss.html">KeyMap.js</a></td></tr>
|
||||
</table>
|
||||
<div class="description">
|
||||
Handles mapping keys to actions for an element. One key map can be used for multiple actions.
|
||||
The constructor accepts the same config object as defined by <a href="#addBinding">addBinding</a>.
|
||||
If you bind a callback function to a KeyMap, anytime the KeyMap handles an expected key
|
||||
combination it will call the function with this signature (if the match is a multi-key
|
||||
combination the callback will still be called only once): (String key, Ext.EventObject e)
|
||||
A KeyMap can also handle a string representation of keys.<br />
|
||||
Usage:
|
||||
<pre class="highlighted"><code><i>// map one key by key code</i>
|
||||
<b>var</b> map = <b>new</b> Ext.KeyMap("my-element", {
|
||||
key: 13, <i>// or Ext.EventObject.ENTER</i>
|
||||
fn: myHandler,
|
||||
scope: myObject
|
||||
});
|
||||
|
||||
<i>// map multiple keys to one action by string</i>
|
||||
<b>var</b> map = <b>new</b> Ext.KeyMap("my-element", {
|
||||
key: "a\r\n\t",
|
||||
fn: myHandler,
|
||||
scope: myObject
|
||||
});
|
||||
|
||||
<i>// map multiple keys to multiple actions by strings and array of codes</i>
|
||||
<b>var</b> map = <b>new</b> Ext.KeyMap("my-element", [
|
||||
{
|
||||
key: [10,13],
|
||||
fn: <b>function</b>(){ alert("Return was pressed"); }
|
||||
}, {
|
||||
key: "abc",
|
||||
fn: <b>function</b>(){ alert('a, b or c was pressed'); }
|
||||
}, {
|
||||
key: "\t",
|
||||
ctrl:true,
|
||||
shift:true,
|
||||
fn: <b>function</b>(){ alert('Control + shift + tab was pressed.'); }
|
||||
}
|
||||
]);</code></pre>
|
||||
<b>Note: A KepMap starts enabled</b> </div>
|
||||
<br />
|
||||
<a href="#properties">Properties</a>
|
||||
- <a href="#methods">Methods</a>
|
||||
- <a href="#events">Events</a>
|
||||
<hr />
|
||||
<a name="properties"></a>
|
||||
<h2>Public Properties</h2>
|
||||
<table cellspacing="0" class="member-table">
|
||||
<tr>
|
||||
<th class="sig-header" colspan="2">Property</th>
|
||||
<th class="msource-header">Defined By</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="micon" rowspan="2"> </td>
|
||||
<td class="sig"><a class="mlink" href="#stopEvent">stopEvent</a> : Boolean</td>
|
||||
<td class="msource" rowspan="2">KeyMap</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="mdesc">True to stop the event from bubbling and prevent the default browser action if the
|
||||
key was handled by the KeyMap (def...</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a name="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>
|
||||
<td class="micon" rowspan="2"> </td>
|
||||
<td class="sig"><a class="mlink" href="#KeyMap">KeyMap</a>(<code>String/HTMLElement/Ext.Element el</code>, <code>Object config</code>, <span class="optional" title="Optional">[<code>String eventName</code>]</span>)</td>
|
||||
<td class="msource" rowspan="2">KeyMap</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="mdesc"></td>
|
||||
</tr>
|
||||
<tr class="alt">
|
||||
<td class="micon" rowspan="2"> </td>
|
||||
<td class="sig"><a class="mlink" href="#addBinding">addBinding</a>(<code>Object config</code>) : void</td>
|
||||
<td class="msource" rowspan="2">KeyMap</td>
|
||||
</tr>
|
||||
<tr class="alt">
|
||||
<td class="mdesc">Add a new binding to this KeyMap. The following config object properties are supported:
|
||||
|
||||
Property Type ...</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="micon" rowspan="2"> </td>
|
||||
<td class="sig"><a class="mlink" href="#disable">disable</a>() : void</td>
|
||||
<td class="msource" rowspan="2">KeyMap</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="mdesc">Disable this KeyMap</td>
|
||||
</tr>
|
||||
<tr class="alt">
|
||||
<td class="micon" rowspan="2"> </td>
|
||||
<td class="sig"><a class="mlink" href="#enable">enable</a>() : void</td>
|
||||
<td class="msource" rowspan="2">KeyMap</td>
|
||||
</tr>
|
||||
<tr class="alt">
|
||||
<td class="mdesc">Enable this KeyMap</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="micon" rowspan="2"> </td>
|
||||
<td class="sig"><a class="mlink" href="#isEnabled">isEnabled</a>() : Boolean</td>
|
||||
<td class="msource" rowspan="2">KeyMap</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="mdesc">Returns true if this KepMap is enabled</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a name="events"></a>
|
||||
<h2>Public Events</h2>
|
||||
<div class="no-members">This class has no public events.</div> <h2 class="mdetail-head">Property Details</h2>
|
||||
<div class="detail-wrap">
|
||||
<a name="stopEvent"></a>
|
||||
<div class="mdetail">
|
||||
<h3>stopEvent</i></h3>
|
||||
<code>public Boolean stopEvent</code>
|
||||
<div class="mdetail-desc">
|
||||
True to stop the event from bubbling and prevent the default browser action if the
|
||||
key was handled by the KeyMap (defaults to false) </div>
|
||||
<div class="mdetail-def">This property is defined by KeyMap.</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="KeyMap"></a>
|
||||
<h2 class="mdetail-head">Constructor Details</h2>
|
||||
<div class="detail-wrap">
|
||||
<div class="mdetail">
|
||||
<h3>KeyMap</i></h3>
|
||||
<code>public function KeyMap(<code>String/HTMLElement/Ext.Element el</code>, <code>Object config</code>, <span class="optional" title="Optional">[<code>String eventName</code>]</span>)</code>
|
||||
<div class="mdetail-desc">
|
||||
<div class="mdetail-params">
|
||||
<strong>Parameters:</strong>
|
||||
<ul><li><code>el</code> : String/HTMLElement/Ext.Element<div class="sub-desc">The element to bind to</div></li><li><code>config</code> : Object<div class="sub-desc">The config</div></li><li><code>eventName</code> : String<div class="sub-desc">(optional) The event to bind to (defaults to "keydown")</div></li> </ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<h2 class="mdetail-head">Method Details</h2>
|
||||
<div class="detail-wrap">
|
||||
<a name="addBinding"></a>
|
||||
<div class="mdetail">
|
||||
<h3>addBinding</i></h3>
|
||||
<code>public function addBinding(<code>Object config</code>)</code>
|
||||
<div class="mdetail-desc">
|
||||
Add a new binding to this KeyMap. The following config object properties are supported:
|
||||
<pre>
|
||||
Property Type Description
|
||||
---------- --------------- ----------------------------------------------------------------------
|
||||
key String/Array A single keycode or an array of keycodes to handle
|
||||
shift Boolean True to handle key only when shift is pressed (defaults to false)
|
||||
ctrl Boolean True to handle key only when ctrl is pressed (defaults to false)
|
||||
alt Boolean True to handle key only when alt is pressed (defaults to false)
|
||||
fn Function The function to call when KeyMap finds the expected key combination
|
||||
scope Object The scope of the callback function
|
||||
</pre>
|
||||
Usage:
|
||||
<pre><code>
|
||||
// Create a KeyMap
|
||||
var map = new Ext.KeyMap(document, {
|
||||
key: Ext.EventObject.ENTER,
|
||||
fn: handleKey,
|
||||
scope: this
|
||||
});
|
||||
|
||||
//Add a new binding to the existing KeyMap later
|
||||
map.addBinding({
|
||||
key: 'abc',
|
||||
shift: true,
|
||||
fn: handleKey,
|
||||
scope: this
|
||||
});
|
||||
</code></pre>
|
||||
<div class="mdetail-params">
|
||||
<strong>Parameters:</strong>
|
||||
<ul><li><code>config</code> : Object<div class="sub-desc">A single KeyMap config</div></li> </ul>
|
||||
<strong>Returns:</strong>
|
||||
<ul>
|
||||
<li><code>void</code></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<div class="mdetail-def">This method is defined by KeyMap.</div>
|
||||
</div>
|
||||
<a name="disable"></a>
|
||||
<div class="mdetail alt">
|
||||
<h3>disable</i></h3>
|
||||
<code>public function disable()</code>
|
||||
<div class="mdetail-desc">
|
||||
Disable this KeyMap
|
||||
<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 class="mdetail-def">This method is defined by KeyMap.</div>
|
||||
</div>
|
||||
<a name="enable"></a>
|
||||
<div class="mdetail">
|
||||
<h3>enable</i></h3>
|
||||
<code>public function enable()</code>
|
||||
<div class="mdetail-desc">
|
||||
Enable this KeyMap
|
||||
<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 class="mdetail-def">This method is defined by KeyMap.</div>
|
||||
</div>
|
||||
<a name="isEnabled"></a>
|
||||
<div class="mdetail alt">
|
||||
<h3>isEnabled</i></h3>
|
||||
<code>public function isEnabled()</code>
|
||||
<div class="mdetail-desc">
|
||||
Returns true if this KepMap is enabled
|
||||
<div class="mdetail-params">
|
||||
<strong>Parameters:</strong>
|
||||
<ul><li>None.</li> </ul>
|
||||
<strong>Returns:</strong>
|
||||
<ul>
|
||||
<li><code>Boolean</code></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<div class="mdetail-def">This method is defined by KeyMap.</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
<hr>
|
||||
<div style="font-size:10px;text-align:center;color:gray;">Ext - Copyright © 2006-2007 Ext JS, LLC<br />All rights reserved.</div>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
Loading…
Add table
Add a link
Reference in a new issue