rooteditableelement.js 1.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071
  1. /**
  2. * @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. /**
  6. * @module engine/view/rooteditableelement
  7. */
  8. import EditableElement from './editableelement';
  9. const rootNameSymbol = Symbol( 'rootName' );
  10. /**
  11. * Class representing a single root in the data view. A root can be either {@link ~RootEditableElement#isReadOnly editable or read-only},
  12. * but in both cases it is called "an editable". Roots can contain other {@link module:engine/view/editableelement~EditableElement
  13. * editable elements} making them "nested editables".
  14. *
  15. * @extends module:engine/view/editableelement~EditableElement
  16. */
  17. export default class RootEditableElement extends EditableElement {
  18. /**
  19. * Creates root editable element.
  20. *
  21. * @param {String} name Node name.
  22. */
  23. constructor( name ) {
  24. super( name );
  25. /**
  26. * Name of this root inside {@link module:engine/view/document~Document} that is an owner of this root. If no
  27. * other name is set, `main` name is used.
  28. *
  29. * @readonly
  30. * @member {String}
  31. */
  32. this.rootName = 'main';
  33. }
  34. /**
  35. * @inheritDoc
  36. */
  37. is( type, name = null ) {
  38. if ( !name ) {
  39. return type == 'rootElement' || super.is( type );
  40. } else {
  41. return ( type == 'rootElement' && name == this.name ) || super.is( type, name );
  42. }
  43. }
  44. get rootName() {
  45. return this.getCustomProperty( rootNameSymbol );
  46. }
  47. set rootName( rootName ) {
  48. this._setCustomProperty( rootNameSymbol, rootName );
  49. }
  50. /**
  51. * Overrides old element name and sets new one.
  52. * This is needed because view roots are created before they are attached to the DOM.
  53. * The name of the root element is temporary at this stage. It has to be changed when the
  54. * view root element is attached to the DOM element.
  55. *
  56. * @protected
  57. * @param {String} name The new name of element.
  58. */
  59. set _name( name ) {
  60. this.name = name;
  61. }
  62. }