@eclipse-scout/core/src/keystroke/Key.ts

Eclipse Scout runtime

/*
 * Copyright (c) 2010, 2023 BSI Business Systems Integration AG
 *
 * This program and the accompanying materials are made
 * available under the terms of the Eclipse Public License 2.0
 * which is available at https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 */
import {keys, KeyStroke, KeyStrokeMode, ScoutKeyboardEvent} from '../index';

export class Key {
  keyStroke: KeyStroke;
  which: number;
  ctrl: boolean;
  alt: boolean;
  shift: boolean;
  keyStrokeMode: KeyStrokeMode;
  $drawingArea: JQuery;

  constructor(keyStroke: KeyStroke, which?: number) {
    this.keyStroke = keyStroke;
    this.which = which;
    this.ctrl = keyStroke.ctrl;
    this.alt = keyStroke.alt;
    this.shift = keyStroke.shift;
    this.keyStrokeMode = keyStroke.keyStrokeMode;
  }

  render($drawingArea: JQuery, event: ScoutKeyboardEvent): boolean {
    this.$drawingArea = this.keyStroke.renderKeyBox($drawingArea, event);
    return !!this.$drawingArea;
  }

  remove() {
    this.keyStroke.removeKeyBox(this.$drawingArea);
    this.$drawingArea = null;
  }

  toKeyStrokeString(): string {
    let keyStroke = '';
    if (this.ctrl) {
      keyStroke += 'Ctrl-';
    }
    if (this.alt) {
      keyStroke += 'Alt-';
    }
    if (this.shift) {
      keyStroke += 'Shift-';
    }
    let key = keys.codesToKeys[this.which];
    if (key === undefined) {
      key = this.which;
    }
    keyStroke += key;
    return keyStroke;
  }
}