@eclipse-scout/core/src/keystroke/KeyStrokeContextOptions.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 {KeyStroke, ScoutKeyboardEvent} from '../index';

export interface KeyStrokeContextOptions {
  /**
   * Indicates whether to invoke 'acceptInput' on a currently focused value field prior handling the keystroke.
   */
  invokeAcceptInputOnActiveValueField?: boolean;
  /**
   * Holds the keystrokes registered within this context.
   */
  keyStrokes?: KeyStroke[];
  /**
   * Array of interceptors to participate in setting 'stop propagation' flags.
   */
  stopPropagationInterceptors?: ((event: ScoutKeyboardEvent) => void)[];
  /**
   * Holds the target where to bind this context as keydown listener.
   * This can either be a static value or a function to resolve the target.
   */
  $bindTarget?: JQuery | (() => JQuery);
  /**
   * Holds the scope of this context and is used to determine the context's accessibility, meaning not covert by a glasspane.
   * This can either be a static value or a function to resolve the target.
   */
  $scopeTarget?: JQuery | (() => JQuery);
}