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

75 lines
1.8 KiB
JavaScript

/*!
* VisualEditor DataModel MetaBlockNode class.
*
* @copyright 2011-2012 VisualEditor Team and others; see AUTHORS.txt
* @license The MIT License (MIT); see LICENSE.txt
*/
/**
* DataModel meta block node.
*
* @class
* @extends ve.dm.BranchNode
* @constructor
* @param {number} [length] Length of content data in document
* @param {Object} [element] Reference to element in linear model
*/
ve.dm.MetaBlockNode = function VeDmMetaBlockNode( length, element ) {
// Parent constructor
ve.dm.BranchNode.call( this, 'metaBlock', 0, element );
};
/* Inheritance */
ve.inheritClass( ve.dm.MetaBlockNode, ve.dm.LeafNode );
/* Static Properties */
/**
* Node rules.
*
* @see ve.dm.NodeFactory
* @static
* @property
*/
ve.dm.MetaBlockNode.rules = {
'isWrapped': true,
'isContent': false,
'canContainContent': false,
'hasSignificantWhitespace': false,
'childNodeTypes': [],
'parentNodeTypes': null
};
/**
* Node converters.
*
* @see ve.dm.Converter
* @static
* @property
*/
ve.dm.MetaBlockNode.converters = {
'domElementTypes': ['meta', 'link'],
'toDomElement': function ( type, element ) {
var isLink, domElement;
if ( element.attributes.style === 'comment' ) {
domElement = document.createComment( element.attributes.text );
} else {
isLink = element.attributes.style === 'link';
domElement = document.createElement( isLink ? 'link' : 'meta' );
if ( element.attributes.key !== null ) {
domElement.setAttribute( isLink ? 'rel' : 'property', element.attributes.key );
}
if ( element.attributes.value ) {
domElement.setAttribute( isLink ? 'href' : 'content', element.attributes.value );
}
}
return domElement;
},
'toDataElement': null // Special handling in ve.dm.Converter
};
/* Registration */
ve.dm.nodeFactory.register( 'metaBlock', ve.dm.MetaBlockNode );