widget.js 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387
  1. /**
  2. * @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. /**
  6. * @module widget/widget
  7. */
  8. import Plugin from '@ckeditor/ckeditor5-core/src/plugin';
  9. import MouseObserver from '@ckeditor/ckeditor5-engine/src/view/observer/mouseobserver';
  10. import ModelRange from '@ckeditor/ckeditor5-engine/src/model/range';
  11. import ModelSelection from '@ckeditor/ckeditor5-engine/src/model/selection';
  12. import ModelElement from '@ckeditor/ckeditor5-engine/src/model/element';
  13. import ViewEditableElement from '@ckeditor/ckeditor5-engine/src/view/editableelement';
  14. import RootEditableElement from '@ckeditor/ckeditor5-engine/src/view/rooteditableelement';
  15. import { isWidget, WIDGET_SELECTED_CLASS_NAME, getLabel } from './utils';
  16. import { keyCodes, getCode, parseKeystroke } from '@ckeditor/ckeditor5-utils/src/keyboard';
  17. import '../theme/widget.css';
  18. const selectAllKeystrokeCode = parseKeystroke( 'Ctrl+A' );
  19. /**
  20. * The widget plugin.
  21. * Registers model to view selection converter for editing pipeline. It is hooked after default selection conversion.
  22. * If converted selection is placed around widget element, selection is marked as fake. Additionally, proper CSS class
  23. * is added to indicate that widget has been selected.
  24. * Adds default {@link module:engine/view/document~Document#event:mousedown mousedown} handling on widget elements.
  25. *
  26. * @extends module:core/plugin~Plugin.
  27. */
  28. export default class Widget extends Plugin {
  29. /**
  30. * @inheritDoc
  31. */
  32. static get pluginName() {
  33. return 'Widget';
  34. }
  35. /**
  36. * @inheritDoc
  37. */
  38. init() {
  39. const viewDocument = this.editor.editing.view;
  40. /**
  41. * Holds previously selected widgets.
  42. *
  43. * @private
  44. * @type {Set.<module:engine/view/element~Element>}
  45. */
  46. this._previouslySelected = new Set();
  47. // Model to view selection converter.
  48. // Converts selection placed over widget element to fake selection
  49. this.editor.editing.modelToView.on( 'selection', ( evt, data, consumable, conversionApi ) => {
  50. // Remove selected class from previously selected widgets.
  51. this._clearPreviouslySelectedWidgets();
  52. const viewSelection = conversionApi.viewSelection;
  53. const selectedElement = viewSelection.getSelectedElement();
  54. for ( const range of viewSelection.getRanges() ) {
  55. for ( const value of range ) {
  56. const node = value.item;
  57. if ( node.is( 'element' ) && isWidget( node ) ) {
  58. node.addClass( WIDGET_SELECTED_CLASS_NAME );
  59. this._previouslySelected.add( node );
  60. // Check if widget is a single element selected.
  61. if ( node == selectedElement ) {
  62. viewSelection.setFake( true, { label: getLabel( selectedElement ) } );
  63. }
  64. }
  65. }
  66. }
  67. }, { priority: 'low' } );
  68. // If mouse down is pressed on widget - create selection over whole widget.
  69. viewDocument.addObserver( MouseObserver );
  70. this.listenTo( viewDocument, 'mousedown', ( ...args ) => this._onMousedown( ...args ) );
  71. // Handle custom keydown behaviour.
  72. this.listenTo( viewDocument, 'keydown', ( ...args ) => this._onKeydown( ...args ), { priority: 'high' } );
  73. // Handle custom delete behaviour.
  74. this.listenTo( viewDocument, 'delete', ( evt, data ) => {
  75. if ( this._handleDelete( data.direction == 'forward' ) ) {
  76. data.preventDefault();
  77. evt.stop();
  78. }
  79. }, { priority: 'high' } );
  80. }
  81. /**
  82. * Handles {@link module:engine/view/document~Document#event:mousedown mousedown} events on widget elements.
  83. *
  84. * @private
  85. * @param {module:utils/eventinfo~EventInfo} eventInfo
  86. * @param {module:engine/view/observer/domeventdata~DomEventData} domEventData
  87. */
  88. _onMousedown( eventInfo, domEventData ) {
  89. const editor = this.editor;
  90. const viewDocument = editor.editing.view;
  91. let element = domEventData.target;
  92. // Do nothing if inside nested editable.
  93. if ( isInsideNestedEditable( element ) ) {
  94. return;
  95. }
  96. // If target is not a widget element - check if one of the ancestors is.
  97. if ( !isWidget( element ) ) {
  98. element = element.findAncestor( isWidget );
  99. if ( !element ) {
  100. return;
  101. }
  102. }
  103. domEventData.preventDefault();
  104. // Focus editor if is not focused already.
  105. if ( !viewDocument.isFocused ) {
  106. viewDocument.focus();
  107. }
  108. // Create model selection over widget.
  109. const modelElement = editor.editing.mapper.toModelElement( element );
  110. editor.model.change( () => {
  111. this._setSelectionOverElement( modelElement );
  112. } );
  113. }
  114. /**
  115. * Handles {@link module:engine/view/document~Document#event:keydown keydown} events.
  116. *
  117. * @private
  118. * @param {module:utils/eventinfo~EventInfo} eventInfo
  119. * @param {module:engine/view/observer/domeventdata~DomEventData} domEventData
  120. */
  121. _onKeydown( eventInfo, domEventData ) {
  122. const keyCode = domEventData.keyCode;
  123. const isForward = keyCode == keyCodes.delete || keyCode == keyCodes.arrowdown || keyCode == keyCodes.arrowright;
  124. let wasHandled = false;
  125. // Checks if the keys were handled and then prevents the default event behaviour and stops
  126. // the propagation.
  127. if ( isArrowKeyCode( keyCode ) ) {
  128. wasHandled = this._handleArrowKeys( isForward );
  129. } else if ( isSelectAllKeyCode( domEventData ) ) {
  130. wasHandled = this._selectAllNestedEditableContent() || this._selectAllContent();
  131. }
  132. if ( wasHandled ) {
  133. domEventData.preventDefault();
  134. eventInfo.stop();
  135. }
  136. }
  137. /**
  138. * Handles delete keys: backspace and delete.
  139. *
  140. * @private
  141. * @param {Boolean} isForward Set to true if delete was performed in forward direction.
  142. * @returns {Boolean|undefined} Returns `true` if keys were handled correctly.
  143. */
  144. _handleDelete( isForward ) {
  145. // Do nothing when the read only mode is enabled.
  146. if ( this.editor.isReadOnly ) {
  147. return;
  148. }
  149. const modelDocument = this.editor.model.document;
  150. const modelSelection = modelDocument.selection;
  151. // Do nothing on non-collapsed selection.
  152. if ( !modelSelection.isCollapsed ) {
  153. return;
  154. }
  155. const objectElement = this._getObjectElementNextToSelection( isForward );
  156. if ( objectElement ) {
  157. this.editor.model.change( writer => {
  158. let previousNode = modelSelection.anchor.parent;
  159. // Remove previous element if empty.
  160. while ( previousNode.isEmpty ) {
  161. const nodeToRemove = previousNode;
  162. previousNode = nodeToRemove.parent;
  163. writer.remove( nodeToRemove );
  164. }
  165. this._setSelectionOverElement( objectElement );
  166. } );
  167. return true;
  168. }
  169. }
  170. /**
  171. * Handles arrow keys.
  172. *
  173. * @param {Boolean} isForward Set to true if arrow key should be handled in forward direction.
  174. * @returns {Boolean|undefined} Returns `true` if keys were handled correctly.
  175. */
  176. _handleArrowKeys( isForward ) {
  177. const model = this.editor.model;
  178. const schema = model.schema;
  179. const modelDocument = model.document;
  180. const modelSelection = modelDocument.selection;
  181. const objectElement = modelSelection.getSelectedElement();
  182. // If object element is selected.
  183. if ( objectElement && schema.isObject( objectElement ) ) {
  184. const position = isForward ? modelSelection.getLastPosition() : modelSelection.getFirstPosition();
  185. const newRange = modelDocument.getNearestSelectionRange( position, isForward ? 'forward' : 'backward' );
  186. if ( newRange ) {
  187. model.change( () => {
  188. modelSelection.setRanges( [ newRange ] );
  189. } );
  190. }
  191. return true;
  192. }
  193. // If selection is next to object element.
  194. // Return if not collapsed.
  195. if ( !modelSelection.isCollapsed ) {
  196. return;
  197. }
  198. const objectElement2 = this._getObjectElementNextToSelection( isForward );
  199. if ( objectElement2 instanceof ModelElement && schema.isObject( objectElement2 ) ) {
  200. model.change( () => {
  201. this._setSelectionOverElement( objectElement2 );
  202. } );
  203. return true;
  204. }
  205. }
  206. /**
  207. * Extends the {@link module:engine/model/selection~Selection document's selection} to span the entire
  208. * content of the nested editable if already anchored in one.
  209. *
  210. * See: {@link module:engine/model/schema~Schema#getLimitElement}.
  211. *
  212. * @private
  213. */
  214. _selectAllNestedEditableContent() {
  215. const model = this.editor.model;
  216. const modelSelection = model.document.selection;
  217. const limitElement = model.schema.getLimitElement( modelSelection );
  218. if ( modelSelection.getFirstRange().root == limitElement ) {
  219. return false;
  220. }
  221. model.change( () => {
  222. modelSelection.setIn( limitElement );
  223. } );
  224. return true;
  225. }
  226. /**
  227. * Handles <kbd>CTRL + A</kbd> when widget is selected.
  228. *
  229. * @private
  230. * @returns {Boolean} Returns true if widget was selected and selecting all was handled by this method.
  231. */
  232. _selectAllContent() {
  233. const model = this.editor.model;
  234. const modelSelection = model.document.selection;
  235. const editing = this.editor.editing;
  236. const viewDocument = editing.view;
  237. const viewSelection = viewDocument.selection;
  238. const selectedElement = viewSelection.getSelectedElement();
  239. // Only widget is selected.
  240. // https://github.com/ckeditor/ckeditor5-widget/issues/23
  241. if ( selectedElement && isWidget( selectedElement ) ) {
  242. const widgetParent = editing.mapper.toModelElement( selectedElement.parent );
  243. model.change( () => {
  244. modelSelection.setRanges( [ ModelRange.createIn( widgetParent ) ] );
  245. } );
  246. return true;
  247. }
  248. return false;
  249. }
  250. /**
  251. * Sets {@link module:engine/model/selection~Selection document's selection} over given element.
  252. *
  253. * @private
  254. * @param {module:engine/model/element~Element} element
  255. */
  256. _setSelectionOverElement( element ) {
  257. this.editor.model.document.selection.setRanges( [ ModelRange.createOn( element ) ] );
  258. }
  259. /**
  260. * Checks if {@link module:engine/model/element~Element element} placed next to the current
  261. * {@link module:engine/model/selection~Selection model selection} exists and is marked in
  262. * {@link module:engine/model/schema~Schema schema} as `object`.
  263. *
  264. * @private
  265. * @param {Boolean} forward Direction of checking.
  266. * @returns {module:engine/model/element~Element|null}
  267. */
  268. _getObjectElementNextToSelection( forward ) {
  269. const model = this.editor.model;
  270. const schema = model.schema;
  271. const modelSelection = model.document.selection;
  272. // Clone current selection to use it as a probe. We must leave default selection as it is so it can return
  273. // to its current state after undo.
  274. const probe = ModelSelection.createFromSelection( modelSelection );
  275. model.modifySelection( probe, { direction: forward ? 'forward' : 'backward' } );
  276. const objectElement = forward ? probe.focus.nodeBefore : probe.focus.nodeAfter;
  277. if ( objectElement instanceof ModelElement && schema.isObject( objectElement ) ) {
  278. return objectElement;
  279. }
  280. return null;
  281. }
  282. /**
  283. * Removes CSS class from previously selected widgets.
  284. * @private
  285. */
  286. _clearPreviouslySelectedWidgets() {
  287. for ( const widget of this._previouslySelected ) {
  288. widget.removeClass( WIDGET_SELECTED_CLASS_NAME );
  289. }
  290. this._previouslySelected.clear();
  291. }
  292. }
  293. // Returns 'true' if provided key code represents one of the arrow keys.
  294. //
  295. // @param {Number} keyCode
  296. // @returns {Boolean}
  297. function isArrowKeyCode( keyCode ) {
  298. return keyCode == keyCodes.arrowright ||
  299. keyCode == keyCodes.arrowleft ||
  300. keyCode == keyCodes.arrowup ||
  301. keyCode == keyCodes.arrowdown;
  302. }
  303. // Returns 'true' if provided (DOM) key event data corresponds with the Ctrl+A keystroke.
  304. //
  305. // @param {module:engine/view/observer/keyobserver~KeyEventData} domEventData
  306. // @returns {Boolean}
  307. function isSelectAllKeyCode( domEventData ) {
  308. return getCode( domEventData ) == selectAllKeystrokeCode;
  309. }
  310. // Returns `true` when element is a nested editable or is placed inside one.
  311. //
  312. // @param {module:engine/view/element~Element}
  313. // @returns {Boolean}
  314. function isInsideNestedEditable( element ) {
  315. while ( element ) {
  316. if ( element instanceof ViewEditableElement && !( element instanceof RootEditableElement ) ) {
  317. return true;
  318. }
  319. element = element.parent;
  320. }
  321. return false;
  322. }