8
0

widgetresize.js 7.6 KB

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