mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor
synced 2024-09-27 20:26:46 +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
74 lines
1.6 KiB
JavaScript
74 lines
1.6 KiB
JavaScript
/*!
|
|
* VisualEditor DataModel ListNode class.
|
|
*
|
|
* @copyright 2011-2012 VisualEditor Team and others; see AUTHORS.txt
|
|
* @license The MIT License (MIT); see LICENSE.txt
|
|
*/
|
|
|
|
/**
|
|
* DataModel list node.
|
|
*
|
|
* @class
|
|
* @extends ve.dm.BranchNode
|
|
* @constructor
|
|
* @param {ve.dm.BranchNode[]} [children] Child nodes to attach
|
|
* @param {Object} [element] Reference to element in linear model
|
|
*/
|
|
ve.dm.ListNode = function VeDmListNode( children, element ) {
|
|
// Parent constructor
|
|
ve.dm.BranchNode.call( this, 'list', children, element );
|
|
};
|
|
|
|
/* Inheritance */
|
|
|
|
ve.inheritClass( ve.dm.ListNode, ve.dm.BranchNode );
|
|
|
|
/* Static Properties */
|
|
|
|
ve.dm.ListNode.defaultAttributes = {
|
|
'style': 'bullet'
|
|
};
|
|
|
|
/**
|
|
* Node rules.
|
|
*
|
|
* @see ve.dm.NodeFactory
|
|
* @static
|
|
* @property
|
|
*/
|
|
ve.dm.ListNode.rules = {
|
|
'isWrapped': true,
|
|
'isContent': false,
|
|
'canContainContent': false,
|
|
'hasSignificantWhitespace': false,
|
|
'childNodeTypes': ['listItem'],
|
|
'parentNodeTypes': null
|
|
};
|
|
|
|
/**
|
|
* Node converters.
|
|
*
|
|
* @see ve.dm.Converter
|
|
* @static
|
|
* @property
|
|
*/
|
|
ve.dm.ListNode.converters = {
|
|
'domElementTypes': ['ul', 'ol'],
|
|
'toDomElement': function ( type, element ) {
|
|
return element.attributes && ( {
|
|
'bullet': document.createElement( 'ul' ),
|
|
'number': document.createElement( 'ol' )
|
|
} )[element.attributes.style];
|
|
},
|
|
'toDataElement': function ( tag ) {
|
|
return ( {
|
|
'ul': { 'type': 'list', 'attributes': { 'style': 'bullet' } },
|
|
'ol': { 'type': 'list', 'attributes': { 'style': 'number' } }
|
|
} )[tag];
|
|
}
|
|
};
|
|
|
|
/* Registration */
|
|
|
|
ve.dm.nodeFactory.register( 'list', ve.dm.ListNode );
|