8
0

widget.js 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410
  1. /**
  2. * @license Copyright (c) 2003-2020, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  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 WidgetTypeAround from './widgettypearound/widgettypearound';
  11. import { getLabel, isWidget, WIDGET_SELECTED_CLASS_NAME } from './utils';
  12. import {
  13. isArrowKeyCode,
  14. isForwardArrowKeyCode
  15. } from '@ckeditor/ckeditor5-utils/src/keyboard';
  16. import env from '@ckeditor/ckeditor5-utils/src/env';
  17. import '../theme/widget.css';
  18. import priorities from '@ckeditor/ckeditor5-utils/src/priorities';
  19. import verticalNavigationHandler from './verticalnavigation';
  20. /**
  21. * The widget plugin. It enables base support for widgets.
  22. *
  23. * See {@glink api/widget package page} for more details and documentation.
  24. *
  25. * This plugin enables multiple behaviors required by widgets:
  26. *
  27. * * The model to view selection converter for the editing pipeline (it handles widget custom selection rendering).
  28. * If a converted selection wraps around a widget element, that selection is marked as
  29. * {@link module:engine/view/selection~Selection#isFake fake}. Additionally, the `ck-widget_selected` CSS class
  30. * is added to indicate that widget has been selected.
  31. * * The mouse and keyboard events handling on and around widget elements.
  32. *
  33. * @extends module:core/plugin~Plugin
  34. */
  35. export default class Widget extends Plugin {
  36. /**
  37. * @inheritDoc
  38. */
  39. static get pluginName() {
  40. return 'Widget';
  41. }
  42. /**
  43. * @inheritDoc
  44. */
  45. static get requires() {
  46. return [ WidgetTypeAround ];
  47. }
  48. /**
  49. * @inheritDoc
  50. */
  51. init() {
  52. const view = this.editor.editing.view;
  53. const viewDocument = view.document;
  54. /**
  55. * Holds previously selected widgets.
  56. *
  57. * @private
  58. * @type {Set.<module:engine/view/element~Element>}
  59. */
  60. this._previouslySelected = new Set();
  61. // Model to view selection converter.
  62. // Converts selection placed over widget element to fake selection
  63. this.editor.editing.downcastDispatcher.on( 'selection', ( evt, data, conversionApi ) => {
  64. // Remove selected class from previously selected widgets.
  65. this._clearPreviouslySelectedWidgets( conversionApi.writer );
  66. const viewWriter = conversionApi.writer;
  67. const viewSelection = viewWriter.document.selection;
  68. const selectedElement = viewSelection.getSelectedElement();
  69. let lastMarked = null;
  70. for ( const range of viewSelection.getRanges() ) {
  71. for ( const value of range ) {
  72. const node = value.item;
  73. // Do not mark nested widgets in selected one. See: #57.
  74. if ( isWidget( node ) && !isChild( node, lastMarked ) ) {
  75. viewWriter.addClass( WIDGET_SELECTED_CLASS_NAME, node );
  76. this._previouslySelected.add( node );
  77. lastMarked = node;
  78. // Check if widget is a single element selected.
  79. if ( node == selectedElement ) {
  80. viewWriter.setSelection( viewSelection.getRanges(), { fake: true, label: getLabel( selectedElement ) } );
  81. }
  82. }
  83. }
  84. }
  85. }, { priority: 'low' } );
  86. // If mouse down is pressed on widget - create selection over whole widget.
  87. view.addObserver( MouseObserver );
  88. this.listenTo( viewDocument, 'mousedown', ( ...args ) => this._onMousedown( ...args ) );
  89. // There are two keydown listeners working on different priorities. This allows other
  90. // features such as WidgetTypeAround or TableKeyboard to attach their listeners in between
  91. // and customize the behavior even further in different content/selection scenarios.
  92. //
  93. // * The first listener handles changing the selection on arrow key press
  94. // if the widget is selected or if the selection is next to a widget and the widget
  95. // should become selected upon the arrow key press.
  96. //
  97. // * The second (late) listener makes sure the default browser action on arrow key press is
  98. // prevented when a widget is selected. This prevents the selection from being moved
  99. // from a fake selection container.
  100. this.listenTo( viewDocument, 'keydown', ( ...args ) => {
  101. this._handleSelectionChangeOnArrowKeyPress( ...args );
  102. }, { priority: 'high' } );
  103. this.listenTo( viewDocument, 'keydown', ( ...args ) => {
  104. this._preventDefaultOnArrowKeyPress( ...args );
  105. }, { priority: priorities.get( 'high' ) - 20 } );
  106. this.listenTo( viewDocument, 'keydown', verticalNavigationHandler( this.editor.editing ) );
  107. // Handle custom delete behaviour.
  108. this.listenTo( viewDocument, 'delete', ( evt, data ) => {
  109. if ( this._handleDelete( data.direction == 'forward' ) ) {
  110. data.preventDefault();
  111. evt.stop();
  112. }
  113. }, { priority: 'high' } );
  114. }
  115. /**
  116. * Handles {@link module:engine/view/document~Document#event:mousedown mousedown} events on widget elements.
  117. *
  118. * @private
  119. * @param {module:utils/eventinfo~EventInfo} eventInfo
  120. * @param {module:engine/view/observer/domeventdata~DomEventData} domEventData
  121. */
  122. _onMousedown( eventInfo, domEventData ) {
  123. const editor = this.editor;
  124. const view = editor.editing.view;
  125. const viewDocument = view.document;
  126. let element = domEventData.target;
  127. // Do nothing for single or double click inside nested editable.
  128. if ( isInsideNestedEditable( element ) ) {
  129. // But at least triple click inside nested editable causes broken selection in Safari.
  130. // For such event, we select the entire nested editable element.
  131. // See: https://github.com/ckeditor/ckeditor5/issues/1463.
  132. if ( ( env.isSafari || env.isGecko ) && domEventData.domEvent.detail >= 3 ) {
  133. const mapper = editor.editing.mapper;
  134. const viewElement = element.is( 'attributeElement' ) ?
  135. element.findAncestor( element => !element.is( 'attributeElement' ) ) : element;
  136. const modelElement = mapper.toModelElement( viewElement );
  137. domEventData.preventDefault();
  138. this.editor.model.change( writer => {
  139. writer.setSelection( modelElement, 'in' );
  140. } );
  141. }
  142. return;
  143. }
  144. // If target is not a widget element - check if one of the ancestors is.
  145. if ( !isWidget( element ) ) {
  146. element = element.findAncestor( isWidget );
  147. if ( !element ) {
  148. return;
  149. }
  150. }
  151. domEventData.preventDefault();
  152. // Focus editor if is not focused already.
  153. if ( !viewDocument.isFocused ) {
  154. view.focus();
  155. }
  156. // Create model selection over widget.
  157. const modelElement = editor.editing.mapper.toModelElement( element );
  158. this._setSelectionOverElement( modelElement );
  159. }
  160. /**
  161. * Handles {@link module:engine/view/document~Document#event:keydown keydown} events and changes
  162. * the model selection when:
  163. *
  164. * * arrow key is pressed when the widget is selected,
  165. * * the selection is next to a widget and the widget should become selected upon the arrow key press.
  166. *
  167. * See {@link #_preventDefaultOnArrowKeyPress}.
  168. *
  169. * @private
  170. * @param {module:utils/eventinfo~EventInfo} eventInfo
  171. * @param {module:engine/view/observer/domeventdata~DomEventData} domEventData
  172. */
  173. _handleSelectionChangeOnArrowKeyPress( eventInfo, domEventData ) {
  174. const keyCode = domEventData.keyCode;
  175. // Checks if the keys were handled and then prevents the default event behaviour and stops
  176. // the propagation.
  177. if ( !isArrowKeyCode( keyCode ) ) {
  178. return;
  179. }
  180. const model = this.editor.model;
  181. const schema = model.schema;
  182. const modelSelection = model.document.selection;
  183. const objectElement = modelSelection.getSelectedElement();
  184. const isForward = isForwardArrowKeyCode( keyCode, this.editor.locale.contentLanguageDirection );
  185. // If object element is selected.
  186. if ( objectElement && schema.isObject( objectElement ) ) {
  187. const position = isForward ? modelSelection.getLastPosition() : modelSelection.getFirstPosition();
  188. const newRange = schema.getNearestSelectionRange( position, isForward ? 'forward' : 'backward' );
  189. if ( newRange ) {
  190. model.change( writer => {
  191. writer.setSelection( newRange );
  192. } );
  193. domEventData.preventDefault();
  194. eventInfo.stop();
  195. }
  196. return;
  197. }
  198. // If selection is next to object element.
  199. // Return if not collapsed.
  200. if ( !modelSelection.isCollapsed ) {
  201. return;
  202. }
  203. const objectElementNextToSelection = this._getObjectElementNextToSelection( isForward );
  204. if ( objectElementNextToSelection && schema.isObject( objectElementNextToSelection ) ) {
  205. this._setSelectionOverElement( objectElementNextToSelection );
  206. domEventData.preventDefault();
  207. eventInfo.stop();
  208. }
  209. }
  210. /**
  211. * Handles {@link module:engine/view/document~Document#event:keydown keydown} events and prevents
  212. * the default browser behavior to make sure the fake selection is not being moved from a fake selection
  213. * container.
  214. *
  215. * See {@link #_handleSelectionChangeOnArrowKeyPress}.
  216. *
  217. * @private
  218. * @param {module:utils/eventinfo~EventInfo} eventInfo
  219. * @param {module:engine/view/observer/domeventdata~DomEventData} domEventData
  220. */
  221. _preventDefaultOnArrowKeyPress( eventInfo, domEventData ) {
  222. const keyCode = domEventData.keyCode;
  223. // Checks if the keys were handled and then prevents the default event behaviour and stops
  224. // the propagation.
  225. if ( !isArrowKeyCode( keyCode ) ) {
  226. return;
  227. }
  228. const model = this.editor.model;
  229. const schema = model.schema;
  230. const objectElement = model.document.selection.getSelectedElement();
  231. // If object element is selected.
  232. if ( objectElement && schema.isObject( objectElement ) ) {
  233. domEventData.preventDefault();
  234. eventInfo.stop();
  235. }
  236. }
  237. /**
  238. * Handles delete keys: backspace and delete.
  239. *
  240. * @private
  241. * @param {Boolean} isForward Set to true if delete was performed in forward direction.
  242. * @returns {Boolean|undefined} Returns `true` if keys were handled correctly.
  243. */
  244. _handleDelete( isForward ) {
  245. // Do nothing when the read only mode is enabled.
  246. if ( this.editor.isReadOnly ) {
  247. return;
  248. }
  249. const modelDocument = this.editor.model.document;
  250. const modelSelection = modelDocument.selection;
  251. // Do nothing on non-collapsed selection.
  252. if ( !modelSelection.isCollapsed ) {
  253. return;
  254. }
  255. const objectElement = this._getObjectElementNextToSelection( isForward );
  256. if ( objectElement ) {
  257. this.editor.model.change( writer => {
  258. let previousNode = modelSelection.anchor.parent;
  259. // Remove previous element if empty.
  260. while ( previousNode.isEmpty ) {
  261. const nodeToRemove = previousNode;
  262. previousNode = nodeToRemove.parent;
  263. writer.remove( nodeToRemove );
  264. }
  265. this._setSelectionOverElement( objectElement );
  266. } );
  267. return true;
  268. }
  269. }
  270. /**
  271. * Sets {@link module:engine/model/selection~Selection document's selection} over given element.
  272. *
  273. * @protected
  274. * @param {module:engine/model/element~Element} element
  275. */
  276. _setSelectionOverElement( element ) {
  277. this.editor.model.change( writer => {
  278. writer.setSelection( writer.createRangeOn( element ) );
  279. } );
  280. }
  281. /**
  282. * Checks if {@link module:engine/model/element~Element element} placed next to the current
  283. * {@link module:engine/model/selection~Selection model selection} exists and is marked in
  284. * {@link module:engine/model/schema~Schema schema} as `object`.
  285. *
  286. * @protected
  287. * @param {Boolean} forward Direction of checking.
  288. * @returns {module:engine/model/element~Element|null}
  289. */
  290. _getObjectElementNextToSelection( forward ) {
  291. const model = this.editor.model;
  292. const schema = model.schema;
  293. const modelSelection = model.document.selection;
  294. // Clone current selection to use it as a probe. We must leave default selection as it is so it can return
  295. // to its current state after undo.
  296. const probe = model.createSelection( modelSelection );
  297. model.modifySelection( probe, { direction: forward ? 'forward' : 'backward' } );
  298. const objectElement = forward ? probe.focus.nodeBefore : probe.focus.nodeAfter;
  299. if ( !!objectElement && schema.isObject( objectElement ) ) {
  300. return objectElement;
  301. }
  302. return null;
  303. }
  304. /**
  305. * Removes CSS class from previously selected widgets.
  306. *
  307. * @private
  308. * @param {module:engine/view/downcastwriter~DowncastWriter} writer
  309. */
  310. _clearPreviouslySelectedWidgets( writer ) {
  311. for ( const widget of this._previouslySelected ) {
  312. writer.removeClass( WIDGET_SELECTED_CLASS_NAME, widget );
  313. }
  314. this._previouslySelected.clear();
  315. }
  316. }
  317. // Returns `true` when element is a nested editable or is placed inside one.
  318. //
  319. // @param {module:engine/view/element~Element}
  320. // @returns {Boolean}
  321. function isInsideNestedEditable( element ) {
  322. while ( element ) {
  323. if ( element.is( 'editableElement' ) && !element.is( 'rootElement' ) ) {
  324. return true;
  325. }
  326. // Click on nested widget should select it.
  327. if ( isWidget( element ) ) {
  328. return false;
  329. }
  330. element = element.parent;
  331. }
  332. return false;
  333. }
  334. // Checks whether the specified `element` is a child of the `parent` element.
  335. //
  336. // @param {module:engine/view/element~Element} element An element to check.
  337. // @param {module:engine/view/element~Element|null} parent A parent for the element.
  338. // @returns {Boolean}
  339. function isChild( element, parent ) {
  340. if ( !parent ) {
  341. return false;
  342. }
  343. return Array.from( element.getAncestors() ).includes( parent );
  344. }