Ver Fonte

KeystrokeHandler initial implementation.

Piotrek Koszuliński há 9 anos atrás
pai
commit
2afad5563e
3 ficheiros alterados com 85 adições e 1 exclusões
  1. 3 1
      src/creator/standardcreator.js
  2. 9 0
      src/editor.js
  3. 73 0
      src/keystrokehandler.js

+ 3 - 1
src/creator/standardcreator.js

@@ -6,11 +6,12 @@
 'use strict';
 
 import Creator from './creator.js';
-
 import Document from '../engine/model/document.js';
 import DataController from '../engine/datacontroller.js';
 import EditingController from '../engine/editingcontroller.js';
 import HtmlDataProcessor from '../engine/dataprocessor/htmldataprocessor.js';
+import KeystrokeHandler from '../keystrokehandler.js';
+
 /**
  * Standard creator for browser environment.
  *
@@ -34,6 +35,7 @@ export default class StandardCreator extends Creator {
 		editor.document = new Document();
 		editor.editing = new EditingController( editor.document );
 		editor.data = new DataController( editor.document, dataProcessor );
+		editor.keystrokes = new KeystrokeHandler( editor );
 
 		/**
 		 * The elements replaced by {@link ckeditor5.creator.StandardCreator#_replaceElement} and their replacements.

+ 9 - 0
src/editor.js

@@ -122,6 +122,15 @@ export default class Editor {
 		 * @member {engine.DataController} ckeditor5.Editor#data
 		 */
 
+		/**
+		 * Instance of the {@link ckeditor5.KeystrokeHandler}.
+		 *
+		 * This property is set by the {@link ckeditor5.creator.Creator}.
+		 *
+		 * @readonly
+		 * @member {engine.treecontroller.DataController} ckeditor5.Editor#keystrokes
+		 */
+
 		/**
 		 * The chosen creator.
 		 *

+ 73 - 0
src/keystrokehandler.js

@@ -0,0 +1,73 @@
+/**
+ * @license Copyright (c) 2003-2016, CKSource - Frederico Knabben. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
+
+'use strict';
+
+import EmitterMixin from './utils/emittermixin.js';
+import KeyObserver from './engine/treeview/observer/keyobserver.js';
+import { getCode, parseKeystroke } from './utils/keyboard.js';
+
+/**
+ * Keystroke handler.
+ *
+ * @memberOf ckeditor5
+ */
+export default class KeystrokeHandler {
+	/**
+	 * @param {engine.treeView.TreeView} editingView
+	 */
+	constructor( editor ) {
+		this.editor = editor;
+
+		this._observer = Object.create( EmitterMixin );
+		this._keystrokes = new Map();
+
+		editor.editing.view.addObserver( KeyObserver );
+		this._observer.listenTo( editor.editing.view, 'keydown', ( evt, data ) => {
+			const handled = this.press( data );
+
+			if ( handled ) {
+				data.preventDefault();
+			}
+		} );
+	}
+
+	/**
+	 * @param {String|Array.<String|Number>} keystroke Keystroke defined in a format accepted by
+	 * the {@link utils.keyboard.parseKeystroke} function.
+	 * @param {String|Function} callback If a string is passed, then the keystroke will trigger a command.
+	 * If a function, then it will be called with the {@link {utils.keyboard.KeystrokeInfo keystroke info} object.
+	 */
+	add( keystroke, callback ) {
+		this._keystrokes.set( parseKeystroke( keystroke ), callback );
+	}
+
+	/**
+	 *
+	 * @param {utils.keyboard.KeystrokeInfo} keystrokeInfo Keystroke info object.
+	 * @returns {Boolean} Whether the keystroke was handled.
+	 */
+	press( keystrokeInfo ) {
+		const keyCode = getCode( keystrokeInfo );
+		const callback = this._keystrokes.get( keyCode );
+
+		if ( !callback ) {
+			return false;
+		}
+
+		if ( typeof callback == 'string' ) {
+			this.editor.execute( callback );
+		} else {
+			callback( keystrokeInfo );
+		}
+
+		return true;
+	}
+
+	destroy() {
+		this._keystrokes = new Map();
+		this._observer.stopListening();
+	}
+}