rootelement.js 1.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253
  1. /**
  2. * @license Copyright (c) 2003-2016, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. 'use strict';
  6. import Element from './element.js';
  7. /**
  8. * Class for nodes that are roots of trees in tree data model.
  9. *
  10. * @memberOf engine.model
  11. * @extends engine.model.Element
  12. */
  13. export default class RootElement extends Element {
  14. /**
  15. * Creates tree root node.
  16. *
  17. * @param {engine.model.Document} doc {@link engine.model.Document} that is an owner of the root.
  18. * @param {String} name Node name.
  19. * @param {String} rootName Root name inside parent {@link engine.model.Document}.
  20. */
  21. constructor( doc, name, rootName ) {
  22. super( name );
  23. /**
  24. * {@link engine.model.Document} that is an owner of this root.
  25. *
  26. * @readonly
  27. * @member {engine.model.Document} engine.model.RootElement#document
  28. */
  29. this.document = doc;
  30. /**
  31. * Name of this root inside {@link engine.model.Document} that is an owner of this root.
  32. *
  33. * @readonly
  34. * @member {String} engine.model.RootElement#rootName
  35. */
  36. this.rootName = rootName;
  37. }
  38. /**
  39. * Custom toJSON method to solve child-parent circular dependencies.
  40. *
  41. * @method engine.model.RootElement#toJSON
  42. * @returns {String} Name of this root inside {@link engine.model.Document} that is an owner of this root.
  43. */
  44. toJSON() {
  45. return this.rootName;
  46. }
  47. }