mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor
synced 2024-11-14 10:04:52 +00:00
ce60b54d33
This allows us to put other internal data in there in the future. Also passing it through the Node constructor properly now. * ve.dm.Node ** Rename fringeWhitespace property to internal ** Add internal parameter to constructor ** Remove setFringeWhitespace() * Increase the number of parameters passed through by ve.Factory to 3 * Pass through .internal from linmod to nodeFactory in ve.dm.Document * ve.dm.Converter ** Rename .fringeWhitespace to .internal.whitespace and make it an array ** Store a temporary reference to .internal in domElement.veInternal * Add internal to all node constructors except TextNode Tests: * Update for fringeWhitespace->internal rename * Add third parameter to ve.Factory tests * Add .internal to getNodeTreeSummary Change-Id: If20c0bb78fee3efa55f72e51e7fc261283358de7
132 lines
3.3 KiB
JavaScript
132 lines
3.3 KiB
JavaScript
/**
|
|
* VisualEditor data model BranchNode class.
|
|
*
|
|
* @copyright 2011-2012 VisualEditor Team and others; see AUTHORS.txt
|
|
* @license The MIT License (MIT); see LICENSE.txt
|
|
*/
|
|
|
|
/**
|
|
* DataModel node that can have branch or leaf children.
|
|
*
|
|
* @class
|
|
* @abstract
|
|
* @constructor
|
|
* @extends {ve.BranchNode}
|
|
* @extends {ve.dm.Node}
|
|
* @param {String} type Symbolic name of node type
|
|
* @param {ve.dm.Node[]} [children] Child nodes to attach
|
|
* @param {Object} [attributes] Reference to map of attribute key/value pairs
|
|
* @param {Object} [internal] Reference to internal data object
|
|
*/
|
|
ve.dm.BranchNode = function ( type, children, attributes, internal ) {
|
|
// Inheritance
|
|
ve.dm.Node.call( this, type, 0, attributes, internal );
|
|
ve.BranchNode.call( this );
|
|
|
|
if ( ve.isArray( children ) && children.length ) {
|
|
this.splice.apply( this, [0, 0].concat( children ) );
|
|
}
|
|
};
|
|
|
|
/* Methods */
|
|
|
|
/**
|
|
* Adds a node to the end of this node's children.
|
|
*
|
|
* @method
|
|
* @param {ve.dm.BranchNode} childModel Item to add
|
|
* @returns {Integer} New number of children
|
|
* @emits splice (index, 0, [childModel])
|
|
* @emits update
|
|
*/
|
|
ve.dm.BranchNode.prototype.push = function ( childModel ) {
|
|
this.splice( this.children.length, 0, childModel );
|
|
return this.children.length;
|
|
};
|
|
|
|
/**
|
|
* Removes a node from the end of this node's children
|
|
*
|
|
* @method
|
|
* @returns {ve.dm.BranchNode} Removed childModel
|
|
* @emits splice (index, 1, [])
|
|
* @emits update
|
|
*/
|
|
ve.dm.BranchNode.prototype.pop = function () {
|
|
if ( this.children.length ) {
|
|
var childModel = this.children[this.children.length - 1];
|
|
this.splice( this.children.length - 1, 1 );
|
|
return childModel;
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Adds a node to the beginning of this node's children.
|
|
*
|
|
* @method
|
|
* @param {ve.dm.BranchNode} childModel Item to add
|
|
* @returns {Integer} New number of children
|
|
* @emits splice (0, 0, [childModel])
|
|
* @emits update
|
|
*/
|
|
ve.dm.BranchNode.prototype.unshift = function ( childModel ) {
|
|
this.splice( 0, 0, childModel );
|
|
return this.children.length;
|
|
};
|
|
|
|
/**
|
|
* Removes a node from the beginning of this node's children
|
|
*
|
|
* @method
|
|
* @returns {ve.dm.BranchNode} Removed childModel
|
|
* @emits splice (0, 1, [])
|
|
* @emits update
|
|
*/
|
|
ve.dm.BranchNode.prototype.shift = function () {
|
|
if ( this.children.length ) {
|
|
var childModel = this.children[0];
|
|
this.splice( 0, 1 );
|
|
return childModel;
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Adds and removes nodes from this node's children.
|
|
*
|
|
* @method
|
|
* @param {Integer} index Index to remove and or insert nodes at
|
|
* @param {Integer} howmany Number of nodes to remove
|
|
* @param {ve.dm.BranchNode} [...] Variadic list of nodes to insert
|
|
* @returns {ve.dm.BranchNode[]} Removed nodes
|
|
* @emits splice (index, howmany, [...])
|
|
*/
|
|
ve.dm.BranchNode.prototype.splice = function () {
|
|
var i,
|
|
length,
|
|
removals,
|
|
args = Array.prototype.slice.call( arguments ),
|
|
diff = 0;
|
|
|
|
if ( args.length >= 3 ) {
|
|
length = args.length;
|
|
for ( i = 2; i < length; i++ ) {
|
|
args[i].attach( this );
|
|
diff += args[i].getOuterLength();
|
|
}
|
|
}
|
|
|
|
removals = this.children.splice.apply( this.children, args );
|
|
for ( i = 0, length = removals.length; i < length; i++ ) {
|
|
removals[i].detach();
|
|
diff -= removals[i].getOuterLength();
|
|
}
|
|
|
|
this.adjustLength( diff, true );
|
|
this.emit.apply( this, ['splice'].concat( args ) );
|
|
return removals;
|
|
};
|
|
|
|
/* Inheritance */
|
|
|
|
ve.extendClass( ve.dm.BranchNode, ve.BranchNode, ve.dm.Node );
|