mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor
synced 2024-09-27 04:06:51 +00:00
22d1908bd4
The easy part is getting the correct numbers from the InternalList and generating the ordered list HTML. The tricky part is connecting up the events to make sure the renumberings/list generations are triggered when required. InternalList can emit an update event on document transaction, which triggers the renumbering/relisting if any references have been added or deleted during that transaction. ve.ce.MWReferenceListNode also listens to changes on the InternalListNode (i.e. changes to the contents of the references) and always triggers a rebuild. Change-Id: I1b48ef5240e433c3b314259aa68cde13841ea98b
129 lines
3.6 KiB
JavaScript
129 lines
3.6 KiB
JavaScript
/*!
|
|
* VisualEditor DataModel MWReferenceNode class.
|
|
*
|
|
* @copyright 2011-2013 VisualEditor Team and others; see AUTHORS.txt
|
|
* @license The MIT License (MIT); see LICENSE.txt
|
|
*/
|
|
|
|
/**
|
|
* DataModel MediaWiki reference node.
|
|
*
|
|
* @class
|
|
* @extends ve.dm.LeafNode
|
|
* @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.MWReferenceNode = function VeDmMWReferenceNode( length, element ) {
|
|
// Parent constructor
|
|
ve.dm.LeafNode.call( this, 0, element );
|
|
|
|
// Event handlers
|
|
this.connect( this, {
|
|
'root': 'onRoot',
|
|
'unroot': 'onUnroot'
|
|
} );
|
|
};
|
|
|
|
/* Inheritance */
|
|
|
|
ve.inheritClass( ve.dm.MWReferenceNode, ve.dm.LeafNode );
|
|
|
|
/* Static members */
|
|
|
|
ve.dm.MWReferenceNode.static.name = 'mwReference';
|
|
|
|
ve.dm.MWReferenceNode.static.matchTagNames = null;
|
|
|
|
ve.dm.MWReferenceNode.static.matchRdfaTypes = [ 'mw:Extension/ref' ];
|
|
|
|
ve.dm.MWReferenceNode.static.isContent = true;
|
|
|
|
ve.dm.MWReferenceNode.static.toDataElement = function ( domElements, converter ) {
|
|
var dataElement,
|
|
about = domElements[0].getAttribute( 'about' ),
|
|
mw = JSON.parse( domElements[0].getAttribute( 'data-mw' ) || '{}' ),
|
|
body = mw.body ? mw.body.html : '',
|
|
refGroup = mw.attrs.group || '',
|
|
listGroup = this.name + '/' + refGroup,
|
|
listKey = mw.attrs && mw.attrs.name !== undefined ? mw.attrs.name : ve.getHash( body ),
|
|
listIndex = converter.internalList.queueItemHtml( listGroup, listKey, body );
|
|
|
|
dataElement = {
|
|
'type': this.name,
|
|
'attributes': {
|
|
'mw': mw,
|
|
'about': about,
|
|
'listIndex': listIndex,
|
|
'listGroup': listGroup,
|
|
'listKey': listKey,
|
|
'refGroup': refGroup
|
|
}
|
|
};
|
|
return dataElement;
|
|
};
|
|
|
|
ve.dm.MWReferenceNode.static.toDomElements = function ( dataElement, doc, converter ) {
|
|
var itemNodeHtml, mwAttr,
|
|
span = doc.createElement( 'span' ),
|
|
itemNodeWrapper = doc.createElement( 'div' ),
|
|
itemNode = converter.internalList.getItemNode( dataElement.attributes.listIndex ),
|
|
itemNodeRange = itemNode.getRange();
|
|
|
|
span.setAttribute( 'about', dataElement.attributes.about );
|
|
span.setAttribute( 'typeof', 'mw:Extension/ref' );
|
|
|
|
converter.getDomSubtreeFromData(
|
|
itemNode.getDocument().getData().slice( itemNodeRange.start, itemNodeRange.end ),
|
|
itemNodeWrapper
|
|
),
|
|
itemNodeHtml = $( itemNodeWrapper ).html();
|
|
|
|
mwAttr = ( dataElement.attributes && ve.copyObject( dataElement.attributes.mw ) ) || {};
|
|
ve.setProp( mwAttr, 'body', 'html', itemNodeHtml );
|
|
span.setAttribute( 'data-mw', JSON.stringify( mwAttr ) );
|
|
|
|
return [ span ];
|
|
};
|
|
|
|
ve.dm.MWReferenceNode.static.remapInternalListIndexes = function ( dataElement, mapping ) {
|
|
dataElement.attributes.listIndex = mapping[dataElement.attributes.listIndex];
|
|
};
|
|
|
|
/* Methods */
|
|
|
|
/**
|
|
* Gets the internal item node associated with this node
|
|
* @method
|
|
* @returns {ve.dm.InternalItemNode} Item node
|
|
*/
|
|
ve.dm.MWReferenceNode.prototype.getInternalItem = function () {
|
|
return this.getDocument().getInternalList().getItemNode( this.getAttribute( 'listIndex' ) );
|
|
};
|
|
|
|
/**
|
|
* Handle the node being attached to the root
|
|
* @method
|
|
*/
|
|
ve.dm.MWReferenceNode.prototype.onRoot = function () {
|
|
if ( this.getRoot() === this.getDocument().getDocumentNode() ) {
|
|
this.getDocument().getInternalList().addNode(
|
|
this.element.attributes.listGroup, this.element.attributes.listKey, this
|
|
);
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Handle the node being detatched from the root
|
|
* @method
|
|
*/
|
|
ve.dm.MWReferenceNode.prototype.onUnroot = function () {
|
|
this.getDocument().getInternalList().removeNode(
|
|
this.element.attributes.listGroup, this.element.attributes.listKey, this
|
|
);
|
|
};
|
|
|
|
/* Registration */
|
|
|
|
ve.dm.modelRegistry.register( ve.dm.MWReferenceNode );
|