mediawiki-extensions-Visual.../modules/ve/ce/ve.ce.DomRange.js
Timo Tijhof ac6c4da3a7 doc: @return -> @returns
Follows-up 8f05cdbf70.

Change-Id: Id2b68e521ab68862f0f635925708a35d10795342
2013-08-01 02:10:23 +02:00

53 lines
1.3 KiB
JavaScript

/*!
* VisualEditor DomRange class.
*
* @copyright 2011-2013 VisualEditor Team and others; see AUTHORS.txt
* @license The MIT License (MIT); see LICENSE.txt
*/
/**
* DomRange.
*
* @class
* @constructor
* @param {HTMLElement} focusNode Selection focus node
* @param {number} focusOffset Selection focus offset
* @param {HTMLElement} anchorNode Selection anchor node
* @param {number} anchorOffset Selection anchor offset
*/
ve.ce.DomRange = function VeCeDomRange( focusNode, focusOffset, anchorNode, anchorOffset ) {
this.focusNode = focusNode;
this.focusOffset = focusOffset;
this.anchorNode = anchorNode;
this.anchorOffset = anchorOffset;
};
/* Static Methods */
ve.ce.DomRange.newFromDomSelection = function ( selection ) {
return new ve.ce.DomRange(
selection.focusNode, selection.focusOffset, selection.anchorNode, selection.anchorOffset
);
};
/* Methods */
/** */
ve.ce.DomRange.prototype.equals = function ( other ) {
return other &&
this.focusNode === other.focusNode &&
this.focusOffset === other.focusOffset &&
this.anchorNode === other.anchorNode &&
this.anchorOffset === other.anchorOffset;
};
/**
* @returns {ve.Range}
*/
ve.ce.DomRange.prototype.getRange = function () {
return new ve.Range(
ve.ce.getOffset( this.anchorNode, this.anchorOffset ),
ve.ce.getOffset( this.focusNode, this.focusOffset )
);
};