mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor
synced 2024-09-27 20:26:46 +00:00
8d33a3de0d
* Made method descriptions imperative: "Do this" rather than "Does this" * Changed use of "this object" to "the object" in method documentation * Added missing documentation * Fixed incorrect documentation * Fixed incorrect debug method names (as in those VeDmClassName tags we add to functions so they make sense when dumped into in the console) * Normalized use of package names throughout * Normalized class descriptions * Removed incorrect @abstract tags * Added missing @method tags * Lots of other minor cleanup Change-Id: I4ea66a2dd107613e2ea3a5f56ff54d675d72957e
43 lines
992 B
JavaScript
43 lines
992 B
JavaScript
/*!
|
|
* VisualEditor DataModel DocumentSlice class.
|
|
*
|
|
* @copyright 2011-2012 VisualEditor Team and others; see AUTHORS.txt
|
|
* @license The MIT License (MIT); see LICENSE.txt
|
|
*/
|
|
|
|
/**
|
|
* DataModel document slice.
|
|
*
|
|
* @extends ve.Node
|
|
* @constructor
|
|
* @param {Array} data Balanced sliced data (will be deep copied internally)
|
|
* @param {ve.Range} [range] Original context within data
|
|
*/
|
|
ve.dm.DocumentSlice = function VeDmDocumentSlice( data, range ) {
|
|
// Properties
|
|
this.data = ve.copyArray( data );
|
|
this.range = range || new ve.Range( 0, data.length );
|
|
};
|
|
|
|
/* Methods */
|
|
|
|
/**
|
|
* Get a deep copy of the sliced data.
|
|
*
|
|
* @method
|
|
* @returns {Array} Document data
|
|
*/
|
|
ve.dm.DocumentSlice.prototype.getData = function () {
|
|
return this.data.slice( this.range.start, this.range.end );
|
|
};
|
|
|
|
/**
|
|
* Get a balanced version of the sliced data.
|
|
*
|
|
* @method
|
|
* @returns {Array} Document data
|
|
*/
|
|
ve.dm.DocumentSlice.prototype.getBalancedData = function () {
|
|
return this.data.slice( 0 );
|
|
};
|