mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor
synced 2024-09-27 12:16:51 +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
82 lines
2 KiB
JavaScript
82 lines
2 KiB
JavaScript
/*!
|
|
* VisualEditor DataModel HeadingNode class.
|
|
*
|
|
* @copyright 2011-2012 VisualEditor Team and others; see AUTHORS.txt
|
|
* @license The MIT License (MIT); see LICENSE.txt
|
|
*/
|
|
|
|
/**
|
|
* DataModel heading node.
|
|
*
|
|
* @class
|
|
* @extends ve.dm.BranchNode
|
|
* @constructor
|
|
* @param {ve.dm.LeafNode[]} [children] Child nodes to attach
|
|
* @param {Object} [element] Reference to element in linear model
|
|
*/
|
|
ve.dm.HeadingNode = function VeDmHeadingNode( children, element ) {
|
|
// Parent constructor
|
|
ve.dm.BranchNode.call( this, 'heading', children, element );
|
|
};
|
|
|
|
/* Inheritance */
|
|
|
|
ve.inheritClass( ve.dm.HeadingNode, ve.dm.BranchNode );
|
|
|
|
/* Static Properties */
|
|
|
|
ve.dm.HeadingNode.defaultAttributes = {
|
|
'level': 1
|
|
};
|
|
|
|
/**
|
|
* Node rules.
|
|
*
|
|
* @see ve.dm.NodeFactory
|
|
* @static
|
|
* @property
|
|
*/
|
|
ve.dm.HeadingNode.rules = {
|
|
'isWrapped': true,
|
|
'isContent': false,
|
|
'canContainContent': true,
|
|
'hasSignificantWhitespace': false,
|
|
'childNodeTypes': null,
|
|
'parentNodeTypes': null
|
|
};
|
|
|
|
/**
|
|
* Node converters.
|
|
*
|
|
* @see ve.dm.Converter
|
|
* @static
|
|
* @property
|
|
*/
|
|
ve.dm.HeadingNode.converters = {
|
|
'domElementTypes': ['h1', 'h2', 'h3', 'h4', 'h5', 'h6'],
|
|
'toDomElement': function ( type, element ) {
|
|
return element.attributes && ( {
|
|
1: document.createElement( 'h1' ),
|
|
2: document.createElement( 'h2' ),
|
|
3: document.createElement( 'h3' ),
|
|
4: document.createElement( 'h4' ),
|
|
5: document.createElement( 'h5' ),
|
|
6: document.createElement( 'h6' )
|
|
} )[element.attributes.level];
|
|
},
|
|
'toDataElement': function ( tag ) {
|
|
return ( {
|
|
'h1': { 'type': 'heading', 'attributes': { 'level': 1 } },
|
|
'h2': { 'type': 'heading', 'attributes': { 'level': 2 } },
|
|
'h3': { 'type': 'heading', 'attributes': { 'level': 3 } },
|
|
'h4': { 'type': 'heading', 'attributes': { 'level': 4 } },
|
|
'h5': { 'type': 'heading', 'attributes': { 'level': 5 } },
|
|
'h6': { 'type': 'heading', 'attributes': { 'level': 6 } }
|
|
} )[tag];
|
|
}
|
|
};
|
|
|
|
/* Registration */
|
|
|
|
ve.dm.nodeFactory.register( 'heading', ve.dm.HeadingNode );
|