widgetresize.js 8.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287
  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/widgetresize
  7. */
  8. import Plugin from '@ckeditor/ckeditor5-core/src/plugin';
  9. import Resizer from './widgetresize/resizer';
  10. import DomEmitterMixin from '@ckeditor/ckeditor5-utils/src/dom/emittermixin';
  11. import global from '@ckeditor/ckeditor5-utils/src/dom/global';
  12. import ObservableMixin from '@ckeditor/ckeditor5-utils/src/observablemixin';
  13. import MouseObserver from '@ckeditor/ckeditor5-engine/src/view/observer/mouseobserver';
  14. import mix from '@ckeditor/ckeditor5-utils/src/mix';
  15. import { throttle } from 'lodash-es';
  16. import '../theme/widgetresize.css';
  17. /**
  18. * The widget resize feature plugin.
  19. *
  20. * Use the {@link module:widget/widgetresize~WidgetResize#attachTo} method to create a resizer for the specified widget.
  21. *
  22. * @extends module:core/plugin~Plugin
  23. * @mixes module:utils/observablemixin~ObservableMixin
  24. */
  25. export default class WidgetResize extends Plugin {
  26. /**
  27. * @inheritDoc
  28. */
  29. static get pluginName() {
  30. return 'WidgetResize';
  31. }
  32. /**
  33. * @inheritDoc
  34. */
  35. init() {
  36. /**
  37. * The currently visible resizer.
  38. *
  39. * @observable
  40. * @member {module:widget/widgetresize/resizer~Resizer|null} #visibleResizer
  41. */
  42. this.set( 'visibleResizer', null );
  43. /**
  44. * References an active resizer.
  45. *
  46. * Active resizer means a resizer which handle is actively used by the end user.
  47. *
  48. * @protected
  49. * @observable
  50. * @member {module:widget/widgetresize/resizer~Resizer|null} #_activeResizer
  51. */
  52. this.set( '_activeResizer', null );
  53. /**
  54. * A map of resizers created using this plugin instance.
  55. *
  56. * @private
  57. * @type {Map.<module:engine/view/containerelement~ContainerElement, module:widget/widgetresize/resizer~Resizer>}
  58. */
  59. this._resizers = new Map();
  60. const domDocument = global.window.document;
  61. this.editor.model.schema.setAttributeProperties( 'width', {
  62. isFormatting: true
  63. } );
  64. this.editor.editing.view.addObserver( MouseObserver );
  65. this._observer = Object.create( DomEmitterMixin );
  66. this.listenTo( this.editor.editing.view.document, 'mousedown', this._mouseDownListener.bind( this ), { priority: 'high' } );
  67. this._observer.listenTo( domDocument, 'mousemove', this._mouseMoveListener.bind( this ) );
  68. this._observer.listenTo( domDocument, 'mouseup', this._mouseUpListener.bind( this ) );
  69. const redrawFocusedResizer = () => {
  70. if ( this.visibleResizer ) {
  71. this.visibleResizer.redraw();
  72. }
  73. };
  74. const redrawFocusedResizerThrottled = throttle( redrawFocusedResizer, 200 );
  75. // Redraws occurring upon a change of visible resizer must not be throttled, as it is crucial for the initial
  76. // render. Without it the resizer frame would be misaligned with resizing host for a fraction of second.
  77. this.on( 'change:visibleResizer', redrawFocusedResizer );
  78. // Redrawing on any change of the UI of the editor (including content changes).
  79. this.editor.ui.on( 'update', redrawFocusedResizerThrottled );
  80. // Resizers need to be redrawn upon window resize, because new window might shrink resize host.
  81. this._observer.listenTo( global.window, 'resize', redrawFocusedResizerThrottled );
  82. const viewSelection = this.editor.editing.view.document.selection;
  83. viewSelection.on( 'change', () => {
  84. const selectedElement = viewSelection.getSelectedElement();
  85. this.visibleResizer = this.getResizerByViewElement( selectedElement ) || null;
  86. } );
  87. }
  88. /**
  89. * @inheritDoc
  90. */
  91. destroy() {
  92. this._observer.stopListening();
  93. for ( const resizer of this._resizers.values() ) {
  94. resizer.destroy();
  95. }
  96. }
  97. /**
  98. * @param {module:widget/widgetresize~ResizerOptions} [options] Resizer options.
  99. * @returns {module:widget/widgetresize/resizer~Resizer}
  100. */
  101. attachTo( options ) {
  102. const resizer = new Resizer( options );
  103. const plugins = this.editor.plugins;
  104. resizer.attach();
  105. if ( plugins.has( 'WidgetToolbarRepository' ) ) {
  106. // Hiding widget toolbar to improve the performance
  107. // (https://github.com/ckeditor/ckeditor5-widget/pull/112#issuecomment-564528765).
  108. const widgetToolbarRepository = plugins.get( 'WidgetToolbarRepository' );
  109. resizer.on( 'begin', () => {
  110. widgetToolbarRepository.forceDisabled( 'resize' );
  111. }, { priority: 'lowest' } );
  112. resizer.on( 'cancel', () => {
  113. widgetToolbarRepository.clearForceDisabled( 'resize' );
  114. }, { priority: 'highest' } );
  115. resizer.on( 'commit', () => {
  116. widgetToolbarRepository.clearForceDisabled( 'resize' );
  117. }, { priority: 'highest' } );
  118. }
  119. this._resizers.set( options.viewElement, resizer );
  120. const viewSelection = this.editor.editing.view.document.selection;
  121. const selectedElement = viewSelection.getSelectedElement();
  122. // It could be that the element the resizer is created for is currently focused. In that
  123. // case it should become visible.
  124. if ( this.getResizerByViewElement( selectedElement ) == resizer ) {
  125. this.visibleResizer = resizer;
  126. }
  127. return resizer;
  128. }
  129. /**
  130. * Returns a resizer created for a given view element (widget element).
  131. *
  132. * @param {module:engine/view/containerelement~ContainerElement} viewElement View element associated with the resizer.
  133. * @returns {module:widget/widgetresize/resizer~Resizer|undefined}
  134. */
  135. getResizerByViewElement( viewElement ) {
  136. return this._resizers.get( viewElement );
  137. }
  138. /**
  139. * Returns a resizer that contains a given resize handle.
  140. *
  141. * @protected
  142. * @param {HTMLElement} domResizeHandle
  143. * @returns {module:widget/widgetresize/resizer~Resizer}
  144. */
  145. _getResizerByHandle( domResizeHandle ) {
  146. for ( const resizer of this._resizers.values() ) {
  147. if ( resizer.containsHandle( domResizeHandle ) ) {
  148. return resizer;
  149. }
  150. }
  151. }
  152. /**
  153. * @protected
  154. * @param {module:utils/eventinfo~EventInfo} event
  155. * @param {Event} domEventData Native DOM event.
  156. */
  157. _mouseDownListener( event, domEventData ) {
  158. const resizeHandle = domEventData.domTarget;
  159. if ( !Resizer.isResizeHandle( resizeHandle ) ) {
  160. return;
  161. }
  162. this._activeResizer = this._getResizerByHandle( resizeHandle );
  163. if ( this._activeResizer ) {
  164. this._activeResizer.begin( resizeHandle );
  165. // Do not call other events when resizing. See: #6755.
  166. event.stop();
  167. domEventData.preventDefault();
  168. }
  169. }
  170. /**
  171. * @protected
  172. * @param {module:utils/eventinfo~EventInfo} event
  173. * @param {Event} domEventData Native DOM event.
  174. */
  175. _mouseMoveListener( event, domEventData ) {
  176. if ( this._activeResizer ) {
  177. this._activeResizer.updateSize( domEventData );
  178. }
  179. }
  180. /**
  181. * @protected
  182. */
  183. _mouseUpListener() {
  184. if ( this._activeResizer ) {
  185. this._activeResizer.commit();
  186. this._activeResizer = null;
  187. }
  188. }
  189. }
  190. mix( WidgetResize, ObservableMixin );
  191. /**
  192. * Interface describing a resizer. It allows to specify the resizing host, custom logic for calculating aspect ratio, etc.
  193. *
  194. * @interface ResizerOptions
  195. */
  196. /**
  197. * Editor instance associated with the resizer.
  198. *
  199. * @member {module:core/editor/editor~Editor} module:widget/widgetresize~ResizerOptions#editor
  200. */
  201. /**
  202. * @member {module:engine/model/element~Element} module:widget/widgetresize~ResizerOptions#modelElement
  203. */
  204. /**
  205. * A view of an element to be resized. Typically it's the main widget's view instance.
  206. *
  207. * @member {module:engine/view/containerelement~ContainerElement} module:widget/widgetresize~ResizerOptions#viewElement
  208. */
  209. /**
  210. * A callback to be executed once the resizing process is done.
  211. *
  212. * It receives a `Number` (`newValue`) as a parameter.
  213. *
  214. * For example, {@link module:image/imageresize~ImageResize} uses it to execute the image resize command
  215. * which puts the new value into the model.
  216. *
  217. * ```js
  218. * {
  219. * editor,
  220. * modelElement: data.item,
  221. * viewElement: widget,
  222. *
  223. * onCommit( newValue ) {
  224. * editor.execute( 'imageResize', { width: newValue } );
  225. * }
  226. * };
  227. * ```
  228. *
  229. *
  230. * @member {Function} module:widget/widgetresize~ResizerOptions#onCommit
  231. */
  232. /**
  233. * @member {Function} module:widget/widgetresize~ResizerOptions#getResizeHost
  234. */
  235. /**
  236. * @member {Function} module:widget/widgetresize~ResizerOptions#isCentered
  237. */