mediawiki-extensions-Visual.../modules/ve2/dm/nodes/ve.dm.DocumentNode.js
Trevor Parscal 9b2098cb56 Added documentation to static rules on ve.dm nodes
They are used by ve.dm.factory so this might make it easier for people to understand what's going on.

Change-Id: I490627e3bfc55ca9c96fdc4f5d047737b6a3db8c
2012-04-30 15:47:54 -07:00

46 lines
991 B
JavaScript

/**
* Data model node for a document.
*
* @class
* @constructor
* @extends {ve.dm.BranchNode}
* @param {ve.dm.BranchNode[]} [children] Child nodes to attach
* @param {Object} [attributes] Reference to map of attribute key/value pairs
*/
ve.dm.DocumentNode = function( children, attributes ) {
// Inheritance
ve.dm.BranchNode.call( this, 'document', children, attributes );
};
/* Static Members */
/**
* @see ve.dm.NodeFactory
*/
ve.dm.DocumentNode.rules = {
'canHaveChildren': true,
'canHaveGrandchildren': true,
'childNodeTypes': null,
'parentNodeTypes': []
};
/* Methods */
/**
* Gets the outer length, which for a document node is the same as the inner length.
*
* @method
* @returns {Integer} Length of the entire node
*/
ve.dm.DocumentNode.prototype.getOuterLength = function() {
return this.length;
};
/* Registration */
ve.dm.factory.register( 'document', ve.dm.DocumentNode );
/* Inheritance */
ve.extendClass( ve.dm.DocumentNode, ve.dm.BranchNode );