@maxgraph/core/lib/esm/editor/EditorKeyHandler.d.ts

maxGraph is a fully client side JavaScript diagramming library that uses SVG and HTML for rendering.

import KeyHandler from '../view/handler/KeyHandler.js';
import Editor from './Editor.js';
/**
 * Binds keycodes to action names in an editor.
 *
 * This aggregates an internal {@link handler} and extends the implementation of {@link KeyHandler.escape} to not only cancel the editing,
 * but also hide the properties dialog and fire an {@link InternalEvent.ESCAPE} event via {@link editor}.
 *
 * An instance of this class is created by {@link Editor} and stored in {@link Editor.keyHandler}.
 *
 * ### Example
 * Bind the delete key to the delete action in an existing editor.
 * ```javascript
 * const keyHandler = new EditorKeyHandler(editor);
 * keyHandler.bindAction(46, 'delete');
 * ```
 *
 * ### Codec
 * This class uses the {@link EditorKeyHandlerCodec} to read configuration data into an existing instance.  See {@link EditorKeyHandlerCodec} for a description of the configuration format.
 *
 * ### Keycodes
 * See {@link KeyHandler}.
 * An {@link InternalEvent.ESCAPE} event is fired via the editor if the escape key is pressed.
 *
 * @category Editor
 */
export declare class EditorKeyHandler {
    constructor(editor?: Editor | null);
    /**
     * Reference to the enclosing {@link Editor}.
     */
    editor: Editor | null;
    /**
     * Holds the {@link KeyHandler} for key event handling.
     */
    handler: KeyHandler | null;
    /**
     * Binds the specified keycode to the given action in {@link editor}.  The optional control flag specifies if the control key must be pressed to trigger the action.
     *
     * @param code      Integer that specifies the keycode.
     * @param action    Name of the action to execute in {@link editor}.
     * @param control   Optional boolean that specifies if control must be pressed.  Default is false.
     */
    bindAction(code: number, action: string, control?: boolean): void;
    /**
     * Destroys the {@link handler} associated with this object.  This does normally not need to be called, the {@link handler} is destroyed automatically when the window unloads (in IE) by {@link Editor}.
     */
    destroy(): void;
}
export default EditorKeyHandler;