| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280 |
- /**
- * @license Copyright (c) 2003-2020, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
- /**
- * @module widget/widgetresize
- */
- import Plugin from '@ckeditor/ckeditor5-core/src/plugin';
- import Resizer from './widgetresize/resizer';
- import DomEmitterMixin from '@ckeditor/ckeditor5-utils/src/dom/emittermixin';
- import global from '@ckeditor/ckeditor5-utils/src/dom/global';
- import ObservableMixin from '@ckeditor/ckeditor5-utils/src/observablemixin';
- import MouseObserver from '@ckeditor/ckeditor5-engine/src/view/observer/mouseobserver';
- import mix from '@ckeditor/ckeditor5-utils/src/mix';
- import { throttle } from 'lodash-es';
- import '../theme/widgetresize.css';
- /**
- * The widget resize feature plugin.
- *
- * Use the {@link module:widget/widgetresize~WidgetResize#attachTo} method to create a resizer for the specified widget.
- *
- * @extends module:core/plugin~Plugin
- * @mixes module:utils/observablemixin~ObservableMixin
- */
- export default class WidgetResize extends Plugin {
- /**
- * @inheritDoc
- */
- static get pluginName() {
- return 'WidgetResize';
- }
- /**
- * @inheritDoc
- */
- init() {
- /**
- * The currently visible resizer.
- *
- * @protected
- * @observable
- * @member {module:widget/widgetresize/resizer~Resizer|null} #_visibleResizer
- */
- this.set( '_visibleResizer', null );
- /**
- * References an active resizer.
- *
- * Active resizer means a resizer which handle is actively used by the end user.
- *
- * @protected
- * @observable
- * @member {module:widget/widgetresize/resizer~Resizer|null} #_activeResizer
- */
- this.set( '_activeResizer', null );
- /**
- * A map of resizers created using this plugin instance.
- *
- * @private
- * @type {Map.<module:engine/view/containerelement~ContainerElement, module:widget/widgetresize/resizer~Resizer>}
- */
- this._resizers = new Map();
- const domDocument = global.window.document;
- this.editor.model.schema.setAttributeProperties( 'width', {
- isFormatting: true
- } );
- this.editor.editing.view.addObserver( MouseObserver );
- this._observer = Object.create( DomEmitterMixin );
- this.listenTo( this.editor.editing.view.document, 'mousedown', this._mouseDownListener.bind( this ), { priority: 'high' } );
- this._observer.listenTo( domDocument, 'mousemove', this._mouseMoveListener.bind( this ) );
- this._observer.listenTo( domDocument, 'mouseup', this._mouseUpListener.bind( this ) );
- const redrawFocusedResizer = () => {
- if ( this._visibleResizer ) {
- this._visibleResizer.redraw();
- }
- };
- const redrawFocusedResizerThrottled = throttle( redrawFocusedResizer, 200 );
- // Redraws occurring upon a change of visible resizer must not be throttled, as it is crucial for the initial
- // render. Without it the resizer frame would be misaligned with resizing host for a fraction of second.
- this.on( 'change:_visibleResizer', redrawFocusedResizer );
- // Redrawing on any change of the UI of the editor (including content changes).
- this.editor.ui.on( 'update', redrawFocusedResizerThrottled );
- // Resizers need to be redrawn upon window resize, because new window might shrink resize host.
- this._observer.listenTo( global.window, 'resize', redrawFocusedResizerThrottled );
- const viewSelection = this.editor.editing.view.document.selection;
- viewSelection.on( 'change', () => {
- const selectedElement = viewSelection.getSelectedElement();
- this._visibleResizer = this._getResizerByViewElement( selectedElement ) || null;
- } );
- }
- /**
- * @inheritDoc
- */
- destroy() {
- this._observer.stopListening();
- for ( const resizer of this._resizers.values() ) {
- resizer.destroy();
- }
- }
- /**
- * @param {module:widget/widgetresize~ResizerOptions} [options] Resizer options.
- * @returns {module:widget/widgetresize/resizer~Resizer}
- */
- attachTo( options ) {
- const resizer = new Resizer( options );
- const plugins = this.editor.plugins;
- resizer.attach();
- if ( plugins.has( 'WidgetToolbarRepository' ) ) {
- // Hiding widget toolbar to improve the performance
- // (https://github.com/ckeditor/ckeditor5-widget/pull/112#issuecomment-564528765).
- const widgetToolbarRepository = plugins.get( 'WidgetToolbarRepository' );
- resizer.on( 'begin', () => {
- widgetToolbarRepository.forceDisabled( 'resize' );
- }, { priority: 'lowest' } );
- resizer.on( 'cancel', () => {
- widgetToolbarRepository.clearForceDisabled( 'resize' );
- }, { priority: 'highest' } );
- resizer.on( 'commit', () => {
- widgetToolbarRepository.clearForceDisabled( 'resize' );
- }, { priority: 'highest' } );
- }
- this._resizers.set( options.viewElement, resizer );
- return resizer;
- }
- /**
- * Returns a resizer that contains a given resize handle.
- *
- * @protected
- * @param {HTMLElement} domResizeHandle
- * @returns {module:widget/widgetresize/resizer~Resizer}
- */
- _getResizerByHandle( domResizeHandle ) {
- for ( const resizer of this._resizers.values() ) {
- if ( resizer.containsHandle( domResizeHandle ) ) {
- return resizer;
- }
- }
- }
- /**
- * Returns a resizer created for a given view element (widget element).
- *
- * @protected
- * @param {module:engine/view/containerelement~ContainerElement} viewElement
- * @returns {module:widget/widgetresize/resizer~Resizer}
- */
- _getResizerByViewElement( viewElement ) {
- return this._resizers.get( viewElement );
- }
- /**
- * @protected
- * @param {module:utils/eventinfo~EventInfo} event
- * @param {Event} domEventData Native DOM event.
- */
- _mouseDownListener( event, domEventData ) {
- const resizeHandle = domEventData.domTarget;
- if ( !Resizer.isResizeHandle( resizeHandle ) ) {
- return;
- }
- this._activeResizer = this._getResizerByHandle( resizeHandle );
- if ( this._activeResizer ) {
- this._activeResizer.begin( resizeHandle );
- // Do not call other events when resizing. See: #6755.
- event.stop();
- domEventData.preventDefault();
- }
- }
- /**
- * @protected
- * @param {module:utils/eventinfo~EventInfo} event
- * @param {Event} domEventData Native DOM event.
- */
- _mouseMoveListener( event, domEventData ) {
- if ( this._activeResizer ) {
- this._activeResizer.updateSize( domEventData );
- }
- }
- /**
- * @protected
- */
- _mouseUpListener() {
- if ( this._activeResizer ) {
- this._activeResizer.commit();
- this._activeResizer = null;
- }
- }
- }
- mix( WidgetResize, ObservableMixin );
- /**
- * Interface describing a resizer. It allows to specify the resizing host, custom logic for calculating aspect ratio, etc.
- *
- * @interface ResizerOptions
- */
- /**
- * Editor instance associated with the resizer.
- *
- * @member {module:core/editor/editor~Editor} module:widget/widgetresize~ResizerOptions#editor
- */
- /**
- * @member {module:engine/model/element~Element} module:widget/widgetresize~ResizerOptions#modelElement
- */
- /**
- * A view of an element to be resized. Typically it's the main widget's view instance.
- *
- * @member {module:engine/view/containerelement~ContainerElement} module:widget/widgetresize~ResizerOptions#viewElement
- */
- /**
- * A callback to be executed once the resizing process is done.
- *
- * It receives a `Number` (`newValue`) as a parameter.
- *
- * For example, {@link module:image/imageresize~ImageResize} uses it to execute the image resize command
- * which puts the new value into the model.
- *
- * ```js
- * {
- * editor,
- * modelElement: data.item,
- * viewElement: widget,
- *
- * onCommit( newValue ) {
- * editor.execute( 'imageResize', { width: newValue } );
- * }
- * };
- * ```
- *
- *
- * @member {Function} module:widget/widgetresize~ResizerOptions#onCommit
- */
- /**
- * @member {Function} module:widget/widgetresize~ResizerOptions#getResizeHost
- */
- /**
- * @member {Function} module:widget/widgetresize~ResizerOptions#isCentered
- */
|