fnc c0007 commonKeyDown - cwtickle/danoniplus GitHub Wiki

← オブジェクトリファレンスに戻る

commonKeyDown

概要

  • キーを押したときの動作を定義。
  • g_shortcutObjより対象画面のショートカットリストを取得し、
    対象キーに合致していれば、その処理を実行する。
  • ショートカット処理とは別に実行したい内容を_func内で定義することも可能。

引数（括弧内はデフォルト値）

引数 型 必須 指定内容
_evt object * イベントオブジェクト
_displayName string * 画面名(g_shortcutObjで定義したプロパティ名)
_func function 後続処理（任意）
_dfEvtFlg boolean 表示している画面でブラウザが採用しているショートカットキー操作を有効にするかどうか。例えばF5リロード、F1ヘルプなど。デフォルトはfalse(無効にする)。※WindowsキーなどOS既存のものは無効化されない。

返却値

  • イベントの真偽値 (イベント実行時はtrue, キャンセルする場合はfalse)

使用例

// この部分の既定値は danoni_constants.js で定義
// 拡張が必要な場合、danoni_settings.js などで定義することもできる
const g_shortcutObj = {
    keyConfig: {
        Escape: { id: `btnBack` },
    },
};

// この場合は g_shortcutObj.keyConfig が対象
// Escapeキーが押されたら、id: btnBackのボタンを実行する
document.onkeydown = evt => commonKeyDown(evt, `keyConfig`, setCode => {
  // ショートカット以外の独自処理
};

関連項目

更新履歴

Version 変更内容
v27.6.0 ・引数に_dfEvtFlgを追加
v19.5.0 ・初回実装