mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor
synced 2024-09-28 12:46:45 +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
116 lines
3 KiB
JavaScript
116 lines
3 KiB
JavaScript
/*!
|
|
* VisualEditor ContentEditable MWReferenceNode class.
|
|
*
|
|
* @copyright 2011-2013 VisualEditor Team and others; see AUTHORS.txt
|
|
* @license The MIT License (MIT); see LICENSE.txt
|
|
*/
|
|
|
|
/**
|
|
* ContentEditable MediaWiki reference node.
|
|
*
|
|
* @class
|
|
* @extends ve.ce.LeafNode
|
|
* @mixins ve.ce.FocusableNode
|
|
* @mixins ve.ce.ProtectedNode
|
|
*
|
|
* @constructor
|
|
* @param {ve.dm.MWReferenceNode} model Model to observe
|
|
* @param {Object} [config] Config options
|
|
*/
|
|
ve.ce.MWReferenceNode = function VeCeMWReferenceNode( model, config ) {
|
|
// Parent constructor
|
|
ve.ce.LeafNode.call( this, model, config );
|
|
|
|
// Mixin constructors
|
|
ve.ce.FocusableNode.call( this );
|
|
ve.ce.ProtectedNode.call( this );
|
|
|
|
// DOM Changes
|
|
this.$link = $( '<a>' ).attr( 'href', '#' );
|
|
this.$.addClass( 've-ce-mwReferenceNode', 'reference' )
|
|
.attr( 'contenteditable', false )
|
|
.append( this.$link );
|
|
|
|
this.index = '';
|
|
this.internalList = this.model.getDocument().internalList;
|
|
|
|
// Events
|
|
this.connect( this, { 'live': 'onLive' } );
|
|
this.$link.click( ve.bind( this.onClick, this ) );
|
|
|
|
// Initialization
|
|
this.update();
|
|
};
|
|
|
|
/* Inheritance */
|
|
|
|
ve.inheritClass( ve.ce.MWReferenceNode, ve.ce.LeafNode );
|
|
|
|
ve.mixinClass( ve.ce.MWReferenceNode, ve.ce.FocusableNode );
|
|
ve.mixinClass( ve.ce.MWReferenceNode, ve.ce.ProtectedNode );
|
|
|
|
/* Static Properties */
|
|
|
|
ve.ce.MWReferenceNode.static.name = 'mwReference';
|
|
|
|
ve.ce.MWReferenceNode.static.tagName = 'sup';
|
|
|
|
/* Methods */
|
|
|
|
/**
|
|
* Handle live events.
|
|
* @method
|
|
*/
|
|
ve.ce.MWReferenceNode.prototype.onLive = function () {
|
|
// As we are listening to the internal list, we need to make sure
|
|
// we remove the listeners when this object is removed from the document
|
|
if ( this.live ) {
|
|
this.internalList.connect( this, { 'update': 'onInternalListUpdate' } );
|
|
} else {
|
|
this.internalList.disconnect( this );
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Handle the updating of the InternalList object.
|
|
*
|
|
* This will occur after a document transaction.
|
|
*
|
|
* @method
|
|
* @param {string[]} groupsChanged A list of groups which have changed in this transaction
|
|
*/
|
|
ve.ce.MWReferenceNode.prototype.onInternalListUpdate = function ( groupsChanged ) {
|
|
// Only update if this group has been changed
|
|
if ( ve.indexOf( this.model.getAttribute( 'listGroup' ), groupsChanged ) !== -1 ) {
|
|
this.update();
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Handle update events.
|
|
*
|
|
* @method
|
|
*/
|
|
ve.ce.MWReferenceNode.prototype.update = function () {
|
|
var listKey = this.model.getAttribute( 'listKey' ),
|
|
listGroup = this.model.getAttribute( 'listGroup' ),
|
|
refGroup = this.model.getAttribute( 'refGroup' ),
|
|
position = this.internalList.getKeyPosition( listGroup, listKey );
|
|
this.$link.text( '[' + ( refGroup ? refGroup + ' ' : '' ) + ( position + 1 ) + ']' );
|
|
};
|
|
|
|
/**
|
|
* Handle the reference being clicked.
|
|
*
|
|
* @method
|
|
*/
|
|
ve.ce.MWReferenceNode.prototype.onClick = function ( e ) {
|
|
// TODO: Start editing. Internal item dm node can be accessed using:
|
|
// var itemNode = this.model.getInternalItem();
|
|
e.preventDefault();
|
|
};
|
|
|
|
/* Registration */
|
|
|
|
ve.ce.nodeFactory.register( ve.ce.MWReferenceNode );
|