mediawiki-extensions-Visual.../modules/ve/dm/nodes/ve.dm.AlienNode.js
Catrope cf9e5dd953 Add .static.enableAboutGrouping
Defaults to false, nodes can opt into about grouping. Not being used
yet, will be used in the converter rewrite.

Change-Id: Ic2a529241e69fb07ac926c826ead0108193b3050
2013-02-22 15:21:40 -08:00

112 lines
3.2 KiB
JavaScript

/*!
* VisualEditor DataModel AlienNode, AlienBlockNode and AlienInlineNode classes.
*
* @copyright 2011-2013 VisualEditor Team and others; see AUTHORS.txt
* @license The MIT License (MIT); see LICENSE.txt
*/
/**
* DataModel alien node.
*
* @class
* @abstract
* @extends ve.dm.LeafNode
* @constructor
* @param {string} name Node name
* @param {number} [length] Length of content data in document; ignored and overridden to 0
* @param {Object} [element] Reference to element in linear model
*/
ve.dm.AlienNode = function VeDmAlienNode( name, length, element ) {
// Parent constructor
ve.dm.LeafNode.call( this, name, 0, element );
};
/* Inheritance */
ve.inheritClass( ve.dm.AlienNode, ve.dm.LeafNode );
/* Static members */
ve.dm.AlienNode.static.name = 'alien';
ve.dm.AlienNode.static.matchTagNames = [];
ve.dm.AlienNode.static.enableAboutGrouping = true;
ve.dm.AlienNode.static.storeHtmlAttributes = false;
ve.dm.AlienNode.static.toDataElement = function ( domElement, context ) {
// We generate alienBlock elements for block tags and alienInline elements for
// inline tags; unless we're in a content location, in which case we have no choice
// but to generate an alienInline element.
var isInline =
// Force inline in content locations (but not wrappers)
( context.expectingContent && !context.inWrapper ) ||
// Also force inline in wrappers that we can't close
( context.inWrapper && !context.canCloseWrapper ) ||
// Look at the tag name otherwise
!ve.isBlockElement( domElement ),
type = isInline ? 'alienInline' : 'alienBlock',
// TODO handle about groups somehow
html = $( '<div>' ).append( $( domElement ).clone() ).html();
return {
'type': type,
'attributes': {
'html': html
}
};
};
ve.dm.AlienNode.static.toDomElement = function ( dataElement ) {
var wrapper = document.createElement( 'div' );
wrapper.innerHTML = dataElement.attributes.html;
// TODO handle multiple nodes (from about groups) somehow
return wrapper.firstChild;
};
/* Concrete subclasses */
/**
* DataModel alienBlock node.
*
* @class
* @extends ve.dm.AlienNode
* @constructor
* @param {number} [length] Length of content data in document; ignored and overridden to 0
* @param {Object} [element] Reference to element in linear model
*/
ve.dm.AlienBlockNode = function VeDmAlienBlockNode( length, element ) {
// Parent constructor
ve.dm.AlienNode.call( this, 'alienBlock', length, element );
};
ve.inheritClass( ve.dm.AlienBlockNode, ve.dm.AlienNode );
ve.dm.AlienBlockNode.static.name = 'alienBlock';
/**
* DataModel alienInline node.
*
* @class
* @extends ve.dm.AlienNode
* @constructor
* @param {number} [length] Length of content data in document; ignored and overridden to 0
* @param {Object} [element] Reference to element in linear model
*/
ve.dm.AlienInlineNode = function VeDmAlienInlineNode( length, element ) {
// Parent constructor
ve.dm.AlienNode.call( this, 'alienInline', length, element );
};
ve.inheritClass( ve.dm.AlienInlineNode, ve.dm.AlienNode );
ve.dm.AlienInlineNode.static.name = 'alienInline';
ve.dm.AlienInlineNode.static.isContent = true;
/* Registration */
ve.dm.modelRegistry.register( ve.dm.AlienNode );
ve.dm.modelRegistry.register( ve.dm.AlienBlockNode );
ve.dm.modelRegistry.register( ve.dm.AlienInlineNode );