mediawiki-extensions-Visual.../modules/ve/dm/nodes/ve.dm.BreakNode.js
Trevor Parscal 8d33a3de0d Major Documentation Cleanup
* 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
2013-01-16 15:37:59 -08:00

64 lines
1.2 KiB
JavaScript

/*!
* VisualEditor DataModel BreakNode class.
*
* @copyright 2011-2012 VisualEditor Team and others; see AUTHORS.txt
* @license The MIT License (MIT); see LICENSE.txt
*/
/**
* DataModel break node.
*
* @class
* @extends ve.dm.LeafNode
* @constructor
* @param {number} [length] Length of content data in document
* @param {Object} [element] Reference to element in linear model
*/
ve.dm.BreakNode = function VeDmBreakNode( length, element ) {
// Parent constructor
ve.dm.LeafNode.call( this, 'break', 0, element );
};
/* Inheritance */
ve.inheritClass( ve.dm.BreakNode, ve.dm.LeafNode );
/* Static Properties */
/**
* Node rules.
*
* @see ve.dm.NodeFactory
* @static
* @property
*/
ve.dm.BreakNode.rules = {
'isWrapped': true,
'isContent': true,
'canContainContent': false,
'hasSignificantWhitespace': false,
'childNodeTypes': [],
'parentNodeTypes': null
};
/**
* Node converters.
*
* @see ve.dm.Converter
* @static
* @property
*/
ve.dm.BreakNode.converters = {
'domElementTypes': ['br'],
'toDomElement': function () {
return document.createElement( 'br' );
},
'toDataElement': function () {
return { 'type': 'break' };
}
};
/* Registration */
ve.dm.nodeFactory.register( 'break', ve.dm.BreakNode );