デザイナーにも分かりやすいjQuery入門講座|jQueryの使い方

このエントリーをはてなブックマークに追加
索引
Core:コアとなる仕組み
Selectors:セレクタ
Attributes:属性
Traversing:対象の変更
Manipulation:操作
CSS:スタイルシート
Events:イベント
Effects:演出効果
Ajax:xml等との連携
Utilities:ユーティリティ
Data:データ
Miscellaneous:諸々
Deferred:処理管理
Callbacks:コールバック
Internals:内部処理

.keydown( )キーを押した時の処理を設定

構文

キーを押した時の処理を設定返値:jQueryオブジェクト
jQo.keydown( function )ver1.0〜
jQo.keydown( )ver1.0〜
jQo.keydown( object, function )ver1.4.3〜

機能

jQueryオブジェクトで指定した要素にフォーカスがあるとき、キーが押されたら引数のfunctionを実行します。引数にfunctionを設定しない場合は、要素に設定(バインド)されたfunctionを実行します。

ver1.4.3からは引数にobjectオブジェクトを設定することで、実行するfunctionにデータを渡すことができます(データはイベントオブジェクトのdataプロパティ経由で渡されます)。

keypressメソッドと異なり「controlキー」「shiftキー」など文字入力に関係ないキーでもfunctionが実行されます。

解説

キーを押した時に実行する処理を設定

サンプル(keydown/01.html)を開いてbody内にtype属性がtextのinput要素とp要素があることを確認してください。

<input type="text" value="focus me" />
<p></p>

jQueryは以下の様に記述され、keydownメソッドの引数にfunctionの「downFunc」が設定されています。

$(function () {
	$("input").keydown(downFunc);
});

keydownメソッドの引数に設定するFunctionは以下の様な構文になっています。まず引数(イベントオブジェクト)を受け取ります。そしてキーを押したら実行したい処理を{}の中に書きます、何かをreturnする必要はありません。イベントオブジェクトは別項にまとめてあるので、そちらを確認してください。

keydownに設定するFunctionの構文
function 任意の名前(イベントオブジェクト){
 キーを押したら実行したい処理
}

サンプルkeydown/01.htmlで利用したdownFuncは以下の様になっており、引数eo(イベントオブジェクト)に含まれるwhichプロパティを利用して、押したキーのキーコードを取得します。キーコードはappendメソッドを利用してp要素に追加していきます。

function downFunc(eo) {
	$("p").append(eo.which + " ");
};

結果として、input要素にフォーカスを当ててから何かキーを押すとキーコードがp要素に追加されていきます。
イベントのfunction設定は、無名関数を利用することが多いです。→サンプル(keydown/01b.html

$("input").keydown(function (eo) {
	$("p").append(eo.which + " ");
});

他の要素に設定されたキーダウン時の処理を実行する

keydownメソッドは引数を設定しないと、指定した要素に設定されたキーダウン時の処理を実行します。
サンプル(keydown/02.html)を開いてbody内にbutton要素が追加されたことを確認してください。

続いてjQueryを確認してください。キーダウン時の処理はkeydown/01b.htmlと同じですが、以下の処理が追加されています。この処理によってbutton要素をクリックするとinput要素に設定されたキーダウン時の処理が実行されます。

$("button").click(function(){
	$("input").keydown();
})

結果として、button要素をクリックしてもinput要素でキーを押したのと同じように処理されます。ただしキーではないためキーコードが取れず表示されるのは「undefined」となります。

objectオブジェクトをfunctionに渡す

第1引数にobjectオブジェクトを設定することで、実行するfunctionにデータを渡すことができます。データはイベントオブジェクトのdataプロパティを介して渡されます。サンプル(keydown/03.html)を開いてbody内の構成はkeydown/01b.htmlと同じ事を確認してください。

jQueryは以下の様に記述され、keydownメソッドの第1引数にtestプロパティが10の値を持ったobjectオブジェクトが設定されています。このデータはイベントオブジェクト(eo)を通してfunctionに渡され、dataプロパティの値として取得できます。

$("input").keydown({test:10},function(eo){
	$("p").append(eo.data.test + " ");
})

結果として、input要素にフォーカスを当ててから何かキーを押すと、第1引数で渡されたtestプロパティの値「10」がp要素に追加されます。

関連項目

キーを離した時の処理を設定したい場合はkeyupメソッドを利用します。
keydownメソッドと似たメソッドにkeypressメソッドがあります。これはキー「入力」があったときの処理を設定します。つまり「controlキー」「shiftキー」など文字が入力されないキーを押しても処理が実行されません。

メモ

セレクタはinput要素以外でもOKです

keydownメソッドはinput要素以外にも利用できます。サンプル(keydown/test01.html)を開いてbody内にdiv要素が1つあることを確認してください。jQueryは以下の様に記述され、document(つまりページ)にフォーカスがあるときにキーを押すとdownFuncが実行され、キーを離すとupFuncが実行されます。このようにinput要素以外をセレクタにしても問題ありません。

$(function () {
	$(document).keydown(downFunc);
	$(document).keyup(upFunc);
});

downFuncやupFuncではcssメソッドを利用してdiv要素の背景色を変更しているだけです。結果として、ページにフォーカスがあるときキーを押すとdiv要素がオレンジ色になり、キーを離すと青に戻ります。