| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708 |
- /**
- * @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 engine/view/view
- */
- import Document from './document';
- import DowncastWriter from './downcastwriter';
- import Renderer from './renderer';
- import DomConverter from './domconverter';
- import Position from './position';
- import Range from './range';
- import Selection from './selection';
- import MutationObserver from './observer/mutationobserver';
- import KeyObserver from './observer/keyobserver';
- import FakeSelectionObserver from './observer/fakeselectionobserver';
- import SelectionObserver from './observer/selectionobserver';
- import FocusObserver from './observer/focusobserver';
- import CompositionObserver from './observer/compositionobserver';
- import InputObserver from './observer/inputobserver';
- import ObservableMixin from '@ckeditor/ckeditor5-utils/src/observablemixin';
- import mix from '@ckeditor/ckeditor5-utils/src/mix';
- import { scrollViewportToShowTarget } from '@ckeditor/ckeditor5-utils/src/dom/scroll';
- import { injectUiElementHandling } from './uielement';
- import { injectQuirksHandling } from './filler';
- import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror';
- import env from '@ckeditor/ckeditor5-utils/src/env';
- /**
- * Editor's view controller class. Its main responsibility is DOM - View management for editing purposes, to provide
- * abstraction over the DOM structure and events and hide all browsers quirks.
- *
- * View controller renders view document to DOM whenever view structure changes. To determine when view can be rendered,
- * all changes need to be done using the {@link module:engine/view/view~View#change} method, using
- * {@link module:engine/view/downcastwriter~DowncastWriter}:
- *
- * view.change( writer => {
- * writer.insert( position, writer.createText( 'foo' ) );
- * } );
- *
- * View controller also register {@link module:engine/view/observer/observer~Observer observers} which observes changes
- * on DOM and fire events on the {@link module:engine/view/document~Document Document}.
- * Note that the following observers are added by the class constructor and are always available:
- *
- * * {@link module:engine/view/observer/mutationobserver~MutationObserver},
- * * {@link module:engine/view/observer/selectionobserver~SelectionObserver},
- * * {@link module:engine/view/observer/focusobserver~FocusObserver},
- * * {@link module:engine/view/observer/keyobserver~KeyObserver},
- * * {@link module:engine/view/observer/fakeselectionobserver~FakeSelectionObserver}.
- * * {@link module:engine/view/observer/compositionobserver~CompositionObserver}.
- *
- * This class also {@link module:engine/view/view~View#attachDomRoot binds the DOM and the view elements}.
- *
- * If you do not need full a DOM - view management, and only want to transform a tree of view elements to a tree of DOM
- * elements you do not need this controller. You can use the {@link module:engine/view/domconverter~DomConverter DomConverter} instead.
- *
- * @mixes module:utils/observablemixin~ObservableMixin
- */
- export default class View {
- /**
- * @param {module:engine/view/stylesmap~StylesProcessor} stylesProcessor The styles processor instance..
- */
- constructor( stylesProcessor ) {
- /**
- * Instance of the {@link module:engine/view/document~Document} associated with this view controller.
- *
- * @readonly
- * @type {module:engine/view/document~Document}
- */
- this.document = new Document( stylesProcessor );
- /**
- * Instance of the {@link module:engine/view/domconverter~DomConverter domConverter} used by
- * {@link module:engine/view/view~View#_renderer renderer}
- * and {@link module:engine/view/observer/observer~Observer observers}.
- *
- * @readonly
- * @type {module:engine/view/domconverter~DomConverter}
- */
- this.domConverter = new DomConverter( this.document );
- /**
- * Roots of the DOM tree. Map on the `HTMLElement`s with roots names as keys.
- *
- * @readonly
- * @type {Map.<String, HTMLElement>}
- */
- this.domRoots = new Map();
- /**
- * Used to prevent calling {@link #forceRender} and {@link #change} during rendering view to the DOM.
- *
- * @readonly
- * @member {Boolean} #isRenderingInProgress
- */
- this.set( 'isRenderingInProgress', false );
- /**
- * Instance of the {@link module:engine/view/renderer~Renderer renderer}.
- *
- * @protected
- * @type {module:engine/view/renderer~Renderer}
- */
- this._renderer = new Renderer( this.domConverter, this.document.selection );
- this._renderer.bind( 'isFocused' ).to( this.document );
- /**
- * A DOM root attributes cache. It saves the initial values of DOM root attributes before the DOM element
- * is {@link module:engine/view/view~View#attachDomRoot attached} to the view so later on, when
- * the view is destroyed ({@link module:engine/view/view~View#detachDomRoot}), they can be easily restored.
- * This way, the DOM element can go back to the (clean) state as if the editing view never used it.
- *
- * @private
- * @member {WeakMap.<HTMLElement,Object>}
- */
- this._initialDomRootAttributes = new WeakMap();
- /**
- * Map of registered {@link module:engine/view/observer/observer~Observer observers}.
- *
- * @private
- * @type {Map.<Function, module:engine/view/observer/observer~Observer>}
- */
- this._observers = new Map();
- /**
- * Is set to `true` when {@link #change view changes} are currently in progress.
- *
- * @private
- * @type {Boolean}
- */
- this._ongoingChange = false;
- /**
- * Used to prevent calling {@link #forceRender} and {@link #change} during rendering view to the DOM.
- *
- * @private
- * @type {Boolean}
- */
- this._postFixersInProgress = false;
- /**
- * Internal flag to temporary disable rendering. See the usage in the {@link #_disableRendering}.
- *
- * @private
- * @type {Boolean}
- */
- this._renderingDisabled = false;
- /**
- * Internal flag that disables rendering when there are no changes since the last rendering.
- * It stores information about changed selection and changed elements from attached document roots.
- *
- * @private
- * @type {Boolean}
- */
- this._hasChangedSinceTheLastRendering = false;
- /**
- * DowncastWriter instance used in {@link #change change method} callbacks.
- *
- * @private
- * @type {module:engine/view/downcastwriter~DowncastWriter}
- */
- this._writer = new DowncastWriter( this.document );
- // Add default observers.
- this.addObserver( MutationObserver );
- this.addObserver( SelectionObserver );
- this.addObserver( FocusObserver );
- this.addObserver( KeyObserver );
- this.addObserver( FakeSelectionObserver );
- this.addObserver( CompositionObserver );
- if ( env.isAndroid ) {
- this.addObserver( InputObserver );
- }
- // Inject quirks handlers.
- injectQuirksHandling( this );
- injectUiElementHandling( this );
- // Use 'normal' priority so that rendering is performed as first when using that priority.
- this.on( 'render', () => {
- this._render();
- // Informs that layout has changed after render.
- this.document.fire( 'layoutChanged' );
- // Reset the `_hasChangedSinceTheLastRendering` flag after rendering.
- this._hasChangedSinceTheLastRendering = false;
- } );
- // Listen to the document selection changes directly.
- this.listenTo( this.document.selection, 'change', () => {
- this._hasChangedSinceTheLastRendering = true;
- } );
- }
- /**
- * Attaches a DOM root element to the view element and enable all observers on that element.
- * Also {@link module:engine/view/renderer~Renderer#markToSync mark element} to be synchronized
- * with the view what means that all child nodes will be removed and replaced with content of the view root.
- *
- * This method also will change view element name as the same as tag name of given dom root.
- * Name is always transformed to lower case.
- *
- * **Note:** Use {@link #detachDomRoot `detachDomRoot()`} to revert this action.
- *
- * @param {Element} domRoot DOM root element.
- * @param {String} [name='main'] Name of the root.
- */
- attachDomRoot( domRoot, name = 'main' ) {
- const viewRoot = this.document.getRoot( name );
- // Set view root name the same as DOM root tag name.
- viewRoot._name = domRoot.tagName.toLowerCase();
- const initialDomRootAttributes = {};
- // 1. Copy and cache the attributes to remember the state of the element before attaching.
- // The cached attributes will be restored in detachDomRoot() so the element goes to the
- // clean state as if the editing view never used it.
- // 2. Apply the attributes using the view writer, so they all go under the control of the engine.
- // The editing view takes over the attribute management completely because various
- // features (e.g. addPlaceholder()) require dynamic changes of those attributes and they
- // cannot be managed by the engine and the UI library at the same time.
- for ( const { name, value } of Array.from( domRoot.attributes ) ) {
- initialDomRootAttributes[ name ] = value;
- // Do not use writer.setAttribute() for the class attribute. The EditableUIView class
- // and its descendants could have already set some using the writer.addClass() on the view
- // document root. They haven't been rendered yet so they are not present in the DOM root.
- // Using writer.setAttribute( 'class', ... ) would override them completely.
- if ( name === 'class' ) {
- this._writer.addClass( value.split( ' ' ), viewRoot );
- } else {
- this._writer.setAttribute( name, value, viewRoot );
- }
- }
- this._initialDomRootAttributes.set( domRoot, initialDomRootAttributes );
- const updateContenteditableAttribute = () => {
- this._writer.setAttribute( 'contenteditable', !viewRoot.isReadOnly, viewRoot );
- if ( viewRoot.isReadOnly ) {
- this._writer.addClass( 'ck-read-only', viewRoot );
- } else {
- this._writer.removeClass( 'ck-read-only', viewRoot );
- }
- };
- // Set initial value.
- updateContenteditableAttribute();
- this.domRoots.set( name, domRoot );
- this.domConverter.bindElements( domRoot, viewRoot );
- this._renderer.markToSync( 'children', viewRoot );
- this._renderer.markToSync( 'attributes', viewRoot );
- this._renderer.domDocuments.add( domRoot.ownerDocument );
- viewRoot.on( 'change:children', ( evt, node ) => this._renderer.markToSync( 'children', node ) );
- viewRoot.on( 'change:attributes', ( evt, node ) => this._renderer.markToSync( 'attributes', node ) );
- viewRoot.on( 'change:text', ( evt, node ) => this._renderer.markToSync( 'text', node ) );
- viewRoot.on( 'change:isReadOnly', () => this.change( updateContenteditableAttribute ) );
- viewRoot.on( 'change', () => {
- this._hasChangedSinceTheLastRendering = true;
- } );
- for ( const observer of this._observers.values() ) {
- observer.observe( domRoot, name );
- }
- }
- /**
- * Detaches a DOM root element from the view element and restores its attributes to the state before
- * {@link #attachDomRoot `attachDomRoot()`}.
- *
- * @param {String} name Name of the root to detach.
- */
- detachDomRoot( name ) {
- const domRoot = this.domRoots.get( name );
- // Remove all root attributes so the DOM element is "bare".
- Array.from( domRoot.attributes ).forEach( ( { name } ) => domRoot.removeAttribute( name ) );
- const initialDomRootAttributes = this._initialDomRootAttributes.get( domRoot );
- // Revert all view root attributes back to the state before attachDomRoot was called.
- for ( const attribute in initialDomRootAttributes ) {
- domRoot.setAttribute( attribute, initialDomRootAttributes[ attribute ] );
- }
- this.domRoots.delete( name );
- this.domConverter.unbindDomElement( domRoot );
- }
- /**
- * Gets DOM root element.
- *
- * @param {String} [name='main'] Name of the root.
- * @returns {Element} DOM root element instance.
- */
- getDomRoot( name = 'main' ) {
- return this.domRoots.get( name );
- }
- /**
- * Creates observer of the given type if not yet created, {@link module:engine/view/observer/observer~Observer#enable enables} it
- * and {@link module:engine/view/observer/observer~Observer#observe attaches} to all existing and future
- * {@link #domRoots DOM roots}.
- *
- * Note: Observers are recognized by their constructor (classes). A single observer will be instantiated and used only
- * when registered for the first time. This means that features and other components can register a single observer
- * multiple times without caring whether it has been already added or not.
- *
- * @param {Function} Observer The constructor of an observer to add.
- * Should create an instance inheriting from {@link module:engine/view/observer/observer~Observer}.
- * @returns {module:engine/view/observer/observer~Observer} Added observer instance.
- */
- addObserver( Observer ) {
- let observer = this._observers.get( Observer );
- if ( observer ) {
- return observer;
- }
- observer = new Observer( this );
- this._observers.set( Observer, observer );
- for ( const [ name, domElement ] of this.domRoots ) {
- observer.observe( domElement, name );
- }
- observer.enable();
- return observer;
- }
- /**
- * Returns observer of the given type or `undefined` if such observer has not been added yet.
- *
- * @param {Function} Observer The constructor of an observer to get.
- * @returns {module:engine/view/observer/observer~Observer|undefined} Observer instance or undefined.
- */
- getObserver( Observer ) {
- return this._observers.get( Observer );
- }
- /**
- * Disables all added observers.
- */
- disableObservers() {
- for ( const observer of this._observers.values() ) {
- observer.disable();
- }
- }
- /**
- * Enables all added observers.
- */
- enableObservers() {
- for ( const observer of this._observers.values() ) {
- observer.enable();
- }
- }
- /**
- * Scrolls the page viewport and {@link #domRoots} with their ancestors to reveal the
- * caret, if not already visible to the user.
- */
- scrollToTheSelection() {
- const range = this.document.selection.getFirstRange();
- if ( range ) {
- scrollViewportToShowTarget( {
- target: this.domConverter.viewRangeToDom( range ),
- viewportOffset: 20
- } );
- }
- }
- /**
- * It will focus DOM element representing {@link module:engine/view/editableelement~EditableElement EditableElement}
- * that is currently having selection inside.
- */
- focus() {
- if ( !this.document.isFocused ) {
- const editable = this.document.selection.editableElement;
- if ( editable ) {
- this.domConverter.focus( editable );
- this.forceRender();
- } else {
- // Before focusing view document, selection should be placed inside one of the view's editables.
- // Normally its selection will be converted from model document (which have default selection), but
- // when using view document on its own, we need to manually place selection before focusing it.
- //
- // @if CK_DEBUG // console.warn( 'There is no selection in any editable to focus.' );
- }
- }
- }
- /**
- * The `change()` method is the primary way of changing the view. You should use it to modify any node in the view tree.
- * It makes sure that after all changes are made the view is rendered to the DOM (assuming that the view will be changed
- * inside the callback). It prevents situations when the DOM is updated when the view state is not yet correct. It allows
- * to nest calls one inside another and still performs a single rendering after all those changes are made.
- * It also returns the return value of its callback.
- *
- * const text = view.change( writer => {
- * const newText = writer.createText( 'foo' );
- * writer.insert( position1, newText );
- *
- * view.change( writer => {
- * writer.insert( position2, writer.createText( 'bar' ) );
- * } );
- *
- * writer.remove( range );
- *
- * return newText;
- * } );
- *
- * When the outermost change block is done and rendering to the DOM is over the
- * {@link module:engine/view/view~View#event:render `View#render`} event is fired.
- *
- * This method throws a `applying-view-changes-on-rendering` error when
- * the change block is used after rendering to the DOM has started.
- *
- * @param {Function} callback Callback function which may modify the view.
- * @returns {*} Value returned by the callback.
- */
- change( callback ) {
- if ( this.isRenderingInProgress || this._postFixersInProgress ) {
- /**
- * Thrown when there is an attempt to make changes to the view tree when it is in incorrect state. This may
- * cause some unexpected behaviour and inconsistency between the DOM and the view.
- * This may be caused by:
- *
- * * calling {@link #change} or {@link #forceRender} during rendering process,
- * * calling {@link #change} or {@link #forceRender} inside of
- * {@link module:engine/view/document~Document#registerPostFixer post-fixer function}.
- *
- * @error cannot-change-view-tree
- */
- throw new CKEditorError(
- 'cannot-change-view-tree: ' +
- 'Attempting to make changes to the view when it is in an incorrect state: rendering or post-fixers are in progress. ' +
- 'This may cause some unexpected behavior and inconsistency between the DOM and the view.',
- this
- );
- }
- try {
- // Recursive call to view.change() method - execute listener immediately.
- if ( this._ongoingChange ) {
- return callback( this._writer );
- }
- // This lock will assure that all recursive calls to view.change() will end up in same block - one "render"
- // event for all nested calls.
- this._ongoingChange = true;
- const callbackResult = callback( this._writer );
- this._ongoingChange = false;
- // This lock is used by editing controller to render changes from outer most model.change() once. As plugins might call
- // view.change() inside model.change() block - this will ensures that postfixers and rendering are called once after all
- // changes. Also, we don't need to render anything if there're no changes since last rendering.
- if ( !this._renderingDisabled && this._hasChangedSinceTheLastRendering ) {
- this._postFixersInProgress = true;
- this.document._callPostFixers( this._writer );
- this._postFixersInProgress = false;
- this.fire( 'render' );
- }
- return callbackResult;
- } catch ( err ) {
- // @if CK_DEBUG // throw err;
- /* istanbul ignore next */
- CKEditorError.rethrowUnexpectedError( err, this );
- }
- }
- /**
- * Forces rendering {@link module:engine/view/document~Document view document} to DOM. If any view changes are
- * currently in progress, rendering will start after all {@link #change change blocks} are processed.
- *
- * Note that this method is dedicated for special cases. All view changes should be wrapped in the {@link #change}
- * block and the view will automatically check whether it needs to render DOM or not.
- *
- * Throws {@link module:utils/ckeditorerror~CKEditorError CKEditorError} `applying-view-changes-on-rendering` when
- * trying to re-render when rendering to DOM has already started.
- */
- forceRender() {
- this._hasChangedSinceTheLastRendering = true;
- this.change( () => {} );
- }
- /**
- * Destroys this instance. Makes sure that all observers are destroyed and listeners removed.
- */
- destroy() {
- for ( const observer of this._observers.values() ) {
- observer.destroy();
- }
- this.document.destroy();
- this.stopListening();
- }
- /**
- * Creates position at the given location. The location can be specified as:
- *
- * * a {@link module:engine/view/position~Position position},
- * * parent element and offset (offset defaults to `0`),
- * * parent element and `'end'` (sets position at the end of that element),
- * * {@link module:engine/view/item~Item view item} and `'before'` or `'after'` (sets position before or after given view item).
- *
- * This method is a shortcut to other constructors such as:
- *
- * * {@link #createPositionBefore},
- * * {@link #createPositionAfter},
- *
- * @param {module:engine/view/item~Item|module:engine/model/position~Position} itemOrPosition
- * @param {Number|'end'|'before'|'after'} [offset] Offset or one of the flags. Used only when
- * first parameter is a {@link module:engine/view/item~Item view item}.
- */
- createPositionAt( itemOrPosition, offset ) {
- return Position._createAt( itemOrPosition, offset );
- }
- /**
- * Creates a new position after given view item.
- *
- * @param {module:engine/view/item~Item} item View item after which the position should be located.
- * @returns {module:engine/view/position~Position}
- */
- createPositionAfter( item ) {
- return Position._createAfter( item );
- }
- /**
- * Creates a new position before given view item.
- *
- * @param {module:engine/view/item~Item} item View item before which the position should be located.
- * @returns {module:engine/view/position~Position}
- */
- createPositionBefore( item ) {
- return Position._createBefore( item );
- }
- /**
- * Creates a range spanning from `start` position to `end` position.
- *
- * **Note:** This factory method creates it's own {@link module:engine/view/position~Position} instances basing on passed values.
- *
- * @param {module:engine/view/position~Position} start Start position.
- * @param {module:engine/view/position~Position} [end] End position. If not set, range will be collapsed at `start` position.
- * @returns {module:engine/view/range~Range}
- */
- createRange( start, end ) {
- return new Range( start, end );
- }
- /**
- * Creates a range that starts before given {@link module:engine/view/item~Item view item} and ends after it.
- *
- * @param {module:engine/view/item~Item} item
- * @returns {module:engine/view/range~Range}
- */
- createRangeOn( item ) {
- return Range._createOn( item );
- }
- /**
- * Creates a range inside an {@link module:engine/view/element~Element element} which starts before the first child of
- * that element and ends after the last child of that element.
- *
- * @param {module:engine/view/element~Element} element Element which is a parent for the range.
- * @returns {module:engine/view/range~Range}
- */
- createRangeIn( element ) {
- return Range._createIn( element );
- }
- /**
- Creates new {@link module:engine/view/selection~Selection} instance.
- *
- * // Creates empty selection without ranges.
- * const selection = view.createSelection();
- *
- * // Creates selection at the given range.
- * const range = view.createRange( start, end );
- * const selection = view.createSelection( range );
- *
- * // Creates selection at the given ranges
- * const ranges = [ view.createRange( start1, end2 ), view.createRange( star2, end2 ) ];
- * const selection = view.createSelection( ranges );
- *
- * // Creates selection from the other selection.
- * const otherSelection = view.createSelection();
- * const selection = view.createSelection( otherSelection );
- *
- * // Creates selection from the document selection.
- * const selection = view.createSelection( editor.editing.view.document.selection );
- *
- * // Creates selection at the given position.
- * const position = view.createPositionFromPath( root, path );
- * const selection = view.createSelection( position );
- *
- * // Creates collapsed selection at the position of given item and offset.
- * const paragraph = view.createContainerElement( 'paragraph' );
- * const selection = view.createSelection( paragraph, offset );
- *
- * // Creates a range inside an {@link module:engine/view/element~Element element} which starts before the
- * // first child of that element and ends after the last child of that element.
- * const selection = view.createSelection( paragraph, 'in' );
- *
- * // Creates a range on an {@link module:engine/view/item~Item item} which starts before the item and ends
- * // just after the item.
- * const selection = view.createSelection( paragraph, 'on' );
- *
- * `Selection`'s factory method allow passing additional options (`backward`, `fake` and `label`) as the last argument.
- *
- * // Creates backward selection.
- * const selection = view.createSelection( range, { backward: true } );
- *
- * Fake selection does not render as browser native selection over selected elements and is hidden to the user.
- * This way, no native selection UI artifacts are displayed to the user and selection over elements can be
- * represented in other way, for example by applying proper CSS class.
- *
- * Additionally fake's selection label can be provided. It will be used to describe fake selection in DOM
- * (and be properly handled by screen readers).
- *
- * // Creates fake selection with label.
- * const selection = view.createSelection( range, { fake: true, label: 'foo' } );
- *
- * @param {module:engine/view/selection~Selectable} [selectable=null]
- * @param {Number|'before'|'end'|'after'|'on'|'in'} [placeOrOffset] Offset or place when selectable is an `Item`.
- * @param {Object} [options]
- * @param {Boolean} [options.backward] Sets this selection instance to be backward.
- * @param {Boolean} [options.fake] Sets this selection instance to be marked as `fake`.
- * @param {String} [options.label] Label for the fake selection.
- * @returns {module:engine/view/selection~Selection}
- */
- createSelection( selectable, placeOrOffset, options ) {
- return new Selection( selectable, placeOrOffset, options );
- }
- /**
- * Disables or enables rendering. If the flag is set to `true` then the rendering will be disabled.
- * If the flag is set to `false` and if there was some change in the meantime, then the rendering action will be performed.
- *
- * @protected
- * @param {Boolean} flag A flag indicates whether the rendering should be disabled.
- */
- _disableRendering( flag ) {
- this._renderingDisabled = flag;
- if ( flag == false ) {
- // Render when you stop blocking rendering.
- this.change( () => {} );
- }
- }
- /**
- * Renders all changes. In order to avoid triggering the observers (e.g. mutations) all observers are disabled
- * before rendering and re-enabled after that.
- *
- * @private
- */
- _render() {
- this.isRenderingInProgress = true;
- this.disableObservers();
- this._renderer.render();
- this.enableObservers();
- this.isRenderingInProgress = false;
- }
- /**
- * Fired after a topmost {@link module:engine/view/view~View#change change block} and all
- * {@link module:engine/view/document~Document#registerPostFixer post-fixers} are executed.
- *
- * Actual rendering is performed as a first listener on 'normal' priority.
- *
- * view.on( 'render', () => {
- * // Rendering to the DOM is complete.
- * } );
- *
- * This event is useful when you want to update interface elements after the rendering, e.g. position of the
- * balloon panel. If you wants to change view structure use
- * {@link module:engine/view/document~Document#registerPostFixer post-fixers}.
- *
- * @event module:engine/view/view~View#event:render
- */
- }
- mix( View, ObservableMixin );
|