mediawiki-extensions-Visual.../modules/ve/ce/nodes/ve.ce.HeadingNode.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

74 lines
1.4 KiB
JavaScript

/*!
* VisualEditor ContentEditable HeadingNode class.
*
* @copyright 2011-2012 VisualEditor Team and others; see AUTHORS.txt
* @license The MIT License (MIT); see LICENSE.txt
*/
/**
* ContentEditable heading node.
*
* @class
* @extends ve.ce.BranchNode
* @constructor
* @param {ve.dm.HeadingNode} model Model to observe
*/
ve.ce.HeadingNode = function VeCeHeadingNode( model ) {
// Parent constructor
ve.ce.ContentBranchNode.call(
this, 'heading', model, ve.ce.BranchNode.getDomWrapper( model, 'level' )
);
// Events
this.model.addListenerMethod( this, 'update', 'onUpdate' );
};
/* Inheritance */
ve.inheritClass( ve.ce.HeadingNode, ve.ce.ContentBranchNode );
/* Static Properties */
/**
* Node rules.
*
* @see ve.ce.NodeFactory
* @static
* @property
*/
ve.ce.HeadingNode.rules = {
'canBeSplit': true
};
/**
* Mapping of heading level values and DOM wrapper element types.
*
* @static
* @property
*/
ve.ce.HeadingNode.domWrapperElementTypes = {
'1': 'h1',
'2': 'h2',
'3': 'h3',
'4': 'h4',
'5': 'h5',
'6': 'h6'
};
/* Methods */
/**
* Handle model update events.
*
* If the level changed since last update the DOM wrapper will be replaced with an appropriate one.
*
* @method
*/
ve.ce.HeadingNode.prototype.onUpdate = function () {
this.updateDomWrapper( 'level' );
};
/* Registration */
ve.ce.nodeFactory.register( 'heading', ve.ce.HeadingNode );