range.js 2.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576
  1. /**
  2. * @license Copyright (c) 2003-2015, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. 'use strict';
  6. import Position from './position.js';
  7. /**
  8. * Tree view range.
  9. *
  10. * @memberOf core.treeView
  11. * @extends core.treeView.Range
  12. */
  13. export default class Range {
  14. /**
  15. * Creates a range spanning from `start` position to `end` position.
  16. * **Note:** Constructor creates it's own {@link core.treeView.Position} instances basing on passed values.
  17. *
  18. * @param {core.treeView.Position} start Start position.
  19. * @param {core.treeView.Position} end End position.
  20. */
  21. constructor( start, end ) {
  22. /**
  23. * Start position.
  24. *
  25. * @public
  26. * @member {core.treeView.Position} core.treeModel.Range#start
  27. */
  28. this.start = Position.createFromPosition( start );
  29. /**
  30. * End position.
  31. *
  32. * @public
  33. * @member {core.treeView.Position} core.treeModel.Range#end
  34. */
  35. this.end = Position.createFromPosition( end );
  36. }
  37. /**
  38. * Returns whether the range is collapsed, that is it start and end positions are equal.
  39. *
  40. * @type {Boolean}
  41. */
  42. get isCollapsed() {
  43. return this.start.isEqual( this.end );
  44. }
  45. /**
  46. * Two ranges equal if their start and end positions equal.
  47. *
  48. * @param {core.treeView.Range} otherRange Range to compare with.
  49. * @returns {Boolean} True if ranges equal.
  50. */
  51. isEqual( otherRange ) {
  52. return this == otherRange || ( this.start.isEqual( otherRange.start ) && this.end.isEqual( otherRange.end ) );
  53. }
  54. /**
  55. * Creates a range from given parents and offsets.
  56. *
  57. * @param {core.treeView.Element} startElement Start position parent element.
  58. * @param {Number} startOffset Start position offset.
  59. * @param {core.treeView.Element} endElement End position parent element.
  60. * @param {Number} endOffset End position offset.
  61. * @returns {core.treeView.Range} Created range.
  62. */
  63. static createFromParentsAndOffsets( startElement, startOffset, endElement, endOffset ) {
  64. return new this(
  65. new Position( startElement, startOffset ),
  66. new Position( endElement, endOffset )
  67. );
  68. }
  69. }