■キー割当表示 [Shift-H] ─ KeyNavi:キーボードを活用して 
ホームページを快適に─
 
ホーム KeyNavi対応方法 [0] API リファレンス 目次 [1] 4. KeyNaviユティリティ関数 ・サイトマップ [Shift-S]

KeyNavi API リファレンス
 ■ 4. KeyNaviユティリティ関数

 ■ 4.1 設定ウィンドウ




■ 4.1.1  KeyNavi設定ウィンドウを開く   kl_pwin_open() << 前 : 4.1 設定ウィン... [Y]   |   kl_pwin_close [H] : 次>>
名前:
kl_pwin_open()
説明:KeyNaviの設定用ウィンドウを開きます。 キー配置を「デフォルト/Unix/KeyNavi無効」フォーカス割当を 「矢印キー単独」「Ctrl(Shift)-矢印」など選択できます。
注意:「Ctrl-/(¥)」キーに割当てられています。
使用例:

関連: kl_pwin_close()
参照: 
収録: keynavi_ja.js
適用:KeyNavi設定ウィンドウを開きたい。
対応ブラウザ:
WindowsMacLinux
IE4 IE5 IE5.5 IE6 NS4 NS6 NS7 MZ1 OP7 IE5 NS7 MZ1 NS7 MZ1
関数一覧(先頭)へ移動 [W・O]   |   スクロール位置回復 [N]




■ 4.1.2  KeyNavi設定ウィンドウを閉じる   kl_pwin_close() << 前 : kl_pwin_open [Y]   |   4.2 使い方ウィ... [H] : 次>>
名前:
kl_pwin_close()
説明:KeyNaviの設定用ウィンドウを閉じます。 既に閉じられていてもエラーにはなりません。
注意: 
使用例:

関連: kl_pwin_open()
参照: 
収録: keynavi_ja.js
適用:KeyNavi設定ウィンドウを閉じたい。
対応ブラウザ:
WindowsMacLinux
IE4 IE5 IE5.5 IE6 NS4 NS6 NS7 MZ1 OP7 IE5 NS7 MZ1 NS7 MZ1
関数一覧(先頭)へ移動 [W・O]   |   スクロール位置回復 [N]

 ■ 4.2 使い方ウィンドウ




■ 4.2.1  使い方ウィンドウを開く   kl_hwin_open() << 前 : 4.2 使い方ウィ... [Y]   |   kl_hwin_close [H] : 次>>
名前:
kl_hwin_open()
説明:キー割当表を縦長の別ウィンドウに開きます。 作成したウィンドウオブジェクトを返します。
注意: 
使用例:

関連: kl_hwin_close()
参照: 
収録: keynavi_ja.js
適用:ユーザにキー割当一覧を参照させたい。
対応ブラウザ:
WindowsMacLinux
IE4 IE5 IE5.5 IE6 NS4 NS6 NS7 MZ1 OP7 IE5 NS7 MZ1 NS7 MZ1
関数一覧(先頭)へ移動 [W・O]   |   スクロール位置回復 [N]




■ 4.2.2  使い方ウィンドウ閉じる   kl_hwin_close() << 前 : kl_hwin_open [Y]   |   4.3 メイン処理 [H] : 次>>
名前:
kl_hwin_close()
説明:表示した使い方ウィンドウを閉じます。 既に閉じられていてもエラーにはなりません。
注意:実際にウィンドウが存在しない時に実行してもエラーにはなりません。
使用例:

関連: kl_hwin_open()
参照: 
収録: keynavi_ja.js
適用:ユーザにキー割当一覧を参照させたい。
対応ブラウザ:
WindowsMacLinux
IE4 IE5 IE5.5 IE6 NS4 NS6 NS7 MZ1 OP7 IE5 NS7 MZ1 NS7 MZ1
関数一覧(先頭)へ移動 [W・O]   |   スクロール位置回復 [N]

 ■ 4.3 メイン処理




■ 4.3.1  keyNaviメイン処理   kl_keymain(kc,md,action,e) << 前 : 4.3 メイン処理 [Y]   |   kl_clear [H] : 次>>
名前:
kl_keymain(kc,md,action,e)
説明:キーコードkc、修飾キーオブジェクトmd、キー動作action、 イベントオブジェクトe(0可)でKeyNaviを実行します。
注意: 
使用例: 
関連: 
参照: 
収録: keynavi_ja.js
適用:別フレームや別ウィンドウからページを制御したい。
対応ブラウザ:
WindowsMacLinux
IE4 IE5 IE5.5 IE6 NS4 NS6 NS7 MZ1 OP7 IE5 NS7 MZ1 NS7 MZ1
関数一覧(先頭)へ移動 [W・O]   |   スクロール位置回復 [N]




■ 4.3.2  内部変数のリセット   kl_clear() << 前 : kl_keymain [Y]   |   4.4 KeyNaviイ... [H] : 次>>
名前:
kl_clear()
説明:フォーカス位置の制御では実行速度を上げるためオブジェクトの位置などの 情報を内部変数として保持しています。 DHTMLなどでページの内容が変わりリンクが増減したり位置が変わった場合には それらの再計算が必要になります。 その場合はこの関数を呼び出し再計算が必要なことをKeyNaviに伝えます。
注意:KeyNaviでは可能な限り自動判定しているので特に呼び出さなくても 大丈夫なケースが多いですが必要に応じて呼んでください。
使用例:

関連: 
参照: 
収録: keynavi_ja.js
適用:DHTMLでリンクの位置が変わったり可視性が変更された。
対応ブラウザ:
WindowsMacLinux
IE4 IE5 IE5.5 IE6 NS4 NS6 NS7 MZ1 OP7 IE5 NS7 MZ1 NS7 MZ1
関数一覧(先頭)へ移動 [W・O]   |   スクロール位置回復 [N]

 ■ 4.4 KeyNaviイベントハンドラ

接尾子として「_ex」がついたものは KeyNavi拡張用関数です。



■ 4.4.1  カスタマイズハンドラ登録   kl_addhandler_ex(etype,func,is_post) << 前 : 4.4 KeyNaviイ... [Y]   |   kl_delhandler_ex [H] : 次>>
名前:
kl_addhandler_ex(etype,func,is_post)
説明:ページ全体に対するハンドラ関数funcを登録します。 etypeには 文字列 setup, onload, onresize, onmousedown, onkeydown, onkeypress, onkeyup, keyfunc, keyfunc0 を指定できます。 is_postが真の場合は該当イベントに対するKeyNaviの処理が終ってから funcが実行されます。
注意:kl_addhandler()では登録先Objectも指定する必要がありますが この関数を利用する場合は不要です。 また各etypeに対して「kl_(etype名)_ex()」という形式でハンドラ関数を 定義することができます。
使用例:function MyOnLoad(){ kl_status('Hello'); }
kl_addhandler_ex("onload",MyOnload);
関連: kl_delhandler_ex(etype,func,is_post)  kl_setup_ex()  kl_onload_ex(e)  kl_onresize_ex(e)  kl_onmousedown_ex(e)  kl_onkeydown_ex(e)  kl_onkeypress_ex(e)  kl_onkeyup_ex(e)  kl_keyfunc_ex(stat)  kl_keyfunc0_ex(stat)
参照: 「JavaScript@KeyNavi.Net」イベントハンドラの登録:kl_addhandler()
収録: keynavi_ja.js
適用:KeyNaviハンドラ関数を追加したい。
対応ブラウザ:
WindowsMacLinux
IE4 IE5 IE5.5 IE6 NS4 NS6 NS7 MZ1 OP7 IE5 NS7 MZ1 NS7 MZ1
関数一覧(先頭)へ移動 [W・O]   |   スクロール位置回復 [N]




■ 4.4.2  カスタマイズハンドラ削除   kl_delhandler_ex(etype,func,is_post) << 前 : kl_addhandler_ex [Y]   |   4.5 KeyNavi拡... [H] : 次>>
名前:
kl_delhandler_ex(etype,func,is_post)
説明:ページ全体に対するハンドラ関数funcを削除します。
注意: 
使用例:kl_delhandler_ex("onload",MyOnLoad);
関連: kl_addhandler_ex(etype,func,is_post)  kl_setup_ex()  kl_onload_ex(e)  kl_onresize_ex(e)  kl_onmousedown_ex(e)  kl_onkeydown_ex(e)  kl_onkeypress_ex(e)  kl_onkeyup_ex(e)  kl_keyfunc_ex(stat)  kl_keyfunc0_ex(stat)
参照: 「JavaScript@KeyNavi.Net」イベントハンドラの登録:kl_addhandler()
収録: keynavi_ja.js
適用:KeyNaviハンドラ関数を削除したい。
対応ブラウザ:
WindowsMacLinux
IE4 IE5 IE5.5 IE6 NS4 NS6 NS7 MZ1 OP7 IE5 NS7 MZ1 NS7 MZ1
関数一覧(先頭)へ移動 [W・O]   |   スクロール位置回復 [N]

 ■ 4.5 KeyNavi拡張用関数

接尾子として「_ex」がついたものは KeyNavi拡張用関数です。



■ 4.5.1  setup時に実行   kl_setup_ex() << 前 : 4.5 KeyNavi拡... [Y]   |   kl_onload_ex [H] : 次>>
名前:
kl_setup_ex()
説明:KeyNaviのsetup関数「kl_setup()」が実行されるときに 合わせて実行されます。
一般的には「keynavi_ja.js」が読まれた時点で実行されます。 例外的にNetscape4且つフレームを使ったページの場合は 実行停止のバグ回避のためにonLoadのタイミングで呼ばれます。

この関数が呼ばれる時点では「kl_identify()」は実行済みなので ブラウザ判定定数「KL_IE4/KL_NS4/KL_NS6」等々を利用できます。 KeyNaviのカスタマイズでもっとも使われる関数です。
注意:ハンドラ登録は不要で関数を定義するだけでOKです。
動作はkl_addhandler_ex()で登録される関数と同じです。
なお「kl_setup_ex()」は「keynavi_ja.js」を読み込む前に定義されている 必要があります。
使用例:function kl_setup_ex(){ ...KeyNaviカスタマイズ変数設定処理... }
関連: kl_addhandler_ex(etype,func,is_post)  kl_delhandler_ex(etype,func,is_post)  kl_onload_ex(e)  kl_onresize_ex(e)  kl_onmousedown_ex(e)  kl_onkeydown_ex(e)  kl_onkeypress_ex(e)  kl_onkeyup_ex(e)  kl_keyfunc_ex(stat)  kl_keyfunc0_ex(stat)
参照: 
収録: keynavi_ja.js
適用:KeyNavi各種のカスタマイズ定数を変更したい。
対応ブラウザ:
WindowsMacLinux
IE4 IE5 IE5.5 IE6 NS4 NS6 NS7 MZ1 OP7 IE5 NS7 MZ1 NS7 MZ1
関数一覧(先頭)へ移動 [W・O]   |   スクロール位置回復 [N]




■ 4.5.2  onLoad関数   kl_onload_ex(e) << 前 : kl_setup_ex [Y]   |   kl_onresize_ex [H] : 次>>
名前:
kl_onload_ex(e)
説明:ページのonLoadイベント発生時に呼ばれます。 eはイベントオブジェクトで略しても構いません。 kl_setup()が呼ばれ、且つページの読み込みが完了した時点で呼ばれます。
注意:ハンドラ登録は不要で関数を定義するだけでOKです。
動作はkl_addhandler_ex()で登録される関数と同じです。
使用例: 
関連: kl_addhandler_ex(etype,func,is_post)  kl_delhandler_ex(etype,func,is_post)  kl_setup_ex()  kl_onresize_ex(e)  kl_onmousedown_ex(e)  kl_onkeydown_ex(e)  kl_onkeypress_ex(e)  kl_onkeyup_ex(e)  kl_keyfunc_ex(stat)  kl_keyfunc0_ex(stat)
参照: 
収録: keynavi_ja.js
適用:onLoadハンドラを登録したい。
対応ブラウザ:
WindowsMacLinux
IE4 IE5 IE5.5 IE6 NS4 NS6 NS7 MZ1 OP7 IE5 NS7 MZ1 NS7 MZ1
関数一覧(先頭)へ移動 [W・O]   |   スクロール位置回復 [N]




■ 4.5.3  onResize関数   kl_onresize_ex(e) << 前 : kl_onload_ex [Y]   |   kl_onmousedow... [H] : 次>>
名前:
kl_onresize_ex(e)
説明:ウィンドウのonResizeイベント発生時に呼ばれます。 eはイベントオブジェクトで略しても構いません。
注意:ハンドラ登録は不要で関数を定義するだけでOKです。
動作はkl_addhandler_ex()で登録される関数と同じです。
使用例: 
関連: kl_addhandler_ex(etype,func,is_post)  kl_delhandler_ex(etype,func,is_post)  kl_setup_ex()  kl_onload_ex(e)  kl_onmousedown_ex(e)  kl_onkeydown_ex(e)  kl_onkeypress_ex(e)  kl_onkeyup_ex(e)  kl_keyfunc_ex(stat)  kl_keyfunc0_ex(stat)
参照: 
収録: keynavi_ja.js
適用:onResizeハンドラを登録したい。
対応ブラウザ:
WindowsMacLinux
IE4 IE5 IE5.5 IE6 NS4 NS6 NS7 MZ1 OP7 IE5 NS7 MZ1 NS7 MZ1
関数一覧(先頭)へ移動 [W・O]   |   スクロール位置回復 [N]




■ 4.5.4  onmousedown関数   kl_onmousedown_ex(e) << 前 : kl_onresize_ex [Y]   |   kl_onkeydown_ex [H] : 次>>
名前:
kl_onmousedown_ex(e)
説明:ページのonmousedownイベント発生時に呼ばれます。 eはイベントオブジェクトで略しても構いません。
注意:ハンドラ登録は不要で関数を定義するだけでOKです。
動作はkl_addhandler_ex()で登録される関数と同じです。
使用例: 
関連: kl_addhandler_ex(etype,func,is_post)  kl_delhandler_ex(etype,func,is_post)  kl_setup_ex()  kl_onload_ex(e)  kl_onresize_ex(e)  kl_onkeydown_ex(e)  kl_onkeypress_ex(e)  kl_onkeyup_ex(e)  kl_keyfunc_ex(stat)  kl_keyfunc0_ex(stat)
参照: 「JavaScript@KeyNavi.Net」キーやマウスが押されたことを確認したい
収録: keynavi_ja.js
適用:onmousedownハンドラを登録したい。
対応ブラウザ:
WindowsMacLinux
IE4 IE5 IE5.5 IE6 NS4 NS6 NS7 MZ1 OP7 IE5 NS7 MZ1 NS7 MZ1
関数一覧(先頭)へ移動 [W・O]   |   スクロール位置回復 [N]




■ 4.5.5  onkeydown関数   kl_onkeydown_ex(e) << 前 : kl_onmousedow... [Y]   |   kl_onkeypress_... [H] : 次>>
名前:
kl_onkeydown_ex(e)
説明:ページのonkeydownイベント発生時に呼ばれます。 eはイベントオブジェクトで略しても構いません。
注意:ハンドラ登録は不要で関数を定義するだけでOKです。
動作はkl_addhandler_ex()で登録される関数と同じです。
使用例: 
関連: kl_addhandler_ex(etype,func,is_post)  kl_delhandler_ex(etype,func,is_post)  kl_setup_ex()  kl_onload_ex(e)  kl_onresize_ex(e)  kl_onmousedown_ex(e)  kl_onkeypress_ex(e)  kl_onkeyup_ex(e)  kl_keyfunc_ex(stat)  kl_keyfunc0_ex(stat)
参照: 「JavaScript@KeyNavi.Net」キーやマウスが押されたことを確認したい
収録: keynavi_ja.js
適用:onkeydownハンドラを登録したい。
対応ブラウザ:
WindowsMacLinux
IE4 IE5 IE5.5 IE6 NS4 NS6 NS7 MZ1 OP7 IE5 NS7 MZ1 NS7 MZ1
関数一覧(先頭)へ移動 [W・O]   |   スクロール位置回復 [N]




■ 4.5.6  onkeypress関数   kl_onkeypress_ex(e) << 前 : kl_onkeydown_ex [Y]   |   kl_onkeyup_ex [H] : 次>>
名前:
kl_onkeypress_ex(e)
説明:ページのonkeypressイベント発生時に呼ばれます。 eはイベントオブジェクトで略しても構いません。
注意:ハンドラ登録は不要で関数を定義するだけでOKです。
動作はkl_addhandler_ex()で登録される関数と同じです。
使用例: 
関連: kl_addhandler_ex(etype,func,is_post)  kl_delhandler_ex(etype,func,is_post)  kl_setup_ex()  kl_onload_ex(e)  kl_onresize_ex(e)  kl_onmousedown_ex(e)  kl_onkeydown_ex(e)  kl_onkeyup_ex(e)  kl_keyfunc_ex(stat)  kl_keyfunc0_ex(stat)
参照: 
収録: keynavi_ja.js
適用:onkeypressハンドラを登録したい。
対応ブラウザ:
WindowsMacLinux
IE4 IE5 IE5.5 IE6 NS4 NS6 NS7 MZ1 OP7 IE5 NS7 MZ1 NS7 MZ1
関数一覧(先頭)へ移動 [W・O]   |   スクロール位置回復 [N]




■ 4.5.7  onkeyup関数   kl_onkeyup_ex(e) << 前 : kl_onkeypress_... [Y]   |   kl_keyfunc_ex [H] : 次>>
名前:
kl_onkeyup_ex(e)
説明:ページのonkeyupイベント発生時に呼ばれます。 eはイベントオブジェクトで略しても構いません。
注意:ハンドラ登録は不要で関数を定義するだけでOKです。
動作はkl_addhandler_ex()で登録される関数と同じです。
使用例: 
関連: kl_addhandler_ex(etype,func,is_post)  kl_delhandler_ex(etype,func,is_post)  kl_setup_ex()  kl_onload_ex(e)  kl_onresize_ex(e)  kl_onmousedown_ex(e)  kl_onkeydown_ex(e)  kl_onkeypress_ex(e)  kl_keyfunc_ex(stat)  kl_keyfunc0_ex(stat)
参照: 
収録: keynavi_ja.js
適用:onkeyupハンドラを登録したい。
対応ブラウザ:
WindowsMacLinux
IE4 IE5 IE5.5 IE6 NS4 NS6 NS7 MZ1 OP7 IE5 NS7 MZ1 NS7 MZ1
関数一覧(先頭)へ移動 [W・O]   |   スクロール位置回復 [N]




■ 4.5.8  keyfunc関数   kl_keyfunc_ex(stat) << 前 : kl_onkeyup_ex [Y]   |   kl_keyfunc0_ex [H] : 次>>
名前:
kl_keyfunc_ex(stat)
説明:KeyNaviのキーイベント処理のカスタマイズで使われます。 statは擬似連想配列として利用され stat["knx"]に拡張キー名が格納されており これによって処理を分岐します。 キーイベントにはaction=keydown, keypress, keyupの3つがありますが その中で処理に適したタイミングで一度のみ呼ばれます。

ブラウザ互換性が低いので処理を被せています。 この部分を直接操作したい場合はkl_keyfunc0_ex()や kl_onkeydown/press/up_ex()を使って下さい。

statには キーコードkc、キー名kn、拡張キー名knx、修飾状態md, 動作actionが格納されています。 md["alt", "ctrl", "shift"]の真偽値でALTキー、Ctrlキー、Shiftキーが 押されているか分かります。

knxにはkn,mdの情報が集約されており 「Shift-F」なら "sF"、 「Ctrl-F」なら "cF" などとなります。また両方押された場合は "csF"となります。

注意:ハンドラ登録は不要で関数を定義するだけでOKです。
動作はkl_addhandler_ex()で登録される関数と同じです。
使用例: 
関連: kl_addhandler_ex(etype,func,is_post)  kl_delhandler_ex(etype,func,is_post)  kl_setup_ex()  kl_onload_ex(e)  kl_onresize_ex(e)  kl_onmousedown_ex(e)  kl_onkeydown_ex(e)  kl_onkeypress_ex(e)  kl_onkeyup_ex(e)  kl_keyfunc0_ex(stat)
参照: KL_KEY2FNC
収録: keynavi_ja.js
適用:ショートカットを作りたい。
対応ブラウザ:
WindowsMacLinux
IE4 IE5 IE5.5 IE6 NS4 NS6 NS7 MZ1 OP7 IE5 NS7 MZ1 NS7 MZ1
関数一覧(先頭)へ移動 [W・O]   |   スクロール位置回復 [N]




■ 4.5.9  keyfunc0関数   kl_keyfunc0_ex(stat) << 前 : kl_keyfunc_ex [Y]   |   4.6 その他 [H] : 次>>
名前:
kl_keyfunc0_ex(stat)
説明:kl_keyfunc_ex()と異なりキーイベントの全ての action(keydown, keypress, keyup)で呼ばれます。 より凝ったカスタマイズをしたい場合に使われます。
注意:ハンドラ登録は不要で関数を定義するだけでOKです。
動作はkl_addhandler_ex()で登録される関数と同じです。
使用例: 
関連: kl_addhandler_ex(etype,func,is_post)  kl_delhandler_ex(etype,func,is_post)  kl_setup_ex()  kl_onload_ex(e)  kl_onresize_ex(e)  kl_onmousedown_ex(e)  kl_onkeydown_ex(e)  kl_onkeypress_ex(e)  kl_onkeyup_ex(e)  kl_keyfunc_ex(stat)
参照: 
収録: keynavi_ja.js
適用:ショートカットを作りたい。
対応ブラウザ:
WindowsMacLinux
IE4 IE5 IE5.5 IE6 NS4 NS6 NS7 MZ1 OP7 IE5 NS7 MZ1 NS7 MZ1
関数一覧(先頭)へ移動 [W・O]   |   スクロール位置回復 [N]

 ■ 4.6 その他




■ 4.6.1  ステータスバー出力   kl_status(s,arg) << 前 : 4.6 その他 [Y]   |   5. イベント処理 [H] : 次>>
名前:
kl_status(s,arg)
説明:文字列sをブラウザのステータスバーに出力します。 内部的には「window.status=s」と等価です。 argは使われていませんがエラー番号などの情報を指定してもいいでしょう。
注意:この関数を再定義すれば出力先をリダイレクトできます。  「JavaScript@KeyNavi.Net」status出力をリダイレクト:kl_status(s,opt)では出力先をブラウザ画面中央に表示される 半透明レイヤーにしています。 汎用のメッセージ関数として使うといいでしょう。
使用例:

関連: KL_MSG_
参照: 「JavaScript@KeyNavi.Net」status出力をリダイレクト:kl_status(s,opt)
収録: keynavi_ja.js
適用:ステータスバーに出力したい。出力をリダイレクトしたい。
対応ブラウザ:
WindowsMacLinux
IE4 IE5 IE5.5 IE6 NS4 NS6 NS7 MZ1 OP7 IE5 NS7 MZ1 NS7 MZ1
関数一覧(先頭)へ移動 [W・O]   |   スクロール位置回復 [N]





ページの先頭へ     

前のページへ
次のページへ
【関連リンク】
・JavaScript小技集
KeyNavi API リファレンス 目次 【数字キーでアクセス】
1. 目次
2. 基本編
3. KeyNaviカスタマイズ用定数
4. KeyNaviユティリティ関数
4.1 設定ウィンドウ
4.2 使い方ウィンドウ
4.3 メイン処理
4.4 KeyNaviイベントハンドラ
4.5 KeyNavi拡張用関数
4.6 その他
5. イベント処理
6. ナビゲーション
7. レイヤー処理
8. その他
9. 定数・関数一覧


ホーム KeyNavi対応方法 [0] API リファレンス 目次 [1] 4. KeyNaviユティリティ関数 ・サイトマップ [Shift-S]
■キー割当表示 [Shift-H] ─ KeyNavi Project 2003 ─