8
0

widgetresize.js 7.3 KB

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